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

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * if_ppp.h - Point-to-Point Protocol definitions.
 *
 * Copyright (c) 1989 Carnegie Mellon University.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms are permitted
 * provided that the above copyright notice and this paragraph are
 * duplicated in all such forms and that any documentation,
 * advertising materials, and other materials related to such
 * distribution and use acknowledge that the software was developed
 * by Carnegie Mellon University.  The name of the
 * University may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * $FreeBSD: src/sys/net/if_ppp.h,v 1.14 1999/08/28 00:48:20 peter Exp $
 */

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

/* XXX this used to be self-contained. */
#include <net/ppp_defs.h>
#include <net/if.h>

/*
 * Packet sizes
 */
#define	PPP_MTU		1500	/* Default MTU (size of Info field) */
#define PPP_MAXMRU	65000	/* Largest MRU we allow */
#define PPP_MAXMTU	16384	/* Largest MTU we allow */

/*
 * Bit definitions for flags.
 */
#define SC_COMP_PROT	0x00000001	/* protocol compression (output) */
#define SC_COMP_AC	0x00000002	/* header compression (output) */
#define	SC_COMP_TCP	0x00000004	/* TCP (VJ) compression (output) */
#define SC_NO_TCP_CCID	0x00000008	/* disable VJ connection-id comp. */
#define SC_REJ_COMP_AC	0x00000010	/* reject adrs/ctrl comp. on input */
#define SC_REJ_COMP_TCP	0x00000020	/* reject TCP (VJ) comp. on input */
#define SC_CCP_OPEN	0x00000040	/* Look at CCP packets */
#define SC_CCP_UP	0x00000080	/* May send/recv compressed packets */
#define SC_DEBUG	0x00010000	/* enable debug messages */
#define SC_LOG_INPKT	0x00020000	/* log contents of good pkts recvd */
#define SC_LOG_OUTPKT	0x00040000	/* log contents of pkts sent */
#define SC_LOG_RAWIN	0x00080000	/* log all chars received */
#define SC_LOG_FLUSH	0x00100000	/* log all chars flushed */
#define SC_RCV_B7_0	0x01000000	/* have rcvd char with bit 7 = 0 */
#define SC_RCV_B7_1	0x02000000	/* have rcvd char with bit 7 = 1 */
#define SC_RCV_EVNP	0x04000000	/* have rcvd char with even parity */
#define SC_RCV_ODDP	0x08000000	/* have rcvd char with odd parity */
#define	SC_MASK		0x0fff00ff	/* bits that user can change */

/*
 * State bits in sc_flags, not changeable by user.
 */
#define SC_TIMEOUT	0x00000400	/* timeout is currently pending */
#define SC_VJ_RESET	0x00000800	/* need to reset VJ decomp */
#define SC_COMP_RUN	0x00001000	/* compressor has been initiated */
#define SC_DECOMP_RUN	0x00002000	/* decompressor has been initiated */
#define SC_DC_ERROR	0x00004000	/* non-fatal decomp error detected */
#define SC_DC_FERROR	0x00008000	/* fatal decomp error detected */
#define SC_TBUSY	0x10000000	/* xmitter doesn't need a packet yet */
#define SC_PKTLOST	0x20000000	/* have lost or dropped a packet */
#define	SC_FLUSH	0x40000000	/* flush input until next PPP_FLAG */
#define	SC_ESCAPED	0x80000000	/* saw a PPP_ESCAPE */

/*
 * Ioctl definitions.
 */

struct npioctl {
    int		protocol;	/* PPP procotol, e.g. PPP_IP */
    enum NPmode	mode;
};

/* Structure describing a CCP configuration option, for PPPIOCSCOMPRESS */
struct ppp_option_data {
	u_char	*ptr;
	u_int	length;
	int	transmit;
};

struct ifpppstatsreq {
    char ifr_name[IFNAMSIZ];
    struct ppp_stats stats;
};

struct ifpppcstatsreq {
    char ifr_name[IFNAMSIZ];
    struct ppp_comp_stats stats;
};

/*
 * Ioctl definitions.
 */

