blob: ad004a4c3897ecb3925c47da387a9985a13c51d4 [file] [log] [blame]
Rasesh Mody8b230ed2010-08-23 20:24:12 -07001/*
2 * Linux network driver for Brocade Converged Network Adapter.
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License (GPL) Version 2 as
6 * published by the Free Software Foundation
7 *
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
12 */
13/*
Rasesh Mody758ccc32011-07-22 08:07:49 +000014 * Copyright (c) 2005-2011 Brocade Communications Systems, Inc.
Rasesh Mody8b230ed2010-08-23 20:24:12 -070015 * All rights reserved
16 * www.brocade.com
17 */
18
Ben Hutchings1aa8b472012-07-10 10:56:59 +000019/* BFA common services */
Rasesh Mody8b230ed2010-08-23 20:24:12 -070020
Rasesh Mody758ccc32011-07-22 08:07:49 +000021#ifndef __BFA_CS_H__
22#define __BFA_CS_H__
Rasesh Mody8b230ed2010-08-23 20:24:12 -070023
24#include "cna.h"
25
Ben Hutchings1aa8b472012-07-10 10:56:59 +000026/* BFA state machine interfaces */
Rasesh Mody758ccc32011-07-22 08:07:49 +000027
Rasesh Mody8b230ed2010-08-23 20:24:12 -070028typedef void (*bfa_sm_t)(void *sm, int event);
29
Ben Hutchings1aa8b472012-07-10 10:56:59 +000030/* oc - object class eg. bfa_ioc
Rasesh Mody8b230ed2010-08-23 20:24:12 -070031 * st - state, eg. reset
32 * otype - object type, eg. struct bfa_ioc
33 * etype - object type, eg. enum ioc_event
34 */
Rasesh Mody758ccc32011-07-22 08:07:49 +000035#define bfa_sm_state_decl(oc, st, otype, etype) \
Rasesh Mody8b230ed2010-08-23 20:24:12 -070036 static void oc ## _sm_ ## st(otype * fsm, etype event)
37
38#define bfa_sm_set_state(_sm, _state) ((_sm)->sm = (bfa_sm_t)(_state))
39#define bfa_sm_send_event(_sm, _event) ((_sm)->sm((_sm), (_event)))
40#define bfa_sm_get_state(_sm) ((_sm)->sm)
41#define bfa_sm_cmp_state(_sm, _state) ((_sm)->sm == (bfa_sm_t)(_state))
42
Ben Hutchings1aa8b472012-07-10 10:56:59 +000043/* For converting from state machine function to state encoding. */
Rasesh Mody8b230ed2010-08-23 20:24:12 -070044struct bfa_sm_table {
45 bfa_sm_t sm; /*!< state machine function */
46 int state; /*!< state machine encoding */
47 char *name; /*!< state name for display */
48};
Rasesh Mody758ccc32011-07-22 08:07:49 +000049#define BFA_SM(_sm) ((bfa_sm_t)(_sm))
Rasesh Mody8b230ed2010-08-23 20:24:12 -070050
Ben Hutchings1aa8b472012-07-10 10:56:59 +000051/* State machine with entry actions. */
Rasesh Mody8b230ed2010-08-23 20:24:12 -070052typedef void (*bfa_fsm_t)(void *fsm, int event);
53
Ben Hutchings1aa8b472012-07-10 10:56:59 +000054/* oc - object class eg. bfa_ioc
Rasesh Mody8b230ed2010-08-23 20:24:12 -070055 * st - state, eg. reset
56 * otype - object type, eg. struct bfa_ioc
57 * etype - object type, eg. enum ioc_event
58 */
Rasesh Mody758ccc32011-07-22 08:07:49 +000059#define bfa_fsm_state_decl(oc, st, otype, etype) \
60 static void oc ## _sm_ ## st(otype * fsm, etype event); \
Rasesh Mody8b230ed2010-08-23 20:24:12 -070061 static void oc ## _sm_ ## st ## _entry(otype * fsm)
62
Rasesh Mody758ccc32011-07-22 08:07:49 +000063#define bfa_fsm_set_state(_fsm, _state) do { \
64 (_fsm)->fsm = (bfa_fsm_t)(_state); \
65 _state ## _entry(_fsm); \
Rasesh Mody8b230ed2010-08-23 20:24:12 -070066} while (0)
67
68#define bfa_fsm_send_event(_fsm, _event) ((_fsm)->fsm((_fsm), (_event)))
69#define bfa_fsm_get_state(_fsm) ((_fsm)->fsm)
Rasesh Mody758ccc32011-07-22 08:07:49 +000070#define bfa_fsm_cmp_state(_fsm, _state) \
Rasesh Mody8b230ed2010-08-23 20:24:12 -070071 ((_fsm)->fsm == (bfa_fsm_t)(_state))
72
73static inline int
Rasesh Modyb7ee31c52010-10-05 15:46:05 +000074bfa_sm_to_state(const struct bfa_sm_table *smt, bfa_sm_t sm)
Rasesh Mody8b230ed2010-08-23 20:24:12 -070075{
76 int i = 0;
77
78 while (smt[i].sm && smt[i].sm != sm)
79 i++;
80 return smt[i].state;
81}
Rasesh Mody758ccc32011-07-22 08:07:49 +000082
Ben Hutchings1aa8b472012-07-10 10:56:59 +000083/* Generic wait counter. */
Rasesh Mody758ccc32011-07-22 08:07:49 +000084
85typedef void (*bfa_wc_resume_t) (void *cbarg);
86
87struct bfa_wc {
88 bfa_wc_resume_t wc_resume;
89 void *wc_cbarg;
90 int wc_count;
91};
92
93static inline void
94bfa_wc_up(struct bfa_wc *wc)
95{
96 wc->wc_count++;
97}
98
99static inline void
100bfa_wc_down(struct bfa_wc *wc)
101{
102 wc->wc_count--;
103 if (wc->wc_count == 0)
104 wc->wc_resume(wc->wc_cbarg);
105}
106
Ben Hutchings1aa8b472012-07-10 10:56:59 +0000107/* Initialize a waiting counter. */
Rasesh Mody758ccc32011-07-22 08:07:49 +0000108static inline void
109bfa_wc_init(struct bfa_wc *wc, bfa_wc_resume_t wc_resume, void *wc_cbarg)
110{
111 wc->wc_resume = wc_resume;
112 wc->wc_cbarg = wc_cbarg;
113 wc->wc_count = 0;
114 bfa_wc_up(wc);
115}
116
Ben Hutchings1aa8b472012-07-10 10:56:59 +0000117/* Wait for counter to reach zero */
Rasesh Mody758ccc32011-07-22 08:07:49 +0000118static inline void
119bfa_wc_wait(struct bfa_wc *wc)
120{
121 bfa_wc_down(wc);
122}
123
124#endif /* __BFA_CS_H__ */