xref: /freebsd/sys/netgraph/ng_vjc.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
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  * $Whistle: ng_vjc.h,v 1.6 1999/01/25 02:40:22 archie Exp $
41  */
42 
43 #ifndef _NETGRAPH_NG_VJC_H_
44 #define _NETGRAPH_NG_VJC_H_
45 
46  /* Node type name and magic cookie */
47 #define NG_VJC_NODE_TYPE	"vjc"
48 #define NGM_VJC_COOKIE		868219210
49 
50  /* Hook names */
51 #define NG_VJC_HOOK_IP		"ip"		/* normal IP traffic */
52 #define NG_VJC_HOOK_VJCOMP	"vjcomp"	/* compressed TCP */
53 #define NG_VJC_HOOK_VJUNCOMP	"vjuncomp"	/* uncompressed TCP */
54 #define NG_VJC_HOOK_VJIP	"vjip"		/* uncompressed IP */
55 
56  /* Minimum and maximum number of compression channels */
57 #define NG_VJC_MIN_CHANNELS	4
58 #define NG_VJC_MAX_CHANNELS	16
59 
60  /* Configure struct */
61 struct ngm_vjc_config {
62 	u_char	enableComp;	/* Enable compression */
63 	u_char	enableDecomp;	/* Enable decompression */
64 	u_char	maxChannel;	/* Number of compression channels - 1 */
65 	u_char	compressCID;	/* OK to compress outgoing CID's */
66 };
67 
68 /* Keep this in sync with the above structure definition */
69 #define NG_VJC_CONFIG_TYPE_INFO	{				\
70 	  { "enableComp",	&ng_parse_uint8_type	},	\
71 	  { "enableDecomp",	&ng_parse_uint8_type	},	\
72 	  { "maxChannel",	&ng_parse_uint8_type	},	\
73 	  { "compressCID",	&ng_parse_uint8_type	},	\
74 	  { NULL }						\
75 }
76 
77  /* Netgraph commands */
78 enum {
79 	NGM_VJC_SET_CONFIG,	/* Supply a struct ngm_vjc_config */
80 	NGM_VJC_GET_CONFIG,	/* Returns a struct ngm_vjc_config */
81 	NGM_VJC_GET_STATE,	/* Returns current struct slcompress */
82 	NGM_VJC_CLR_STATS,	/* Clears statistics counters */
83 	NGM_VJC_RECV_ERROR,	/* Indicate loss of incoming frame */
84 };
85 
86 #endif /* _NETGRAPH_NG_VJC_H_ */
87