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 rdma_init_func_ramrod_data rdma_init_func;
  67         struct rdma_close_func_ramrod_data rdma_close_func;
  68         struct rdma_register_tid_ramrod_data rdma_register_tid;
  69         struct rdma_deregister_tid_ramrod_data rdma_deregister_tid;
  70         struct roce_create_qp_resp_ramrod_data roce_create_qp_resp;
  71         struct roce_create_qp_req_ramrod_data roce_create_qp_req;
  72         struct roce_modify_qp_resp_ramrod_data roce_modify_qp_resp;
  73         struct roce_modify_qp_req_ramrod_data roce_modify_qp_req;
  74         struct roce_query_qp_resp_ramrod_data roce_query_qp_resp;
  75         struct roce_query_qp_req_ramrod_data roce_query_qp_req;
  76         struct roce_destroy_qp_resp_ramrod_data roce_destroy_qp_resp;
  77         struct roce_destroy_qp_req_ramrod_data roce_destroy_qp_req;
  78         struct rdma_create_cq_ramrod_data rdma_create_cq;
  79         struct rdma_resize_cq_ramrod_data rdma_resize_cq;
  80         struct rdma_destroy_cq_ramrod_data rdma_destroy_cq;
  81         struct rdma_srq_create_ramrod_data rdma_create_srq;
  82         struct rdma_srq_destroy_ramrod_data rdma_destroy_srq;
  83         struct rdma_srq_modify_ramrod_data rdma_modify_srq;
  84
  85         struct iscsi_slow_path_hdr iscsi_empty;
  86         struct iscsi_init_ramrod_params iscsi_init;
  87         struct iscsi_spe_func_dstry iscsi_destroy;
  88         struct iscsi_spe_conn_offload iscsi_conn_offload;
  89         struct iscsi_conn_update_ramrod_params iscsi_conn_update;
  90         struct iscsi_spe_conn_termination iscsi_conn_terminate;
  91
  92         struct vf_start_ramrod_data vf_start;
  93         struct vf_stop_ramrod_data vf_stop;
  94 };
  95
  96 #define EQ_MAX_CREDIT   0xffffffff
  97
  98 enum spq_priority {
  99         QED_SPQ_PRIORITY_NORMAL,
 100         QED_SPQ_PRIORITY_HIGH,
 101 };
 102
 103 union qed_spq_req_comp {
 104         struct qed_spq_comp_cb  cb;
 105         u64                     *done_addr;
 106 };
 107
 108 struct qed_spq_comp_done {
 109         u64     done;
 110         u8      fw_return_code;
 111 };
 112
 113 struct qed_spq_entry {
 114         struct list_head                list;
 115
 116         u8                              flags;
 117
 118         /* HSI slow path element */
 119         struct slow_path_element        elem;
 120
 121         union ramrod_data               ramrod;
 122
 123         enum spq_priority               priority;
 124
 125         /* pending queue for this entry */
 126         struct list_head                *queue;
 127
 128         enum spq_mode                   comp_mode;
 129         struct qed_spq_comp_cb          comp_cb;
 130         struct qed_spq_comp_done        comp_done; /* SPQ_MODE_EBLOCK */
 131 };
 132
 133 struct qed_eq {
 134         struct qed_chain        chain;
 135         u8                      eq_sb_index;    /* index within the SB */
 136         __le16                  *p_fw_cons;     /* ptr to index value */
 137 };
 138
 139 struct qed_consq {
 140         struct qed_chain chain;
 141 };
 142
 143 struct qed_spq {
 144         spinlock_t              lock; /* SPQ lock */
 145
 146         struct list_head        unlimited_pending;
 147         struct list_head        pending;
 148         struct list_head        completion_pending;
 149         struct list_head        free_pool;
 150
 151         struct qed_chain        chain;
 152
 153         /* allocated dma-able memory for spq entries (+ramrod data) */
 154         dma_addr_t              p_phys;
 155         struct qed_spq_entry    *p_virt;
 156
 157 #define SPQ_RING_SIZE \
 158         (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
 159
 160         /* Bitmap for handling out-of-order completions */
 161         DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE);
 162         u8                      comp_bitmap_idx;
 163
 164         /* Statistics */
 165         u32                     unlimited_pending_count;
 166         u32                     normal_count;
 167         u32                     high_count;
 168         u32                     comp_sent_count;
 169         u32                     comp_count;
 170
 171         u32                     cid;
 172 };
 173
 174 /**
 175  * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that
 176  *        Pends it to the future list.
 177  *
 178  * @param p_hwfn
 179  * @param p_req
 180  *
 181  * @return int
 182  */
 183 int qed_spq_post(struct qed_hwfn *p_hwfn,
 184                  struct qed_spq_entry *p_ent,
 185                  u8 *fw_return_code);
 186
 187 /**
 188  * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ.
 189  *
 190  * @param p_hwfn
 191  *
 192  * @return int
 193  */
 194 int qed_spq_alloc(struct qed_hwfn *p_hwfn);
 195
 196 /**
 197  * @brief qed_spq_setup - Reset the SPQ to its start state.
 198  *
 199  * @param p_hwfn
 200  */
 201 void qed_spq_setup(struct qed_hwfn *p_hwfn);
 202
 203 /**
 204  * @brief qed_spq_deallocate - Deallocates the given SPQ struct.
 205  *
 206  * @param p_hwfn
 207  */
 208 void qed_spq_free(struct qed_hwfn *p_hwfn);
 209
 210 /**
 211  * @brief qed_spq_get_entry - Obtain an entrry from the spq
 212  *        free pool list.
 213  *
 214  *
 215  *
 216  * @param p_hwfn
 217  * @param pp_ent
 218  *
 219  * @return int
 220  */
 221 int
 222 qed_spq_get_entry(struct qed_hwfn *p_hwfn,
 223                   struct qed_spq_entry **pp_ent);
 224
 225 /**
 226  * @brief qed_spq_return_entry - Return an entry to spq free
 227  *                                 pool list
 228  *
 229  * @param p_hwfn
 230  * @param p_ent
 231  */
 232 void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
 233                           struct qed_spq_entry *p_ent);
 234 /**
 235  * @brief qed_eq_allocate - Allocates & initializes an EQ struct
 236  *
 237  * @param p_hwfn
 238  * @param num_elem number of elements in the eq
 239  *
 240  * @return struct qed_eq* - a newly allocated structure; NULL upon error.
 241  */
 242 struct qed_eq *qed_eq_alloc(struct qed_hwfn *p_hwfn,
 243                             u16 num_elem);
 244
 245 /**
 246  * @brief qed_eq_setup - Reset the SPQ to its start state.
 247  *
 248  * @param p_hwfn
 249  * @param p_eq
 250  */
 251 void qed_eq_setup(struct qed_hwfn *p_hwfn,
 252                   struct qed_eq *p_eq);
 253
 254 /**
 255  * @brief qed_eq_deallocate - deallocates the given EQ struct.
 256  *
 257  * @param p_hwfn
 258  * @param p_eq
 259  */
 260 void qed_eq_free(struct qed_hwfn *p_hwfn,
 261                  struct qed_eq *p_eq);
 262
 263 /**
 264  * @brief qed_eq_prod_update - update the FW with default EQ producer
 265  *
 266  * @param p_hwfn
 267  * @param prod
 268  */
 269 void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
 270                         u16 prod);
 271
 272 /**
 273  * @brief qed_eq_completion - Completes currently pending EQ elements
 274  *
 275  * @param p_hwfn
 276  * @param cookie
 277  *
 278  * @return int
 279  */
 280 int qed_eq_completion(struct qed_hwfn *p_hwfn,
 281                       void *cookie);
 282
 283 /**
 284  * @brief qed_spq_completion - Completes a single event
 285  *
 286  * @param p_hwfn
 287  * @param echo - echo value from cookie (used for determining completion)
 288  * @param p_data - data from cookie (used in callback function if applicable)
 289  *
 290  * @return int
 291  */
 292 int qed_spq_completion(struct qed_hwfn *p_hwfn,
 293                        __le16 echo,
 294                        u8 fw_return_code,
 295                        union event_ring_data *p_data);
 296
 297 /**
 298  * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
 299  *
 300  * @param p_hwfn
 301  *
 302  * @return u32 - SPQ CID
 303  */
 304 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn);
 305
 306 /**
 307  * @brief qed_consq_alloc - Allocates & initializes an ConsQ
 308  *        struct
 309  *
 310  * @param p_hwfn
 311  *
 312  * @return struct qed_eq* - a newly allocated structure; NULL upon error.
 313  */
 314 struct qed_consq *qed_consq_alloc(struct qed_hwfn *p_hwfn);
 315
 316 /**
 317  * @brief qed_consq_setup - Reset the ConsQ to its start
 318  *        state.
 319  *
 320  * @param p_hwfn
 321  * @param p_eq
 322  */
 323 void qed_consq_setup(struct qed_hwfn *p_hwfn,
 324                      struct qed_consq *p_consq);
 325
 326 /**
 327  * @brief qed_consq_free - deallocates the given ConsQ struct.
 328  *
 329  * @param p_hwfn
 330  * @param p_eq
 331  */
 332 void qed_consq_free(struct qed_hwfn *p_hwfn,
 333                     struct qed_consq *p_consq);
 334
 335 /**
 336  * @file
 337  *
 338  * @brief Slow-hwfn low-level commands (Ramrods) function definitions.
 339  */
 340
 341 #define QED_SP_EQ_COMPLETION  0x01
 342 #define QED_SP_CQE_COMPLETION 0x02
 343
 344 struct qed_sp_init_data {
 345         u32                     cid;
 346         u16                     opaque_fid;
 347
 348         /* Information regarding operation upon sending & completion */
 349         enum spq_mode           comp_mode;
 350         struct qed_spq_comp_cb *p_comp_data;
 351 };
 352
 353 int qed_sp_init_request(struct qed_hwfn *p_hwfn,
 354                         struct qed_spq_entry **pp_ent,
 355                         u8 cmd,
 356                         u8 protocol,
 357                         struct qed_sp_init_data *p_data);
 358
 359 /**
 360  * @brief qed_sp_pf_start - PF Function Start Ramrod
 361  *
 362  * This ramrod is sent to initialize a physical function (PF). It will
 363  * configure the function related parameters and write its completion to the
 364  * event ring specified in the parameters.
 365  *
 366  * Ramrods complete on the common event ring for the PF. This ring is
 367  * allocated by the driver on host memory and its parameters are written
 368  * to the internal RAM of the UStorm by the Function Start Ramrod.
 369  *
 370  * @param p_hwfn
 371  * @param p_tunn
 372  * @param mode
 373  * @param allow_npar_tx_switch
 374  *
 375  * @return int
 376  */
 377
 378 int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
 379                     struct qed_tunn_start_params *p_tunn,
 380                     enum qed_mf_mode mode, bool allow_npar_tx_switch);
 381
 382 /**
 383  * @brief qed_sp_pf_update - PF Function Update Ramrod
 384  *
 385  * This ramrod updates function-related parameters. Every parameter can be
 386  * updated independently, according to configuration flags.
 387  *
 388  * @param p_hwfn
 389  *
 390  * @return int
 391  */
 392
 393 int qed_sp_pf_update(struct qed_hwfn *p_hwfn);
 394
 395 /**
 396  * @brief qed_sp_pf_stop - PF Function Stop Ramrod
 397  *
 398  * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
 399  * sent and the last completion written to the PFs Event Ring. This ramrod also
 400  * deletes the context for the Slowhwfn connection on this PF.
 401  *
 402  * @note Not required for first packet.
 403  *
 404  * @param p_hwfn
 405  *
 406  * @return int
 407  */
 408
 409 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);
 410
 411 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn,
 412                               struct qed_tunn_update_params *p_tunn,
 413                               enum spq_mode comp_mode,
 414                               struct qed_spq_comp_cb *p_comp_data);
 415 /**
 416  * @brief qed_sp_heartbeat_ramrod - Send empty Ramrod
 417  *
 418  * @param p_hwfn
 419  *
 420  * @return int
 421  */
 422
 423 int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn);
 424
 425 #endif