[apple/xnu.git] / bsd / net / ppp_defs.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * ppp_defs.h - PPP definitions.
 *
 * Copyright (c) 1994 The Australian National University.
 * All rights reserved.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, provided that the above copyright
 * notice appears in all copies.  This software is provided without any
 * warranty, express or implied. The Australian National University
 * makes no representations about the suitability of this software for
 * any purpose.
 *
 * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
 * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
 * OR MODIFICATIONS.
 *
 */

#ifndef _PPP_DEFS_H_
#define _PPP_DEFS_H_
#include <sys/appleapiopts.h>

/*
 * The basic PPP frame.
 */
#define PPP_HDRLEN	4	/* octets for standard ppp header */
#define PPP_FCSLEN	2	/* octets for FCS */
#define PPP_MRU		1500	/* default MRU = max length of info field */

#define PPP_ADDRESS(p)	(((u_char *)(p))[0])
#define PPP_CONTROL(p)	(((u_char *)(p))[1])
#define PPP_PROTOCOL(p)	((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])

/*
 * Significant octet values.
 */
#define	PPP_ALLSTATIONS	0xff	/* All-Stations broadcast address */
#define	PPP_UI		0x03	/* Unnumbered Information */
#define	PPP_FLAG	0x7e	/* Flag Sequence */
#define	PPP_ESCAPE	0x7d	/* Asynchronous Control Escape */
#define	PPP_TRANS	0x20	/* Asynchronous transparency modifier */

/*
 * Protocol field values.
 */
#define PPP_IP		0x21	/* Internet Protocol */
#define	PPP_XNS		0x25	/* Xerox NS */
#define PPP_AT		0x29	/* AppleTalk Protocol */
#define PPP_IPX		0x2b	/* IPX Datagram (RFC1552) */
#define	PPP_VJC_COMP	0x2d	/* VJ compressed TCP */
#define	PPP_VJC_UNCOMP	0x2f	/* VJ uncompressed TCP */
#define PPP_COMP	0xfd	/* compressed packet */
#define PPP_IPCP	0x8021	/* IP Control Protocol */
#define PPP_ATCP	0x8029	/* AppleTalk Control Protocol */
#define PPP_IPXCP	0x802b	/* IPX Control Protocol (RFC1552) */
#define PPP_CCP		0x80fd	/* Compression Control Protocol */
#define PPP_LCP		0xc021	/* Link Control Protocol */
#define PPP_PAP		0xc023	/* Password Authentication Protocol */
#define PPP_LQR		0xc025	/* Link Quality Report protocol */
#define PPP_CHAP	0xc223	/* Cryptographic Handshake Auth. Protocol */
#define PPP_CBCP	0xc029	/* Callback Control Protocol */
#define PPP_IPV6	0x57	/* Internet Protocol version 6*/
#define PPP_IPV6CP	0x8057	/* IPv6 Control Protocol */

/*
 * Values for FCS calculations.
 */
#define PPP_INITFCS	0xffff	/* Initial FCS value */
#define PPP_GOODFCS	0xf0b8	/* Good final FCS value */
#define PPP_FCS(fcs, c)	(((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])

/*
 * Extended asyncmap - allows any character to be escaped.
 */
typedef u_int32_t	ext_accm[8];

/*
 * What to do with network protocol (NP) packets.
 */
enum NPmode {
    NPMODE_PASS,		/* pass the packet through */
    NPMODE_DROP,		/* silently drop the packet */
    NPMODE_ERROR,		/* return an error */
    NPMODE_QUEUE		/* save it up for later. */
};

/*
 * Statistics.
 */
struct pppstat	{
    unsigned int ppp_ibytes;	/* bytes received */
    unsigned int ppp_ipackets;	/* packets received */
    unsigned int ppp_ierrors;	/* receive errors */
    unsigned int ppp_obytes;	/* bytes sent */
    unsigned int ppp_opackets;	/* packets sent */
    unsigned int ppp_oerrors;	/* transmit errors */
};

struct vjstat {
    unsigned int vjs_packets;	/* outbound packets */
    unsigned int vjs_compressed; /* outbound compressed packets */
    unsigned int vjs_searches;	/* searches for connection state */
    unsigned int vjs_misses;	/* times couldn't find conn. state */
    unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
    unsigned int vjs_compressedin; /* inbound compressed packets */
    unsigned int vjs_errorin;	/* inbound unknown type packets */
    unsigned int vjs_tossed;	/* inbound packets tossed because of error */
};

struct ppp_stats {
    struct pppstat p;		/* basic PPP statistics */
    struct vjstat vj;		/* VJ header compression statistics */
};

struct compstat {
    unsigned int unc_bytes;	/* total uncompressed bytes */
    unsigned int unc_packets;	/* total uncompressed packets */
    unsigned int comp_bytes;	/* compressed bytes */
    unsigned int comp_packets;	/* compressed packets */
    unsigned int inc_bytes;	/* incompressible bytes */
    unsigned int inc_packets;	/* incompressible packets */
    unsigned int ratio;		/* recent compression ratio << 8 */
};

struct ppp_comp_stats {
    struct compstat c;		/* packet compression statistics */
    struct compstat d;		/* packet decompression statistics */
};

/*
 * The following structure records the time in seconds since
 * the last NP packet was sent or received.
 */
struct ppp_idle {
    time_t xmit_idle;		/* time since last NP packet sent */
    time_t recv_idle;		/* time since last NP packet received */
};

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