drivers/net/ethernet/qlogic/qed/qed_sp.h

   1 /* QLogic qed NIC Driver
   2  * Copyright (c) 2015 QLogic Corporation
   3  *
   4  * This software is available under the terms of the GNU General Public License
   5  * (GPL) Version 2, available from the file COPYING in the main directory of
   6  * this source tree.
   7  */
   8
   9 #ifndef _QED_SP_H
  10 #define _QED_SP_H
  11
  12 #include <linux/types.h>
  13 #include <linux/kernel.h>
  14 #include <linux/list.h>
  15 #include <linux/slab.h>
  16 #include <linux/spinlock.h>
  17 #include <linux/qed/qed_chain.h>
  18 #include "qed.h"
  19 #include "qed_hsi.h"
  20
  21 enum spq_mode {
  22         QED_SPQ_MODE_BLOCK,     /* Client will poll a designated mem. address */
  23         QED_SPQ_MODE_CB,        /* Client supplies a callback */
  24         QED_SPQ_MODE_EBLOCK,    /* QED should block until completion */
  25 };
  26
  27 struct qed_spq_comp_cb {
  28         void    (*function)(struct qed_hwfn *,
  29                             void *,
  30                             union event_ring_data *,
  31                             u8 fw_return_code);
  32         void    *cookie;
  33 };
  34
  35 /**
  36  * @brief qed_eth_cqe_completion - handles the completion of a
  37  *        ramrod on the cqe ring
  38  *
  39  * @param p_hwfn
  40  * @param cqe
  41  *
  42  * @return int
  43  */
  44 int qed_eth_cqe_completion(struct qed_hwfn *p_hwfn,
  45                            struct eth_slow_path_rx_cqe *cqe);
  46
  47 /**
  48  *  @file
  49  *
  50  *  QED Slow-hwfn queue interface
  51  */
  52
  53 union ramrod_data {
  54         struct pf_start_ramrod_data pf_start;
  55         struct pf_update_ramrod_data pf_update;
  56         struct rx_queue_start_ramrod_data rx_queue_start;
  57         struct rx_queue_update_ramrod_data rx_queue_update;
  58         struct rx_queue_stop_ramrod_data rx_queue_stop;
  59         struct tx_queue_start_ramrod_data tx_queue_start;
  60         struct tx_queue_stop_ramrod_data tx_queue_stop;
  61         struct vport_start_ramrod_data vport_start;
  62         struct vport_stop_ramrod_data vport_stop;
  63         struct vport_update_ramrod_data vport_update;
  64         struct vport_filter_update_ramrod_data vport_filter_update;
  65
  66         struct vf_start_ramrod_data vf_start;
  67 };
  68
  69 #define EQ_MAX_CREDIT   0xffffffff
  70
  71 enum spq_priority {
  72         QED_SPQ_PRIORITY_NORMAL,
  73         QED_SPQ_PRIORITY_HIGH,
  74 };
  75
  76 union qed_spq_req_comp {
  77         struct qed_spq_comp_cb  cb;
  78         u64                     *done_addr;
  79 };
  80
  81 struct qed_spq_comp_done {
  82         u64     done;
  83         u8      fw_return_code;
  84 };
  85
  86 struct qed_spq_entry {
  87         struct list_head                list;
  88
  89         u8                              flags;
  90
  91         /* HSI slow path element */
  92         struct slow_path_element        elem;
  93
  94         union ramrod_data               ramrod;
  95
  96         enum spq_priority               priority;
  97
  98         /* pending queue for this entry */
  99         struct list_head                *queue;
 100
 101         enum spq_mode                   comp_mode;
 102         struct qed_spq_comp_cb          comp_cb;
 103         struct qed_spq_comp_done        comp_done; /* SPQ_MODE_EBLOCK */
 104 };
 105
 106 struct qed_eq {
 107         struct qed_chain        chain;
 108         u8                      eq_sb_index;    /* index within the SB */
 109         __le16                  *p_fw_cons;     /* ptr to index value */
 110 };
 111
 112 struct qed_consq {
 113         struct qed_chain chain;
 114 };
 115
 116 struct qed_spq {
 117         spinlock_t              lock; /* SPQ lock */
 118
 119         struct list_head        unlimited_pending;
 120         struct list_head        pending;
 121         struct list_head        completion_pending;
 122         struct list_head        free_pool;
 123
 124         struct qed_chain        chain;
 125
 126         /* allocated dma-able memory for spq entries (+ramrod data) */
 127         dma_addr_t              p_phys;
 128         struct qed_spq_entry    *p_virt;
 129
 130 #define SPQ_RING_SIZE \
 131         (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
 132
 133         /* Bitmap for handling out-of-order completions */
 134         DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE);
 135         u8                      comp_bitmap_idx;
 136
 137         /* Statistics */
 138         u32                     unlimited_pending_count;
 139         u32                     normal_count;
 140         u32                     high_count;
 141         u32                     comp_sent_count;
 142         u32                     comp_count;
 143
 144         u32                     cid;
 145 };
 146
 147 /**
 148  * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that
 149  *        Pends it to the future list.
 150  *
 151  * @param p_hwfn
 152  * @param p_req
 153  *
 154  * @return int
 155  */
 156 int qed_spq_post(struct qed_hwfn *p_hwfn,
 157                  struct qed_spq_entry *p_ent,
 158                  u8 *fw_return_code);
 159
 160 /**
 161  * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ.
 162  *
 163  * @param p_hwfn
 164  *
 165  * @return int
 166  */
 167 int qed_spq_alloc(struct qed_hwfn *p_hwfn);
 168
 169 /**
 170  * @brief qed_spq_setup - Reset the SPQ to its start state.
 171  *
 172  * @param p_hwfn
 173  */
 174 void qed_spq_setup(struct qed_hwfn *p_hwfn);
 175
 176 /**
 177  * @brief qed_spq_deallocate - Deallocates the given SPQ struct.
 178  *
 179  * @param p_hwfn
 180  */
 181 void qed_spq_free(struct qed_hwfn *p_hwfn);
 182
 183 /**
 184  * @brief qed_spq_get_entry - Obtain an entrry from the spq
 185  *        free pool list.
 186  *
 187  *
 188  *
 189  * @param p_hwfn
 190  * @param pp_ent
 191  *
 192  * @return int
 193  */
 194 int
 195 qed_spq_get_entry(struct qed_hwfn *p_hwfn,
 196                   struct qed_spq_entry **pp_ent);
 197
 198 /**
 199  * @brief qed_spq_return_entry - Return an entry to spq free
 200  *                                 pool list
 201  *
 202  * @param p_hwfn
 203  * @param p_ent
 204  */
 205 void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
 206                           struct qed_spq_entry *p_ent);
 207 /**
 208  * @brief qed_eq_allocate - Allocates & initializes an EQ struct
 209  *
 210  * @param p_hwfn
 211  * @param num_elem number of elements in the eq
 212  *
 213  * @return struct qed_eq* - a newly allocated structure; NULL upon error.
 214  */
 215 struct qed_eq *qed_eq_alloc(struct qed_hwfn *p_hwfn,
 216                             u16 num_elem);
 217
 218 /**
 219  * @brief qed_eq_setup - Reset the SPQ to its start state.
 220  *
 221  * @param p_hwfn
 222  * @param p_eq
 223  */
 224 void qed_eq_setup(struct qed_hwfn *p_hwfn,
 225                   struct qed_eq *p_eq);
 226
 227 /**
 228  * @brief qed_eq_deallocate - deallocates the given EQ struct.
 229  *
 230  * @param p_hwfn
 231  * @param p_eq
 232  */
 233 void qed_eq_free(struct qed_hwfn *p_hwfn,
 234                  struct qed_eq *p_eq);
 235
 236 /**
 237  * @brief qed_eq_prod_update - update the FW with default EQ producer
 238  *
 239  * @param p_hwfn
 240  * @param prod
 241  */
 242 void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
 243                         u16 prod);
 244
 245 /**
 246  * @brief qed_eq_completion - Completes currently pending EQ elements
 247  *
 248  * @param p_hwfn
 249  * @param cookie
 250  *
 251  * @return int
 252  */
 253 int qed_eq_completion(struct qed_hwfn *p_hwfn,
 254                       void *cookie);
 255
 256 /**
 257  * @brief qed_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 int
 264  */
 265 int qed_spq_completion(struct qed_hwfn *p_hwfn,
 266                        __le16 echo,
 267                        u8 fw_return_code,
 268                        union event_ring_data *p_data);
 269
 270 /**
 271  * @brief qed_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 qed_spq_get_cid(struct qed_hwfn *p_hwfn);
 278
 279 /**
 280  * @brief qed_consq_alloc - Allocates & initializes an ConsQ
 281  *        struct
 282  *
 283  * @param p_hwfn
 284  *
 285  * @return struct qed_eq* - a newly allocated structure; NULL upon error.
 286  */
 287 struct qed_consq *qed_consq_alloc(struct qed_hwfn *p_hwfn);
 288
 289 /**
 290  * @brief qed_consq_setup - Reset the ConsQ to its start
 291  *        state.
 292  *
 293  * @param p_hwfn
 294  * @param p_eq
 295  */
 296 void qed_consq_setup(struct qed_hwfn *p_hwfn,
 297                      struct qed_consq *p_consq);
 298
 299 /**
 300  * @brief qed_consq_free - deallocates the given ConsQ struct.
 301  *
 302  * @param p_hwfn
 303  * @param p_eq
 304  */
 305 void qed_consq_free(struct qed_hwfn *p_hwfn,
 306                     struct qed_consq *p_consq);
 307
 308 /**
 309  * @file
 310  *
 311  * @brief Slow-hwfn low-level commands (Ramrods) function definitions.
 312  */
 313
 314 #define QED_SP_EQ_COMPLETION  0x01
 315 #define QED_SP_CQE_COMPLETION 0x02
 316
 317 struct qed_sp_init_data {
 318         u32                     cid;
 319         u16                     opaque_fid;
 320
 321         /* Information regarding operation upon sending & completion */
 322         enum spq_mode           comp_mode;
 323         struct qed_spq_comp_cb *p_comp_data;
 324 };
 325
 326 int qed_sp_init_request(struct qed_hwfn *p_hwfn,
 327                         struct qed_spq_entry **pp_ent,
 328                         u8 cmd,
 329                         u8 protocol,
 330                         struct qed_sp_init_data *p_data);
 331
 332 /**
 333  * @brief qed_sp_pf_start - PF Function Start Ramrod
 334  *
 335  * This ramrod is sent to initialize a physical function (PF). It will
 336  * configure the function related parameters and write its completion to the
 337  * event ring specified in the parameters.
 338  *
 339  * Ramrods complete on the common event ring for the PF. This ring is
 340  * allocated by the driver on host memory and its parameters are written
 341  * to the internal RAM of the UStorm by the Function Start Ramrod.
 342  *
 343  * @param p_hwfn
 344  * @param p_tunn
 345  * @param mode
 346  *
 347  * @return int
 348  */
 349
 350 int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
 351                     struct qed_tunn_start_params *p_tunn,
 352                     enum qed_mf_mode mode);
 353
 354 /**
 355  * @brief qed_sp_pf_stop - PF Function Stop Ramrod
 356  *
 357  * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
 358  * sent and the last completion written to the PFs Event Ring. This ramrod also
 359  * deletes the context for the Slowhwfn connection on this PF.
 360  *
 361  * @note Not required for first packet.
 362  *
 363  * @param p_hwfn
 364  *
 365  * @return int
 366  */
 367
 368 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);
 369
 370 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn,
 371                               struct qed_tunn_update_params *p_tunn,
 372                               enum spq_mode comp_mode,
 373                               struct qed_spq_comp_cb *p_comp_data);
 374 /**
 375  * @brief qed_sp_heartbeat_ramrod - Send empty Ramrod
 376  *
 377  * @param p_hwfn
 378  *
 379  * @return int
 380  */
 381
 382 int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn);
 383
 384 #endif