9b6ca4adfd9f79dd4b4491cfbec84210eac8bb17
[ppp.git] / include / net / ppp_defs.h
1 /*      $Id: ppp_defs.h,v 1.10 1997/03/04 03:32:37 paulus Exp $ */
2
3 /*
4  * ppp_defs.h - PPP definitions.
5  *
6  * Copyright (c) 1994 The Australian National University.
7  * All rights reserved.
8  *
9  * Permission to use, copy, modify, and distribute this software and its
10  * documentation is hereby granted, provided that the above copyright
11  * notice appears in all copies.  This software is provided without any
12  * warranty, express or implied. The Australian National University
13  * makes no representations about the suitability of this software for
14  * any purpose.
15  *
16  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
17  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
18  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
19  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
20  * OF SUCH DAMAGE.
21  *
22  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
23  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
24  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
25  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
26  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
27  * OR MODIFICATIONS.
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_AT          0x29    /* AppleTalk Protocol */
58 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
59 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
60 #define PPP_COMP        0xfd    /* compressed packet */
61 #define PPP_IPCP        0x8021  /* IP Control Protocol */
62 #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
63 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
64 #define PPP_LCP         0xc021  /* Link Control Protocol */
65 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
66 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
67 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
68 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
69
70 /*
71  * Values for FCS calculations.
72  */
73 #define PPP_INITFCS     0xffff  /* Initial FCS value */
74 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
75 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
76
77 /*
78  * A 32-bit unsigned integral type.
79  */
80 #if !defined(__BIT_TYPES_DEFINED__) && !defined(_BITYPES) && !defined(__FreeBSD__)
81 #ifdef  UINT32_T
82 typedef UINT32_T        u_int32_t;
83 #else
84 typedef unsigned int    u_int32_t;
85 #endif
86 #endif
87
88 /*
89  * Extended asyncmap - allows any character to be escaped.
90  */
91 typedef u_int32_t       ext_accm[8];
92
93 /*
94  * What to do with network protocol (NP) packets.
95  */
96 enum NPmode {
97     NPMODE_PASS,                /* pass the packet through */
98     NPMODE_DROP,                /* silently drop the packet */
99     NPMODE_ERROR,               /* return an error */
100     NPMODE_QUEUE                /* save it up for later. */
101 };
102
103 /*
104  * Statistics.
105  */
106 struct pppstat  {
107     unsigned int ppp_ibytes;    /* bytes received */
108     unsigned int ppp_ipackets;  /* packets received */
109     unsigned int ppp_ierrors;   /* receive errors */
110     unsigned int ppp_obytes;    /* bytes sent */
111     unsigned int ppp_opackets;  /* packets sent */
112     unsigned int ppp_oerrors;   /* transmit errors */
113 };
114
115 struct vjstat {
116     unsigned int vjs_packets;   /* outbound packets */
117     unsigned int vjs_compressed; /* outbound compressed packets */
118     unsigned int vjs_searches;  /* searches for connection state */
119     unsigned int vjs_misses;    /* times couldn't find conn. state */
120     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
121     unsigned int vjs_compressedin; /* inbound compressed packets */
122     unsigned int vjs_errorin;   /* inbound unknown type packets */
123     unsigned int vjs_tossed;    /* inbound packets tossed because of error */
124 };
125
126 struct ppp_stats {
127     struct pppstat p;           /* basic PPP statistics */
128     struct vjstat vj;           /* VJ header compression statistics */
129 };
130
131 struct compstat {
132     unsigned int unc_bytes;     /* total uncompressed bytes */
133     unsigned int unc_packets;   /* total uncompressed packets */
134     unsigned int comp_bytes;    /* compressed bytes */
135     unsigned int comp_packets;  /* compressed packets */
136     unsigned int inc_bytes;     /* incompressible bytes */
137     unsigned int inc_packets;   /* incompressible packets */
138     unsigned int ratio;         /* recent compression ratio << 8 */
139 };
140
141 struct ppp_comp_stats {
142     struct compstat c;          /* packet compression statistics */
143     struct compstat d;          /* packet decompression statistics */
144 };
145
146 /*
147  * The following structure records the time in seconds since
148  * the last NP packet was sent or received.
149  */
150 struct ppp_idle {
151     time_t xmit_idle;           /* time since last NP packet sent */
152     time_t recv_idle;           /* time since last NP packet received */
153 };
154
155 #ifndef __P
156 #ifdef __STDC__
157 #define __P(x)  x
158 #else
159 #define __P(x)  ()
160 #endif
161 #endif
162
163 #endif /* _PPP_DEFS_H_ */