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_itjc_l1fsm.c - NetJet-S layer 1 I.430 state machine
28 * ------------------------------------------------------------
30 * $FreeBSD: src/sys/i4b/layer1/itjc/i4b_itjc_l1fsm.c,v 1.1.2.1 2001/08/10 14:08:39 obrien Exp $
32 * last edit-date: [Wed Jan 10 17:16:33 2001]
34 *---------------------------------------------------------------------------*/
39 #if (NITJC > 0) && (NPCI > 0)
41 #include <sys/param.h>
42 #include <sys/kernel.h>
43 #include <sys/systm.h>
45 #include <sys/socket.h>
47 #include <machine/stdarg.h>
48 #include <machine/clock.h>
52 #include <machine/i4b_debug.h>
53 #include <machine/i4b_ioctl.h>
54 #include <machine/i4b_trace.h>
56 #include <i4b/layer1/isic/i4b_isic.h>
57 #include <i4b/layer1/isic/i4b_isac.h>
58 #include <i4b/layer1/isic/i4b_hscx.h>
60 #include <i4b/layer1/i4b_l1.h>
62 #include <i4b/include/i4b_global.h>
64 #include <i4b/include/i4b_mbuf.h>
66 #include <i4b/layer1/itjc/i4b_itjc_ext.h>
69 static char *state_text[N_STATES] = {
72 "F5 Identifying Input",
79 static char *event_text[N_EVENTS] = {
81 "EV_T3 Timer 3 expired",
82 "EV_INFO0 INFO0 received",
83 "EV_RSY Level Detected",
84 "EV_INFO2 INFO2 received",
85 "EV_INFO48 INFO4 received",
86 "EV_INFO410 INFO4 received",
87 "EV_DR Deactivate Req",
89 "EV_DIS Disconnected",
95 /* Function prototypes */
97 static void timer3_expired (struct l1_softc *sc);
98 static void T3_start (struct l1_softc *sc);
99 static void T3_stop (struct l1_softc *sc);
100 static void F_T3ex (struct l1_softc *sc);
101 static void timer4_expired (struct l1_softc *sc);
102 static void T4_start (struct l1_softc *sc);
103 static void T4_stop (struct l1_softc *sc);
104 static void F_AI8 (struct l1_softc *sc);
105 static void F_AI10 (struct l1_softc *sc);
106 static void F_I01 (struct l1_softc *sc);
107 static void F_I02 (struct l1_softc *sc);
108 static void F_I03 (struct l1_softc *sc);
109 static void F_I2 (struct l1_softc *sc);
110 static void F_ill (struct l1_softc *sc);
111 static void F_NULL (struct l1_softc *sc);
113 /*---------------------------------------------------------------------------*
114 * I.430 Timer T3 expire function
115 *---------------------------------------------------------------------------*/
117 timer3_expired(struct l1_softc *sc)
121 NDBGL1(L1_T_ERR, "state = %s", itjc_printstate(sc));
124 /* XXX try some recovery here XXX */
128 sc->sc_init_tries++; /* increment retry count */
130 /*XXX*/ if(sc->sc_init_tries > 4)
134 sc->sc_init_tries = 0;
136 if(sc->sc_obuf2 != NULL)
138 i4b_Dfreembuf(sc->sc_obuf2);
141 if(sc->sc_obuf != NULL)
143 i4b_Dfreembuf(sc->sc_obuf);
152 i4b_l1_mph_status_ind(L0ITJCUNIT(sc->sc_unit), STI_NOL1ACC, 0, NULL);
155 itjc_next_state(sc, EV_T3);
159 NDBGL1(L1_T_ERR, "expired without starting it ....");
163 /*---------------------------------------------------------------------------*
164 * I.430 Timer T3 start
165 *---------------------------------------------------------------------------*/
167 T3_start(struct l1_softc *sc)
169 NDBGL1(L1_T_MSG, "state = %s", itjc_printstate(sc));
171 sc->sc_T3_callout = timeout((TIMEOUT_FUNC_T)timer3_expired,(struct l1_softc *)sc, 2*hz);
174 /*---------------------------------------------------------------------------*
175 * I.430 Timer T3 stop
176 *---------------------------------------------------------------------------*/
178 T3_stop(struct l1_softc *sc)
180 NDBGL1(L1_T_MSG, "state = %s", itjc_printstate(sc));
182 sc->sc_init_tries = 0; /* init connect retry count */
187 untimeout((TIMEOUT_FUNC_T)timer3_expired,(struct l1_softc *)sc, sc->sc_T3_callout);
191 /*---------------------------------------------------------------------------*
192 * I.430 Timer T3 expiry
193 *---------------------------------------------------------------------------*/
195 F_T3ex(struct l1_softc *sc)
197 NDBGL1(L1_F_MSG, "FSM function F_T3ex executing");
198 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
199 i4b_l1_ph_deactivate_ind(L0ITJCUNIT(sc->sc_unit));
202 /*---------------------------------------------------------------------------*
203 * Timer T4 expire function
204 *---------------------------------------------------------------------------*/
206 timer4_expired(struct l1_softc *sc)
210 NDBGL1(L1_T_MSG, "state = %s", itjc_printstate(sc));
212 i4b_l1_mph_status_ind(L0ITJCUNIT(sc->sc_unit), STI_PDEACT, 0, NULL);
216 NDBGL1(L1_T_ERR, "expired without starting it ....");
220 /*---------------------------------------------------------------------------*
222 *---------------------------------------------------------------------------*/
224 T4_start(struct l1_softc *sc)
226 NDBGL1(L1_T_MSG, "state = %s", itjc_printstate(sc));
228 sc->sc_T4_callout = timeout((TIMEOUT_FUNC_T)timer4_expired,(struct l1_softc *)sc, hz);
231 /*---------------------------------------------------------------------------*
233 *---------------------------------------------------------------------------*/
235 T4_stop(struct l1_softc *sc)
237 NDBGL1(L1_T_MSG, "state = %s", itjc_printstate(sc));
242 untimeout((TIMEOUT_FUNC_T)timer4_expired,(struct l1_softc *)sc, sc->sc_T4_callout);
246 /*---------------------------------------------------------------------------*
247 * FSM function: received AI8
248 *---------------------------------------------------------------------------*/
250 F_AI8(struct l1_softc *sc)
254 NDBGL1(L1_F_MSG, "FSM function F_AI8 executing");
256 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
257 i4b_l1_ph_activate_ind(L0ITJCUNIT(sc->sc_unit));
261 if(sc->sc_trace & TRACE_I)
266 hdr.unit = L0ITJCUNIT(sc->sc_unit);
271 i4b_l1_trace_ind(&hdr, 1, &info);
275 /*---------------------------------------------------------------------------*
276 * FSM function: received AI10
277 *---------------------------------------------------------------------------*/
279 F_AI10(struct l1_softc *sc)
283 NDBGL1(L1_F_MSG, "FSM function F_AI10 executing");
285 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
286 i4b_l1_ph_activate_ind(L0ITJCUNIT(sc->sc_unit));
290 if(sc->sc_trace & TRACE_I)
293 char info = INFO4_10;
295 hdr.unit = L0ITJCUNIT(sc->sc_unit);
300 i4b_l1_trace_ind(&hdr, 1, &info);
304 /*---------------------------------------------------------------------------*
305 * FSM function: received INFO 0 in states F3 .. F5
306 *---------------------------------------------------------------------------*/
308 F_I01(struct l1_softc *sc)
310 NDBGL1(L1_F_MSG, "FSM function F_I01 executing");
312 if(sc->sc_trace & TRACE_I)
317 hdr.unit = L0ITJCUNIT(sc->sc_unit);
322 i4b_l1_trace_ind(&hdr, 1, &info);
326 /*---------------------------------------------------------------------------*
327 * FSM function: received INFO 0 in state F6
328 *---------------------------------------------------------------------------*/
330 F_I02(struct l1_softc *sc)
332 NDBGL1(L1_F_MSG, "FSM function F_I02 executing");
334 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
335 i4b_l1_ph_deactivate_ind(L0ITJCUNIT(sc->sc_unit));
337 if(sc->sc_trace & TRACE_I)
342 hdr.unit = L0ITJCUNIT(sc->sc_unit);
347 i4b_l1_trace_ind(&hdr, 1, &info);
351 /*---------------------------------------------------------------------------*
352 * FSM function: received INFO 0 in state F7 or F8
353 *---------------------------------------------------------------------------*/
355 F_I03(struct l1_softc *sc)
357 NDBGL1(L1_F_MSG, "FSM function F_I03 executing");
359 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
360 i4b_l1_ph_deactivate_ind(L0ITJCUNIT(sc->sc_unit));
364 if(sc->sc_trace & TRACE_I)
369 hdr.unit = L0ITJCUNIT(sc->sc_unit);
374 i4b_l1_trace_ind(&hdr, 1, &info);
378 /*---------------------------------------------------------------------------*
379 * FSM function: activate request
380 *---------------------------------------------------------------------------*/
382 F_AR(struct l1_softc *sc)
384 NDBGL1(L1_F_MSG, "FSM function F_AR executing");
386 if(sc->sc_trace & TRACE_I)
391 hdr.unit = L0ITJCUNIT(sc->sc_unit);
396 i4b_l1_trace_ind(&hdr, 1, &info);
399 itjc_isac_l1_cmd(sc, CMD_AR8);
404 /*---------------------------------------------------------------------------*
405 * FSM function: received INFO2
406 *---------------------------------------------------------------------------*/
408 F_I2(struct l1_softc *sc)
410 NDBGL1(L1_F_MSG, "FSM function F_I2 executing");
412 if(sc->sc_trace & TRACE_I)
417 hdr.unit = L0ITJCUNIT(sc->sc_unit);
422 i4b_l1_trace_ind(&hdr, 1, &info);
427 /*---------------------------------------------------------------------------*
428 * illegal state default action
429 *---------------------------------------------------------------------------*/
431 F_ill(struct l1_softc *sc)
433 NDBGL1(L1_F_ERR, "FSM function F_ill executing");
436 /*---------------------------------------------------------------------------*
438 *---------------------------------------------------------------------------*/
440 F_NULL(struct l1_softc *sc)
442 NDBGL1(L1_F_MSG, "FSM function F_NULL executing");
446 /*---------------------------------------------------------------------------*
447 * layer 1 state transition table
448 *---------------------------------------------------------------------------*/
449 struct itjc_state_tab {
450 void (*func) (struct l1_softc *sc); /* function to execute */
451 int newstate; /* next state */
452 } itjc_state_tab[N_EVENTS][N_STATES] = {
454 /* STATE: F3 F4 F5 F6 F7 F8 ILLEGAL STATE */
455 /* -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------*/
456 /* 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}},
457 /* 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}},
458 /* 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}},
459 /* 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}},
460 /* 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}},
461 /* 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}},
462 /* 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}},
463 /* 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}},
464 /* 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}},
465 /* 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}},
466 /* 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}},
467 /* 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}}
470 /*---------------------------------------------------------------------------*
472 *---------------------------------------------------------------------------*/
474 itjc_next_state(struct l1_softc *sc, int event)
476 int currstate, newstate;
478 if(event >= N_EVENTS)
479 panic("i4b_l1fsm.c: event >= N_EVENTS\n");
481 currstate = sc->sc_I430state;
483 if(currstate >= N_STATES)
484 panic("i4b_l1fsm.c: currstate >= N_STATES\n");
486 newstate = itjc_state_tab[event][currstate].newstate;
488 if(newstate >= N_STATES)
489 panic("i4b_l1fsm.c: newstate >= N_STATES\n");
491 NDBGL1(L1_F_MSG, "FSM event [%s]: [%s => %s]", event_text[event],
492 state_text[currstate],
493 state_text[newstate]);
495 (*itjc_state_tab[event][currstate].func)(sc);
497 if(newstate == ST_ILL)
500 NDBGL1(L1_F_ERR, "FSM Illegal State ERROR, oldstate = %s, newstate = %s, event = %s!",
501 state_text[currstate],
502 state_text[newstate],
506 sc->sc_I430state = newstate;
510 /*---------------------------------------------------------------------------*
511 * return pointer to current state description
512 *---------------------------------------------------------------------------*/
514 itjc_printstate(struct l1_softc *sc)
516 return((char *) state_text[sc->sc_I430state]);
520 #endif /* NITJC > 0 */