sys/net/if_sppp.h

   1 /*
   2  * Defines for synchronous PPP/Cisco link level subroutines.
   3  *
   4  * Copyright (C) 1994 Cronyx Ltd.
   5  * Author: Serge Vakulenko, <vak@cronyx.ru>
   6  *
   7  * Heavily revamped to conform to RFC 1661.
   8  * Copyright (C) 1997, Joerg Wunsch.
   9  *
  10  * This software is distributed with NO WARRANTIES, not even the implied
  11  * warranties for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12  *
  13  * Authors grant any other persons or organizations permission to use
  14  * or modify this software as long as this message is kept with the software,
  15  * all derivative works or modified versions.
  16  *
  17  * From: Version 2.0, Fri Oct  6 20:39:21 MSK 1995
  18  *
  19  * $FreeBSD$
  20  */
  21
  22 #ifndef _NET_IF_SPPP_H_
  23 #define _NET_IF_SPPP_H_ 1
  24
  25 #define IDX_LCP 0               /* idx into state table */
  26
  27 struct slcp {
  28         u_long  opts;           /* LCP options to send (bitfield) */
  29         u_long  magic;          /* local magic number */
  30         u_long  mru;            /* our max receive unit */
  31         u_long  their_mru;      /* their max receive unit */
  32         u_long  protos;         /* bitmask of protos that are started */
  33         u_char  echoid;         /* id of last keepalive echo request */
  34         /* restart max values, see RFC 1661 */
  35         int     timeout;
  36         int     max_terminate;
  37         int     max_configure;
  38         int     max_failure;
  39 };
  40
  41 #define IDX_IPCP 1              /* idx into state table */
  42 #define IDX_IPV6CP 2            /* idx into state table */
  43
  44 struct sipcp {
  45         u_long  opts;           /* IPCP options to send (bitfield) */
  46         u_int   flags;
  47 #define IPCP_HISADDR_SEEN 1     /* have seen his address already */
  48 #define IPCP_MYADDR_DYN   2     /* my address is dynamically assigned */
  49 #define IPCP_MYADDR_SEEN  4     /* have seen his address already */
  50 #ifdef notdef
  51 #define IPV6CP_MYIFID_DYN 8     /* my ifid is dynamically assigned */
  52 #endif
  53 #define IPV6CP_MYIFID_SEEN 0x10 /* have seen his ifid already */
  54 #define IPCP_VJ         0x20    /* can use VJ compression */
  55         int     max_state;      /* VJ: Max-Slot-Id */
  56         int     compress_cid;   /* VJ: Comp-Slot-Id */
  57 };
  58
  59 #define AUTHNAMELEN     32
  60 #define AUTHKEYLEN      16
  61
  62 struct sauth {
  63         u_short proto;                  /* authentication protocol to use */
  64         u_short flags;
  65 #define AUTHFLAG_NOCALLOUT      1       /* do not require authentication on */
  66                                         /* callouts */
  67 #define AUTHFLAG_NORECHALLENGE  2       /* do not re-challenge CHAP */
  68         u_char  name[AUTHNAMELEN];      /* system identification name */
  69         u_char  secret[AUTHKEYLEN];     /* secret password */
  70         u_char  challenge[AUTHKEYLEN];  /* random challenge */
  71 };
  72
  73 #define IDX_PAP         3
  74 #define IDX_CHAP        4
  75
  76 #define IDX_COUNT (IDX_CHAP + 1) /* bump this when adding cp's! */
  77
  78 /*
  79  * Don't change the order of this.  Ordering the phases this way allows
  80  * for a comparision of ``pp_phase >= PHASE_AUTHENTICATE'' in order to
  81  * know whether LCP is up.
  82  */
  83 enum ppp_phase {
  84         PHASE_DEAD, PHASE_ESTABLISH, PHASE_TERMINATE,
  85         PHASE_AUTHENTICATE, PHASE_NETWORK
  86 };
  87
  88 struct sppp {
  89         /* NB: pp_if _must_ be first */
  90         struct  ifnet pp_if;    /* network interface data */
  91         struct  ifqueue pp_fastq; /* fast output queue */
  92         struct  ifqueue pp_cpq; /* PPP control protocol queue */
  93         struct  sppp *pp_next;  /* next interface in keepalive list */
  94         u_int   pp_mode;        /* major protocol modes (cisco/ppp/...) */
  95         u_int   pp_flags;       /* sub modes */
  96         u_short pp_alivecnt;    /* keepalive packets counter */
  97         u_short pp_loopcnt;     /* loopback detection counter */
  98         u_long  pp_seq[IDX_COUNT];      /* local sequence number */
  99         u_long  pp_rseq[IDX_COUNT];     /* remote sequence number */
 100         enum ppp_phase pp_phase;        /* phase we're currently in */
 101         int     state[IDX_COUNT];       /* state machine */
 102         u_char  confid[IDX_COUNT];      /* id of last configuration request */
 103         int     rst_counter[IDX_COUNT]; /* restart counter */
 104         int     fail_counter[IDX_COUNT]; /* negotiation failure counter */
 105         int     enable_vj;      /* VJ header compression enabled */
 106         struct callout_handle ch[IDX_COUNT]; /* per-proto and if callouts */
 107         struct callout_handle pap_my_to_ch; /* PAP needs one more... */
 108         struct slcp lcp;                /* LCP params */
 109         struct sipcp ipcp;              /* IPCP params */
 110         struct sipcp ipv6cp;            /* IPv6CP params */
 111         struct sauth myauth;            /* auth params, i'm peer */
 112         struct sauth hisauth;           /* auth params, i'm authenticator */
 113         struct slcompress pp_comp;      /* for VJ compression */
 114         /*
 115          * These functions are filled in by sppp_attach(), and are
 116          * expected to be used by the lower layer (hardware) drivers
 117          * in order to communicate the (un)availability of the
 118          * communication link.  Lower layer drivers that are always
 119          * ready to communicate (like hardware HDLC) can shortcut
 120          * pp_up from pp_tls, and pp_down from pp_tlf.
 121          */
 122         void    (*pp_up)(struct sppp *sp);
 123         void    (*pp_down)(struct sppp *sp);
 124         /*
 125          * These functions need to be filled in by the lower layer
 126          * (hardware) drivers if they request notification from the
 127          * PPP layer whether the link is actually required.  They
 128          * correspond to the tls and tlf actions.
 129          */
 130         void    (*pp_tls)(struct sppp *sp);
 131         void    (*pp_tlf)(struct sppp *sp);
 132         /*
 133          * These (optional) functions may be filled by the hardware
 134          * driver if any notification of established connections
 135          * (currently: IPCP up) is desired (pp_con) or any internal
 136          * state change of the interface state machine should be
 137          * signaled for monitoring purposes (pp_chg).
 138          */
 139         void    (*pp_con)(struct sppp *sp);
 140         void    (*pp_chg)(struct sppp *sp, int new_state);
 141         /* These two fields are for use by the lower layer */
 142         void    *pp_lowerp;
 143         int     pp_loweri;
 144 };
 145
 146 #define PP_KEEPALIVE    0x01    /* use keepalive protocol */
 147                                 /* 0x04 was PP_TIMO */
 148 #define PP_CALLIN       0x08    /* we are being called */
 149 #define PP_NEEDAUTH     0x10    /* remote requested authentication */
 150
 151
 152 #define PP_MTU          1500    /* default/minimal MRU */
 153 #define PP_MAX_MRU      2048    /* maximal MRU we want to negotiate */
 154
 155 /*
 156  * Definitions to pass struct sppp data down into the kernel using the
 157  * SIOC[SG]IFGENERIC ioctl interface.
 158  *
 159  * In order to use this, create a struct spppreq, fill in the cmd
 160  * field with SPPPIOGDEFS, and put the address of this structure into
 161  * the ifr_data portion of a struct ifreq.  Pass this struct to a
 162  * SIOCGIFGENERIC ioctl.  Then replace the cmd field by SPPPIOCDEFS,
 163  * modify the defs field as desired, and pass the struct ifreq now
 164  * to a SIOCSIFGENERIC ioctl.
 165  */
 166
 167 #define SPPPIOGDEFS  ((caddr_t)(('S' << 24) + (1 << 16) + sizeof(struct sppp)))
 168 #define SPPPIOSDEFS  ((caddr_t)(('S' << 24) + (2 << 16) + sizeof(struct sppp)))
 169
 170 struct spppreq {
 171         int     cmd;
 172         struct sppp defs;
 173 };
 174
 175 #ifdef _KERNEL
 176 void sppp_attach (struct ifnet *ifp);
 177 void sppp_detach (struct ifnet *ifp);
 178 void sppp_input (struct ifnet *ifp, struct mbuf *m);
 179 int sppp_ioctl (struct ifnet *ifp, u_long cmd, void *data);
 180 struct mbuf *sppp_dequeue (struct ifnet *ifp);
 181 struct mbuf *sppp_pick(struct ifnet *ifp);
 182 int sppp_isempty (struct ifnet *ifp);
 183 void sppp_flush (struct ifnet *ifp);
 184 #endif
 185
 186 #endif /* _NET_IF_SPPP_H_ */