xref: /netbsd-src/sys/net/ppp_defs.h (revision 4d7e773266e3c3f48566c86c0ad52d51c6454fd1)
1 /*	$NetBSD: ppp_defs.h,v 1.3 1997/05/17 21:12:08 christos 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 _PPP_DEFS_H_
32 #define _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		0x21	/* Internet Protocol */
72 #define PPP_AT		0x29	/* AppleTalk Protocol */
73 #define	PPP_VJC_COMP	0x2d	/* VJ compressed TCP */
74 #define	PPP_VJC_UNCOMP	0x2f	/* VJ uncompressed TCP */
75 #define PPP_COMP	0xfd	/* compressed packet */
76 #define PPP_IPCP	0x8021	/* IP Control Protocol */
77 #define PPP_ATCP	0x8029	/* AppleTalk Control Protocol */
78 #define PPP_CCP		0x80fd	/* Compression Control Protocol */
79 #define PPP_LCP		0xc021	/* Link Control Protocol */
80 #define PPP_PAP		0xc023	/* Password Authentication Protocol */
81 #define PPP_LQR		0xc025	/* Link Quality Report protocol */
82 #define PPP_CHAP	0xc223	/* Cryptographic Handshake Auth. Protocol */
83 #define PPP_CBCP	0xc029	/* Callback Control Protocol */
84 
85 /*
86  * Values for FCS calculations.
87  */
88 #define PPP_INITFCS	0xffff	/* Initial FCS value */
89 #define PPP_GOODFCS	0xf0b8	/* Good final FCS value */
90 #define PPP_FCS(fcs, c)	(((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
91 
92 /*
93  * A 32-bit unsigned integral type.
94  */
95 #if !defined(__BIT_TYPES_DEFINED__) && !defined(_BITYPES) && !defined(__FreeBSD__)
96 #ifdef	UINT32_T
97 typedef UINT32_T	u_int32_t;
98 #else
99 typedef unsigned int	u_int32_t;
100 #endif
101 #endif
102 
103 /*
104  * Extended asyncmap - allows any character to be escaped.
105  */
106 typedef u_int32_t	ext_accm[8];
107 
108 /*
109  * What to do with network protocol (NP) packets.
110  */
111 enum NPmode {
112     NPMODE_PASS,		/* pass the packet through */
113     NPMODE_DROP,		/* silently drop the packet */
114     NPMODE_ERROR,		/* return an error */
115     NPMODE_QUEUE		/* save it up for later. */
116 };
117 
118 /*
119  * Statistics.
120  */
121 struct pppstat	{
122     unsigned int ppp_ibytes;	/* bytes received */
123     unsigned int ppp_ipackets;	/* packets received */
124     unsigned int ppp_ierrors;	/* receive errors */
125     unsigned int ppp_obytes;	/* bytes sent */
126     unsigned int ppp_opackets;	/* packets sent */
127     unsigned int ppp_oerrors;	/* transmit errors */
128 };
129 
130 struct vjstat {
131     unsigned int vjs_packets;	/* outbound packets */
132     unsigned int vjs_compressed; /* outbound compressed packets */
133     unsigned int vjs_searches;	/* searches for connection state */
134     unsigned int vjs_misses;	/* times couldn't find conn. state */
135     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
136     unsigned int vjs_compressedin; /* inbound compressed packets */
137     unsigned int vjs_errorin;	/* inbound unknown type packets */
138     unsigned int vjs_tossed;	/* inbound packets tossed because of error */
139 };
140 
141 struct ppp_stats {
142     struct pppstat p;		/* basic PPP statistics */
143     struct vjstat vj;		/* VJ header compression statistics */
144 };
145 
146 struct compstat {
147     unsigned int unc_bytes;	/* total uncompressed bytes */
148     unsigned int unc_packets;	/* total uncompressed packets */
149     unsigned int comp_bytes;	/* compressed bytes */
150     unsigned int comp_packets;	/* compressed packets */
151     unsigned int inc_bytes;	/* incompressible bytes */
152     unsigned int inc_packets;	/* incompressible packets */
153     unsigned int ratio;		/* recent compression ratio << 8 */
154 };
155 
156 struct ppp_comp_stats {
157     struct compstat c;		/* packet compression statistics */
158     struct compstat d;		/* packet decompression statistics */
159 };
160 
161 /*
162  * The following structure records the time in seconds since
163  * the last NP packet was sent or received.
164  */
165 struct ppp_idle {
166     time_t xmit_idle;		/* time since last NP packet sent */
167     time_t recv_idle;		/* time since last NP packet received */
168 };
169 
170 #ifndef __P
171 #ifdef __STDC__
172 #define __P(x)	x
173 #else
174 #define __P(x)	()
175 #endif
176 #endif
177 
178 #endif /* _PPP_DEFS_H_ */
179