sys/netgraph7/ng_vjc.h

   1
   2 /*
   3  * ng_vjc.h
   4  */
   5
   6 /*-
   7  * Copyright (c) 1996-1999 Whistle Communications, Inc.
   8  * All rights reserved.
   9  *
  10  * Subject to the following obligations and disclaimer of warranty, use and
  11  * redistribution of this software, in source or object code forms, with or
  12  * without modifications are expressly permitted by Whistle Communications;
  13  * provided, however, that:
  14  * 1. Any and all reproductions of the source or object code must include the
  15  *    copyright notice above and the following disclaimer of warranties; and
  16  * 2. No rights are granted, in any manner or form, to use Whistle
  17  *    Communications, Inc. trademarks, including the mark "WHISTLE
  18  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  19  *    such appears in the above copyright notice or in the software.
  20  *
  21  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  22  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  23  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  24  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  26  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  27  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  28  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  29  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  30  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  31  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  32  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  33  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  36  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  37  * OF SUCH DAMAGE.
  38  *
  39  * Author: Archie Cobbs <archie@freebsd.org>
  40  *
  41  * $FreeBSD: src/sys/netgraph/ng_vjc.h,v 1.9 2005/01/07 01:45:39 imp Exp $
  42  * $DragonFly: src/sys/netgraph7/ng_vjc.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
  43  * $Whistle: ng_vjc.h,v 1.6 1999/01/25 02:40:22 archie Exp $
  44  */
  45
  46 #ifndef _NETGRAPH_NG_VJC_H_
  47 #define _NETGRAPH_NG_VJC_H_
  48
  49  /* Node type name and magic cookie */
  50 #define NG_VJC_NODE_TYPE        "vjc"
  51 #define NGM_VJC_COOKIE          868219210
  52
  53  /* Hook names */
  54 #define NG_VJC_HOOK_IP          "ip"            /* normal IP traffic */
  55 #define NG_VJC_HOOK_VJCOMP      "vjcomp"        /* compressed TCP */
  56 #define NG_VJC_HOOK_VJUNCOMP    "vjuncomp"      /* uncompressed TCP */
  57 #define NG_VJC_HOOK_VJIP        "vjip"          /* uncompressed IP */
  58
  59  /* Minimum and maximum number of compression channels */
  60 #define NG_VJC_MIN_CHANNELS     4
  61 #define NG_VJC_MAX_CHANNELS     16
  62
  63  /* Configure struct */
  64 struct ngm_vjc_config {
  65         u_char  enableComp;     /* Enable compression */
  66         u_char  enableDecomp;   /* Enable decompression */
  67         u_char  maxChannel;     /* Number of compression channels - 1 */
  68         u_char  compressCID;    /* OK to compress outgoing CID's */
  69 };
  70
  71 /* Keep this in sync with the above structure definition */
  72 #define NG_VJC_CONFIG_TYPE_INFO {                               \
  73           { "enableComp",       &ng_parse_uint8_type    },      \
  74           { "enableDecomp",     &ng_parse_uint8_type    },      \
  75           { "maxChannel",       &ng_parse_uint8_type    },      \
  76           { "compressCID",      &ng_parse_uint8_type    },      \
  77           { NULL }                                              \
  78 }
  79
  80  /* Netgraph commands */
  81 enum {
  82         NGM_VJC_SET_CONFIG,     /* Supply a struct ngm_vjc_config */
  83         NGM_VJC_GET_CONFIG,     /* Returns a struct ngm_vjc_config */
  84         NGM_VJC_GET_STATE,      /* Returns current struct slcompress */
  85         NGM_VJC_CLR_STATS,      /* Clears statistics counters */
  86         NGM_VJC_RECV_ERROR,     /* Indicate loss of incoming frame */
  87 };
  88
  89 #endif /* _NETGRAPH_NG_VJC_H_ */