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