[apple/xnu.git] / bsd / net / if_pppvar.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_pppvar.h - private structures and declarations for PPP.
 *
 * 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.
 *
 * 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_pppvar.h,v 1.15 2000/01/29 16:56:23 peter Exp $
 */

#include <sys/appleapiopts.h>
#ifndef DONT_WARN_OBSOLETE
#warning if_pppvar.h is not used by the darwin kernel
#endif

#ifdef KERNEL_PRIVATE

/*
 * Supported network protocols.  These values are used for
 * indexing sc_npmode.
 */
#define NP_IP	0		/* Internet Protocol */
#define NUM_NP	1		/* Number of NPs. */

/*
 * Structure describing each ppp unit.
 */
struct ppp_softc {
	struct	ifnet sc_if;		/* network-visible interface */
/*hi*/	u_int	sc_flags;		/* control/status bits; see if_ppp.h */
	struct	callout_handle sc_ch;	/* Used for scheduling timeouts */
	void	*sc_devp;		/* pointer to device-dep structure */
	void	(*sc_start)(struct ppp_softc *);	/* start output proc */
	void	(*sc_ctlp)(struct ppp_softc *); /* rcvd control pkt */
	void	(*sc_relinq)(struct ppp_softc *); /* relinquish ifunit */
	void	(*sc_setmtu)(struct ppp_softc *); /* set mtu */
	short	sc_mru;			/* max receive unit */
	pid_t	sc_xfer;		/* used in transferring unit */
/*hi*/	struct	ifqueue sc_rawq;	/* received packets */
/*net*/	struct	ifqueue sc_inq;		/* queue of input packets for daemon */
/*net*/	struct	ifqueue sc_fastq;	/* interactive output packet q */
	struct	mbuf *sc_npqueue;	/* output packets not to be sent yet */
	struct	mbuf **sc_npqtail;	/* ptr to last next ptr in npqueue */
	struct	pppstat sc_stats;	/* count of bytes/pkts sent/rcvd */
	enum	NPmode sc_npmode[NUM_NP]; /* what to do with each NP */
	struct	compressor *sc_xcomp;	/* transmit compressor */
	void	*sc_xc_state;		/* transmit compressor state */
	struct	compressor *sc_rcomp;	/* receive decompressor */
	void	*sc_rc_state;		/* receive decompressor state */
	time_t	sc_last_sent;		/* time (secs) last NP pkt sent */
	time_t	sc_last_recv;		/* time (secs) last NP pkt rcvd */
#if PPP_FILTER
	struct	bpf_program sc_pass_filt;   /* filter for packets to pass */
	struct	bpf_program sc_active_filt; /* filter for "non-idle" packets */
#endif /* PPP_FILTER */
#if	VJC
	struct	slcompress *sc_comp; 	/* vjc control buffer */
#endif

	/* Device-dependent part for async lines. */
	ext_accm sc_asyncmap;		/* async control character map */
	u_long	sc_rasyncmap;		/* receive async control char map */
	struct	mbuf *sc_outm;		/* mbuf chain currently being output */
	struct	mbuf *sc_m;		/* pointer to input mbuf chain */
	struct	mbuf *sc_mc;		/* pointer to current input mbuf */
	char	*sc_mp;			/* ptr to next char in input mbuf */
	short	sc_ilen;		/* length of input packet so far */
	u_short	sc_fcs;			/* FCS so far (input) */
	u_short	sc_outfcs;		/* FCS so far for output packet */
	u_char	sc_rawin[16];		/* chars as received */
	int	sc_rawin_count;		/* # in sc_rawin */
};

extern struct ppp_softc ppp_softc[];

struct	ppp_softc *pppalloc(pid_t pid);
void	pppdealloc(struct ppp_softc *sc);
int	pppioctl(struct ppp_softc *sc, u_long cmd, caddr_t data,
		      int flag, struct proc *p);
int	pppoutput(struct ifnet *ifp, struct mbuf *m0,
		       struct sockaddr *dst, struct rtentry *rtp);
void	ppp_restart(struct ppp_softc *sc);
void	ppppktin(struct ppp_softc *sc, struct mbuf *m, int lost);
struct	mbuf *ppp_dequeue(struct ppp_softc *sc);
#endif /* __APPLE_API_PRIVATE */
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_pppvar.h - private structures and declarations for PPP.
	30	*
	31	* Copyright (c) 1994 The Australian National University.
	32	* All rights reserved.
	33	*
	34	* Permission to use, copy, modify, and distribute this software and its
	35	* documentation is hereby granted, provided that the above copyright
	36	* notice appears in all copies. This software is provided without any
	37	* warranty, express or implied. The Australian National University
	38	* makes no representations about the suitability of this software for
	39	* any purpose.
	40	*
	41	* IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
	42	* PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
	43	* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
	44	* THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
	45	* OF SUCH DAMAGE.
	46	*
	47	* THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
	48	* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
	49	* AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
	50	* ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
	51	* OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
	52	* OR MODIFICATIONS.
	53	*
	54	* Copyright (c) 1989 Carnegie Mellon University.
	55	* All rights reserved.
	56	*
	57	* Redistribution and use in source and binary forms are permitted
	58	* provided that the above copyright notice and this paragraph are
	59	* duplicated in all such forms and that any documentation,
	60	* advertising materials, and other materials related to such
	61	* distribution and use acknowledge that the software was developed
	62	* by Carnegie Mellon University. The name of the
	63	* University may not be used to endorse or promote products derived
	64	* from this software without specific prior written permission.
	65	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
	66	* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
	67	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
	68	*
