2 * Copyright (c) 1997, 2001 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_l1fsm.c - isdn4bsd layer 1 I.430 state machine
28 * --------------------------------------------------
30 * $FreeBSD: src/sys/i4b/layer1/isic/i4b_l1fsm.c,v 1.5.2.1 2001/08/10 14:08:38 obrien Exp $
32 * last edit-date: [Wed Jan 24 09:12:18 2001]
34 *---------------------------------------------------------------------------*/
40 #include <sys/param.h>
41 #include <sys/kernel.h>
42 #include <sys/systm.h>
43 #include <sys/socket.h>
47 #include <machine/i4b_debug.h>
48 #include <machine/i4b_ioctl.h>
49 #include <machine/i4b_trace.h>
51 #include <i4b/layer1/isic/i4b_isic.h>
53 #include <i4b/layer1/i4b_l1.h>
55 #include <i4b/include/i4b_global.h>
57 #include <i4b/include/i4b_mbuf.h>
60 static char *state_text[N_STATES] = {
63 "F5 Identifying Input",
70 static char *event_text[N_EVENTS] = {
72 "EV_T3 Timer 3 expired",
73 "EV_INFO0 INFO0 received",
74 "EV_RSY Level Detected",
75 "EV_INFO2 INFO2 received",
76 "EV_INFO48 INFO4 received",
77 "EV_INFO410 INFO4 received",
78 "EV_DR Deactivate Req",
80 "EV_DIS Disconnected",
86 /* Function prototypes */
88 static void timer3_expired (struct l1_softc *sc);
89 static void T3_start (struct l1_softc *sc);
90 static void T3_stop (struct l1_softc *sc);
91 static void F_T3ex (struct l1_softc *sc);
92 static void timer4_expired (struct l1_softc *sc);
93 static void T4_start (struct l1_softc *sc);
94 static void T4_stop (struct l1_softc *sc);
95 static void F_AI8 (struct l1_softc *sc);
96 static void F_AI10 (struct l1_softc *sc);
97 static void F_I01 (struct l1_softc *sc);
98 static void F_I02 (struct l1_softc *sc);
99 static void F_I03 (struct l1_softc *sc);
100 static void F_I2 (struct l1_softc *sc);
101 static void F_ill (struct l1_softc *sc);
102 static void F_NULL (struct l1_softc *sc);
104 /*---------------------------------------------------------------------------*
105 * I.430 Timer T3 expire function
106 *---------------------------------------------------------------------------*/
108 timer3_expired(struct l1_softc *sc)
112 NDBGL1(L1_T_ERR, "state = %s", isic_printstate(sc));
115 /* XXX try some recovery here XXX */
119 sc->sc_init_tries++; /* increment retry count */
121 /*XXX*/ if(sc->sc_init_tries > 4)
125 sc->sc_init_tries = 0;
127 if(sc->sc_obuf2 != NULL)
129 i4b_Dfreembuf(sc->sc_obuf2);
132 if(sc->sc_obuf != NULL)
134 i4b_Dfreembuf(sc->sc_obuf);
143 i4b_l1_mph_status_ind(L0ISICUNIT(sc->sc_unit), STI_NOL1ACC, 0, NULL);
146 isic_next_state(sc, EV_T3);
150 NDBGL1(L1_T_ERR, "expired without starting it ....");
154 /*---------------------------------------------------------------------------*
155 * I.430 Timer T3 start
156 *---------------------------------------------------------------------------*/
158 T3_start(struct l1_softc *sc)
160 NDBGL1(L1_T_MSG, "state = %s", isic_printstate(sc));
162 sc->sc_T3_callout = timeout((TIMEOUT_FUNC_T)timer3_expired,(struct l1_softc *)sc, 2*hz);
165 /*---------------------------------------------------------------------------*
166 * I.430 Timer T3 stop
167 *---------------------------------------------------------------------------*/
169 T3_stop(struct l1_softc *sc)
171 NDBGL1(L1_T_MSG, "state = %s", isic_printstate(sc));
173 sc->sc_init_tries = 0; /* init connect retry count */
178 untimeout((TIMEOUT_FUNC_T)timer3_expired,(struct l1_softc *)sc, sc->sc_T3_callout);
182 /*---------------------------------------------------------------------------*
183 * I.430 Timer T3 expiry
184 *---------------------------------------------------------------------------*/
186 F_T3ex(struct l1_softc *sc)
188 NDBGL1(L1_F_MSG, "FSM function F_T3ex executing");
189 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
190 i4b_l1_ph_deactivate_ind(L0ISICUNIT(sc->sc_unit));
193 /*---------------------------------------------------------------------------*
194 * Timer T4 expire function
195 *---------------------------------------------------------------------------*/
197 timer4_expired(struct l1_softc *sc)
201 NDBGL1(L1_T_MSG, "state = %s", isic_printstate(sc));
203 i4b_l1_mph_status_ind(L0ISICUNIT(sc->sc_unit), STI_PDEACT, 0, NULL);
207 NDBGL1(L1_T_ERR, "expired without starting it ....");
211 /*---------------------------------------------------------------------------*
213 *---------------------------------------------------------------------------*/
215 T4_start(struct l1_softc *sc)
217 NDBGL1(L1_T_MSG, "state = %s", isic_printstate(sc));
219 sc->sc_T4_callout = timeout((TIMEOUT_FUNC_T)timer4_expired,(struct l1_softc *)sc, hz);
222 /*---------------------------------------------------------------------------*
224 *---------------------------------------------------------------------------*/
226 T4_stop(struct l1_softc *sc)
228 NDBGL1(L1_T_MSG, "state = %s", isic_printstate(sc));
233 untimeout((TIMEOUT_FUNC_T)timer4_expired,(struct l1_softc *)sc, sc->sc_T4_callout);
237 /*---------------------------------------------------------------------------*
238 * FSM function: received AI8
239 *---------------------------------------------------------------------------*/
241 F_AI8(struct l1_softc *sc)
245 NDBGL1(L1_F_MSG, "FSM function F_AI8 executing");
247 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
248 i4b_l1_ph_activate_ind(L0ISICUNIT(sc->sc_unit));
252 if(sc->sc_trace & TRACE_I)
257 hdr.unit = L0ISICUNIT(sc->sc_unit);
262 i4b_l1_trace_ind(&hdr, 1, &info);
266 /*---------------------------------------------------------------------------*
267 * FSM function: received AI10
268 *---------------------------------------------------------------------------*/
270 F_AI10(struct l1_softc *sc)
274 NDBGL1(L1_F_MSG, "FSM function F_AI10 executing");
276 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
277 i4b_l1_ph_activate_ind(L0ISICUNIT(sc->sc_unit));
281 if(sc->sc_trace & TRACE_I)
284 char info = INFO4_10;
286 hdr.unit = L0ISICUNIT(sc->sc_unit);
291 i4b_l1_trace_ind(&hdr, 1, &info);
295 /*---------------------------------------------------------------------------*
296 * FSM function: received INFO 0 in states F3 .. F5
297 *---------------------------------------------------------------------------*/
299 F_I01(struct l1_softc *sc)
301 NDBGL1(L1_F_MSG, "FSM function F_I01 executing");
303 if(sc->sc_trace & TRACE_I)
308 hdr.unit = L0ISICUNIT(sc->sc_unit);
313 i4b_l1_trace_ind(&hdr, 1, &info);
317 /*---------------------------------------------------------------------------*
318 * FSM function: received INFO 0 in state F6
319 *---------------------------------------------------------------------------*/
321 F_I02(struct l1_softc *sc)
323 NDBGL1(L1_F_MSG, "FSM function F_I02 executing");
325 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
326 i4b_l1_ph_deactivate_ind(L0ISICUNIT(sc->sc_unit));
328 if(sc->sc_trace & TRACE_I)
333 hdr.unit = L0ISICUNIT(sc->sc_unit);
338 i4b_l1_trace_ind(&hdr, 1, &info);
342 /*---------------------------------------------------------------------------*
343 * FSM function: received INFO 0 in state F7 or F8
344 *---------------------------------------------------------------------------*/
346 F_I03(struct l1_softc *sc)
348 NDBGL1(L1_F_MSG, "FSM function F_I03 executing");
350 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
351 i4b_l1_ph_deactivate_ind(L0ISICUNIT(sc->sc_unit));
355 if(sc->sc_trace & TRACE_I)
360 hdr.unit = L0ISICUNIT(sc->sc_unit);
365 i4b_l1_trace_ind(&hdr, 1, &info);
369 /*---------------------------------------------------------------------------*
370 * FSM function: activate request
371 *---------------------------------------------------------------------------*/
373 F_AR(struct l1_softc *sc)
375 NDBGL1(L1_F_MSG, "FSM function F_AR executing");
377 if(sc->sc_trace & TRACE_I)
382 hdr.unit = L0ISICUNIT(sc->sc_unit);
387 i4b_l1_trace_ind(&hdr, 1, &info);
390 isic_isac_l1_cmd(sc, CMD_AR8);
395 /*---------------------------------------------------------------------------*
396 * FSM function: received INFO2
397 *---------------------------------------------------------------------------*/
399 F_I2(struct l1_softc *sc)
401 NDBGL1(L1_F_MSG, "FSM function F_I2 executing");
403 if(sc->sc_trace & TRACE_I)
408 hdr.unit = L0ISICUNIT(sc->sc_unit);
413 i4b_l1_trace_ind(&hdr, 1, &info);
418 /*---------------------------------------------------------------------------*
419 * illegal state default action
420 *---------------------------------------------------------------------------*/
422 F_ill(struct l1_softc *sc)
424 NDBGL1(L1_F_ERR, "FSM function F_ill executing");
427 /*---------------------------------------------------------------------------*
429 *---------------------------------------------------------------------------*/
431 F_NULL(struct l1_softc *sc)
433 NDBGL1(L1_F_MSG, "FSM function F_NULL executing");
437 /*---------------------------------------------------------------------------*
438 * layer 1 state transition table
439 *---------------------------------------------------------------------------*/
440 struct isic_state_tab {
441 void (*func) (struct l1_softc *sc); /* function to execute */
442 int newstate; /* next state */
443 } isic_state_tab[N_EVENTS][N_STATES] = {
445 /* STATE: F3 F4 F5 F6 F7 F8 ILLEGAL STATE */
446 /* -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------*/
447 /* EV_PHAR x*/ {{F_AR, ST_F4}, {F_NULL, ST_F4}, {F_NULL, ST_F5}, {F_NULL, ST_F6}, {F_ill, ST_ILL}, {F_NULL, ST_F8}, {F_ill, ST_ILL}},
448 /* EV_T3 x*/ {{F_NULL, ST_F3}, {F_T3ex, ST_F3}, {F_T3ex, ST_F3}, {F_T3ex, ST_F3}, {F_NULL, ST_F7}, {F_NULL, ST_F8}, {F_ill, ST_ILL}},
449 /* EV_INFO0 */ {{F_I01, ST_F3}, {F_I01, ST_F4}, {F_I01, ST_F5}, {F_I02, ST_F3}, {F_I03, ST_F3}, {F_I03, ST_F3}, {F_ill, ST_ILL}},
450 /* EV_RSY x*/ {{F_NULL, ST_F3}, {F_NULL, ST_F5}, {F_NULL, ST_F5}, {F_NULL, ST_F8}, {F_NULL, ST_F8}, {F_NULL, ST_F8}, {F_ill, ST_ILL}},
451 /* EV_INFO2 */ {{F_I2, ST_F6}, {F_I2, ST_F6}, {F_I2, ST_F6}, {F_I2, ST_F6}, {F_I2, ST_F6}, {F_I2, ST_F6}, {F_ill, ST_ILL}},
452 /* EV_INFO48*/ {{F_AI8, ST_F7}, {F_AI8, ST_F7}, {F_AI8, ST_F7}, {F_AI8, ST_F7}, {F_NULL, ST_F7}, {F_AI8, ST_F7}, {F_ill, ST_ILL}},
453 /* EV_INFO41*/ {{F_AI10, ST_F7}, {F_AI10, ST_F7}, {F_AI10, ST_F7}, {F_AI10, ST_F7}, {F_NULL, ST_F7}, {F_AI10, ST_F7}, {F_ill, ST_ILL}},
454 /* EV_DR */ {{F_NULL, ST_F3}, {F_NULL, ST_F4}, {F_NULL, ST_F5}, {F_NULL, ST_F6}, {F_NULL, ST_F7}, {F_NULL, ST_F8}, {F_ill, ST_ILL}},
455 /* EV_PU */ {{F_NULL, ST_F3}, {F_NULL, ST_F4}, {F_NULL, ST_F5}, {F_NULL, ST_F6}, {F_NULL, ST_F7}, {F_NULL, ST_F8}, {F_ill, ST_ILL}},
456 /* EV_DIS */ {{F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}},
457 /* EV_EI */ {{F_NULL, ST_F3}, {F_NULL, ST_F3}, {F_NULL, ST_F3}, {F_NULL, ST_F3}, {F_NULL, ST_F3}, {F_NULL, ST_F3}, {F_ill, ST_ILL}},
458 /* EV_ILL */ {{F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}, {F_ill, ST_ILL}}
461 /*---------------------------------------------------------------------------*
463 *---------------------------------------------------------------------------*/
465 isic_next_state(struct l1_softc *sc, int event)
467 int currstate, newstate;
469 if(event >= N_EVENTS)
470 panic("i4b_l1fsm.c: event >= N_EVENTS\n");
472 currstate = sc->sc_I430state;
474 if(currstate >= N_STATES)
475 panic("i4b_l1fsm.c: currstate >= N_STATES\n");
477 newstate = isic_state_tab[event][currstate].newstate;
479 if(newstate >= N_STATES)
480 panic("i4b_l1fsm.c: newstate >= N_STATES\n");
482 NDBGL1(L1_F_MSG, "FSM event [%s]: [%s => %s]", event_text[event],
483 state_text[currstate],
484 state_text[newstate]);
486 (*isic_state_tab[event][currstate].func)(sc);
488 if(newstate == ST_ILL)
491 NDBGL1(L1_F_ERR, "FSM Illegal State ERROR, oldstate = %s, newstate = %s, event = %s!",
492 state_text[currstate],
493 state_text[newstate],
497 sc->sc_I430state = newstate;
501 /*---------------------------------------------------------------------------*
502 * return pointer to current state description
503 *---------------------------------------------------------------------------*/
505 isic_printstate(struct l1_softc *sc)
507 return((char *) state_text[sc->sc_I430state]);
511 #endif /* NISIC > 0 */