1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Linux network driver for QLogic BR-series Converged Network Adapter.
4*4882a593Smuzhiyun */
5*4882a593Smuzhiyun /*
6*4882a593Smuzhiyun * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
7*4882a593Smuzhiyun * Copyright (c) 2014-2015 QLogic Corporation
8*4882a593Smuzhiyun * All rights reserved
9*4882a593Smuzhiyun * www.qlogic.com
10*4882a593Smuzhiyun */
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun /* BFA common services */
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun #ifndef __BFA_CS_H__
15*4882a593Smuzhiyun #define __BFA_CS_H__
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun #include "cna.h"
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun /* BFA state machine interfaces */
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun typedef void (*bfa_sm_t)(void *sm, int event);
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun /* For converting from state machine function to state encoding. */
24*4882a593Smuzhiyun struct bfa_sm_table {
25*4882a593Smuzhiyun bfa_sm_t sm; /*!< state machine function */
26*4882a593Smuzhiyun int state; /*!< state machine encoding */
27*4882a593Smuzhiyun char *name; /*!< state name for display */
28*4882a593Smuzhiyun };
29*4882a593Smuzhiyun #define BFA_SM(_sm) ((bfa_sm_t)(_sm))
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun /* State machine with entry actions. */
32*4882a593Smuzhiyun typedef void (*bfa_fsm_t)(void *fsm, int event);
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun /* oc - object class eg. bfa_ioc
35*4882a593Smuzhiyun * st - state, eg. reset
36*4882a593Smuzhiyun * otype - object type, eg. struct bfa_ioc
37*4882a593Smuzhiyun * etype - object type, eg. enum ioc_event
38*4882a593Smuzhiyun */
39*4882a593Smuzhiyun #define bfa_fsm_state_decl(oc, st, otype, etype) \
40*4882a593Smuzhiyun static void oc ## _sm_ ## st(otype * fsm, etype event); \
41*4882a593Smuzhiyun static void oc ## _sm_ ## st ## _entry(otype * fsm)
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun #define bfa_fsm_set_state(_fsm, _state) do { \
44*4882a593Smuzhiyun (_fsm)->fsm = (bfa_fsm_t)(_state); \
45*4882a593Smuzhiyun _state ## _entry(_fsm); \
46*4882a593Smuzhiyun } while (0)
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun #define bfa_fsm_send_event(_fsm, _event) ((_fsm)->fsm((_fsm), (_event)))
49*4882a593Smuzhiyun #define bfa_fsm_cmp_state(_fsm, _state) \
50*4882a593Smuzhiyun ((_fsm)->fsm == (bfa_fsm_t)(_state))
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun static inline int
bfa_sm_to_state(const struct bfa_sm_table * smt,bfa_sm_t sm)53*4882a593Smuzhiyun bfa_sm_to_state(const struct bfa_sm_table *smt, bfa_sm_t sm)
54*4882a593Smuzhiyun {
55*4882a593Smuzhiyun int i = 0;
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun while (smt[i].sm && smt[i].sm != sm)
58*4882a593Smuzhiyun i++;
59*4882a593Smuzhiyun return smt[i].state;
60*4882a593Smuzhiyun }
61*4882a593Smuzhiyun
62*4882a593Smuzhiyun /* Generic wait counter. */
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun typedef void (*bfa_wc_resume_t) (void *cbarg);
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun struct bfa_wc {
67*4882a593Smuzhiyun bfa_wc_resume_t wc_resume;
68*4882a593Smuzhiyun void *wc_cbarg;
69*4882a593Smuzhiyun int wc_count;
70*4882a593Smuzhiyun };
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun static inline void
bfa_wc_up(struct bfa_wc * wc)73*4882a593Smuzhiyun bfa_wc_up(struct bfa_wc *wc)
74*4882a593Smuzhiyun {
75*4882a593Smuzhiyun wc->wc_count++;
76*4882a593Smuzhiyun }
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun static inline void
bfa_wc_down(struct bfa_wc * wc)79*4882a593Smuzhiyun bfa_wc_down(struct bfa_wc *wc)
80*4882a593Smuzhiyun {
81*4882a593Smuzhiyun wc->wc_count--;
82*4882a593Smuzhiyun if (wc->wc_count == 0)
83*4882a593Smuzhiyun wc->wc_resume(wc->wc_cbarg);
84*4882a593Smuzhiyun }
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun /* Initialize a waiting counter. */
87*4882a593Smuzhiyun static inline void
bfa_wc_init(struct bfa_wc * wc,bfa_wc_resume_t wc_resume,void * wc_cbarg)88*4882a593Smuzhiyun bfa_wc_init(struct bfa_wc *wc, bfa_wc_resume_t wc_resume, void *wc_cbarg)
89*4882a593Smuzhiyun {
90*4882a593Smuzhiyun wc->wc_resume = wc_resume;
91*4882a593Smuzhiyun wc->wc_cbarg = wc_cbarg;
92*4882a593Smuzhiyun wc->wc_count = 0;
93*4882a593Smuzhiyun bfa_wc_up(wc);
94*4882a593Smuzhiyun }
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun /* Wait for counter to reach zero */
97*4882a593Smuzhiyun static inline void
bfa_wc_wait(struct bfa_wc * wc)98*4882a593Smuzhiyun bfa_wc_wait(struct bfa_wc *wc)
99*4882a593Smuzhiyun {
100*4882a593Smuzhiyun bfa_wc_down(wc);
101*4882a593Smuzhiyun }
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun #endif /* __BFA_CS_H__ */
104