kernel/drivers/net/ethernet/brocade/bna/bfa_cs.h

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