if_sppp.h revision 1.10 1 /* $NetBSD: if_sppp.h,v 1.10 2001/12/08 19:46:39 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_SEEN 2 /* have a local address assigned already */
55 #define IPCP_MYADDR_DYN 4 /* my address is dynamically assigned */
56 #define IPCP_HISADDR_DYN 8 /* his address is dynamically assigned */
57 #ifdef notdef
58 #define IPV6CP_MYIFID_DYN 2 /* my ifid is dynamically assigned */
59 #endif
60 #define IPV6CP_MYIFID_SEEN 4 /* have seen his ifid already */
61 u_int32_t saved_hisaddr;/* if hisaddr (IPv4) is dynamic, save original one here, in network byte order */
62 u_int32_t req_hisaddr; /* remote address requested */
63 u_int32_t req_myaddr; /* local address requested */
64 };
65
66 #define AUTHNAMELEN 48
67 #define AUTHKEYLEN 16
68
69 struct sauth {
70 u_short proto; /* authentication protocol to use */
71 u_short flags;
72 #define AUTHFLAG_NOCALLOUT 1 /* do not require authentication on */
73 /* callouts */
74 #define AUTHFLAG_NORECHALLENGE 2 /* do not re-challenge CHAP */
75 u_char name[AUTHNAMELEN]; /* system identification name */
76 u_char secret[AUTHKEYLEN]; /* secret password */
77 u_char challenge[AUTHKEYLEN]; /* random challenge */
78 };
79
80 #define IDX_PAP 3
81 #define IDX_CHAP 4
82
83 #define IDX_COUNT (IDX_CHAP + 1) /* bump this when adding cp's! */
84
85 /*
86 * Don't change the order of this. Ordering the phases this way allows
87 * for a comparision of ``pp_phase >= PHASE_AUTHENTICATE'' in order to
88 * know whether LCP is up.
89 */
90 enum ppp_phase {
91 PHASE_DEAD, PHASE_ESTABLISH, PHASE_TERMINATE,
92 PHASE_AUTHENTICATE, PHASE_NETWORK
93 };
94
95 struct sppp {
96 /* NB: pp_if _must_ be first */
97 struct ifnet pp_if; /* network interface data */
98 struct ifqueue pp_fastq; /* fast output queue */
99 struct ifqueue pp_cpq; /* PPP control protocol queue */
100 struct sppp *pp_next; /* next interface in keepalive list */
101 u_int pp_flags; /* use Cisco protocol instead of PPP */
102 u_int pp_framebytes; /* number of bytes added by (hardware) framing */
103 u_short pp_alivecnt; /* keepalive packets counter */
104 u_short pp_loopcnt; /* loopback detection counter */
105 u_long pp_seq[IDX_COUNT]; /* local sequence number */
106 u_long pp_rseq[IDX_COUNT]; /* remote sequence number */
107 enum ppp_phase pp_phase; /* phase we're currently in */
108 int state[IDX_COUNT]; /* state machine */
109 u_char confid[IDX_COUNT]; /* id of last configuration request */
110 int rst_counter[IDX_COUNT]; /* restart counter */
111 int fail_counter[IDX_COUNT]; /* negotiation failure counter */
112 #if defined(__NetBSD__)
113 struct callout ch[IDX_COUNT]; /* per-proto and if callouts */
114 struct callout pap_my_to_ch; /* PAP needs one more... */
115 #endif
116 #if defined(__FreeBSD__) && __FreeBSD__ >= 3
117 struct callout_handle ch[IDX_COUNT]; /* per-proto and if callouts */
118 struct callout_handle pap_my_to_ch; /* PAP needs one more... */
119 #endif
120 struct slcp lcp; /* LCP params */
121 struct sipcp ipcp; /* IPCP params */
122 struct sipcp ipv6cp; /* IPv6CP params */
123 struct sauth myauth; /* auth params, i'm peer */
124 struct sauth hisauth; /* auth params, i'm authenticator */
125 /*
126 * These functions are filled in by sppp_attach(), and are
127 * expected to be used by the lower layer (hardware) drivers
128 * in order to communicate the (un)availability of the
129 * communication link. Lower layer drivers that are always
130 * ready to communicate (like hardware HDLC) can shortcut
131 * pp_up from pp_tls, and pp_down from pp_tlf.
132 */
133 void (*pp_up)(struct sppp *sp);
134 void (*pp_down)(struct sppp *sp);
135 /*
136 * These functions need to be filled in by the lower layer
137 * (hardware) drivers if they request notification from the
138 * PPP layer whether the link is actually required. They
139 * correspond to the tls and tlf actions.
140 */
141 void (*pp_tls)(struct sppp *sp);
142 void (*pp_tlf)(struct sppp *sp);
143 /*
144 * These (optional) functions may be filled by the hardware
145 * driver if any notification of established connections
146 * (currently: IPCP up) is desired (pp_con) or any internal
147 * state change of the interface state machine should be
148 * signaled for monitoring purposes (pp_chg).
149 */
150 void (*pp_con)(struct sppp *sp);
151 void (*pp_chg)(struct sppp *sp, int new_state);
152 };
153
154 #define PP_KEEPALIVE 0x01 /* use keepalive protocol */
155 #define PP_CISCO 0x02 /* use Cisco protocol instead of PPP */
156 /* 0x04 was PP_TIMO */
157 #define PP_CALLIN 0x08 /* we are being called */
158 #define PP_NEEDAUTH 0x10 /* remote requested authentication */
159 #define PP_NOFRAMING 0x20 /* do not add/expect encapsulation
160 around PPP frames (i.e. the serial
161 HDLC like encapsulation, RFC1662) */
162
163
164 #define PP_MTU 1500 /* default/minimal MRU */
165 #define PP_MAX_MRU 2048 /* maximal MRU we want to negotiate */
166
167 /*
168 * Definitions to pass struct sppp data down into the kernel using the
169 * SIOC[SG]IFGENERIC ioctl interface.
170 *
171 * In order to use this, create a struct spppreq, fill in the cmd
172 * field with SPPPIOGDEFS, and put the address of this structure into
173 * the ifr_data portion of a struct ifreq. Pass this struct to a
174 * SIOCGIFGENERIC ioctl. Then replace the cmd field by SPPPIOCDEFS,
175 * modify the defs field as desired, and pass the struct ifreq now
176 * to a SIOCSIFGENERIC ioctl.
177 */
178
179 #define SPPPIOGDEFS ((caddr_t)(('S' << 24) + (1 << 16) + sizeof(struct sppp)))
180 #define SPPPIOSDEFS ((caddr_t)(('S' << 24) + (2 << 16) + sizeof(struct sppp)))
181
182 struct spppreq {
183 int cmd;
184 struct sppp defs;
185 };
186
187 #if (defined(__FreeBSD_version) && __FreeBSD_version < 300000) || \
188 (defined(__FreeBSD__) && __FreeBSD__ < 3)
189 #define SIOCSIFGENERIC _IOW('i', 57, struct ifreq) /* generic IF set op */
190 #define SIOCGIFGENERIC _IOWR('i', 58, struct ifreq) /* generic IF get op */
191 #endif
192
193 #if defined(KERNEL) || defined(_KERNEL)
194 void sppp_attach (struct ifnet *ifp);
195 void sppp_detach (struct ifnet *ifp);
196 void sppp_input (struct ifnet *ifp, struct mbuf *m);
197 int sppp_ioctl(struct ifnet *ifp, u_long cmd, void *data);
198 struct mbuf *sppp_dequeue (struct ifnet *ifp);
199 struct mbuf *sppp_pick(struct ifnet *ifp);
200 int sppp_isempty (struct ifnet *ifp);
201 void sppp_flush (struct ifnet *ifp);
202 #endif
203
204 #endif /* _NET_IF_HDLC_H_ */
205