2 * Copyright (c) 1997, 2000 Hellmuth Michaelis. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 *---------------------------------------------------------------------------
27 * i4b_l2.h - ISDN layer 2 (Q.921) definitions
28 * ---------------------------------------------
30 * $Id: i4b_l2.h,v 1.23 2000/08/24 11:48:58 hm Exp $
32 * $FreeBSD: src/sys/i4b/layer2/i4b_l2.h,v 1.6.2.1 2001/08/10 14:08:41 obrien Exp $
34 * last edit-date: [Sat Mar 18 10:28:22 2000]
36 *---------------------------------------------------------------------------*/
42 int unit; /* unit number this entry is for */
44 int Q921_state; /* state according to Q.921 */
46 u_char last_ril; /* last reference number from TEI management */
49 int tei_valid; /* tei is valid flag */
52 int tei; /* tei, if tei flag valid */
54 int ph_active; /* Layer 1 active flag */
55 #define PH_INACTIVE 0 /* layer 1 inactive */
56 #define PH_ACTIVEPEND 1 /* already tried to activate */
57 #define PH_ACTIVE 2 /* layer 1 active */
59 int T200; /* Multiframe timeout timer */
60 int T201; /* min time between TEI ID check */
61 int T202; /* min time between TEI ID Req messages */
62 int N202; /* TEI ID Req tx counter */
63 void(*T202func)(void *);/* function to be called when T202 expires */
64 int T203; /* max line idle time */
66 #if defined(__FreeBSD__)
67 struct callout_handle T200_callout;
68 struct callout_handle T202_callout;
69 struct callout_handle T203_callout;
70 struct callout_handle IFQU_callout;
72 #if defined(__NetBSD__) && __NetBSD_Version__ >= 104230000
73 struct callout T200_callout;
74 struct callout T202_callout;
75 struct callout T203_callout;
76 struct callout IFQU_callout;
80 * i4b_iframe.c, i4b_i_frame_queued_up(): value of IFQU_DLY
81 * some experimentation Gary did showed a minimal value of (hz/20) was
82 * possible to let this work, Gary suggested using (hz/10) but i settled
83 * down to using (hz/5) for now (-hm).
85 #define IFQU_DLY (hz/5) /* reschedule I-FRAME-QUEUED-UP 0.2 sec */
87 int vr; /* receive sequence frame counter */
88 int vs; /* transmit sequence frame counter */
89 int va; /* acknowledge sequence frame counter */
91 int ack_pend; /* acknowledge pending */
92 int rej_excpt; /* reject exception */
93 int peer_busy; /* peer receiver busy */
94 int own_busy; /* own receiver busy */
95 int l3initiated; /* layer 3 initiated */
97 struct ifqueue i_queue; /* queue of outgoing i frames */
98 #define IQUEUE_MAXLEN 20
100 /* this implementation only supports a k-value of 1 !!! */
101 struct mbuf *ua_frame; /* last unacked frame */
102 int ua_num; /* last unacked frame number */
103 #define UA_EMPTY (-1) /* ua_frame is unused */
105 int rxd_CR; /* received Command Response bit */
106 int rxd_PF; /* received Poll/Final bit */
107 int rxd_NR; /* received N(R) field */
108 int RC; /* Retry Counter */
110 int iframe_sent; /* check if i frame acked by another i frame */
112 int (*postfsmfunc)(int);/* function to be called at fsm exit */
113 int postfsmarg; /* argument for above function */
117 lapdstat_t stat; /* lapd protocol statistics */
121 extern l2_softc_t l2_softc[];
123 /* Q.912 system parameters (Q.921 03/93 pp 43) */
125 #define MAX_K_VALUE 1 /* BRI - # of outstanding frames */
127 #define N200 3 /* max no of retransmissions */
128 #define N201DEF 260 /* max no of octetts in information field */
129 #define N202DEF 3 /* max no of TEI ID Request message transmissions */
131 #define T200DEF (hz*1) /* default T200 timer value = 1 second */
132 #define T201DEF T200DEF /* default T201 timer value = T200DEF */
133 #define T202DEF (hz*2) /* default T202 timer value = 2 seconds */
134 #define T203DEF (hz*10) /* default T203 timer value = 10 seconds*/
136 /* modulo 128 operations */
138 #define M128INC(v) (v)++; \
144 #define M128DEC(v) (v)--; \
164 /* CR-bit values to NT */
171 /* CR-bit values from NT */
178 /* address field - octett 2 */
180 #define OFF_SAPI 0 /* SAPI offset, HDLC flag is eaten by L1 */
181 #define SAPI_CCP 0 /* SAPI = 0 - call control procedures */
182 #define SAPI_X25 16 /* SAPI = 16 - X.25 packet procedures */
183 #define SAPI_L2M 63 /* SAPI = 63 - Layer 2 management procedures */
185 /* extract and insert macros for SAPI octett */
187 #define GETSAPI(octett) (((octett) >> 2) & 0x3f)
188 #define PUTSAPI(sapi,cr,octett) ((octett) = (((sapi << 2) & 0xfc) | ((cr & 0x01) << 1)))
189 #define GETCR(octett) (((octett) >> 1) & 0x01)
190 #define GETEA(octett) ((octett) & 0x01)
192 /* address field - octett 3 */
194 #define OFF_TEI 1 /* TEI offset */
195 #define GETTEI(octett) (((octett) >> 1) & 0x7f)
196 #define PUTTEI(tei, octett) ((octett) = ((((tei) << 1) & 0xfe)) | 0x01)
197 #define GROUP_TEI 127 /* broadcast TEI for LME */
199 /* control field - octett 4 */
201 #define OFF_CNTL 2 /* 1st byte of control field */
205 #define S_FRAME_LEN 4 /* lenght of a U-frame */
206 #define OFF_SRCR 2 /* 1st byte of control field, */
207 /* R-commands and R-responses */
208 #define OFF_SNR 3 /* 2nd byte of control field, N(R) and PF */
209 #define SPFBIT 0x01 /* poll/final bit mask */
210 #define SPBITSET SPFBIT
211 #define SFBITSET SPFBIT
212 #define GETSNR(octett) (((octett) >> 1) & 0x7f)
213 #define GETSPF(octett) ((octett) & SPFBIT)
214 #define RR 0x01 /* RR and bit 0 set */
215 #define RNR 0x05 /* RNR and bit 0 set */
216 #define REJ 0x09 /* REJ and bit 0 set */
220 #define UI_HDR_LEN 3 /* length of UI header in front of L3 frame */
221 #define U_FRAME_LEN 3 /* lenght of a U-frame */
222 #define UPFBIT 0x10 /* poll/final bit mask */
223 #define UPBITSET UPFBIT
224 #define UFBITSET UPFBIT
225 #define GETUPF(octett) (((octett) >> 4) & 0x01)
227 /* commands/responses with pf bit set to 0 */
237 /* control field - octett 3 */
239 #define OFF_MEI 3 /* 2nd byte of control field */
241 /* control field - octett 4,5 */
243 #define OFF_RIL 4 /* Ri low byte */
244 #define OFF_RIH 5 /* Ri high byte */
246 /* control field - octett 6 */
248 #define OFF_MT 6 /* Message Type */
249 #define OFF_AI 7 /* Action Indicator */
250 #define GET_TEIFROMAI(octett) (((octett) >> 1) & 0x7f)
254 #define I_HDR_LEN 4 /* length of I header in front of L3 frame */
255 #define OFF_INS 2 /* transmit sequence number */
256 #define OFF_INR 3 /* receive sequence number */
257 #define IPFBIT 0x01 /* poll/final bit mask */
258 #define IPBITSET 0x01
259 #define GETINR(octett) (((octett) >> 1) & 0x7f)
260 #define GETINS(octett) (((octett) >> 1) & 0x7f)
261 #define GETIP(octett) ((octett) & IPFBIT)
263 /* structure of a TEI management frame */
265 #define TEI_MGMT_FRM_LEN 8 /* frame length */
266 #define TEIM_SAPIO 0x00 /* SAPI, CR, EA */
267 #define TEIM_TEIO 0x01 /* TEI, EA */
268 #define TEIM_UIO 0x02 /* frame type = UI = 0x03 */
269 #define TEIM_MEIO 0x03 /* management entity id = 0x0f */
271 #define TEIM_RILO 0x04 /* reference number, low */
272 #define TEIM_RIHO 0x05 /* reference number, high */
273 #define TEIM_MTO 0x06 /* message type */
274 #define MT_ID_REQEST 0x01
275 #define MT_ID_ASSIGN 0x02
276 #define MT_ID_DENY 0x03
277 #define MT_ID_CHK_REQ 0x04
278 #define MT_ID_CHK_RSP 0x05
279 #define MT_ID_REMOVE 0x06
280 #define MT_ID_VERIFY 0x07
281 #define TEIM_AIO 0x07 /* action indicator */
283 /* i4b_mdl_error_ind codes */
285 enum MDL_ERROR_CODES {
306 extern void i4b_acknowledge_pending ( l2_softc_t *l2sc );
307 extern struct mbuf * i4b_build_s_frame ( l2_softc_t *l2sc, crbit_to_nt_t crbit, pbit_t pbit, u_char type );
308 extern struct mbuf * i4b_build_u_frame ( l2_softc_t *l2sc, crbit_to_nt_t crbit, pbit_t pbit, u_char type );
309 extern void i4b_clear_exception_conditions ( l2_softc_t *l2sc );
310 extern int i4b_dl_data_req ( int unit, struct mbuf *m );
311 extern int i4b_dl_establish_req ( int unit );
312 extern int i4b_dl_release_req ( int unit );
313 extern int i4b_dl_unit_data_req ( int unit, struct mbuf *m );
314 extern void i4b_enquiry_response ( l2_softc_t *l2sc );
315 extern void i4b_establish_data_link ( l2_softc_t *l2sc );
316 extern void i4b_invoke_retransmission ( l2_softc_t *l2sc, int nr );
317 extern void i4b_i_frame_queued_up ( l2_softc_t *l2sc );
318 extern void i4b_l1_activate ( l2_softc_t *l2sc );
319 extern int i4b_l2_nr_ok ( int nr, int va, int vs );
320 extern void i4b_make_rand_ri ( l2_softc_t *l2sc );
321 extern void i4b_mdl_assign_ind ( l2_softc_t *l2sc );
322 extern void i4b_mdl_error_ind ( l2_softc_t *l2sc, char *where, int errorcode );
323 extern int i4b_mph_status_ind ( int unit, int status, int parm );
324 extern void i4b_next_l2state ( l2_softc_t *l2sc, int event );
325 extern void i4b_nr_error_recovery ( l2_softc_t *l2sc );
326 extern int i4b_ph_activate_ind ( int unit );
327 extern int i4b_ph_deactivate_ind ( int unit );
328 extern int i4b_ph_data_ind ( int unit, struct mbuf *m );
329 extern void i4b_print_frame ( int len, u_char *buf );
330 extern char *i4b_print_l2state ( l2_softc_t *l2sc );
331 extern void i4b_print_l2var ( l2_softc_t *l2sc );
332 extern void i4b_rxd_ack(l2_softc_t *l2sc, int nr);
333 extern void i4b_rxd_i_frame ( int unit, struct mbuf *m );
334 extern void i4b_rxd_s_frame ( int unit, struct mbuf *m );
335 extern void i4b_rxd_u_frame ( int unit, struct mbuf *m );
336 extern void i4b_T200_restart ( l2_softc_t *l2sc );
337 extern void i4b_T200_start ( l2_softc_t *l2sc );
338 extern void i4b_T200_stop ( l2_softc_t *l2sc );
339 extern void i4b_T202_start ( l2_softc_t *l2sc );
340 extern void i4b_T202_stop ( l2_softc_t *l2sc );
341 extern void i4b_T203_restart ( l2_softc_t *l2sc );
342 extern void i4b_T203_start ( l2_softc_t *l2sc );
343 extern void i4b_T203_stop ( l2_softc_t *l2sc );
344 extern void i4b_tei_assign ( l2_softc_t *l2sc );
345 extern void i4b_tei_chkresp ( l2_softc_t *l2sc );
346 extern void i4b_tei_rxframe ( int unit, struct mbuf *m );
347 extern void i4b_tei_verify ( l2_softc_t *l2sc );
348 extern void i4b_transmit_enquire ( l2_softc_t *l2sc );
349 extern void i4b_tx_disc ( l2_softc_t *l2sc, pbit_t pbit );
350 extern void i4b_tx_dm ( l2_softc_t *l2sc, fbit_t fbit );
351 extern void i4b_tx_frmr ( l2_softc_t *l2sc, fbit_t fbit );
352 extern void i4b_tx_rej_response ( l2_softc_t *l2sc, fbit_t fbit );
353 extern void i4b_tx_rnr_command ( l2_softc_t *l2sc, pbit_t pbit );
354 extern void i4b_tx_rnr_response ( l2_softc_t *l2sc, fbit_t fbit );
355 extern void i4b_tx_rr_command ( l2_softc_t *l2sc, pbit_t pbit );
356 extern void i4b_tx_rr_response ( l2_softc_t *l2sc, fbit_t fbit );
357 extern void i4b_tx_sabme ( l2_softc_t *l2sc, pbit_t pbit );
358 extern void i4b_tx_ua ( l2_softc_t *l2sc, fbit_t fbit );
360 #endif /* _I4B_L2_H_ */