drivers/scsi/bfa/bfa_cs.h

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