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