ed04486059b479005627018f5b0be09e292dd317
[ppp.git] / include / net / ppp_defs.h
1 /*      $Id: ppp_defs.h,v 1.17 2002/12/06 09:49:15 paulus Exp $ */
2
3 /*
4  * ppp_defs.h - PPP definitions.
5  *
6  * Copyright (c) 1984 Paul Mackerras. 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  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. The name(s) of the authors of this software must not be used to
21  *    endorse or promote products derived from this software without
22  *    prior written permission.
23  *
24  * 4. Redistributions of any form whatsoever must retain the following
25  *    acknowledgment:
26  *    "This product includes software developed by Paul Mackerras
27  *     <paulus@samba.org>".
28  *
29  * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
30  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
31  * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
32  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
33  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
34  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
35  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
36  */
37
38 #include <time.h>
39
40 #ifndef _PPP_DEFS_H_
41 #define _PPP_DEFS_H_
42
43 /*
44  * The basic PPP frame.
45  */
46 #define PPP_HDRLEN      4       /* octets for standard ppp header */
47 #define PPP_FCSLEN      2       /* octets for FCS */
48
49 /*
50  * Packet sizes
51  *
52  * Note - lcp shouldn't be allowed to negotiate stuff outside these
53  *        limits.  See lcp.h in the pppd directory.
54  * (XXX - these constants should simply be shared by lcp.c instead
55  *        of living in lcp.h)
56  */
57 #define PPP_MTU         1500    /* Default MTU (size of Info field) */
58 #define PPP_MAXMTU      65535 - (PPP_HDRLEN + PPP_FCSLEN)
59 #define PPP_MINMTU      64
60 #define PPP_MRU         1500    /* default MRU = max length of info field */
61 #define PPP_MAXMRU      65000   /* Largest MRU we allow */
62 #define PPP_MINMRU      128
63
64 #define PPP_ADDRESS(p)  (((u_char *)(p))[0])
65 #define PPP_CONTROL(p)  (((u_char *)(p))[1])
66 #define PPP_PROTOCOL(p) ((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
67
68 /*
69  * Significant octet values.
70  */
71 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
72 #define PPP_UI          0x03    /* Unnumbered Information */
73 #define PPP_FLAG        0x7e    /* Flag Sequence */
74 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
75 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
76
77 /*
78  * Protocol field values.
79  */
80 #define PPP_IP          0x21    /* Internet Protocol */
81 #define PPP_AT          0x29    /* AppleTalk Protocol */
82 #define PPP_IPX         0x2b    /* IPX protocol */
83 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
84 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
85 #define PPP_IPV6        0x57    /* Internet Protocol Version 6 */
86 #define PPP_COMP        0xfd    /* compressed packet */
87 #define PPP_IPCP        0x8021  /* IP Control Protocol */
88 #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
89 #define PPP_IPXCP       0x802b  /* IPX Control Protocol */
90 #define PPP_IPV6CP      0x8057  /* IPv6 Control Protocol */
91 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
92 #define PPP_ECP         0x8053  /* Encryption Control Protocol */
93 #define PPP_LCP         0xc021  /* Link Control Protocol */
94 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
95 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
96 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
97 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
98 #define PPP_EAP         0xc227  /* Extensible Authentication Protocol */
99
100 /*
101  * Values for FCS calculations.
102  */
103 #define PPP_INITFCS     0xffff  /* Initial FCS value */
104 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
105 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
106
107 /*
108  * A 32-bit unsigned integral type.
109  */
110
111 #if !defined(__BIT_TYPES_DEFINED__) && !defined(_BITYPES) \
112  && !defined(__FreeBSD__) && (NS_TARGET < 40)
113 #ifdef  UINT32_T
114 typedef UINT32_T        u_int32_t;
115 #else
116 typedef unsigned int    u_int32_t;
117 typedef unsigned short  u_int16_t;
118 #endif
119 #endif
120
121 /*
122  * Extended asyncmap - allows any character to be escaped.
123  */
124 typedef u_int32_t       ext_accm[8];
125
126 /*
127  * What to do with network protocol (NP) packets.
128  */
129 enum NPmode {
130     NPMODE_PASS,                /* pass the packet through */
131     NPMODE_DROP,                /* silently drop the packet */
132     NPMODE_ERROR,               /* return an error */
133     NPMODE_QUEUE                /* save it up for later. */
134 };
135
136 /*
137  * Statistics.
138  */
139 struct pppstat  {
140     unsigned int ppp_ibytes;    /* bytes received */
141     unsigned int ppp_ipackets;  /* packets received */
142     unsigned int ppp_ierrors;   /* receive errors */
143     unsigned int ppp_obytes;    /* bytes sent */
144     unsigned int ppp_opackets;  /* packets sent */
145     unsigned int ppp_oerrors;   /* transmit errors */
146 };
147
148 struct vjstat {
149     unsigned int vjs_packets;   /* outbound packets */
150     unsigned int vjs_compressed; /* outbound compressed packets */
151     unsigned int vjs_searches;  /* searches for connection state */
152     unsigned int vjs_misses;    /* times couldn't find conn. state */
153     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
154     unsigned int vjs_compressedin; /* inbound compressed packets */
155     unsigned int vjs_errorin;   /* inbound unknown type packets */
156     unsigned int vjs_tossed;    /* inbound packets tossed because of error */
157 };
158
159 struct ppp_stats {
160     struct pppstat p;           /* basic PPP statistics */
161     struct vjstat vj;           /* VJ header compression statistics */
162 };
163
164 struct compstat {
165     unsigned int unc_bytes;     /* total uncompressed bytes */
166     unsigned int unc_packets;   /* total uncompressed packets */
167     unsigned int comp_bytes;    /* compressed bytes */
168     unsigned int comp_packets;  /* compressed packets */
169     unsigned int inc_bytes;     /* incompressible bytes */
170     unsigned int inc_packets;   /* incompressible packets */
171     unsigned int ratio;         /* recent compression ratio << 8 */
172 };
173
174 struct ppp_comp_stats {
175     struct compstat c;          /* packet compression statistics */
176     struct compstat d;          /* packet decompression statistics */
177 };
178
179 /*
180  * The following structure records the time in seconds since
181  * the last NP packet was sent or received.
182  */
183 struct ppp_idle {
184     time_t xmit_idle;           /* time since last NP packet sent */
185     time_t recv_idle;           /* time since last NP packet received */
186 };
187
188 #ifndef __P
189 #ifdef __STDC__
190 #define __P(x)  x
191 #else
192 #define __P(x)  ()
193 #endif
194 #endif
195
196 #endif /* _PPP_DEFS_H_ */