1 /*
2  * ppp_defs.h - PPP definitions.
3  *
4  * Copyright 1994-2000 Paul Mackerras.
5  *
6  *  This program is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU General Public License
8  *  version 2 as published by the Free Software Foundation.
9  */
10 #include <linux/types.h>
11 
12 #ifndef _UAPI_PPP_DEFS_H_
13 #define _UAPI_PPP_DEFS_H_
14 
15 /*
16  * The basic PPP frame.
17  */
18 #define PPP_HDRLEN	4	/* octets for standard ppp header */
19 #define PPP_FCSLEN	2	/* octets for FCS */
20 #define PPP_MRU		1500	/* default MRU = max length of info field */
21 
22 #define PPP_ADDRESS(p)	(((__u8 *)(p))[0])
23 #define PPP_CONTROL(p)	(((__u8 *)(p))[1])
24 #define PPP_PROTOCOL(p)	((((__u8 *)(p))[2] << 8) + ((__u8 *)(p))[3])
25 
26 /*
27  * Significant octet values.
28  */
29 #define	PPP_ALLSTATIONS	0xff	/* All-Stations broadcast address */
30 #define	PPP_UI		0x03	/* Unnumbered Information */
31 #define	PPP_FLAG	0x7e	/* Flag Sequence */
32 #define	PPP_ESCAPE	0x7d	/* Asynchronous Control Escape */
33 #define	PPP_TRANS	0x20	/* Asynchronous transparency modifier */
34 
35 /*
36  * Protocol field values.
37  */
38 #define PPP_IP		0x21	/* Internet Protocol */
39 #define PPP_AT		0x29	/* AppleTalk Protocol */
40 #define PPP_IPX		0x2b	/* IPX protocol */
41 #define	PPP_VJC_COMP	0x2d	/* VJ compressed TCP */
42 #define	PPP_VJC_UNCOMP	0x2f	/* VJ uncompressed TCP */
43 #define PPP_MP		0x3d	/* Multilink protocol */
44 #define PPP_IPV6	0x57	/* Internet Protocol Version 6 */
45 #define PPP_COMPFRAG	0xfb	/* fragment compressed below bundle */
46 #define PPP_COMP	0xfd	/* compressed packet */
47 #define PPP_MPLS_UC	0x0281	/* Multi Protocol Label Switching - Unicast */
48 #define PPP_MPLS_MC	0x0283	/* Multi Protocol Label Switching - Multicast */
49 #define PPP_IPCP	0x8021	/* IP Control Protocol */
50 #define PPP_ATCP	0x8029	/* AppleTalk Control Protocol */
51 #define PPP_IPXCP	0x802b	/* IPX Control Protocol */
52 #define PPP_IPV6CP	0x8057	/* IPv6 Control Protocol */
53 #define PPP_CCPFRAG	0x80fb	/* CCP at link level (below MP bundle) */
54 #define PPP_CCP		0x80fd	/* Compression Control Protocol */
55 #define PPP_MPLSCP	0x80fd	/* MPLS Control Protocol */
56 #define PPP_LCP		0xc021	/* Link Control Protocol */
57 #define PPP_PAP		0xc023	/* Password Authentication Protocol */
58 #define PPP_LQR		0xc025	/* Link Quality Report protocol */
59 #define PPP_CHAP	0xc223	/* Cryptographic Handshake Auth. Protocol */
60 #define PPP_CBCP	0xc029	/* Callback Control Protocol */
61 
62 /*
63  * Values for FCS calculations.
64  */
65 
66 #define PPP_INITFCS	0xffff	/* Initial FCS value */
67 #define PPP_GOODFCS	0xf0b8	/* Good final FCS value */
68 
69 
70 /*
71  * Extended asyncmap - allows any character to be escaped.
72  */
73 
74 typedef __u32		ext_accm[8];
75 
76 /*
77  * What to do with network protocol (NP) packets.
78  */
79 enum NPmode {
80     NPMODE_PASS,		/* pass the packet through */
81     NPMODE_DROP,		/* silently drop the packet */
82     NPMODE_ERROR,		/* return an error */
83     NPMODE_QUEUE		/* save it up for later. */
84 };
85 
86 /*
87  * Statistics for LQRP and pppstats
88  */
89 struct pppstat	{
90     __u32	ppp_discards;	/* # frames discarded */
91 
92     __u32	ppp_ibytes;	/* bytes received */
93     __u32	ppp_ioctects;	/* bytes received not in error */
94     __u32	ppp_ipackets;	/* packets received */
95     __u32	ppp_ierrors;	/* receive errors */
96     __u32	ppp_ilqrs;	/* # LQR frames received */
97 
98     __u32	ppp_obytes;	/* raw bytes sent */
99     __u32	ppp_ooctects;	/* frame bytes sent */
100     __u32	ppp_opackets;	/* packets sent */
101     __u32	ppp_oerrors;	/* transmit errors */
102     __u32	ppp_olqrs;	/* # LQR frames sent */
103 };
104 
105 struct vjstat {
106     __u32	vjs_packets;	/* outbound packets */
107     __u32	vjs_compressed;	/* outbound compressed packets */
108     __u32	vjs_searches;	/* searches for connection state */
109     __u32	vjs_misses;	/* times couldn't find conn. state */
110     __u32	vjs_uncompressedin; /* inbound uncompressed packets */
111     __u32	vjs_compressedin;   /* inbound compressed packets */
112     __u32	vjs_errorin;	/* inbound unknown type packets */
113     __u32	vjs_tossed;	/* inbound packets tossed because of error */
114 };
115 
116 struct compstat {
117     __u32	unc_bytes;	/* total uncompressed bytes */
118     __u32	unc_packets;	/* total uncompressed packets */
119     __u32	comp_bytes;	/* compressed bytes */
120     __u32	comp_packets;	/* compressed packets */
121     __u32	inc_bytes;	/* incompressible bytes */
122     __u32	inc_packets;	/* incompressible packets */
123 
124     /* the compression ratio is defined as in_count / bytes_out */
125     __u32       in_count;	/* Bytes received */
126     __u32       bytes_out;	/* Bytes transmitted */
127 
128     double	ratio;		/* not computed in kernel. */
129 };
130 
131 struct ppp_stats {
132     struct pppstat	p;	/* basic PPP statistics */
133     struct vjstat	vj;	/* VJ header compression statistics */
134 };
135 
136 struct ppp_comp_stats {
137     struct compstat	c;	/* packet compression statistics */
138     struct compstat	d;	/* packet decompression statistics */
139 };
140 
141 /*
142  * The following structure records the time in seconds since
143  * the last NP packet was sent or received.
144  */
145 struct ppp_idle {
146     __kernel_time_t xmit_idle;	/* time since last NP packet sent */
147     __kernel_time_t recv_idle;	/* time since last NP packet received */
148 };
149 
150 #endif /* _UAPI_PPP_DEFS_H_ */
151