drivers/net/qede/base/ecore_spq.h

   1 /*
   2  * Copyright (c) 2016 QLogic Corporation.
   3  * All rights reserved.
   4  * www.qlogic.com
   5  *
   6  * See LICENSE.qede_pmd for copyright and licensing details.
   7  */
   8
   9 #ifndef __ECORE_SPQ_H__
  10 #define __ECORE_SPQ_H__
  11
  12 #include "ecore_hsi_common.h"
  13 #include "ecore_status.h"
  14 #include "ecore_hsi_eth.h"
  15 #include "ecore_chain.h"
  16 #include "ecore_sp_api.h"
  17
  18 union ramrod_data {
  19         struct pf_start_ramrod_data                     pf_start;
  20         struct pf_update_ramrod_data                    pf_update;
  21         struct rl_update_ramrod_data                    rl_update;
  22         struct rx_queue_start_ramrod_data               rx_queue_start;
  23         struct rx_queue_update_ramrod_data              rx_queue_update;
  24         struct rx_queue_stop_ramrod_data                rx_queue_stop;
  25         struct tx_queue_start_ramrod_data               tx_queue_start;
  26         struct tx_queue_stop_ramrod_data                tx_queue_stop;
  27         struct vport_start_ramrod_data                  vport_start;
  28         struct vport_stop_ramrod_data                   vport_stop;
  29         struct rx_update_gft_filter_data                rx_update_gft;
  30         struct vport_update_ramrod_data                 vport_update;
  31         struct core_rx_start_ramrod_data                core_rx_queue_start;
  32         struct core_rx_stop_ramrod_data                 core_rx_queue_stop;
  33         struct core_tx_start_ramrod_data                core_tx_queue_start;
  34         struct core_tx_stop_ramrod_data                 core_tx_queue_stop;
  35         struct vport_filter_update_ramrod_data          vport_filter_update;
  36
  37         struct vf_start_ramrod_data                     vf_start;
  38         struct vf_stop_ramrod_data                      vf_stop;
  39 };
  40
  41 #define EQ_MAX_CREDIT   0xffffffff
  42
  43 enum spq_priority {
  44         ECORE_SPQ_PRIORITY_NORMAL,
  45         ECORE_SPQ_PRIORITY_HIGH,
  46 };
  47
  48 union ecore_spq_req_comp {
  49         struct ecore_spq_comp_cb cb;
  50         u64                      *done_addr;
  51 };
  52
  53 /* SPQ_MODE_EBLOCK */
  54 struct ecore_spq_comp_done {
  55         u64 done;
  56         u8  fw_return_code;
  57 };
  58
  59 struct ecore_spq_entry {
  60         osal_list_entry_t               list;
  61
  62         u8                              flags;
  63
  64         /* HSI slow path element */
  65         struct slow_path_element        elem;
  66
  67         union ramrod_data               ramrod;
  68
  69         enum spq_priority               priority;
  70
  71         /* pending queue for this entry */
  72         osal_list_t                     *queue;
  73
  74         enum spq_mode                   comp_mode;
  75         struct ecore_spq_comp_cb        comp_cb;
  76         struct ecore_spq_comp_done      comp_done; /* SPQ_MODE_EBLOCK */
  77 };
  78
  79 struct ecore_eq {
  80         struct ecore_chain      chain;
  81         u8                      eq_sb_index;    /* index within the SB */
  82         __le16                  *p_fw_cons;     /* ptr to index value */
  83 };
  84
  85 struct ecore_consq {
  86         struct ecore_chain      chain;
  87 };
  88
  89 struct ecore_spq {
  90         osal_spinlock_t                 lock;
  91
  92         osal_list_t                     unlimited_pending;
  93         osal_list_t                     pending;
  94         osal_list_t                     completion_pending;
  95         osal_list_t                     free_pool;
  96
  97         struct ecore_chain              chain;
  98
  99         /* allocated dma-able memory for spq entries (+ramrod data) */
 100         dma_addr_t                      p_phys;
 101         struct ecore_spq_entry          *p_virt;
 102
 103         /* Bitmap for handling out-of-order completions */
 104 #define SPQ_RING_SIZE           \
 105         (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
 106 /* BITS_PER_LONG */
 107 #define SPQ_COMP_BMAP_SIZE      (SPQ_RING_SIZE / (sizeof(unsigned long) * 8))
 108         unsigned long                   p_comp_bitmap[SPQ_COMP_BMAP_SIZE];
 109         u8                              comp_bitmap_idx;
 110 #define SPQ_COMP_BMAP_SET_BIT(p_spq, idx)                               \
 111         (OSAL_SET_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
 112
 113 #define SPQ_COMP_BMAP_CLEAR_BIT(p_spq, idx)                             \
 114         (OSAL_CLEAR_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
 115
 116 #define SPQ_COMP_BMAP_TEST_BIT(p_spq, idx)      \
 117         (OSAL_TEST_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
 118
 119         /* Statistics */
 120         u32                             unlimited_pending_count;
 121         u32                             normal_count;
 122         u32                             high_count;
 123         u32                             comp_sent_count;
 124         u32                             comp_count;
 125
 126         u32                             cid;
 127 };
 128
 129 struct ecore_port;
 130 struct ecore_hwfn;
 131
 132 /**
 133  * @brief ecore_spq_post - Posts a Slow hwfn request to FW, or lacking that
 134  *        Pends it to the future list.
 135  *
 136  * @param p_hwfn
 137  * @param p_req
 138  *
 139  * @return enum _ecore_status_t
 140  */
 141 enum _ecore_status_t ecore_spq_post(struct ecore_hwfn      *p_hwfn,
 142                                     struct ecore_spq_entry *p_ent,
 143                                     u8                     *fw_return_code);
 144
 145 /**
 146  * @brief ecore_spq_allocate - Alloocates & initializes the SPQ and EQ.
 147  *
 148  * @param p_hwfn
 149  *
 150  * @return enum _ecore_status_t
 151  */
 152 enum _ecore_status_t ecore_spq_alloc(struct ecore_hwfn  *p_hwfn);
 153
 154 /**
 155  * @brief ecore_spq_setup - Reset the SPQ to its start state.
 156  *
 157  * @param p_hwfn
 158  */
 159 void ecore_spq_setup(struct ecore_hwfn *p_hwfn);
 160
 161 /**
 162  * @brief ecore_spq_deallocate - Deallocates the given SPQ struct.
 163  *
 164  * @param p_hwfn
 165  */
 166 void ecore_spq_free(struct ecore_hwfn *p_hwfn);
 167
 168 /**
 169  * @brief ecore_spq_get_entry - Obtain an entrry from the spq
 170  *        free pool list.
 171  *
 172  *
 173  *
 174  * @param p_hwfn
 175  * @param pp_ent
 176  *
 177  * @return enum _ecore_status_t
 178  */
 179 enum _ecore_status_t
 180 ecore_spq_get_entry(struct ecore_hwfn           *p_hwfn,
 181                     struct ecore_spq_entry      **pp_ent);
 182
 183 /**
 184  * @brief ecore_spq_return_entry - Return an entry to spq free
 185  *                                 pool list
 186  *
 187  * @param p_hwfn
 188  * @param p_ent
 189  */
 190 void ecore_spq_return_entry(struct ecore_hwfn           *p_hwfn,
 191                             struct ecore_spq_entry      *p_ent);
 192 /**
 193  * @brief ecore_eq_allocate - Allocates & initializes an EQ struct
 194  *
 195  * @param p_hwfn
 196  * @param num_elem number of elements in the eq
 197  *
 198  * @return enum _ecore_status_t
 199  */
 200 enum _ecore_status_t ecore_eq_alloc(struct ecore_hwfn   *p_hwfn, u16 num_elem);
 201
 202 /**
 203  * @brief ecore_eq_setup - Reset the EQ to its start state.
 204  *
 205  * @param p_hwfn
 206  */
 207 void ecore_eq_setup(struct ecore_hwfn *p_hwfn);
 208
 209 /**
 210  * @brief ecore_eq_free - deallocates the given EQ struct.
 211  *
 212  * @param p_hwfn
 213  */
 214 void ecore_eq_free(struct ecore_hwfn *p_hwfn);
 215
 216 /**
 217  * @brief ecore_eq_prod_update - update the FW with default EQ producer
 218  *
 219  * @param p_hwfn
 220  * @param prod
 221  */
 222 void ecore_eq_prod_update(struct ecore_hwfn     *p_hwfn,
 223                           u16                   prod);
 224
 225 /**
 226  * @brief ecore_eq_completion - Completes currently pending EQ elements
 227  *
 228  * @param p_hwfn
 229  * @param cookie
 230  *
 231  * @return enum _ecore_status_t
 232  */
 233 enum _ecore_status_t ecore_eq_completion(struct ecore_hwfn      *p_hwfn,
 234                                          void                   *cookie);
 235
 236 /**
 237  * @brief ecore_spq_completion - Completes a single event
 238  *
 239  * @param p_hwfn
 240  * @param echo - echo value from cookie (used for determining completion)
 241  * @param p_data - data from cookie (used in callback function if applicable)
 242  *
 243  * @return enum _ecore_status_t
 244  */
 245 enum _ecore_status_t ecore_spq_completion(struct ecore_hwfn     *p_hwfn,
 246                                           __le16                echo,
 247                                           u8                    fw_return_code,
 248                                           union event_ring_data *p_data);
 249
 250 /**
 251  * @brief ecore_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
 252  *
 253  * @param p_hwfn
 254  *
 255  * @return u32 - SPQ CID
 256  */
 257 u32 ecore_spq_get_cid(struct ecore_hwfn *p_hwfn);
 258
 259 /**
 260  * @brief ecore_consq_alloc - Allocates & initializes an ConsQ struct
 261  *
 262  * @param p_hwfn
 263  *
 264  * @return enum _ecore_status_t
 265  */
 266 enum _ecore_status_t ecore_consq_alloc(struct ecore_hwfn *p_hwfn);
 267
 268 /**
 269  * @brief ecore_consq_setup - Reset the ConsQ to its start state.
 270  *
 271  * @param p_hwfn
 272  */
 273 void ecore_consq_setup(struct ecore_hwfn *p_hwfn);
 274
 275 /**
 276  * @brief ecore_consq_free - deallocates the given ConsQ struct.
 277  *
 278  * @param p_hwfn
 279  */
 280 void ecore_consq_free(struct ecore_hwfn *p_hwfn);
 281
 282 #endif /* __ECORE_SPQ_H__ */