ppp_defs.h revision 21673 
1/*	from Id: ppp_defs.h,v 1.7 1995/08/10 06:49:35 paulus Exp */
2/*	$FreeBSD: head/sys/net/ppp_defs.h 21673 1997-01-14 07:20:47Z jkh $	*/
3
4/*
5 * ppp_defs.h - PPP definitions.
6 *
7 * Copyright (c) 1994 The Australian National University.
8 * All rights reserved.
9 *
10 * Permission to use, copy, modify, and distribute this software and its
11 * documentation is hereby granted, provided that the above copyright
12 * notice appears in all copies.  This software is provided without any
13 * warranty, express or implied. The Australian National University
14 * makes no representations about the suitability of this software for
15 * any purpose.
16 *
17 * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
18 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
19 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
20 * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
21 * OF SUCH DAMAGE.
22 *
23 * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
24 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
25 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
26 * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
27 * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
28 * OR MODIFICATIONS.
29 */
30
31#ifndef _PPP_DEFS_H_
32#define _PPP_DEFS_H_
33
34/*
35 * The basic PPP frame.
36 */
37#define PPP_HDRLEN	4	/* octets for standard ppp header */
38#define PPP_FCSLEN	2	/* octets for FCS */
39#define PPP_MRU		1500	/* default MRU = max length of info field */
40
41#define PPP_ADDRESS(p)	(((u_char *)(p))[0])
42#define PPP_CONTROL(p)	(((u_char *)(p))[1])
43#define PPP_PROTOCOL(p)	((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
44
45/*
46 * Significant octet values.
47 */
48#define	PPP_ALLSTATIONS	0xff	/* All-Stations broadcast address */
49#define	PPP_UI		0x03	/* Unnumbered Information */
50#define	PPP_FLAG	0x7e	/* Flag Sequence */
51#define	PPP_ESCAPE	0x7d	/* Asynchronous Control Escape */
52#define	PPP_TRANS	0x20	/* Asynchronous transparency modifier */
53
54/*
55 * Protocol field values.
56 */
57#define PPP_IP		0x21	/* Internet Protocol */
58#define	PPP_XNS		0x25	/* Xerox NS */
59#define PPP_IPX		0x2b	/* IPX Datagram (RFC1552) */
60#define	PPP_VJC_COMP	0x2d	/* VJ compressed TCP */
61#define	PPP_VJC_UNCOMP	0x2f	/* VJ uncompressed TCP */
62#define PPP_COMP	0xfd	/* compressed packet */
63#define PPP_IPCP	0x8021	/* IP Control Protocol */
64#define PPP_IPXCP	0x802b	/* IPX Control Protocol (RFC1552) */
65#define PPP_CCP		0x80fd	/* Compression Control Protocol */
66#define PPP_LCP		0xc021	/* Link Control Protocol */
67#define PPP_PAP		0xc023	/* Password Authentication Protocol */
68#define PPP_LQR		0xc025	/* Link Quality Report protocol */
69#define PPP_CHAP	0xc223	/* Cryptographic Handshake Auth. Protocol */
70
71/*
72 * Values for FCS calculations.
73 */
74#define PPP_INITFCS	0xffff	/* Initial FCS value */
75#define PPP_GOODFCS	0xf0b8	/* Good final FCS value */
76#define PPP_FCS(fcs, c)	(((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
77
78/*
79 * A 32-bit unsigned integral type.
80 */
81#if !defined(__BIT_TYPES_DEFINED__) && !defined(_BITYPES) && !defined(__FreeBSD__)
82#ifdef	UINT32_T
83typedef UINT32_T	u_int32_t;
84#else
85typedef unsigned int	u_int32_t;
86#endif
87#endif
88
89/*
90 * Extended asyncmap - allows any character to be escaped.
91 */
92typedef u_int32_t	ext_accm[8];
93
94/*
95 * What to do with network protocol (NP) packets.
96 */
97enum NPmode {
98    NPMODE_PASS,		/* pass the packet through */
99    NPMODE_DROP,		/* silently drop the packet */
100    NPMODE_ERROR,		/* return an error */
101    NPMODE_QUEUE		/* save it up for later. */
102};
103
104/*
105 * Statistics.
106 */
107struct pppstat	{
108    u_int	ppp_ibytes;	/* bytes received */
109    u_int	ppp_ipackets;	/* packets received */
110    u_int	ppp_ierrors;	/* receive errors */
111    u_int	ppp_obytes;	/* bytes sent */
112    u_int	ppp_opackets;	/* packets sent */
113    u_int	ppp_oerrors;	/* transmit errors */
114};
115
116struct vjstat {
117    u_int	vjs_packets;	/* outbound packets */
118    u_int	vjs_compressed;	/* outbound compressed packets */
119    u_int	vjs_searches;	/* searches for connection state */
120    u_int	vjs_misses;	/* times couldn't find conn. state */
121    u_int	vjs_uncompressedin; /* inbound uncompressed packets */
122    u_int	vjs_compressedin;   /* inbound compressed packets */
123    u_int	vjs_errorin;	/* inbound unknown type packets */
124    u_int	vjs_tossed;	/* inbound packets tossed because of error */
125};
126
127struct ppp_stats {
128    struct pppstat	p;	/* basic PPP statistics */
129    struct vjstat	vj;	/* VJ header compression statistics */
130};
131
132struct compstat {
133    u_int	unc_bytes;	/* total uncompressed bytes */
134    u_int	unc_packets;	/* total uncompressed packets */
135    u_int	comp_bytes;	/* compressed bytes */
136    u_int	comp_packets;	/* compressed packets */
137    u_int	inc_bytes;	/* incompressible bytes */
138    u_int	inc_packets;	/* incompressible packets */
139    u_int	ratio;		/* recent compression ratio << 8 */
140};
141
142struct ppp_comp_stats {
143    struct compstat	c;	/* packet compression statistics */
144    struct compstat	d;	/* packet decompression statistics */
145};
146
147/*
148 * The following structure records the time in seconds since
149 * the last NP packet was sent or received.
150 */
151struct ppp_idle {
152    time_t xmit_idle;		/* time since last NP packet sent */
153    time_t recv_idle;		/* time since last NP packet received */
154};
155
156#ifndef __P
157#ifdef __STDC__
158#define __P(x)	x
159#else
160#define __P(x)	()
161#endif
162#endif
163
164#endif /* _PPP_DEFS_H_ */
165