sys/net/if_pppvar.h

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