27eaa89deaadc5e12858e7044c60efe3e0681eca
[ppp.git] / linux / ppp_defs.h
1 /*      From: ppp_defs.h,v 1.2 1994/09/21 01:31:06 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 /*
31  *  ==FILEVERSION 960918==
32  *
33  *  NOTE TO MAINTAINERS:
34  *     If you modify this file at all, please set the above date.
35  *     ppp_defs.h is shipped with a PPP distribution as well as with the kernel;
36  *     if everyone increases the FILEVERSION number above, then scripts
37  *     can do the right thing when deciding whether to install a new ppp_defs.h
38  *     file.  Don't change the format of that line otherwise, so the
39  *     installation script can recognize it.
40  */
41
42 #ifndef _PPP_DEFS_H_
43 #define _PPP_DEFS_H_
44
45 /*
46  * The basic PPP frame.
47  */
48 #define PPP_HDRLEN      4       /* octets for standard ppp header */
49 #define PPP_FCSLEN      2       /* octets for FCS */
50 #define PPP_MRU         1500    /* default MRU = max length of info field */
51
52 #define PPP_ADDRESS(p)  (((__u8 *)(p))[0])
53 #define PPP_CONTROL(p)  (((__u8 *)(p))[1])
54 #define PPP_PROTOCOL(p) ((((__u8 *)(p))[2] << 8) + ((__u8 *)(p))[3])
55
56 /*
57  * Significant octet values.
58  */
59 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
60 #define PPP_UI          0x03    /* Unnumbered Information */
61 #define PPP_FLAG        0x7e    /* Flag Sequence */
62 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
63 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
64
65 /*
66  * Protocol field values.
67  */
68 #define PPP_IP          0x21    /* Internet Protocol */
69 #define PPP_IPX         0x2b    /* IPX protocol */
70 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
71 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
72 #define PPP_COMP        0xfd    /* compressed packet */
73 #define PPP_IPCP        0x8021  /* IP Control Protocol */
74 #define PPP_IPXCP       0x802b  /* IPX Control Protocol */
75 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
76 #define PPP_LCP         0xc021  /* Link Control Protocol */
77 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
78 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
79 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
80
81 /*
82  * Values for FCS calculations.
83  */
84
85 #define PPP_INITFCS     0xffff  /* Initial FCS value */
86 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
87 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
88
89 /*
90  * Extended asyncmap - allows any character to be escaped.
91  */
92
93 typedef __u32           ext_accm[8];
94
95 /*
96  * What to do with network protocol (NP) packets.
97  */
98 enum NPmode {
99     NPMODE_PASS,                /* pass the packet through */
100     NPMODE_DROP,                /* silently drop the packet */
101     NPMODE_ERROR,               /* return an error */
102     NPMODE_QUEUE                /* save it up for later. */
103 };
104
105 /*
106  * Statistics for LQRP and pppstats
107  */
108 struct pppstat  {
109     __u32       ppp_discards;   /* # frames discarded */
110
111     __u32       ppp_ibytes;     /* bytes received */
112     __u32       ppp_ioctects;   /* bytes received not in error */
113     __u32       ppp_ipackets;   /* packets received */
114     __u32       ppp_ierrors;    /* receive errors */
115     __u32       ppp_ilqrs;      /* # LQR frames received */
116
117     __u32       ppp_obytes;     /* raw bytes sent */
118     __u32       ppp_ooctects;   /* frame bytes sent */
119     __u32       ppp_opackets;   /* packets sent */
120     __u32       ppp_oerrors;    /* transmit errors */ 
121     __u32       ppp_olqrs;      /* # LQR frames sent */
122 };
123
124 struct vjstat {
125     __u32       vjs_packets;    /* outbound packets */
126     __u32       vjs_compressed; /* outbound compressed packets */
127     __u32       vjs_searches;   /* searches for connection state */
128     __u32       vjs_misses;     /* times couldn't find conn. state */
129     __u32       vjs_uncompressedin; /* inbound uncompressed packets */
130     __u32       vjs_compressedin;   /* inbound compressed packets */
131     __u32       vjs_errorin;    /* inbound unknown type packets */
132     __u32       vjs_tossed;     /* inbound packets tossed because of error */
133 };
134
135 struct compstat {
136     __u32       unc_bytes;      /* total uncompressed bytes */
137     __u32       unc_packets;    /* total uncompressed packets */
138     __u32       comp_bytes;     /* compressed bytes */
139     __u32       comp_packets;   /* compressed packets */
140     __u32       inc_bytes;      /* incompressible bytes */
141     __u32       inc_packets;    /* incompressible packets */
142
143     /* the compression ratio is defined as in_count / bytes_out */
144     __u32       in_count;       /* Bytes received */
145     __u32       bytes_out;      /* Bytes transmitted */
146
147     double      ratio;          /* not computed in kernel. */
148 };
149
150 struct ppp_stats {
151     struct pppstat      p;      /* basic PPP statistics */
152     struct vjstat       vj;     /* VJ header compression statistics */
153 };
154
155 struct ppp_comp_stats {
156     struct compstat     c;      /* packet compression statistics */
157     struct compstat     d;      /* packet decompression statistics */
158 };
159
160 /*
161  * The following structure records the time in seconds since
162  * the last NP packet was sent or received.
163  */
164 struct ppp_idle {
165     time_t xmit_idle;           /* time since last NP packet sent */
166     time_t recv_idle;           /* time since last NP packet received */
167 };
168
169 #ifndef __P
170 #ifdef __STDC__
171 #define __P(x)  x
172 #else
173 #define __P(x)  ()
174 #endif
175 #endif
176
177 #endif /* _PPP_DEFS_H_ */