if_sppp.h revision 30300 
1/*
2 * Defines for synchronous PPP/Cisco link level subroutines.
3 *
4 * Copyright (C) 1994 Cronyx Ltd.
5 * Author: Serge Vakulenko, <vak@cronyx.ru>
6 *
7 * Heavily revamped to conform to RFC 1661.
8 * Copyright (C) 1997, Joerg Wunsch.
9 *
10 * This software is distributed with NO WARRANTIES, not even the implied
11 * warranties for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 *
13 * Authors grant any other persons or organizations permission to use
14 * or modify this software as long as this message is kept with the software,
15 * all derivative works or modified versions.
16 *
17 * From: Version 2.0, Fri Oct  6 20:39:21 MSK 1995
18 *
19 * $Id: if_sppp.h,v 1.6 1997/05/22 22:15:39 joerg Exp $
20 */
21
22#ifndef _NET_IF_HDLC_H_
23#define _NET_IF_HDLC_H_ 1
24
25#define IDX_LCP 0		/* idx into state table */
26
27struct slcp {
28	u_long	opts;		/* LCP options to send (bitfield) */
29	u_long  magic;          /* local magic number */
30	u_long	mru;		/* our max receive unit */
31	u_long	their_mru;	/* their max receive unit */
32	u_long	protos;		/* bitmask of protos that are started */
33	u_char  echoid;         /* id of last keepalive echo request */
34	/* restart max values, see RFC 1661 */
35	int	timeout;
36	int	max_terminate;
37	int	max_configure;
38	int	max_failure;
39};
40
41#define IDX_IPCP 1		/* idx into state table */
42
43struct sipcp {
44	u_long	opts;		/* IPCP options to send (bitfield) */
45	u_int	flags;
46#define IPCP_HISADDR_SEEN 1	/* have seen his address already */
47#define IPCP_MYADDR_DYN   2	/* my address is dynamically assigned */
48};
49
50#define AUTHNAMELEN	32
51#define AUTHKEYLEN	16
52
53struct sauth {
54	u_short	proto;			/* authentication protocol to use */
55	u_short	flags;
56#define AUTHFLAG_NOCALLOUT	1	/* do not require authentication on */
57					/* callouts */
58#define AUTHFLAG_NORECHALLENGE	2	/* do not re-challenge CHAP */
59	u_char	name[AUTHNAMELEN];	/* system identification name */
60	u_char	secret[AUTHKEYLEN];	/* secret password */
61	u_char	challenge[AUTHKEYLEN];	/* random challenge */
62};
63
64#define IDX_PAP		2
65#define IDX_CHAP	3
66
67#define IDX_COUNT (IDX_CHAP + 1) /* bump this when adding cp's! */
68
69/*
70 * Don't change the order of this.  Ordering the phases this way allows
71 * for a comparision of ``pp_phase >= PHASE_AUTHENTICATE'' in order to
72 * know whether LCP is up.
73 */
74enum ppp_phase {
75	PHASE_DEAD, PHASE_ESTABLISH, PHASE_TERMINATE,
76	PHASE_AUTHENTICATE, PHASE_NETWORK
77};
78
79struct sppp {
80	/* NB: pp_if _must_ be first */
81	struct  ifnet pp_if;    /* network interface data */
82	struct  ifqueue pp_fastq; /* fast output queue */
83	struct	ifqueue pp_cpq;	/* PPP control protocol queue */
84	struct  sppp *pp_next;  /* next interface in keepalive list */
85	u_int   pp_flags;       /* use Cisco protocol instead of PPP */
86	u_short pp_alivecnt;    /* keepalive packets counter */
87	u_short pp_loopcnt;     /* loopback detection counter */
88	u_long  pp_seq;         /* local sequence number */
89	u_long  pp_rseq;        /* remote sequence number */
90	enum ppp_phase pp_phase;	/* phase we're currently in */
91	int	state[IDX_COUNT];	/* state machine */
92	u_char  confid[IDX_COUNT];	/* id of last configuration request */
93	int	rst_counter[IDX_COUNT];	/* restart counter */
94	int	fail_counter[IDX_COUNT]; /* negotiation failure counter */
95	struct callout_handle ch[IDX_COUNT]; /* per-proto and if callouts */
96	struct callout_handle pap_my_to_ch; /* PAP needs one more... */
97	struct slcp lcp;		/* LCP params */
98	struct sipcp ipcp;		/* IPCP params */
99	struct sauth myauth;		/* auth params, i'm peer */
100	struct sauth hisauth;		/* auth params, i'm authenticator */
101	/*
102	 * These functions are filled in by sppp_attach(), and are
103	 * expected to be used by the lower layer (hardware) drivers
104	 * in order to communicate the (un)availability of the
105	 * communication link.  Lower layer drivers that are always
106	 * ready to communicate (like hardware HDLC) can shortcut
107	 * pp_up from pp_tls, and pp_down from pp_tlf.
108	 */
109	void	(*pp_up)(struct sppp *sp);
110	void	(*pp_down)(struct sppp *sp);
111	/*
112	 * These functions need to be filled in by the lower layer
113	 * (hardware) drivers if they request notification from the
114	 * PPP layer whether the link is actually required.  They
115	 * correspond to the tls and tlf actions.
116	 */
117	void	(*pp_tls)(struct sppp *sp);
118	void	(*pp_tlf)(struct sppp *sp);
119};
120
121#define PP_KEEPALIVE    0x01    /* use keepalive protocol */
122#define PP_CISCO        0x02    /* use Cisco protocol instead of PPP */
123				/* 0x04 was PP_TIMO */
124#define PP_CALLIN	0x08	/* we are being called */
125#define PP_NEEDAUTH	0x10	/* remote requested authentication */
126
127
128#define PP_MTU          1500    /* default/minimal MRU */
129#define PP_MAX_MRU	2048	/* maximal MRU we want to negotiate */
130
131/*
132 * Definitions to pass struct sppp data down into the kernel using the
133 * SIOC[SG]IFGENERIC ioctl interface.
134 *
135 * In order to use this, create a struct spppreq, fill in the cmd
136 * field with SPPPIOGDEFS, and put the address of this structure into
137 * the ifr_data portion of a struct ifreq.  Pass this struct to a
138 * SIOCGIFGENERIC ioctl.  Then replace the cmd field by SPPPIOCDEFS,
139 * modify the defs field as desired, and pass the struct ifreq now
140 * to a SIOCSIFGENERIC ioctl.
141 */
142
143#define SPPPIOGDEFS  ((caddr_t)(('S' << 24) + (1 << 16) + sizeof(struct sppp)))
144#define SPPPIOSDEFS  ((caddr_t)(('S' << 24) + (2 << 16) + sizeof(struct sppp)))
145
146struct spppreq {
147	int	cmd;
148	struct sppp defs;
149};
150
151#ifdef KERNEL
152void sppp_attach (struct ifnet *ifp);
153void sppp_detach (struct ifnet *ifp);
154void sppp_input (struct ifnet *ifp, struct mbuf *m);
155int sppp_ioctl (struct ifnet *ifp, int cmd, void *data);
156struct mbuf *sppp_dequeue (struct ifnet *ifp);
157struct mbuf *sppp_pick(struct ifnet *ifp);
158int sppp_isempty (struct ifnet *ifp);
159void sppp_flush (struct ifnet *ifp);
160#endif
161
162#endif /* _NET_IF_HDLC_H_ */
163