xref: /xnu-8792.61.2/bsd/net/ppp_defs.h (revision 42e220869062b56f8d7d0726fd4c88954f87902c)
1 /*
2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * ppp_defs.h - PPP definitions.
30  *
31  * Copyright (c) 1994 The Australian National University.
32  * All rights reserved.
33  *
34  * Permission to use, copy, modify, and distribute this software and its
35  * documentation is hereby granted, provided that the above copyright
36  * notice appears in all copies.  This software is provided without any
37  * warranty, express or implied. The Australian National University
38  * makes no representations about the suitability of this software for
39  * any purpose.
40  *
41  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
42  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
43  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
44  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
45  * OF SUCH DAMAGE.
46  *
47  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
48  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
49  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
50  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
51  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
52  * OR MODIFICATIONS.
53  *
54  */
55 
56 #ifndef _PPP_DEFS_H_
57 #define _PPP_DEFS_H_
58 #include <sys/appleapiopts.h>
59 
60 /*
61  * The basic PPP frame.
62  */
63 #define PPP_HDRLEN      4       /* octets for standard ppp header */
64 #define PPP_FCSLEN      2       /* octets for FCS */
65 #define PPP_MRU         1500    /* default MRU = max length of info field */
66 
67 #define PPP_ADDRESS(p)  (((u_char *)(p))[0])
68 #define PPP_CONTROL(p)  (((u_char *)(p))[1])
69 #define PPP_PROTOCOL(p) ((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
70 
71 /*
72  * Significant octet values.
73  */
74 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
75 #define PPP_UI          0x03    /* Unnumbered Information */
76 #define PPP_FLAG        0x7e    /* Flag Sequence */
77 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
78 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
79 
80 /*
81  * Protocol field values.
82  */
83 #define PPP_IP          0x21    /* Internet Protocol */
84 #define PPP_XNS         0x25    /* Xerox NS */
85 #define PPP_AT          0x29    /* AppleTalk Protocol */
86 #define PPP_IPX         0x2b    /* IPX Datagram (RFC1552) */
87 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
88 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
89 #define PPP_COMP        0xfd    /* compressed packet */
90 #define PPP_IPCP        0x8021  /* IP Control Protocol */
91 #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
92 #define PPP_IPXCP       0x802b  /* IPX Control Protocol (RFC1552) */
93 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
94 #define PPP_LCP         0xc021  /* Link Control Protocol */
95 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
96 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
97 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
98 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
99 #define PPP_IPV6        0x57    /* Internet Protocol version 6*/
100 #define PPP_IPV6CP      0x8057  /* IPv6 Control Protocol */
101 
102 /*
103  * Values for FCS calculations.
104  */
105 #define PPP_INITFCS     0xffff  /* Initial FCS value */
106 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
107 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
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 #endif /* _PPP_DEFS_H_ */
177