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