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 typedef enum _ecore_status_t
  90 (*ecore_spq_async_comp_cb)(struct ecore_hwfn *p_hwfn,
  91                            u8 opcode,
  92                            u16 echo,
  93                            union event_ring_data *data,
  94                            u8 fw_return_code);
  95
  96 enum _ecore_status_t
  97 ecore_spq_register_async_cb(struct ecore_hwfn *p_hwfn,
  98                             enum protocol_type protocol_id,
  99                             ecore_spq_async_comp_cb cb);
 100
 101 void
 102 ecore_spq_unregister_async_cb(struct ecore_hwfn *p_hwfn,
 103                               enum protocol_type protocol_id);
 104
 105 struct ecore_spq {
 106         osal_spinlock_t                 lock;
 107
 108         osal_list_t                     unlimited_pending;
 109         osal_list_t                     pending;
 110         osal_list_t                     completion_pending;
 111         osal_list_t                     free_pool;
 112
 113         struct ecore_chain              chain;
 114
 115         /* allocated dma-able memory for spq entries (+ramrod data) */
 116         dma_addr_t                      p_phys;
 117         struct ecore_spq_entry          *p_virt;
 118
 119         /* Bitmap for handling out-of-order completions */
 120 #define SPQ_RING_SIZE           \
 121         (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
 122 /* BITS_PER_LONG */
 123 #define SPQ_COMP_BMAP_SIZE      (SPQ_RING_SIZE / (sizeof(unsigned long) * 8))
 124         unsigned long                   p_comp_bitmap[SPQ_COMP_BMAP_SIZE];
 125         u8                              comp_bitmap_idx;
 126 #define SPQ_COMP_BMAP_SET_BIT(p_spq, idx)                               \
 127         (OSAL_SET_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
 128
 129 #define SPQ_COMP_BMAP_CLEAR_BIT(p_spq, idx)                             \
 130         (OSAL_CLEAR_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
 131
 132 #define SPQ_COMP_BMAP_TEST_BIT(p_spq, idx)      \
 133         (OSAL_TEST_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
 134
 135         /* Statistics */
 136         u32                             unlimited_pending_count;
 137         u32                             normal_count;
 138         u32                             high_count;
 139         u32                             comp_sent_count;
 140         u32                             comp_count;
 141
 142         u32                             cid;
 143
 144         u32                             db_addr_offset;
 145         struct core_db_data             db_data;
 146         ecore_spq_async_comp_cb         async_comp_cb[MAX_PROTOCOL_TYPE];
 147 };
 148
 149 struct ecore_port;
 150 struct ecore_hwfn;
 151
 152 /**
 153  * @brief ecore_spq_post - Posts a Slow hwfn request to FW, or lacking that
 154  *        Pends it to the future list.
 155  *
 156  * @param p_hwfn
 157  * @param p_req
 158  *
 159  * @return enum _ecore_status_t
 160  */
 161 enum _ecore_status_t ecore_spq_post(struct ecore_hwfn      *p_hwfn,
 162                                     struct ecore_spq_entry *p_ent,
 163                                     u8                     *fw_return_code);
 164
 165 /**
 166  * @brief ecore_spq_allocate - Alloocates & initializes the SPQ and EQ.
 167  *
 168  * @param p_hwfn
 169  *
 170  * @return enum _ecore_status_t
 171  */
 172 enum _ecore_status_t ecore_spq_alloc(struct ecore_hwfn  *p_hwfn);
 173
 174 /**
 175  * @brief ecore_spq_setup - Reset the SPQ to its start state.
 176  *
 177  * @param p_hwfn
 178  */
 179 void ecore_spq_setup(struct ecore_hwfn *p_hwfn);
 180
 181 /**
 182  * @brief ecore_spq_deallocate - Deallocates the given SPQ struct.
 183  *
 184  * @param p_hwfn
 185  */
 186 void ecore_spq_free(struct ecore_hwfn *p_hwfn);
 187
 188 /**
 189  * @brief ecore_spq_get_entry - Obtain an entrry from the spq
 190  *        free pool list.
 191  *
 192  *
 193  *
 194  * @param p_hwfn
 195  * @param pp_ent
 196  *
 197  * @return enum _ecore_status_t
 198  */
 199 enum _ecore_status_t
 200 ecore_spq_get_entry(struct ecore_hwfn           *p_hwfn,
 201                     struct ecore_spq_entry      **pp_ent);
 202
 203 /**
 204  * @brief ecore_spq_return_entry - Return an entry to spq free
 205  *                                 pool list
 206  *
 207  * @param p_hwfn
 208  * @param p_ent
 209  */
 210 void ecore_spq_return_entry(struct ecore_hwfn           *p_hwfn,
 211                             struct ecore_spq_entry      *p_ent);
 212 /**
 213  * @brief ecore_eq_allocate - Allocates & initializes an EQ struct
 214  *
 215  * @param p_hwfn
 216  * @param num_elem number of elements in the eq
 217  *
 218  * @return enum _ecore_status_t
 219  */
 220 enum _ecore_status_t ecore_eq_alloc(struct ecore_hwfn   *p_hwfn, u16 num_elem);
 221
 222 /**
 223  * @brief ecore_eq_setup - Reset the EQ to its start state.
 224  *
 225  * @param p_hwfn
 226  */
 227 void ecore_eq_setup(struct ecore_hwfn *p_hwfn);
 228
 229 /**
 230  * @brief ecore_eq_free - deallocates the given EQ struct.
 231  *
 232  * @param p_hwfn
 233  */
 234 void ecore_eq_free(struct ecore_hwfn *p_hwfn);
 235
 236 /**
 237  * @brief ecore_eq_prod_update - update the FW with default EQ producer
 238  *
 239  * @param p_hwfn
 240  * @param prod
 241  */
 242 void ecore_eq_prod_update(struct ecore_hwfn     *p_hwfn,
 243                           u16                   prod);
 244
 245 /**
 246  * @brief ecore_eq_completion - Completes currently pending EQ elements
 247  *
 248  * @param p_hwfn
 249  * @param cookie
 250  *
 251  * @return enum _ecore_status_t
 252  */
 253 enum _ecore_status_t ecore_eq_completion(struct ecore_hwfn      *p_hwfn,
 254                                          void                   *cookie);
 255
 256 /**
 257  * @brief ecore_spq_completion - Completes a single event
 258  *
 259  * @param p_hwfn
 260  * @param echo - echo value from cookie (used for determining completion)
 261  * @param p_data - data from cookie (used in callback function if applicable)
 262  *
 263  * @return enum _ecore_status_t
 264  */
 265 enum _ecore_status_t ecore_spq_completion(struct ecore_hwfn     *p_hwfn,
 266                                           __le16                echo,
 267                                           u8                    fw_return_code,
 268                                           union event_ring_data *p_data);
 269
 270 /**
 271  * @brief ecore_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
 272  *
 273  * @param p_hwfn
 274  *
 275  * @return u32 - SPQ CID
 276  */
 277 u32 ecore_spq_get_cid(struct ecore_hwfn *p_hwfn);
 278
 279 /**
 280  * @brief ecore_consq_alloc - Allocates & initializes an ConsQ struct
 281  *
 282  * @param p_hwfn
 283  *
 284  * @return enum _ecore_status_t
 285  */
 286 enum _ecore_status_t ecore_consq_alloc(struct ecore_hwfn *p_hwfn);
 287
 288 /**
 289  * @brief ecore_consq_setup - Reset the ConsQ to its start state.
 290  *
 291  * @param p_hwfn
 292  */
 293 void ecore_consq_setup(struct ecore_hwfn *p_hwfn);
 294
 295 /**
 296  * @brief ecore_consq_free - deallocates the given ConsQ struct.
 297  *
 298  * @param p_hwfn
 299  */
 300 void ecore_consq_free(struct ecore_hwfn *p_hwfn);
 301
 302 #endif /* __ECORE_SPQ_H__ */