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