#define	PPPIOCGFLAGS	_IOR('t', 90, int)	/* get configuration flags */
#define	PPPIOCSFLAGS	_IOW('t', 89, int)	/* set configuration flags */
#define	PPPIOCGASYNCMAP	_IOR('t', 88, int)	/* get async map */
#define	PPPIOCSASYNCMAP	_IOW('t', 87, int)	/* set async map */
#define	PPPIOCGUNIT	_IOR('t', 86, int)	/* get ppp unit number */
#define	PPPIOCGRASYNCMAP _IOR('t', 85, int)	/* get receive async map */
#define	PPPIOCSRASYNCMAP _IOW('t', 84, int)	/* set receive async map */
#define	PPPIOCGMRU	_IOR('t', 83, int)	/* get max receive unit */
#define	PPPIOCSMRU	_IOW('t', 82, int)	/* set max receive unit */
#define	PPPIOCSMAXCID	_IOW('t', 81, int)	/* set VJ max slot ID */
#define PPPIOCGXASYNCMAP _IOR('t', 80, ext_accm) /* get extended ACCM */
#define PPPIOCSXASYNCMAP _IOW('t', 79, ext_accm) /* set extended ACCM */
#define PPPIOCXFERUNIT	_IO('t', 78)		/* transfer PPP unit */
#define PPPIOCSCOMPRESS	_IOW('t', 77, struct ppp_option_data)
#define PPPIOCGNPMODE	_IOWR('t', 76, struct npioctl) /* get NP mode */
#define PPPIOCSNPMODE	_IOW('t', 75, struct npioctl)  /* set NP mode */
#define PPPIOCGIDLE	_IOR('t', 74, struct ppp_idle) /* get idle time */
#define PPPIOCSPASS	_IOW('t', 71, struct bpf_program) /* set pass filter */
#define PPPIOCSACTIVE	_IOW('t', 70, struct bpf_program) /* set active filt */

/* PPPIOC[GS]MTU are alternatives to SIOC[GS]IFMTU, used under Ultrix */
#define PPPIOCGMTU	_IOR('t', 73, int)	/* get interface MTU */
#define PPPIOCSMTU	_IOW('t', 72, int)	/* set interface MTU */

/*
 * These two are interface ioctls so that pppstats can do them on
 * a socket without having to open the serial device.
 */
#define SIOCGPPPSTATS	_IOWR('i', 123, struct ifpppstatsreq)
#define SIOCGPPPCSTATS	_IOWR('i', 122, struct ifpppcstatsreq)

#if !defined(ifr_mtu)
#define ifr_mtu	ifr_ifru.ifru_metric
#endif

#endif /* _IF_PPP_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* if_ppp.h - Point-to-Point Protocol definitions.
	30	*
	31	* Copyright (c) 1989 Carnegie Mellon University.
	32	* All rights reserved.
	33	*
	34	* Redistribution and use in source and binary forms are permitted
	35	* provided that the above copyright notice and this paragraph are
	36	* duplicated in all such forms and that any documentation,
	37	* advertising materials, and other materials related to such
	38	* distribution and use acknowledge that the software was developed
	39	* by Carnegie Mellon University. The name of the
	40	* University may not be used to endorse or promote products derived
	41	* from this software without specific prior written permission.
	42	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
	43	* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
	44	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
	45	*
9bccf70c	46	* $FreeBSD: src/sys/net/if_ppp.h,v 1.14 1999/08/28 00:48:20 peter Exp $
1c79356b A	47	*/
	48
	49	#ifndef _IF_PPP_H_
	50	#define _IF_PPP_H_
9bccf70c	51	#include <sys/appleapiopts.h>
1c79356b A	52
	53	/* XXX this used to be self-contained. */
	54	#include <net/ppp_defs.h>
	55	#include <net/if.h>
	56
	57	/*
	58	* Packet sizes
	59	*/
	60	#define PPP_MTU 1500 /* Default MTU (size of Info field) */
	61	#define PPP_MAXMRU 65000 /* Largest MRU we allow */
	62	#define PPP_MAXMTU 16384 /* Largest MTU we allow */
	63
	64	/*
	65	* Bit definitions for flags.
	66	*/
	67	#define SC_COMP_PROT 0x00000001 /* protocol compression (output) */
	68	#define SC_COMP_AC 0x00000002 /* header compression (output) */
	69	#define SC_COMP_TCP 0x00000004 /* TCP (VJ) compression (output) */
	70	#define SC_NO_TCP_CCID 0x00000008 /* disable VJ connection-id comp. */
	71	#define SC_REJ_COMP_AC 0x00000010 /* reject adrs/ctrl comp. on input */
	72	#define SC_REJ_COMP_TCP 0x00000020 /* reject TCP (VJ) comp. on input */
	73	#define SC_CCP_OPEN 0x00000040 /* Look at CCP packets */
	74	#define SC_CCP_UP 0x00000080 /* May send/recv compressed packets */
	75	#define SC_DEBUG 0x00010000 /* enable debug messages */
	76	#define SC_LOG_INPKT 0x00020000 /* log contents of good pkts recvd */
	77	#define SC_LOG_OUTPKT 0x00040000 /* log contents of pkts sent */
	78	#define SC_LOG_RAWIN 0x00080000 /* log all chars received */
	79	#define SC_LOG_FLUSH 0x00100000 /* log all chars flushed */
	80	#define SC_RCV_B7_0 0x01000000 /* have rcvd char with bit 7 = 0 */
	81	#define SC_RCV_B7_1 0x02000000 /* have rcvd char with bit 7 = 1 */
	82	#define SC_RCV_EVNP 0x04000000 /* have rcvd char with even parity */
	83	#define SC_RCV_ODDP 0x08000000 /* have rcvd char with odd parity */
	84	#define SC_MASK 0x0fff00ff /* bits that user can change */
	85
	86	/*
	87	* State bits in sc_flags, not changeable by user.
	88	*/
	89	#define SC_TIMEOUT 0x00000400 /* timeout is currently pending */
	90	#define SC_VJ_RESET 0x00000800 /* need to reset VJ decomp */
	91	#define SC_COMP_RUN 0x00001000 /* compressor has been initiated */
	92	#define SC_DECOMP_RUN 0x00002000 /* decompressor has been initiated */
	93	#define SC_DC_ERROR 0x00004000 /* non-fatal decomp error detected */
	94	#define SC_DC_FERROR 0x00008000 /* fatal decomp error detected */
	95	#define SC_TBUSY 0x10000000 /* xmitter doesn't need a packet yet */
	96	#define SC_PKTLOST 0x20000000 /* have lost or dropped a packet */
	97	#define SC_FLUSH 0x40000000 /* flush input until next PPP_FLAG */
	98	#define SC_ESCAPED 0x80000000 /* saw a PPP_ESCAPE */
	99
	100	/*
	101	* Ioctl definitions.
	102	*/
	103
	104	struct npioctl {
	105	int protocol; /* PPP procotol, e.g. PPP_IP */
	106	enum NPmode mode;
	107	};
	108
	109	/* Structure describing a CCP configuration option, for PPPIOCSCOMPRESS */
	110	struct ppp_option_data {
	111	u_char *ptr;
	112	u_int length;
	113	int transmit;
	114	};
	115
