FreeBSD/Linux Kernel Cross Reference
sys/net/if_sppp.h

     /*
      * Defines for synchronous PPP/Cisco link level subroutines.
      *
      * Copyright (C) 1994 Cronyx Ltd.
      * Author: Serge Vakulenko, <vak@cronyx.ru>
      *
      * Heavily revamped to conform to RFC 1661.
      * Copyright (C) 1997, Joerg Wunsch.
      *
     * This software is distributed with NO WARRANTIES, not even the implied
     * warranties for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
     *
     * Authors grant any other persons or organizations permission to use
     * or modify this software as long as this message is kept with the software,
     * all derivative works or modified versions.
     *
     * From: Version 2.0, Fri Oct  6 20:39:21 MSK 1995
     *
     * $FreeBSD: releng/5.0/sys/net/if_sppp.h 88723 2001-12-30 20:42:29Z joerg $
     */
    
    #ifndef _NET_IF_SPPP_H_
    #define _NET_IF_SPPP_H_ 1
    
    #define IDX_LCP 0               /* idx into state table */
    
    struct slcp {
            u_long  opts;           /* LCP options to send (bitfield) */
            u_long  magic;          /* local magic number */
            u_long  mru;            /* our max receive unit */
            u_long  their_mru;      /* their max receive unit */
            u_long  protos;         /* bitmask of protos that are started */
            u_char  echoid;         /* id of last keepalive echo request */
            /* restart max values, see RFC 1661 */
            int     timeout;
            int     max_terminate;
            int     max_configure;
            int     max_failure;
    };
    
    #define IDX_IPCP 1              /* idx into state table */
    #define IDX_IPV6CP 2            /* idx into state table */
    
    struct sipcp {
            u_long  opts;           /* IPCP options to send (bitfield) */
            u_int   flags;
    #define IPCP_HISADDR_SEEN 1     /* have seen his address already */
    #define IPCP_MYADDR_DYN   2     /* my address is dynamically assigned */
    #define IPCP_MYADDR_SEEN  4     /* have seen his address already */
    #ifdef notdef
    #define IPV6CP_MYIFID_DYN 8     /* my ifid is dynamically assigned */
    #endif
    #define IPV6CP_MYIFID_SEEN 0x10 /* have seen his ifid already */
    #define IPCP_VJ         0x20    /* can use VJ compression */
            int     max_state;      /* VJ: Max-Slot-Id */
            int     compress_cid;   /* VJ: Comp-Slot-Id */
    };
    
    #define AUTHNAMELEN     64
    #define AUTHKEYLEN      16
    
    struct sauth {
            u_short proto;                  /* authentication protocol to use */
            u_short flags;
    #define AUTHFLAG_NOCALLOUT      1       /* do not require authentication on */
                                            /* callouts */
    #define AUTHFLAG_NORECHALLENGE  2       /* do not re-challenge CHAP */
            u_char  name[AUTHNAMELEN];      /* system identification name */
            u_char  secret[AUTHKEYLEN];     /* secret password */
            u_char  challenge[AUTHKEYLEN];  /* random challenge */
    };
    
    #define IDX_PAP         3
    #define IDX_CHAP        4
    
    #define IDX_COUNT (IDX_CHAP + 1) /* bump this when adding cp's! */
    
    /*
     * Don't change the order of this.  Ordering the phases this way allows
     * for a comparision of ``pp_phase >= PHASE_AUTHENTICATE'' in order to
     * know whether LCP is up.
     */
    enum ppp_phase {
            PHASE_DEAD, PHASE_ESTABLISH, PHASE_TERMINATE,
            PHASE_AUTHENTICATE, PHASE_NETWORK
    };
    
    #define PP_MTU          1500    /* default/minimal MRU */
    #define PP_MAX_MRU      2048    /* maximal MRU we want to negotiate */
    
    /*
     * This is a cut down struct sppp (see below) that can easily be
     * exported to/ imported from userland without the need to include
     * dozens of kernel-internal header files.  It is used by the
     * SPPPIO[GS]DEFS ioctl commands below.
     */
    struct sppp_parms {
            enum ppp_phase pp_phase;        /* phase we're currently in */
            int     enable_vj;              /* VJ header compression enabled */
           int     enable_ipv6;            /*
                                            * Enable IPv6 negotiations -- only
                                            * needed since each IPv4 i/f auto-
                                            * matically gets an IPv6 address
                                            * assigned, so we can't use this as
                                            * a decision.
                                            */
           struct slcp lcp;                /* LCP params */
           struct sipcp ipcp;              /* IPCP params */
           struct sipcp ipv6cp;            /* IPv6CP params */
           struct sauth myauth;            /* auth params, i'm peer */
           struct sauth hisauth;           /* auth params, i'm authenticator */
   };
   
   /*
    * Definitions to pass struct sppp_parms data down into the kernel
    * using the SIOC[SG]IFGENERIC ioctl interface.
    *
    * In order to use this, create a struct spppreq, fill in the cmd
    * field with SPPPIOGDEFS, and put the address of this structure into
    * the ifr_data portion of a struct ifreq.  Pass this struct to a
    * SIOCGIFGENERIC ioctl.  Then replace the cmd field by SPPPIOSDEFS,
    * modify the defs field as desired, and pass the struct ifreq now
    * to a SIOCSIFGENERIC ioctl.
    */
   
   #define SPPPIOGDEFS  ((caddr_t)(('S' << 24) + (1 << 16) +\
           sizeof(struct sppp_parms)))
   #define SPPPIOSDEFS  ((caddr_t)(('S' << 24) + (2 << 16) +\
           sizeof(struct sppp_parms)))
   
   struct spppreq {
           int     cmd;
           struct sppp_parms defs;
   };
   
   #ifdef _KERNEL
   struct sppp {
           /* NB: pp_if _must_ be first */
           struct  ifnet pp_if;    /* network interface data */
           struct  ifqueue pp_fastq; /* fast output queue */
           struct  ifqueue pp_cpq; /* PPP control protocol queue */
           struct  sppp *pp_next;  /* next interface in keepalive list */
           u_int   pp_mode;        /* major protocol modes (cisco/ppp/...) */
           u_int   pp_flags;       /* sub modes */
           u_short pp_alivecnt;    /* keepalive packets counter */
           u_short pp_loopcnt;     /* loopback detection counter */
           u_long  pp_seq[IDX_COUNT];      /* local sequence number */
           u_long  pp_rseq[IDX_COUNT];     /* remote sequence number */
           enum ppp_phase pp_phase;        /* phase we're currently in */
           int     state[IDX_COUNT];       /* state machine */
           u_char  confid[IDX_COUNT];      /* id of last configuration request */
           int     rst_counter[IDX_COUNT]; /* restart counter */
           int     fail_counter[IDX_COUNT]; /* negotiation failure counter */
           int     confflags;      /* administrative configuration flags */
   #define CONF_ENABLE_VJ    0x01  /* VJ header compression enabled */
   #define CONF_ENABLE_IPV6  0x02  /* IPv6 administratively enabled */
           time_t  pp_last_recv;   /* time last packet has been received */
           time_t  pp_last_sent;   /* time last packet has been sent */
           struct callout_handle ch[IDX_COUNT]; /* per-proto and if callouts */
           struct callout_handle pap_my_to_ch; /* PAP needs one more... */
           struct slcp lcp;                /* LCP params */
           struct sipcp ipcp;              /* IPCP params */
           struct sipcp ipv6cp;            /* IPv6CP params */
           struct sauth myauth;            /* auth params, i'm peer */
           struct sauth hisauth;           /* auth params, i'm authenticator */
           struct slcompress *pp_comp;     /* for VJ compression */
           /*
            * These functions are filled in by sppp_attach(), and are
            * expected to be used by the lower layer (hardware) drivers
            * in order to communicate the (un)availability of the
            * communication link.  Lower layer drivers that are always
            * ready to communicate (like hardware HDLC) can shortcut
            * pp_up from pp_tls, and pp_down from pp_tlf.
            */
           void    (*pp_up)(struct sppp *sp);
           void    (*pp_down)(struct sppp *sp);
           /*
            * These functions need to be filled in by the lower layer
            * (hardware) drivers if they request notification from the
            * PPP layer whether the link is actually required.  They
            * correspond to the tls and tlf actions.
            */
           void    (*pp_tls)(struct sppp *sp);
           void    (*pp_tlf)(struct sppp *sp);
           /*
            * These (optional) functions may be filled by the hardware
            * driver if any notification of established connections
            * (currently: IPCP up) is desired (pp_con) or any internal
            * state change of the interface state machine should be
            * signaled for monitoring purposes (pp_chg).
            */
           void    (*pp_con)(struct sppp *sp);
           void    (*pp_chg)(struct sppp *sp, int new_state);
           /* These two fields are for use by the lower layer */
           void    *pp_lowerp;
           int     pp_loweri;
   };
   
   /* bits for pp_flags */
   #define PP_KEEPALIVE    0x01    /* use keepalive protocol */
                                   /* 0x04 was PP_TIMO */
   #define PP_CALLIN       0x08    /* we are being called */
   #define PP_NEEDAUTH     0x10    /* remote requested authentication */
   
   void sppp_attach (struct ifnet *ifp);
   void sppp_detach (struct ifnet *ifp);
   void sppp_input (struct ifnet *ifp, struct mbuf *m);
   int sppp_ioctl (struct ifnet *ifp, u_long cmd, void *data);
   struct mbuf *sppp_dequeue (struct ifnet *ifp);
   struct mbuf *sppp_pick(struct ifnet *ifp);
   int sppp_isempty (struct ifnet *ifp);
   void sppp_flush (struct ifnet *ifp);
   #endif
   
   #endif /* _NET_IF_SPPP_H_ */

Cache object: 3cd12796cb0969e86e30bde361d9346f