xref: /freebsd/sys/netgraph/ng_ppp.h (revision a14a0223ae1b172e96dd2a1d849e22026a98b692)
1 
2 /*
3  * ng_ppp.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@whistle.com>
38  *
39  * $FreeBSD$
40  * $Whistle: ng_ppp.h,v 1.8 1999/01/25 02:40:02 archie Exp $
41  */
42 
43 #ifndef _NETGRAPH_PPP_H_
44 #define _NETGRAPH_PPP_H_
45 
46 /* Node type name and magic cookie */
47 #define NG_PPP_NODE_TYPE	"ppp"
48 #define NGM_PPP_COOKIE		940897792
49 
50 /* Maximum number of supported links */
51 #define NG_PPP_MAX_LINKS	16
52 
53 /* Pseudo-link number representing the multi-link bundle */
54 #define NG_PPP_BUNDLE_LINKNUM	0xffff
55 
56 /* Max allowable link latency (miliseconds) and bandwidth (bytes/second/10) */
57 #define NG_PPP_MAX_LATENCY	1000		/* 1 second */
58 #define NG_PPP_MAX_BANDWIDTH	125000		/* 10 Mbits / second */
59 
60 /* Hook names */
61 #define NG_PPP_HOOK_BYPASS	"bypass"	/* unknown protocols */
62 #define NG_PPP_HOOK_COMPRESS	"compress"	/* outgoing compression */
63 #define NG_PPP_HOOK_DECOMPRESS	"decompress"	/* incoming decompression */
64 #define NG_PPP_HOOK_ENCRYPT	"encrypt"	/* outgoing encryption */
65 #define NG_PPP_HOOK_DECRYPT	"decrypt"	/* incoming decryption */
66 #define NG_PPP_HOOK_VJC_IP	"vjc_ip"	/* VJC raw IP */
67 #define NG_PPP_HOOK_VJC_COMP	"vjc_vjcomp"	/* VJC compressed TCP */
68 #define NG_PPP_HOOK_VJC_UNCOMP	"vjc_vjuncomp"	/* VJC uncompressed TCP */
69 #define NG_PPP_HOOK_VJC_VJIP	"vjc_vjip"	/* VJC uncompressed IP */
70 #define NG_PPP_HOOK_INET	"inet"		/* IP packet data */
71 #define NG_PPP_HOOK_ATALK	"atalk"		/* AppleTalk packet data */
72 #define NG_PPP_HOOK_IPX		"ipx"		/* IPX packet data */
73 
74 #define NG_PPP_HOOK_LINK_PREFIX	"link"		/* append decimal link number */
75 
76 /* Netgraph commands */
77 enum {
78 	NGM_PPP_SET_CONFIG = 1,		/* takes struct ng_ppp_bundle_config */
79 	NGM_PPP_GET_CONFIG,		/* returns ng_ppp_bundle_config */
80 	NGM_PPP_GET_LINK_STATS,		/* takes link #, returns stats struct */
81 	NGM_PPP_CLR_LINK_STATS,		/* takes link #, clears link stats */
82 	NGM_PPP_GETCLR_LINK_STATS,	/* takes link #, returns & clrs stats */
83 };
84 
85 /* Per-link config structure */
86 struct ng_ppp_link_config {
87 	u_char		enableLink;	/* enable this link */
88 	u_char		enableProtoComp;/* enable protocol field compression */
89 	u_int16_t	mru;		/* peer MRU */
90 	u_int32_t	latency;	/* link latency (in milliseconds) */
91 	u_int32_t	bandwidth;	/* link bandwidth (in bytes/second) */
92 };
93 
94 /* Node config structure */
95 struct ng_ppp_node_config {
96 	u_int16_t	mrru;			/* multilink peer MRRU */
97 	u_char		enableMultilink;	/* enable multilink */
98 	u_char		recvShortSeq;		/* recv multilink short seq # */
99 	u_char		xmitShortSeq;		/* xmit multilink short seq # */
100 	u_char		enableRoundRobin;	/* xmit whole packets */
101 	u_char		enableIP;		/* enable IP data flow */
102 	u_char		enableAtalk;		/* enable AppleTalk data flow */
103 	u_char		enableIPX;		/* enable IPX data flow */
104 	u_char		enableCompression;	/* enable PPP compression */
105 	u_char		enableDecompression;	/* enable PPP decompression */
106 	u_char		enableEncryption;	/* enable PPP encryption */
107 	u_char		enableDecryption;	/* enable PPP decryption */
108 	u_char		enableVJCompression;	/* enable VJ compression */
109 	u_char		enableVJDecompression;	/* enable VJ decompression */
110 	struct ng_ppp_link_config		/* per link config params */
111 			links[NG_PPP_MAX_LINKS];
112 };
113 
114 /* Statistics struct for a link (or the bundle if NG_PPP_BUNDLE_LINKNUM) */
115 struct ng_ppp_link_stat {
116 	u_int32_t xmitFrames;		/* xmit frames on link */
117 	u_int32_t xmitOctets;		/* xmit octets on link */
118 	u_int32_t recvFrames;		/* recv frames on link */
119 	u_int32_t recvOctets;		/* recv octets on link */
120 	u_int32_t badProtos;		/* frames rec'd with bogus protocol */
121 	u_int32_t dupFragments;		/* MP frames with duplicate seq # */
122 };
123 
124 #endif /* _NETGRAPH_PPP_H_ */
125