116	struct ifpppstatsreq {
117	char ifr_name[IFNAMSIZ];
118	struct ppp_stats stats;
119	};
120
121	struct ifpppcstatsreq {
122	char ifr_name[IFNAMSIZ];
123	struct ppp_comp_stats stats;
124	};
125
126	/*
127	* Ioctl definitions.
128	*/
129
130	#define PPPIOCGFLAGS _IOR('t', 90, int) /* get configuration flags */
131	#define PPPIOCSFLAGS _IOW('t', 89, int) /* set configuration flags */
132	#define PPPIOCGASYNCMAP _IOR('t', 88, int) /* get async map */
133	#define PPPIOCSASYNCMAP _IOW('t', 87, int) /* set async map */
134	#define PPPIOCGUNIT _IOR('t', 86, int) /* get ppp unit number */
135	#define PPPIOCGRASYNCMAP _IOR('t', 85, int) /* get receive async map */
136	#define PPPIOCSRASYNCMAP _IOW('t', 84, int) /* set receive async map */
137	#define PPPIOCGMRU _IOR('t', 83, int) /* get max receive unit */
138	#define PPPIOCSMRU _IOW('t', 82, int) /* set max receive unit */
139	#define PPPIOCSMAXCID _IOW('t', 81, int) /* set VJ max slot ID */
140	#define PPPIOCGXASYNCMAP _IOR('t', 80, ext_accm) /* get extended ACCM */
141	#define PPPIOCSXASYNCMAP _IOW('t', 79, ext_accm) /* set extended ACCM */
142	#define PPPIOCXFERUNIT _IO('t', 78) /* transfer PPP unit */
143	#define PPPIOCSCOMPRESS _IOW('t', 77, struct ppp_option_data)
144	#define PPPIOCGNPMODE _IOWR('t', 76, struct npioctl) /* get NP mode */
145	#define PPPIOCSNPMODE _IOW('t', 75, struct npioctl) /* set NP mode */
146	#define PPPIOCGIDLE _IOR('t', 74, struct ppp_idle) /* get idle time */
147	#define PPPIOCSPASS _IOW('t', 71, struct bpf_program) /* set pass filter */
148	#define PPPIOCSACTIVE _IOW('t', 70, struct bpf_program) /* set active filt */
149
150	/* PPPIOC[GS]MTU are alternatives to SIOC[GS]IFMTU, used under Ultrix */
151	#define PPPIOCGMTU _IOR('t', 73, int) /* get interface MTU */
152	#define PPPIOCSMTU _IOW('t', 72, int) /* set interface MTU */
153
154	/*
155	* These two are interface ioctls so that pppstats can do them on
156	* a socket without having to open the serial device.
157	*/
158	#define SIOCGPPPSTATS _IOWR('i', 123, struct ifpppstatsreq)
159	#define SIOCGPPPCSTATS _IOWR('i', 122, struct ifpppcstatsreq)
160
161	#if !defined(ifr_mtu)
162	#define ifr_mtu ifr_ifru.ifru_metric
163	#endif
164
165	#endif /* _IF_PPP_H_ */