9bccf70c	69	* $FreeBSD: src/sys/net/if_pppvar.h,v 1.15 2000/01/29 16:56:23 peter Exp $
1c79356b A	70	*/
1c79356b A	71
9bccf70c A	72	#include <sys/appleapiopts.h>
	73	#ifndef DONT_WARN_OBSOLETE
	74	#warning if_pppvar.h is not used by the darwin kernel
	75	#endif
	76
91447636	77	#ifdef KERNEL_PRIVATE
9bccf70c	78
1c79356b A	79	/*
	80	* Supported network protocols. These values are used for
	81	* indexing sc_npmode.
	82	*/
	83	#define NP_IP 0 /* Internet Protocol */
	84	#define NUM_NP 1 /* Number of NPs. */
	85
	86	/*
	87	* Structure describing each ppp unit.
	88	*/
	89	struct ppp_softc {
	90	struct ifnet sc_if; /* network-visible interface */
	91	/hi/ u_int sc_flags; /* control/status bits; see if_ppp.h */
	92	struct callout_handle sc_ch; /* Used for scheduling timeouts */
	93	void sc_devp; / pointer to device-dep structure */
91447636 A	94	void (sc_start)(struct ppp_softc ); /* start output proc */
	95	void (sc_ctlp)(struct ppp_softc ); /* rcvd control pkt */
	96	void (sc_relinq)(struct ppp_softc ); /* relinquish ifunit */
	97	void (sc_setmtu)(struct ppp_softc ); /* set mtu */
1c79356b A	98	short sc_mru; /* max receive unit */
	99	pid_t sc_xfer; /* used in transferring unit */
	100	/hi/ struct ifqueue sc_rawq; /* received packets */
	101	/net/ struct ifqueue sc_inq; /* queue of input packets for daemon */
	102	/net/ struct ifqueue sc_fastq; /* interactive output packet q */
	103	struct mbuf sc_npqueue; / output packets not to be sent yet */
	104	struct mbuf *sc_npqtail; / ptr to last next ptr in npqueue */
	105	struct pppstat sc_stats; /* count of bytes/pkts sent/rcvd */
	106	enum NPmode sc_npmode[NUM_NP]; /* what to do with each NP */
	107	struct compressor sc_xcomp; / transmit compressor */
	108	void sc_xc_state; / transmit compressor state */
	109	struct compressor sc_rcomp; / receive decompressor */
	110	void sc_rc_state; / receive decompressor state */
	111	time_t sc_last_sent; /* time (secs) last NP pkt sent */
	112	time_t sc_last_recv; /* time (secs) last NP pkt rcvd */
	113	#if PPP_FILTER
	114	struct bpf_program sc_pass_filt; /* filter for packets to pass */
	115	struct bpf_program sc_active_filt; /* filter for "non-idle" packets */
	116	#endif /* PPP_FILTER */
	117	#if VJC
	118	struct slcompress sc_comp; / vjc control buffer */
	119	#endif
	120
	121	/* Device-dependent part for async lines. */
	122	ext_accm sc_asyncmap; /* async control character map */
	123	u_long sc_rasyncmap; /* receive async control char map */
	124	struct mbuf sc_outm; / mbuf chain currently being output */
	125	struct mbuf sc_m; / pointer to input mbuf chain */
	126	struct mbuf sc_mc; / pointer to current input mbuf */
	127	char sc_mp; / ptr to next char in input mbuf */
	128	short sc_ilen; /* length of input packet so far */
	129	u_short sc_fcs; /* FCS so far (input) */
	130	u_short sc_outfcs; /* FCS so far for output packet */
	131	u_char sc_rawin[16]; /* chars as received */
	132	int sc_rawin_count; /* # in sc_rawin */
	133	};
	134
9bccf70c	135	extern struct ppp_softc ppp_softc[];
1c79356b	136
91447636 A	137	struct ppp_softc *pppalloc(pid_t pid);
	138	void pppdealloc(struct ppp_softc *sc);
	139	int pppioctl(struct ppp_softc *sc, u_long cmd, caddr_t data,
	140	int flag, struct proc *p);
	141	int pppoutput(struct ifnet ifp, struct mbuf m0,
	142	struct sockaddr dst, struct rtentry rtp);
	143	void ppp_restart(struct ppp_softc *sc);
	144	void ppppktin(struct ppp_softc sc, struct mbuf m, int lost);
	145	struct mbuf ppp_dequeue(struct ppp_softc sc);
9bccf70c	146	#endif /* __APPLE_API_PRIVATE */