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