include netbsd-1.2
[ppp.git] / netbsd-1.1 / if_pppvar.h
1 /*      $Id: if_pppvar.h,v 1.3 1996/07/01 01:04:37 paulus Exp $ */
2
3 /*
4  * if_pppvar.h - private structures and declarations for PPP.
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  * Copyright (c) 1989 Carnegie Mellon University.
30  * All rights reserved.
31  *
32  * Redistribution and use in source and binary forms are permitted
33  * provided that the above copyright notice and this paragraph are
34  * duplicated in all such forms and that any documentation,
35  * advertising materials, and other materials related to such
36  * distribution and use acknowledge that the software was developed
37  * by Carnegie Mellon University.  The name of the
38  * University may not be used to endorse or promote products derived
39  * from this software without specific prior written permission.
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
41  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
42  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
43  */
44
45 /*
46  * Supported network protocols.  These values are used for
47  * indexing sc_npmode.
48  */
49 #define NP_IP   0               /* Internet Protocol */
50 #define NUM_NP  1               /* Number of NPs. */
51
52 /*
53  * Structure describing each ppp unit.
54  */
55 struct ppp_softc {
56         struct  ifnet sc_if;            /* network-visible interface */
57         u_int   sc_flags;               /* control/status bits; see if_ppp.h */
58         void    *sc_devp;               /* pointer to device-dep structure */
59         void    (*sc_start) __P((struct ppp_softc *));  /* start output proc */
60         void    (*sc_ctlp) __P((struct ppp_softc *)); /* rcvd control pkt */
61         void    (*sc_relinq) __P((struct ppp_softc *)); /* relinquish ifunit */
62         u_int16_t sc_mru;               /* max receive unit */
63         pid_t   sc_xfer;                /* used in transferring unit */
64         struct  ifqueue sc_rawq;        /* received packets */
65         struct  ifqueue sc_inq;         /* queue of input packets for daemon */
66         struct  ifqueue sc_fastq;       /* interactive output packet q */
67         struct  mbuf *sc_togo;          /* output packet ready to go */
68         struct  mbuf *sc_npqueue;       /* output packets not to be sent yet */
69         struct  mbuf **sc_npqtail;      /* ptr to last next ptr in npqueue */
70         struct  pppstat sc_stats;       /* count of bytes/pkts sent/rcvd */
71         caddr_t sc_bpf;                 /* hook for BPF */
72         enum    NPmode sc_npmode[NUM_NP]; /* what to do with each NP */
73         struct  compressor *sc_xcomp;   /* transmit compressor */
74         void    *sc_xc_state;           /* transmit compressor state */
75         struct  compressor *sc_rcomp;   /* receive decompressor */
76         void    *sc_rc_state;           /* receive decompressor state */
77         time_t  sc_last_sent;           /* time (secs) last NP pkt sent */
78         time_t  sc_last_recv;           /* time (secs) last NP pkt rcvd */
79 #ifdef  VJC
80         struct  slcompress *sc_comp;    /* vjc control buffer */
81 #endif
82
83         /* Device-dependent part for async lines. */
84         ext_accm sc_asyncmap;           /* async control character map */
85         u_int32_t sc_rasyncmap;         /* receive async control char map */
86         struct  mbuf *sc_outm;          /* mbuf chain currently being output */
87         struct  mbuf *sc_m;             /* pointer to input mbuf chain */
88         struct  mbuf *sc_mc;            /* pointer to current input mbuf */
89         char    *sc_mp;                 /* ptr to next char in input mbuf */
90         u_int16_t sc_ilen;              /* length of input packet so far */
91         u_int16_t sc_fcs;               /* FCS so far (input) */
92         u_int16_t sc_outfcs;            /* FCS so far for output packet */
93         u_char  sc_rawin[16];           /* chars as received */
94         int     sc_rawin_count;         /* # in sc_rawin */
95 };
96
97 struct  ppp_softc ppp_softc[NPPP];
98
99 struct  ppp_softc *pppalloc __P((pid_t pid));
100 void    pppdealloc __P((struct ppp_softc *sc));
101 int     pppioctl __P((struct ppp_softc *sc, u_long cmd, caddr_t data,
102                       int flag, struct proc *p));
103 void    ppp_restart __P((struct ppp_softc *sc));
104 void    ppppktin __P((struct ppp_softc *sc, struct mbuf *m, int lost));
105 struct  mbuf *ppp_dequeue __P((struct ppp_softc *sc));