Commit | Line | Data |
---|---|---|
a36c61f9 KG |
1 | /* |
2 | * Copyright (c) 2005-2010 Brocade Communications Systems, Inc. | |
3 | * All rights reserved | |
4 | * www.brocade.com | |
5 | * | |
6 | * Linux driver for Brocade Fibre Channel Host Bus Adapter. | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify it | |
9 | * under the terms of the GNU General Public License (GPL) Version 2 as | |
10 | * published by the Free Software Foundation | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * General Public License for more details. | |
16 | */ | |
17 | ||
acdc79a6 | 18 | /* |
a36c61f9 KG |
19 | * bfa_cs.h BFA common services |
20 | */ | |
21 | ||
22 | #ifndef __BFA_CS_H__ | |
23 | #define __BFA_CS_H__ | |
24 | ||
f16a1750 | 25 | #include "bfad_drv.h" |
a36c61f9 | 26 | |
acdc79a6 | 27 | /* |
a36c61f9 KG |
28 | * BFA TRC |
29 | */ | |
30 | ||
31 | #ifndef BFA_TRC_MAX | |
32 | #define BFA_TRC_MAX (4 * 1024) | |
33 | #endif | |
34 | ||
f16a1750 MZ |
35 | #define BFA_TRC_TS(_trcm) \ |
36 | ({ \ | |
37 | struct timeval tv; \ | |
38 | \ | |
39 | do_gettimeofday(&tv); \ | |
40 | (tv.tv_sec*1000000+tv.tv_usec); \ | |
41 | }) | |
42 | ||
a36c61f9 KG |
43 | #ifndef BFA_TRC_TS |
44 | #define BFA_TRC_TS(_trcm) ((_trcm)->ticks++) | |
45 | #endif | |
46 | ||
47 | struct bfa_trc_s { | |
f16a1750 | 48 | #ifdef __BIG_ENDIAN |
a36c61f9 KG |
49 | u16 fileno; |
50 | u16 line; | |
51 | #else | |
52 | u16 line; | |
53 | u16 fileno; | |
54 | #endif | |
55 | u32 timestamp; | |
56 | union { | |
57 | struct { | |
58 | u32 rsvd; | |
59 | u32 u32; | |
60 | } u32; | |
61 | u64 u64; | |
62 | } data; | |
63 | }; | |
64 | ||
65 | struct bfa_trc_mod_s { | |
66 | u32 head; | |
67 | u32 tail; | |
68 | u32 ntrc; | |
69 | u32 stopped; | |
70 | u32 ticks; | |
71 | u32 rsvd[3]; | |
72 | struct bfa_trc_s trc[BFA_TRC_MAX]; | |
73 | }; | |
74 | ||
75 | enum { | |
76 | BFA_TRC_HAL = 1, /* BFA modules */ | |
77 | BFA_TRC_FCS = 2, /* BFA FCS modules */ | |
78 | BFA_TRC_LDRV = 3, /* Linux driver modules */ | |
79 | BFA_TRC_CNA = 4, /* Common modules */ | |
80 | }; | |
81 | #define BFA_TRC_MOD_SH 10 | |
82 | #define BFA_TRC_MOD(__mod) ((BFA_TRC_ ## __mod) << BFA_TRC_MOD_SH) | |
83 | ||
acdc79a6 | 84 | /* |
a36c61f9 KG |
85 | * Define a new tracing file (module). Module should match one defined above. |
86 | */ | |
87 | #define BFA_TRC_FILE(__mod, __submod) \ | |
88 | static int __trc_fileno = ((BFA_TRC_ ## __mod ## _ ## __submod) | \ | |
89 | BFA_TRC_MOD(__mod)) | |
90 | ||
91 | ||
92 | #define bfa_trc32(_trcp, _data) \ | |
93 | __bfa_trc((_trcp)->trcmod, __trc_fileno, __LINE__, (u32)_data) | |
94 | #define bfa_trc(_trcp, _data) \ | |
95 | __bfa_trc((_trcp)->trcmod, __trc_fileno, __LINE__, (u64)_data) | |
96 | ||
97 | static inline void | |
98 | bfa_trc_init(struct bfa_trc_mod_s *trcm) | |
99 | { | |
100 | trcm->head = trcm->tail = trcm->stopped = 0; | |
101 | trcm->ntrc = BFA_TRC_MAX; | |
102 | } | |
103 | ||
104 | static inline void | |
105 | bfa_trc_stop(struct bfa_trc_mod_s *trcm) | |
106 | { | |
107 | trcm->stopped = 1; | |
108 | } | |
109 | ||
a36c61f9 KG |
110 | static inline void |
111 | __bfa_trc(struct bfa_trc_mod_s *trcm, int fileno, int line, u64 data) | |
112 | { | |
113 | int tail = trcm->tail; | |
114 | struct bfa_trc_s *trc = &trcm->trc[tail]; | |
115 | ||
116 | if (trcm->stopped) | |
117 | return; | |
118 | ||
119 | trc->fileno = (u16) fileno; | |
120 | trc->line = (u16) line; | |
121 | trc->data.u64 = data; | |
122 | trc->timestamp = BFA_TRC_TS(trcm); | |
a36c61f9 KG |
123 | |
124 | trcm->tail = (trcm->tail + 1) & (BFA_TRC_MAX - 1); | |
125 | if (trcm->tail == trcm->head) | |
126 | trcm->head = (trcm->head + 1) & (BFA_TRC_MAX - 1); | |
a36c61f9 KG |
127 | } |
128 | ||
129 | ||
130 | static inline void | |
131 | __bfa_trc32(struct bfa_trc_mod_s *trcm, int fileno, int line, u32 data) | |
132 | { | |
133 | int tail = trcm->tail; | |
134 | struct bfa_trc_s *trc = &trcm->trc[tail]; | |
135 | ||
136 | if (trcm->stopped) | |
137 | return; | |
138 | ||
139 | trc->fileno = (u16) fileno; | |
140 | trc->line = (u16) line; | |
141 | trc->data.u32.u32 = data; | |
142 | trc->timestamp = BFA_TRC_TS(trcm); | |
a36c61f9 KG |
143 | |
144 | trcm->tail = (trcm->tail + 1) & (BFA_TRC_MAX - 1); | |
145 | if (trcm->tail == trcm->head) | |
146 | trcm->head = (trcm->head + 1) & (BFA_TRC_MAX - 1); | |
a36c61f9 KG |
147 | } |
148 | ||
a36c61f9 KG |
149 | #define bfa_sm_fault(__mod, __event) do { \ |
150 | bfa_trc(__mod, (((u32)0xDEAD << 16) | __event)); \ | |
151 | printk(KERN_ERR "Assertion failure: %s:%d: %d", \ | |
152 | __FILE__, __LINE__, (__event)); \ | |
153 | } while (0) | |
154 | ||
a36c61f9 KG |
155 | /* BFA queue definitions */ |
156 | #define bfa_q_first(_q) ((void *)(((struct list_head *) (_q))->next)) | |
157 | #define bfa_q_next(_qe) (((struct list_head *) (_qe))->next) | |
158 | #define bfa_q_prev(_qe) (((struct list_head *) (_qe))->prev) | |
159 | ||
160 | /* | |
161 | * bfa_q_qe_init - to initialize a queue element | |
162 | */ | |
163 | #define bfa_q_qe_init(_qe) { \ | |
164 | bfa_q_next(_qe) = (struct list_head *) NULL; \ | |
165 | bfa_q_prev(_qe) = (struct list_head *) NULL; \ | |
166 | } | |
167 | ||
168 | /* | |
169 | * bfa_q_deq - dequeue an element from head of the queue | |
170 | */ | |
c3f1b123 | 171 | #define bfa_q_deq(_q, _qe) do { \ |
a36c61f9 KG |
172 | if (!list_empty(_q)) { \ |
173 | (*((struct list_head **) (_qe))) = bfa_q_next(_q); \ | |
174 | bfa_q_prev(bfa_q_next(*((struct list_head **) _qe))) = \ | |
175 | (struct list_head *) (_q); \ | |
176 | bfa_q_next(_q) = bfa_q_next(*((struct list_head **) _qe));\ | |
a36c61f9 KG |
177 | } else { \ |
178 | *((struct list_head **) (_qe)) = (struct list_head *) NULL;\ | |
179 | } \ | |
c3f1b123 | 180 | } while (0) |
a36c61f9 KG |
181 | |
182 | /* | |
183 | * bfa_q_deq_tail - dequeue an element from tail of the queue | |
184 | */ | |
185 | #define bfa_q_deq_tail(_q, _qe) { \ | |
186 | if (!list_empty(_q)) { \ | |
187 | *((struct list_head **) (_qe)) = bfa_q_prev(_q); \ | |
188 | bfa_q_next(bfa_q_prev(*((struct list_head **) _qe))) = \ | |
189 | (struct list_head *) (_q); \ | |
190 | bfa_q_prev(_q) = bfa_q_prev(*(struct list_head **) _qe);\ | |
a36c61f9 KG |
191 | } else { \ |
192 | *((struct list_head **) (_qe)) = (struct list_head *) NULL;\ | |
193 | } \ | |
194 | } | |
195 | ||
196 | static inline int | |
197 | bfa_q_is_on_q_func(struct list_head *q, struct list_head *qe) | |
198 | { | |
199 | struct list_head *tqe; | |
200 | ||
201 | tqe = bfa_q_next(q); | |
202 | while (tqe != q) { | |
203 | if (tqe == qe) | |
204 | return 1; | |
205 | tqe = bfa_q_next(tqe); | |
206 | if (tqe == NULL) | |
207 | break; | |
208 | } | |
209 | return 0; | |
210 | } | |
211 | ||
a36c61f9 KG |
212 | #define bfa_q_is_on_q(_q, _qe) \ |
213 | bfa_q_is_on_q_func(_q, (struct list_head *)(_qe)) | |
214 | ||
acdc79a6 | 215 | /* |
a36c61f9 KG |
216 | * @ BFA state machine interfaces |
217 | */ | |
218 | ||
219 | typedef void (*bfa_sm_t)(void *sm, int event); | |
220 | ||
acdc79a6 | 221 | /* |
a36c61f9 KG |
222 | * oc - object class eg. bfa_ioc |
223 | * st - state, eg. reset | |
224 | * otype - object type, eg. struct bfa_ioc_s | |
225 | * etype - object type, eg. enum ioc_event | |
226 | */ | |
227 | #define bfa_sm_state_decl(oc, st, otype, etype) \ | |
228 | static void oc ## _sm_ ## st(otype * fsm, etype event) | |
229 | ||
230 | #define bfa_sm_set_state(_sm, _state) ((_sm)->sm = (bfa_sm_t)(_state)) | |
231 | #define bfa_sm_send_event(_sm, _event) ((_sm)->sm((_sm), (_event))) | |
232 | #define bfa_sm_get_state(_sm) ((_sm)->sm) | |
233 | #define bfa_sm_cmp_state(_sm, _state) ((_sm)->sm == (bfa_sm_t)(_state)) | |
234 | ||
acdc79a6 | 235 | /* |
a36c61f9 KG |
236 | * For converting from state machine function to state encoding. |
237 | */ | |
238 | struct bfa_sm_table_s { | |
239 | bfa_sm_t sm; /* state machine function */ | |
240 | int state; /* state machine encoding */ | |
241 | char *name; /* state name for display */ | |
242 | }; | |
243 | #define BFA_SM(_sm) ((bfa_sm_t)(_sm)) | |
244 | ||
acdc79a6 | 245 | /* |
a36c61f9 KG |
246 | * State machine with entry actions. |
247 | */ | |
248 | typedef void (*bfa_fsm_t)(void *fsm, int event); | |
249 | ||
acdc79a6 | 250 | /* |
a36c61f9 KG |
251 | * oc - object class eg. bfa_ioc |
252 | * st - state, eg. reset | |
253 | * otype - object type, eg. struct bfa_ioc_s | |
254 | * etype - object type, eg. enum ioc_event | |
255 | */ | |
256 | #define bfa_fsm_state_decl(oc, st, otype, etype) \ | |
257 | static void oc ## _sm_ ## st(otype * fsm, etype event); \ | |
258 | static void oc ## _sm_ ## st ## _entry(otype * fsm) | |
259 | ||
260 | #define bfa_fsm_set_state(_fsm, _state) do { \ | |
261 | (_fsm)->fsm = (bfa_fsm_t)(_state); \ | |
262 | _state ## _entry(_fsm); \ | |
263 | } while (0) | |
264 | ||
265 | #define bfa_fsm_send_event(_fsm, _event) ((_fsm)->fsm((_fsm), (_event))) | |
266 | #define bfa_fsm_get_state(_fsm) ((_fsm)->fsm) | |
267 | #define bfa_fsm_cmp_state(_fsm, _state) \ | |
268 | ((_fsm)->fsm == (bfa_fsm_t)(_state)) | |
269 | ||
270 | static inline int | |
271 | bfa_sm_to_state(struct bfa_sm_table_s *smt, bfa_sm_t sm) | |
272 | { | |
273 | int i = 0; | |
274 | ||
275 | while (smt[i].sm && smt[i].sm != sm) | |
276 | i++; | |
277 | return smt[i].state; | |
278 | } | |
279 | ||
acdc79a6 | 280 | /* |
a36c61f9 KG |
281 | * @ Generic wait counter. |
282 | */ | |
283 | ||
284 | typedef void (*bfa_wc_resume_t) (void *cbarg); | |
285 | ||
286 | struct bfa_wc_s { | |
287 | bfa_wc_resume_t wc_resume; | |
288 | void *wc_cbarg; | |
289 | int wc_count; | |
290 | }; | |
291 | ||
292 | static inline void | |
293 | bfa_wc_up(struct bfa_wc_s *wc) | |
294 | { | |
295 | wc->wc_count++; | |
296 | } | |
297 | ||
298 | static inline void | |
299 | bfa_wc_down(struct bfa_wc_s *wc) | |
300 | { | |
301 | wc->wc_count--; | |
302 | if (wc->wc_count == 0) | |
303 | wc->wc_resume(wc->wc_cbarg); | |
304 | } | |
305 | ||
acdc79a6 | 306 | /* |
a36c61f9 KG |
307 | * Initialize a waiting counter. |
308 | */ | |
309 | static inline void | |
310 | bfa_wc_init(struct bfa_wc_s *wc, bfa_wc_resume_t wc_resume, void *wc_cbarg) | |
311 | { | |
312 | wc->wc_resume = wc_resume; | |
313 | wc->wc_cbarg = wc_cbarg; | |
314 | wc->wc_count = 0; | |
315 | bfa_wc_up(wc); | |
316 | } | |
317 | ||
acdc79a6 | 318 | /* |
a36c61f9 KG |
319 | * Wait for counter to reach zero |
320 | */ | |
321 | static inline void | |
322 | bfa_wc_wait(struct bfa_wc_s *wc) | |
323 | { | |
324 | bfa_wc_down(wc); | |
325 | } | |
326 | ||
f16a1750 MZ |
327 | static inline void |
328 | wwn2str(char *wwn_str, u64 wwn) | |
329 | { | |
330 | union { | |
331 | u64 wwn; | |
332 | u8 byte[8]; | |
333 | } w; | |
334 | ||
335 | w.wwn = wwn; | |
336 | sprintf(wwn_str, "%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x", w.byte[0], | |
337 | w.byte[1], w.byte[2], w.byte[3], w.byte[4], w.byte[5], | |
338 | w.byte[6], w.byte[7]); | |
339 | } | |
340 | ||
341 | static inline void | |
342 | fcid2str(char *fcid_str, u32 fcid) | |
343 | { | |
344 | union { | |
345 | u32 fcid; | |
346 | u8 byte[4]; | |
347 | } f; | |
348 | ||
349 | f.fcid = fcid; | |
350 | sprintf(fcid_str, "%02x:%02x:%02x", f.byte[1], f.byte[2], f.byte[3]); | |
351 | } | |
352 | ||
353 | #define bfa_swap_3b(_x) \ | |
354 | ((((_x) & 0xff) << 16) | \ | |
355 | ((_x) & 0x00ff00) | \ | |
356 | (((_x) & 0xff0000) >> 16)) | |
357 | ||
358 | #ifndef __BIG_ENDIAN | |
359 | #define bfa_hton3b(_x) bfa_swap_3b(_x) | |
360 | #else | |
361 | #define bfa_hton3b(_x) (_x) | |
362 | #endif | |
363 | ||
364 | #define bfa_ntoh3b(_x) bfa_hton3b(_x) | |
365 | ||
a36c61f9 | 366 | #endif /* __BFA_CS_H__ */ |