if_sppp.h revision 88507
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: head/sys/net/if_sppp.h 88507 2001-12-26 22:35:10Z joerg $ 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 27struct 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 44struct 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}; 55 56#define AUTHNAMELEN 32 57#define AUTHKEYLEN 16 58 59struct sauth { 60 u_short proto; /* authentication protocol to use */ 61 u_short flags; 62#define AUTHFLAG_NOCALLOUT 1 /* do not require authentication on */ 63 /* callouts */ 64#define AUTHFLAG_NORECHALLENGE 2 /* do not re-challenge CHAP */ 65 u_char name[AUTHNAMELEN]; /* system identification name */ 66 u_char secret[AUTHKEYLEN]; /* secret password */ 67 u_char challenge[AUTHKEYLEN]; /* random challenge */ 68}; 69 70#define IDX_PAP 3 71#define IDX_CHAP 4 72 73#define IDX_COUNT (IDX_CHAP + 1) /* bump this when adding cp's! */ 74 75/* 76 * Don't change the order of this. Ordering the phases this way allows 77 * for a comparision of ``pp_phase >= PHASE_AUTHENTICATE'' in order to 78 * know whether LCP is up. 79 */ 80enum ppp_phase { 81 PHASE_DEAD, PHASE_ESTABLISH, PHASE_TERMINATE, 82 PHASE_AUTHENTICATE, PHASE_NETWORK 83}; 84 85struct sppp { 86 /* NB: pp_if _must_ be first */ 87 struct ifnet pp_if; /* network interface data */ 88 struct ifqueue pp_fastq; /* fast output queue */ 89 struct ifqueue pp_cpq; /* PPP control protocol queue */ 90 struct sppp *pp_next; /* next interface in keepalive list */ 91 u_int pp_mode; /* major protocol modes (cisco/ppp/...) */ 92 u_int pp_flags; /* sub modes */ 93 u_short pp_alivecnt; /* keepalive packets counter */ 94 u_short pp_loopcnt; /* loopback detection counter */ 95 u_long pp_seq[IDX_COUNT]; /* local sequence number */ 96 u_long pp_rseq[IDX_COUNT]; /* remote sequence number */ 97 enum ppp_phase pp_phase; /* phase we're currently in */ 98 int state[IDX_COUNT]; /* state machine */ 99 u_char confid[IDX_COUNT]; /* id of last configuration request */ 100 int rst_counter[IDX_COUNT]; /* restart counter */ 101 int fail_counter[IDX_COUNT]; /* negotiation failure counter */ 102 struct callout_handle ch[IDX_COUNT]; /* per-proto and if callouts */ 103 struct callout_handle pap_my_to_ch; /* PAP needs one more... */ 104 struct slcp lcp; /* LCP params */ 105 struct sipcp ipcp; /* IPCP params */ 106 struct sipcp ipv6cp; /* IPv6CP params */ 107 struct sauth myauth; /* auth params, i'm peer */ 108 struct sauth hisauth; /* auth params, i'm authenticator */ 109 /* 110 * These functions are filled in by sppp_attach(), and are 111 * expected to be used by the lower layer (hardware) drivers 112 * in order to communicate the (un)availability of the 113 * communication link. Lower layer drivers that are always 114 * ready to communicate (like hardware HDLC) can shortcut 115 * pp_up from pp_tls, and pp_down from pp_tlf. 116 */ 117 void (*pp_up)(struct sppp *sp); 118 void (*pp_down)(struct sppp *sp); 119 /* 120 * These functions need to be filled in by the lower layer 121 * (hardware) drivers if they request notification from the 122 * PPP layer whether the link is actually required. They 123 * correspond to the tls and tlf actions. 124 */ 125 void (*pp_tls)(struct sppp *sp); 126 void (*pp_tlf)(struct sppp *sp); 127 /* 128 * These (optional) functions may be filled by the hardware 129 * driver if any notification of established connections 130 * (currently: IPCP up) is desired (pp_con) or any internal 131 * state change of the interface state machine should be 132 * signaled for monitoring purposes (pp_chg). 133 */ 134 void (*pp_con)(struct sppp *sp); 135 void (*pp_chg)(struct sppp *sp, int new_state); 136 /* These two fields are for use by the lower layer */ 137 void *pp_lowerp; 138 int pp_loweri; 139}; 140 141#define PP_KEEPALIVE 0x01 /* use keepalive protocol */ 142 /* 0x04 was PP_TIMO */ 143#define PP_CALLIN 0x08 /* we are being called */ 144#define PP_NEEDAUTH 0x10 /* remote requested authentication */ 145 146 147#define PP_MTU 1500 /* default/minimal MRU */ 148#define PP_MAX_MRU 2048 /* maximal MRU we want to negotiate */ 149 150/* 151 * Definitions to pass struct sppp data down into the kernel using the 152 * SIOC[SG]IFGENERIC ioctl interface. 153 * 154 * In order to use this, create a struct spppreq, fill in the cmd 155 * field with SPPPIOGDEFS, and put the address of this structure into 156 * the ifr_data portion of a struct ifreq. Pass this struct to a 157 * SIOCGIFGENERIC ioctl. Then replace the cmd field by SPPPIOCDEFS, 158 * modify the defs field as desired, and pass the struct ifreq now 159 * to a SIOCSIFGENERIC ioctl. 160 */ 161 162#define SPPPIOGDEFS ((caddr_t)(('S' << 24) + (1 << 16) + sizeof(struct sppp))) 163#define SPPPIOSDEFS ((caddr_t)(('S' << 24) + (2 << 16) + sizeof(struct sppp))) 164 165struct spppreq { 166 int cmd; 167 struct sppp defs; 168}; 169 170#ifdef _KERNEL 171void sppp_attach (struct ifnet *ifp); 172void sppp_detach (struct ifnet *ifp); 173void sppp_input (struct ifnet *ifp, struct mbuf *m); 174int sppp_ioctl (struct ifnet *ifp, u_long cmd, void *data); 175struct mbuf *sppp_dequeue (struct ifnet *ifp); 176struct mbuf *sppp_pick(struct ifnet *ifp); 177int sppp_isempty (struct ifnet *ifp); 178void sppp_flush (struct ifnet *ifp); 179#endif 180 181#endif /* _NET_IF_SPPP_H_ */ 182