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