1/* $NetBSD: if_spppvar.h,v 1.17 2016/09/14 10:58:38 roy 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@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 <net/if_media.h>
30
31#define IDX_LCP 0 /* idx into state table */
32
33struct 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
50struct 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 uint32_t saved_hisaddr;/* if hisaddr (IPv4) is dynamic, save original one here, in network byte order */
62 uint32_t req_hisaddr; /* remote address requested */
63 uint32_t req_myaddr; /* local address requested */
64};
65
66struct sauth {
67 u_short proto; /* authentication protocol to use */
68 u_short flags;
69 char *name; /* system identification name */
70 char *secret; /* secret password */
71 u_char name_len; /* no need to have a bigger size */
72 u_char secret_len; /* because proto gives size in a byte */
73 char challenge[16]; /* random challenge [don't change size! it's really hardcoded!] */
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
81struct sppp {
82 /* NB: pp_if _must_ be first */
83 struct ifnet pp_if; /* network interface data */
84 struct ifmedia pp_im; /* interface media, to report link status */
85 struct ifqueue pp_fastq; /* fast output queue */
86 struct ifqueue pp_cpq; /* PPP control protocol queue */
87 struct sppp *pp_next; /* next interface in keepalive list */
88 u_int pp_flags; /* use Cisco protocol instead of PPP */
89 u_int pp_framebytes; /* number of bytes added by (hardware) framing */
90 u_int pp_alivecnt; /* keepalive packets counter */
91 u_int pp_loopcnt; /* loopback detection counter */
92 u_int pp_maxalive; /* number or echo req. w/o reply */
93 u_long pp_seq[IDX_COUNT]; /* local sequence number */
94 u_long pp_rseq[IDX_COUNT]; /* remote sequence number */
95 uint64_t pp_saved_mtu; /* saved MTU value */
96 time_t pp_last_receive; /* peer's last "sign of life" */
97 time_t pp_max_noreceive; /* seconds since last receive before
98 we start to worry and send echo
99 requests */
100 time_t pp_last_activity; /* second of last payload data s/r */
101 time_t pp_idle_timeout; /* idle seconds before auto-disconnect,
102 * 0 = disabled */
103 int pp_auth_failures; /* authorization failures */
104 int pp_max_auth_fail; /* max. allowed authorization failures */
105 int pp_phase; /* phase we're currently in */
106 int query_dns; /* 1 if we want to know the dns addresses */
107 uint32_t dns_addrs[2];
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 *);
134 void (*pp_down)(struct sppp *);
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 *);
142 void (*pp_tlf)(struct sppp *);
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 *);
151 void (*pp_chg)(struct sppp *, int);
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#ifdef _KERNEL
168void sppp_attach (struct ifnet *);
169void sppp_detach (struct ifnet *);
170void sppp_input (struct ifnet *, struct mbuf *);
171int sppp_ioctl(struct ifnet *, u_long, void *);
172struct mbuf *sppp_dequeue (struct ifnet *);
173int sppp_isempty (struct ifnet *);
174void sppp_flush (struct ifnet *);
175#endif
176#endif /* !_NET_IF_SPPPVAR_H_ */
177