ppp_defs.h revision 11967 
1/*	$Id: ppp_defs.h,v 1.7 1995/08/10 06:49:35 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_VJC_COMP	0x2d	/* VJ compressed TCP */
58#define	PPP_VJC_UNCOMP	0x2f	/* VJ uncompressed TCP */
59#define PPP_COMP	0xfd	/* compressed packet */
60#define PPP_IPCP	0x8021	/* IP Control Protocol */
61#define PPP_CCP		0x80fd	/* Compression Control Protocol */
62#define PPP_LCP		0xc021	/* Link Control Protocol */
63#define PPP_PAP		0xc023	/* Password Authentication Protocol */
64#define PPP_LQR		0xc025	/* Link Quality Report protocol */
65#define PPP_CHAP	0xc223	/* Cryptographic Handshake Auth. Protocol */
66
67/*
68 * Values for FCS calculations.
69 */
70#define PPP_INITFCS	0xffff	/* Initial FCS value */
71#define PPP_GOODFCS	0xf0b8	/* Good final FCS value */
72#define PPP_FCS(fcs, c)	(((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
73
74/*
75 * A 32-bit unsigned integral type.
76 */
77#if !defined(__BIT_TYPES_DEFINED__) && !defined(_BITYPES)
78#ifdef	UINT32_T
79typedef UINT32_T	u_int32_t;
80#else
81typedef unsigned int	u_int32_t;
82#endif
83#endif
84
85/*
86 * Extended asyncmap - allows any character to be escaped.
87 */
88typedef u_int32_t	ext_accm[8];
89
90/*
91 * What to do with network protocol (NP) packets.
92 */
93enum NPmode {
94    NPMODE_PASS,		/* pass the packet through */
95    NPMODE_DROP,		/* silently drop the packet */
96    NPMODE_ERROR,		/* return an error */
97    NPMODE_QUEUE		/* save it up for later. */
98};
99
100/*
101 * Statistics.
102 */
103struct pppstat	{
104    u_int	ppp_ibytes;	/* bytes received */
105    u_int	ppp_ipackets;	/* packets received */
106    u_int	ppp_ierrors;	/* receive errors */
107    u_int	ppp_obytes;	/* bytes sent */
108    u_int	ppp_opackets;	/* packets sent */
109    u_int	ppp_oerrors;	/* transmit errors */
110};
111
112struct vjstat {
113    u_int	vjs_packets;	/* outbound packets */
114    u_int	vjs_compressed;	/* outbound compressed packets */
115    u_int	vjs_searches;	/* searches for connection state */
116    u_int	vjs_misses;	/* times couldn't find conn. state */
117    u_int	vjs_uncompressedin; /* inbound uncompressed packets */
118    u_int	vjs_compressedin;   /* inbound compressed packets */
119    u_int	vjs_errorin;	/* inbound unknown type packets */
120    u_int	vjs_tossed;	/* inbound packets tossed because of error */
121};
122
123struct ppp_stats {
124    struct pppstat	p;	/* basic PPP statistics */
125    struct vjstat	vj;	/* VJ header compression statistics */
126};
127
128struct compstat {
129    u_int	unc_bytes;	/* total uncompressed bytes */
130    u_int	unc_packets;	/* total uncompressed packets */
131    u_int	comp_bytes;	/* compressed bytes */
132    u_int	comp_packets;	/* compressed packets */
133    u_int	inc_bytes;	/* incompressible bytes */
134    u_int	inc_packets;	/* incompressible packets */
135    u_int	ratio;		/* recent compression ratio << 8 */
136};
137
138struct ppp_comp_stats {
139    struct compstat	c;	/* packet compression statistics */
140    struct compstat	d;	/* packet decompression statistics */
141};
142
143/*
144 * The following structure records the time in seconds since
145 * the last NP packet was sent or received.
146 */
147struct ppp_idle {
148    time_t xmit_idle;		/* time since last NP packet sent */
149    time_t recv_idle;		/* time since last NP packet received */
150};
151
152#ifndef __P
153#ifdef __STDC__
154#define __P(x)	x
155#else
156#define __P(x)	()
157#endif
158#endif
159
160#endif /* _PPP_DEFS_H_ */
161