source: rtems-libbsd/rtemsbsd/sys/net/if_pppvar.h

/*
 * 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.26 2006/12/05 18:54:21 ume Exp $
 */

 
#ifndef _NET_IF_PPPVAR_H_
#define _NET_IF_PPPVAR_H_

#include <net/if_var.h> /* struct ifnet */
#include <net/ppp_defs.h> /* struct pppstat */
#include <rtems/rtems/types.h> /* rtems_id */

#ifdef __cplusplus
extern "C" {
#endif

struct proc;

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


/*
 * Structure describing each ppp unit.
 */
struct ppp_softc {
        device_t sc_dev;
        struct mtx sc_mtx;
        struct  ifnet *sc_ifp;          /* network-visible interface */
        u_int   sc_flags;               /* control/status bits; see if_ppp.h */
        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 */
        short   sc_mru;                 /* max receive unit */
        pid_t   sc_xfer;                /* used in transferring unit */
        struct  ifqueue sc_rawq;                /* received packets */
        struct  ifqueue sc_inq;         /* queue of input packets for daemon */
        struct  ifaltq 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 */
        caddr_t sc_bpf;                 /* hook for BPF */
        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 */
#ifdef 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 */
#ifdef  VJC
        struct  vjcompress *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_outmc;         /* mbuf 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 */

        struct  ifqueue sc_freeq;       /* free packets */
        short   sc_outoff;              /* output packet byte offset */
        bool    sc_outoff_update;       /* outoff needs update in pppstart */
        short   sc_outflag;             /* output status flag */
        short   sc_outlen;              /* length of output packet */
        short   sc_outfcslen;           /* length of output fcs data */
        u_char  sc_outfcsbuf[8];        /* output packet fcs buffer */
        u_char *sc_outbuf;              /* pointer to output data */
        u_char  sc_outchar;

        rtems_id sc_rxtask;
        rtems_id sc_txtask;
        rtems_id sc_pppdtask;
};

struct  ppp_softc *pppalloc(pid_t pid);
void    pppdealloc(struct ppp_softc *sc);
int     pppoutput(struct ifnet *, struct mbuf *, const struct sockaddr *,
            struct route *);
int     pppioctl(struct ppp_softc *sc, ioctl_command_t cmd, caddr_t data,
                      int flag, struct proc *p);
struct  mbuf *ppp_dequeue(struct ppp_softc *sc);
u_short pppfcs(u_short fcs, u_char *cp, int len);
void    pppallocmbuf(struct ppp_softc *sc, struct mbuf **mp);


/* define event values */
#define RX_PACKET    RTEMS_EVENT_1
#define RX_MBUF      RTEMS_EVENT_2
#define RX_EMPTY     RTEMS_EVENT_3
#define TX_PACKET    RTEMS_EVENT_1
#define TX_TRANSMIT  RTEMS_EVENT_2
#define PPPD_EVENT   RTEMS_EVENT_31

/* define out flag values */
#define SC_TX_BUSY      0x0001
#define SC_TX_FCS       0x0002
#define SC_TX_ESCAPE    0x0004
#define SC_TX_LASTCHAR  0x0008
#define SC_TX_PENDING   0x0010

/*
 * Special interface queue functions to exchange mbufs between task and
 * interrupt context via pppinput() and pppstart().
 */

static inline void
if_ppp_enqueue(struct ifqueue *ifq, struct mbuf *m)
{
        rtems_interrupt_level level;

        rtems_interrupt_disable(level);
        _IF_ENQUEUE(ifq, m);
        rtems_interrupt_enable(level);
}

static inline struct mbuf *
if_ppp_dequeue(struct ifqueue *ifq)
{
        struct mbuf *m;
        rtems_interrupt_level level;

        rtems_interrupt_disable(level);
        _IF_DEQUEUE(ifq, m);
        rtems_interrupt_enable(level);

        return m;
}

#ifdef __cplusplus
}
#endif

#endif /* _NET_IF_PPPVAR_H_ */