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