xref: /freebsd/sys/netgraph/ng_ppp.h (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
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		860635544
49 
50 /* Hook names */
51 #define NG_PPP_HOOK_DOWNLINK	"downlink"	/* downstream hook */
52 #define NG_PPP_HOOK_BYPASS	"bypass"	/* any unhooked protocol */
53 
54 /* Netgraph commands */
55 enum {
56 	NGM_PPP_SET_PROTOCOMP = 1,	/* takes an integer 0 or 1 */
57 	NGM_PPP_GET_STATS,		/* returns struct ng_ppp_stat */
58 	NGM_PPP_CLR_STATS,		/* clear stats */
59 };
60 
61 /* Statistics struct */
62 struct ng_ppp_stat {
63 	u_int32_t xmitFrames;		/* xmit frames on "downstream" */
64 	u_int32_t xmitOctets;		/* xmit octets on "downstream" */
65 	u_int32_t recvFrames;		/* recv frames on "downstream" */
66 	u_int32_t recvOctets;		/* recv octets on "downstream" */
67 	u_int32_t badProto;		/* frames with invalid protocol */
68 	u_int32_t unknownProto;		/* frames sent to "unhooked" */
69 };
70 
71 /*
72  * We recognize these hook names for some various PPP protocols. But we
73  * always recognize the hook name "0xNNNN" for any protocol, including these.
74  * So these are really just alias hook names.
75  */
76 #define NG_PPP_HOOK_LCP		"lcp"		/* 0xc021 */
77 #define NG_PPP_HOOK_IPCP	"ipcp"		/* 0x8021 */
78 #define NG_PPP_HOOK_ATCP	"atcp"		/* 0x8029 */
79 #define NG_PPP_HOOK_CCP		"ccp"		/* 0x80fd */
80 #define NG_PPP_HOOK_ECP		"ecp"		/* 0x8053 */
81 #define NG_PPP_HOOK_IP		"ip"		/* 0x0021 */
82 #define NG_PPP_HOOK_VJCOMP	"vjcomp"	/* 0x002d */
83 #define NG_PPP_HOOK_VJUNCOMP	"vjuncomp"	/* 0x002f */
84 #define NG_PPP_HOOK_MP		"mp"		/* 0x003d */
85 #define NG_PPP_HOOK_COMPD	"compd"		/* 0x00fd */
86 #define NG_PPP_HOOK_CRYPTD	"cryptd"	/* 0x0053 */
87 #define NG_PPP_HOOK_PAP		"pap"		/* 0xc023 */
88 #define NG_PPP_HOOK_CHAP	"chap"		/* 0xc223 */
89 #define NG_PPP_HOOK_LQR		"lqr"		/* 0xc025 */
90 
91 #endif /* _NETGRAPH_PPP_H_ */
92