if_spppvar.h revision 1.18 1 /* $NetBSD: if_spppvar.h,v 1.18 2016/11/25 05:03:12 knakahara Exp $ */
2
3 #ifndef _NET_IF_SPPPVAR_H_
4 #define _NET_IF_SPPPVAR_H_
5
6 /*
7 * Defines for synchronous PPP/Cisco link level subroutines.
8 *
9 * Copyright (C) 1994 Cronyx Ltd.
10 * Author: Serge Vakulenko, <vak (at) cronyx.ru>
11 *
12 * Heavily revamped to conform to RFC 1661.
13 * Copyright (C) 1997, Joerg Wunsch.
14 *
15 * This software is distributed with NO WARRANTIES, not even the implied
16 * warranties for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
17 *
18 * Authors grant any other persons or organizations permission to use
19 * or modify this software as long as this message is kept with the software,
20 * all derivative works or modified versions.
21 *
22 * From: Version 2.0, Fri Oct 6 20:39:21 MSK 1995
23 *
24 * From: if_sppp.h,v 1.8 1997/10/11 11:25:20 joerg Exp
25 *
26 * From: Id: if_sppp.h,v 1.7 1998/12/01 20:20:19 hm Exp
27 */
28
29 #include <sys/workqueue.h>
30
31 #include <net/if_media.h>
32
33 #define IDX_LCP 0 /* idx into state table */
34
35 struct slcp {
36 u_long opts; /* LCP options to send (bitfield) */
37 u_long magic; /* local magic number */
38 u_long mru; /* our max receive unit */
39 u_long their_mru; /* their max receive unit */
40 u_long protos; /* bitmask of protos that are started */
41 u_char echoid; /* id of last keepalive echo request */
42 /* restart max values, see RFC 1661 */
43 int timeout;
44 int max_terminate;
45 int max_configure;
46 int max_failure;
47 };
48
49 #define IDX_IPCP 1 /* idx into state table */
50 #define IDX_IPV6CP 2 /* idx into state table */
51
52 struct sipcp {
53 u_long opts; /* IPCP options to send (bitfield) */
54 u_int flags;
55 #define IPCP_HISADDR_SEEN 1 /* have seen his address already */
56 #define IPCP_MYADDR_SEEN 2 /* have a local address assigned already */
57 #define IPCP_MYADDR_DYN 4 /* my address is dynamically assigned */
58 #define IPCP_HISADDR_DYN 8 /* his address is dynamically assigned */
59 #ifdef notdef
60 #define IPV6CP_MYIFID_DYN 2 /* my ifid is dynamically assigned */
61 #endif
62 #define IPV6CP_MYIFID_SEEN 4 /* have seen his ifid already */
63 uint32_t saved_hisaddr;/* if hisaddr (IPv4) is dynamic, save original one here, in network byte order */
64 uint32_t req_hisaddr; /* remote address requested */
65 uint32_t req_myaddr; /* local address requested */
66
67 struct workqueue *set_addrs_wq;
68 struct work set_addrs_wk;
69 u_int set_addrs_enqueued;
70
71 struct workqueue *clear_addrs_wq;
72 struct work clear_addrs_wk;
73 u_int clear_addrs_enqueued;
74 };
75
76 struct sauth {
77 u_short proto; /* authentication protocol to use */
78 u_short flags;
79 char *name; /* system identification name */
80 char *secret; /* secret password */
81 u_char name_len; /* no need to have a bigger size */
82 u_char secret_len; /* because proto gives size in a byte */
83 char challenge[16]; /* random challenge [don't change size! it's really hardcoded!] */
84 };
85
86 #define IDX_PAP 3
87 #define IDX_CHAP 4
88
89 #define IDX_COUNT (IDX_CHAP + 1) /* bump this when adding cp's! */
90
91 struct sppp {
92 /* NB: pp_if _must_ be first */
93 struct ifnet pp_if; /* network interface data */
94 struct ifmedia pp_im; /* interface media, to report link status */
95 struct ifqueue pp_fastq; /* fast output queue */
96 struct ifqueue pp_cpq; /* PPP control protocol queue */
97 struct sppp *pp_next; /* next interface in keepalive list */
98 u_int pp_flags; /* use Cisco protocol instead of PPP */
99 u_int pp_framebytes; /* number of bytes added by (hardware) framing */
100 u_int pp_alivecnt; /* keepalive packets counter */
101 u_int pp_loopcnt; /* loopback detection counter */
102 u_int pp_maxalive; /* number or echo req. w/o reply */
103 u_long pp_seq[IDX_COUNT]; /* local sequence number */
104 u_long pp_rseq[IDX_COUNT]; /* remote sequence number */
105 uint64_t pp_saved_mtu; /* saved MTU value */
106 time_t pp_last_receive; /* peer's last "sign of life" */
107 time_t pp_max_noreceive; /* seconds since last receive before
108 we start to worry and send echo
109 requests */
110 time_t pp_last_activity; /* second of last payload data s/r */
111 time_t pp_idle_timeout; /* idle seconds before auto-disconnect,
112 * 0 = disabled */
113 int pp_auth_failures; /* authorization failures */
114 int pp_max_auth_fail; /* max. allowed authorization failures */
115 int pp_phase; /* phase we're currently in */
116 int query_dns; /* 1 if we want to know the dns addresses */
117 uint32_t dns_addrs[2];
118 int state[IDX_COUNT]; /* state machine */
119 u_char confid[IDX_COUNT]; /* id of last configuration request */
120 int rst_counter[IDX_COUNT]; /* restart counter */
121 int fail_counter[IDX_COUNT]; /* negotiation failure counter */
122 #if defined(__NetBSD__)
123 struct callout ch[IDX_COUNT]; /* per-proto and if callouts */
124 struct callout pap_my_to_ch; /* PAP needs one more... */
125 #endif
126 #if defined(__FreeBSD__) && __FreeBSD__ >= 3
127 struct callout_handle ch[IDX_COUNT]; /* per-proto and if callouts */
128 struct callout_handle pap_my_to_ch; /* PAP needs one more... */
129 #endif
130 struct slcp lcp; /* LCP params */
131 struct sipcp ipcp; /* IPCP params */
132 struct sipcp ipv6cp; /* IPv6CP params */
133 struct sauth myauth; /* auth params, i'm peer */
134 struct sauth hisauth; /* auth params, i'm authenticator */
135 /*
136 * These functions are filled in by sppp_attach(), and are
137 * expected to be used by the lower layer (hardware) drivers
138 * in order to communicate the (un)availability of the
139 * communication link. Lower layer drivers that are always
140 * ready to communicate (like hardware HDLC) can shortcut
141 * pp_up from pp_tls, and pp_down from pp_tlf.
142 */
143 void (*pp_up)(struct sppp *);
144 void (*pp_down)(struct sppp *);
145 /*
146 * These functions need to be filled in by the lower layer
147 * (hardware) drivers if they request notification from the
148 * PPP layer whether the link is actually required. They
149 * correspond to the tls and tlf actions.
150 */
151 void (*pp_tls)(struct sppp *);
152 void (*pp_tlf)(struct sppp *);
153 /*
154 * These (optional) functions may be filled by the hardware
155 * driver if any notification of established connections
156 * (currently: IPCP up) is desired (pp_con) or any internal
157 * state change of the interface state machine should be
158 * signaled for monitoring purposes (pp_chg).
159 */
160 void (*pp_con)(struct sppp *);
161 void (*pp_chg)(struct sppp *, int);
162 };
163
164 #define PP_KEEPALIVE 0x01 /* use keepalive protocol */
165 #define PP_CISCO 0x02 /* use Cisco protocol instead of PPP */
166 /* 0x04 was PP_TIMO */
167 #define PP_CALLIN 0x08 /* we are being called */
168 #define PP_NEEDAUTH 0x10 /* remote requested authentication */
169 #define PP_NOFRAMING 0x20 /* do not add/expect encapsulation
170 around PPP frames (i.e. the serial
171 HDLC like encapsulation, RFC1662) */
172
173
174 #define PP_MTU 1500 /* default/minimal MRU */
175 #define PP_MAX_MRU 2048 /* maximal MRU we want to negotiate */
176
177 #ifdef _KERNEL
178 void sppp_attach (struct ifnet *);
179 void sppp_detach (struct ifnet *);
180 void sppp_input (struct ifnet *, struct mbuf *);
181 int sppp_ioctl(struct ifnet *, u_long, void *);
182 struct mbuf *sppp_dequeue (struct ifnet *);
183 int sppp_isempty (struct ifnet *);
184 void sppp_flush (struct ifnet *);
185 #endif
186 #endif /* !_NET_IF_SPPPVAR_H_ */
187