xref: /netbsd/sys/net/ppp_defs.h (revision bf9ec67e)
1 /*	$NetBSD: ppp_defs.h,v 1.7 2000/07/02 17:38:09 sommerfeld Exp $	*/
2 /*	Id: ppp_defs.h,v 1.11 1997/04/30 05:46:24 paulus Exp 	*/
3 
4 /*
5  * ppp_defs.h - PPP definitions.
6  *
7  * Copyright (c) 1994 The Australian National University.
8  * All rights reserved.
9  *
10  * Permission to use, copy, modify, and distribute this software and its
11  * documentation is hereby granted, provided that the above copyright
12  * notice appears in all copies.  This software is provided without any
13  * warranty, express or implied. The Australian National University
14  * makes no representations about the suitability of this software for
15  * any purpose.
16  *
17  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
18  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
19  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
20  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
21  * OF SUCH DAMAGE.
22  *
23  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
24  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
25  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
26  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
27  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
28  * OR MODIFICATIONS.
29  */
30 
31 #ifndef _NET_PPP_DEFS_H_
32 #define _NET_PPP_DEFS_H_
33 
34 /*
35  * The basic PPP frame.
36  */
37 #define PPP_HDRLEN	4	/* octets for standard ppp header */
38 #define PPP_FCSLEN	2	/* octets for FCS */
39 
40 /*
41  * Packet sizes
42  *
43  * Note - lcp shouldn't be allowed to negotiate stuff outside these
44  *	  limits.  See lcp.h in the pppd directory.
45  * (XXX - these constants should simply be shared by lcp.c instead
46  *	  of living in lcp.h)
47  */
48 #define	PPP_MTU		1500	/* Default MTU (size of Info field) */
49 #define PPP_MAXMTU	65535 - (PPP_HDRLEN + PPP_FCSLEN)
50 #define PPP_MINMTU	64
51 #define PPP_MRU		1500	/* default MRU = max length of info field */
52 #define PPP_MAXMRU	65000	/* Largest MRU we allow */
53 #define PPP_MINMRU	128
54 
55 #define PPP_ADDRESS(p)	(((u_char *)(p))[0])
56 #define PPP_CONTROL(p)	(((u_char *)(p))[1])
57 #define PPP_PROTOCOL(p)	((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
58 
59 /*
60  * Significant octet values.
61  */
62 #define	PPP_ALLSTATIONS	0xff	/* All-Stations broadcast address */
63 #define	PPP_UI		0x03	/* Unnumbered Information */
64 #define	PPP_FLAG	0x7e	/* Flag Sequence */
65 #define	PPP_ESCAPE	0x7d	/* Asynchronous Control Escape */
66 #define	PPP_TRANS	0x20	/* Asynchronous transparency modifier */
67 
68 /*
69  * Protocol field values.
70  */
71 #define PPP_IP		0x0021		/* Internet Protocol */
72 #define PPP_ISO		0x0023		/* ISO OSI Protocol */
73 #define PPP_XNS		0x0025		/* Xerox NS Protocol */
74 #define PPP_AT		0x0029		/* AppleTalk Protocol */
75 #define PPP_IPX		0x002b		/* IPX protocol */
76 #define	PPP_VJC_COMP	0x002d		/* VJ compressed TCP */
77 #define	PPP_VJC_UNCOMP	0x002f		/* VJ uncompressed TCP */
78 #define PPP_IPV6	0x0057		/* Internet Protocol Version 6 */
79 #define PPP_COMP	0x00fd		/* compressed packet */
80 #define PPP_IPCP	0x8021		/* IP Control Protocol */
81 #define PPP_ATCP	0x8029		/* AppleTalk Control Protocol */
82 #define PPP_IPXCP	0x802b		/* IPX Control Protocol */
83 #define PPP_IPV6CP	0x8057		/* IPv6 Control Protocol */
84 #define PPP_CCP		0x80fd		/* Compression Control Protocol */
85 #define PPP_LCP		0xc021		/* Link Control Protocol */
86 #define PPP_PAP		0xc023		/* Password Authentication Protocol */
87 #define PPP_LQR		0xc025		/* Link Quality Report protocol */
88 #define PPP_CHAP	0xc223		/* Crypto Handshake Auth. Protocol */
89 #define PPP_CBCP	0xc029		/* Callback Control Protocol */
90 
91 /*
92  * Values for FCS calculations.
93  */
94 #define PPP_INITFCS	0xffff	/* Initial FCS value */
95 #define PPP_GOODFCS	0xf0b8	/* Good final FCS value */
96 #define PPP_FCS(fcs, c)	(((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
97 
98 /*
99  * A 32-bit unsigned integral type.
100  */
101 #if !defined(__BIT_TYPES_DEFINED__) && !defined(_BITYPES) && !defined(__FreeBSD__)
102 #ifdef	UINT32_T
103 typedef UINT32_T	u_int32_t;
104 #else
105 typedef unsigned int	u_int32_t;
106 #endif
107 #endif
108 
109 /*
110  * Extended asyncmap - allows any character to be escaped.
111  */
112 typedef u_int32_t	ext_accm[8];
113 
114 /*
115  * What to do with network protocol (NP) packets.
116  */
117 enum NPmode {
118     NPMODE_PASS,		/* pass the packet through */
119     NPMODE_DROP,		/* silently drop the packet */
120     NPMODE_ERROR,		/* return an error */
121     NPMODE_QUEUE		/* save it up for later. */
122 };
123 
124 /*
125  * Statistics.
126  */
127 struct pppstat	{
128     unsigned int ppp_ibytes;	/* bytes received */
129     unsigned int ppp_ipackets;	/* packets received */
130     unsigned int ppp_ierrors;	/* receive errors */
131     unsigned int ppp_obytes;	/* bytes sent */
132     unsigned int ppp_opackets;	/* packets sent */
133     unsigned int ppp_oerrors;	/* transmit errors */
134 };
135 
136 struct vjstat {
137     unsigned int vjs_packets;	/* outbound packets */
138     unsigned int vjs_compressed; /* outbound compressed packets */
139     unsigned int vjs_searches;	/* searches for connection state */
140     unsigned int vjs_misses;	/* times couldn't find conn. state */
141     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
142     unsigned int vjs_compressedin; /* inbound compressed packets */
143     unsigned int vjs_errorin;	/* inbound unknown type packets */
144     unsigned int vjs_tossed;	/* inbound packets tossed because of error */
145 };
146 
147 struct ppp_stats {
148     struct pppstat p;		/* basic PPP statistics */
149     struct vjstat vj;		/* VJ header compression statistics */
150 };
151 
152 struct compstat {
153     unsigned int unc_bytes;	/* total uncompressed bytes */
154     unsigned int unc_packets;	/* total uncompressed packets */
155     unsigned int comp_bytes;	/* compressed bytes */
156     unsigned int comp_packets;	/* compressed packets */
157     unsigned int inc_bytes;	/* incompressible bytes */
158     unsigned int inc_packets;	/* incompressible packets */
159     unsigned int ratio;		/* recent compression ratio << 8 */
160 };
161 
162 struct ppp_comp_stats {
163     struct compstat c;		/* packet compression statistics */
164     struct compstat d;		/* packet decompression statistics */
165 };
166 
167 /*
168  * The following structure records the time in seconds since
169  * the last NP packet was sent or received.
170  */
171 struct ppp_idle {
172     time_t xmit_idle;		/* time since last NP packet sent */
173     time_t recv_idle;		/* time since last NP packet received */
174 };
175 
176 #ifndef __P
177 #ifdef __STDC__
178 #define __P(x)	x
179 #else
180 #define __P(x)	()
181 #endif
182 #endif
183 
184 #endif /* _NET_PPP_DEFS_H_ */
185