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_ifpi_l1fsm.c - AVM Fritz PCI layer 1 I.430 state machine
28 * ------------------------------------------------------------
30 * $Id: i4b_ifpi_l1fsm.c,v 1.4 2000/05/29 15:41:41 hm Exp $
32 * $FreeBSD: src/sys/i4b/layer1/ifpi/i4b_ifpi_l1fsm.c,v 1.4.2.1 2001/08/10 14:08:37 obrien Exp $
33 * $DragonFly: src/sys/net/i4b/layer1/ifpi/i4b_ifpi_l1fsm.c,v 1.6 2005/06/03 16:50:00 dillon Exp $
35 * last edit-date: [Mon May 29 15:23:15 2000]
37 *---------------------------------------------------------------------------*/
42 #if (NIFPI > 0) && (NPCI > 0)
44 #include <sys/param.h>
45 #include <sys/kernel.h>
46 #include <sys/systm.h>
47 #include <sys/socket.h>
48 #include <sys/thread2.h>
53 #include <net/i4b/include/machine/i4b_debug.h>
54 #include <net/i4b/include/machine/i4b_ioctl.h>
55 #include <net/i4b/include/machine/i4b_trace.h>
57 #include "../isic/i4b_isic.h"
58 #include "../i4b_l1.h"
59 #include "../../include/i4b_global.h"
60 #include "../../include/i4b_mbuf.h"
62 #include "i4b_ifpi_ext.h"
65 static char *state_text[N_STATES] = {
68 "F5 Identifying Input",
75 static char *event_text[N_EVENTS] = {
77 "EV_T3 Timer 3 expired",
78 "EV_INFO0 INFO0 received",
79 "EV_RSY Level Detected",
80 "EV_INFO2 INFO2 received",
81 "EV_INFO48 INFO4 received",
82 "EV_INFO410 INFO4 received",
83 "EV_DR Deactivate Req",
85 "EV_DIS Disconnected",
91 /* Function prototypes */
93 static void timer3_expired (struct l1_softc *sc);
94 static void T3_start (struct l1_softc *sc);
95 static void T3_stop (struct l1_softc *sc);
96 static void F_T3ex (struct l1_softc *sc);
97 static void timer4_expired (struct l1_softc *sc);
98 static void T4_start (struct l1_softc *sc);
99 static void T4_stop (struct l1_softc *sc);
100 static void F_AI8 (struct l1_softc *sc);
101 static void F_AI10 (struct l1_softc *sc);
102 static void F_I01 (struct l1_softc *sc);
103 static void F_I02 (struct l1_softc *sc);
104 static void F_I03 (struct l1_softc *sc);
105 static void F_I2 (struct l1_softc *sc);
106 static void F_ill (struct l1_softc *sc);
107 static void F_NULL (struct l1_softc *sc);
109 /*---------------------------------------------------------------------------*
110 * I.430 Timer T3 expire function
111 *---------------------------------------------------------------------------*/
113 timer3_expired(struct l1_softc *sc)
117 NDBGL1(L1_T_ERR, "state = %s", ifpi_printstate(sc));
120 /* XXX try some recovery here XXX */
124 sc->sc_init_tries++; /* increment retry count */
126 /*XXX*/ if(sc->sc_init_tries > 4)
130 sc->sc_init_tries = 0;
132 if(sc->sc_obuf2 != NULL)
134 i4b_Dfreembuf(sc->sc_obuf2);
137 if(sc->sc_obuf != NULL)
139 i4b_Dfreembuf(sc->sc_obuf);
148 i4b_l1_mph_status_ind(L0IFPIUNIT(sc->sc_unit), STI_NOL1ACC, 0, NULL);
151 ifpi_next_state(sc, EV_T3);
155 NDBGL1(L1_T_ERR, "expired without starting it ....");
159 /*---------------------------------------------------------------------------*
160 * I.430 Timer T3 start
161 *---------------------------------------------------------------------------*/
163 T3_start(struct l1_softc *sc)
165 NDBGL1(L1_T_MSG, "state = %s", ifpi_printstate(sc));
167 callout_reset(&sc->sc_T3_timeout, 2 * hz,
168 (TIMEOUT_FUNC_T)timer3_expired, (struct l1_softc *)sc);
171 /*---------------------------------------------------------------------------*
172 * I.430 Timer T3 stop
173 *---------------------------------------------------------------------------*/
175 T3_stop(struct l1_softc *sc)
177 NDBGL1(L1_T_MSG, "state = %s", ifpi_printstate(sc));
179 sc->sc_init_tries = 0; /* init connect retry count */
184 callout_stop(&sc->sc_T3_timeout);
188 /*---------------------------------------------------------------------------*
189 * I.430 Timer T3 expiry
190 *---------------------------------------------------------------------------*/
192 F_T3ex(struct l1_softc *sc)
194 NDBGL1(L1_F_MSG, "FSM function F_T3ex executing");
195 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
196 i4b_l1_ph_deactivate_ind(L0IFPIUNIT(sc->sc_unit));
199 /*---------------------------------------------------------------------------*
200 * Timer T4 expire function
201 *---------------------------------------------------------------------------*/
203 timer4_expired(struct l1_softc *sc)
207 NDBGL1(L1_T_MSG, "state = %s", ifpi_printstate(sc));
209 i4b_l1_mph_status_ind(L0IFPIUNIT(sc->sc_unit), STI_PDEACT, 0, NULL);
213 NDBGL1(L1_T_ERR, "expired without starting it ....");
217 /*---------------------------------------------------------------------------*
219 *---------------------------------------------------------------------------*/
221 T4_start(struct l1_softc *sc)
223 NDBGL1(L1_T_MSG, "state = %s", ifpi_printstate(sc));
225 callout_reset(&sc->sc_T4_timeout, hz,
226 (TIMEOUT_FUNC_T)timer4_expired, (struct l1_softc *)sc);
229 /*---------------------------------------------------------------------------*
231 *---------------------------------------------------------------------------*/
233 T4_stop(struct l1_softc *sc)
235 NDBGL1(L1_T_MSG, "state = %s", ifpi_printstate(sc));
240 callout_stop(&sc->sc_T4_timeout);
244 /*---------------------------------------------------------------------------*
245 * FSM function: received AI8
246 *---------------------------------------------------------------------------*/
248 F_AI8(struct l1_softc *sc)
252 NDBGL1(L1_F_MSG, "FSM function F_AI8 executing");
254 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
255 i4b_l1_ph_activate_ind(L0IFPIUNIT(sc->sc_unit));
259 if(sc->sc_trace & TRACE_I)
264 hdr.unit = L0IFPIUNIT(sc->sc_unit);
269 i4b_l1_trace_ind(&hdr, 1, &info);
273 /*---------------------------------------------------------------------------*
274 * FSM function: received AI10
275 *---------------------------------------------------------------------------*/
277 F_AI10(struct l1_softc *sc)
281 NDBGL1(L1_F_MSG, "FSM function F_AI10 executing");
283 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
284 i4b_l1_ph_activate_ind(L0IFPIUNIT(sc->sc_unit));
288 if(sc->sc_trace & TRACE_I)
291 char info = INFO4_10;
293 hdr.unit = L0IFPIUNIT(sc->sc_unit);
298 i4b_l1_trace_ind(&hdr, 1, &info);
302 /*---------------------------------------------------------------------------*
303 * FSM function: received INFO 0 in states F3 .. F5
304 *---------------------------------------------------------------------------*/
306 F_I01(struct l1_softc *sc)
308 NDBGL1(L1_F_MSG, "FSM function F_I01 executing");
310 if(sc->sc_trace & TRACE_I)
315 hdr.unit = L0IFPIUNIT(sc->sc_unit);
320 i4b_l1_trace_ind(&hdr, 1, &info);
324 /*---------------------------------------------------------------------------*
325 * FSM function: received INFO 0 in state F6
326 *---------------------------------------------------------------------------*/
328 F_I02(struct l1_softc *sc)
330 NDBGL1(L1_F_MSG, "FSM function F_I02 executing");
332 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
333 i4b_l1_ph_deactivate_ind(L0IFPIUNIT(sc->sc_unit));
335 if(sc->sc_trace & TRACE_I)
340 hdr.unit = L0IFPIUNIT(sc->sc_unit);
345 i4b_l1_trace_ind(&hdr, 1, &info);
349 /*---------------------------------------------------------------------------*
350 * FSM function: received INFO 0 in state F7 or F8
351 *---------------------------------------------------------------------------*/
353 F_I03(struct l1_softc *sc)
355 NDBGL1(L1_F_MSG, "FSM function F_I03 executing");
357 if(ctrl_desc[sc->sc_unit].protocol != PROTOCOL_D64S)
358 i4b_l1_ph_deactivate_ind(L0IFPIUNIT(sc->sc_unit));
362 if(sc->sc_trace & TRACE_I)
367 hdr.unit = L0IFPIUNIT(sc->sc_unit);
372 i4b_l1_trace_ind(&hdr, 1, &info);
376 /*---------------------------------------------------------------------------*
377 * FSM function: activate request
378 *---------------------------------------------------------------------------*/
380 F_AR(struct l1_softc *sc)
382 NDBGL1(L1_F_MSG, "FSM function F_AR executing");
384 if(sc->sc_trace & TRACE_I)
389 hdr.unit = L0IFPIUNIT(sc->sc_unit);
394 i4b_l1_trace_ind(&hdr, 1, &info);
397 ifpi_isac_l1_cmd(sc, CMD_AR8);
402 /*---------------------------------------------------------------------------*
403 * FSM function: received INFO2
404 *---------------------------------------------------------------------------*/
406 F_I2(struct l1_softc *sc)
408 NDBGL1(L1_F_MSG, "FSM function F_I2 executing");
410 if(sc->sc_trace & TRACE_I)
415 hdr.unit = L0IFPIUNIT(sc->sc_unit);
420 i4b_l1_trace_ind(&hdr, 1, &info);
425 /*---------------------------------------------------------------------------*
426 * illegal state default action
427 *---------------------------------------------------------------------------*/
429 F_ill(struct l1_softc *sc)
431 NDBGL1(L1_F_ERR, "FSM function F_ill executing");
434 /*---------------------------------------------------------------------------*
436 *---------------------------------------------------------------------------*/
438 F_NULL(struct l1_softc *sc)
440 NDBGL1(L1_F_MSG, "FSM function F_NULL executing");
444 /*---------------------------------------------------------------------------*
445 * layer 1 state transition table
446 *---------------------------------------------------------------------------*/
447 struct ifpi_state_tab {
448 void (*func) (struct l1_softc *sc); /* function to execute */
449 int newstate; /* next state */
450 } ifpi_state_tab[N_EVENTS][N_STATES] = {
452 /* STATE: F3 F4 F5 F6 F7 F8 ILLEGAL STATE */
453 /* -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------*/
454 /* 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}},
455 /* 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}},
456 /* 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}},
457 /* 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}},
458 /* 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}},
459 /* 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}},
460 /* 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}},
461 /* 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}},
462 /* 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}},
463 /* 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}},
464 /* 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}},
465 /* 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}}
468 /*---------------------------------------------------------------------------*
470 *---------------------------------------------------------------------------*/
472 ifpi_next_state(struct l1_softc *sc, int event)
474 int currstate, newstate;
476 if(event >= N_EVENTS)
477 panic("i4b_l1fsm.c: event >= N_EVENTS\n");
479 currstate = sc->sc_I430state;
481 if(currstate >= N_STATES)
482 panic("i4b_l1fsm.c: currstate >= N_STATES\n");
484 newstate = ifpi_state_tab[event][currstate].newstate;
486 if(newstate >= N_STATES)
487 panic("i4b_l1fsm.c: newstate >= N_STATES\n");
489 NDBGL1(L1_F_MSG, "FSM event [%s]: [%s => %s]", event_text[event],
490 state_text[currstate],
491 state_text[newstate]);
493 (*ifpi_state_tab[event][currstate].func)(sc);
495 if(newstate == ST_ILL)
498 NDBGL1(L1_F_ERR, "FSM Illegal State ERROR, oldstate = %s, newstate = %s, event = %s!",
499 state_text[currstate],
500 state_text[newstate],
504 sc->sc_I430state = newstate;
508 /*---------------------------------------------------------------------------*
509 * return pointer to current state description
510 *---------------------------------------------------------------------------*/
512 ifpi_printstate(struct l1_softc *sc)
514 return((char *) state_text[sc->sc_I430state]);
518 #endif /* NIFPI > 0 */