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

   1 /* QLogic qed NIC Driver
   2  * Copyright (c) 2015-2017  QLogic Corporation
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and /or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #ifndef _QED_SP_H
  34 #define _QED_SP_H
  35
  36 #include <linux/types.h>
  37 #include <linux/kernel.h>
  38 #include <linux/list.h>
  39 #include <linux/slab.h>
  40 #include <linux/spinlock.h>
  41 #include <linux/qed/qed_chain.h>
  42 #include "qed.h"
  43 #include "qed_hsi.h"
  44
  45 enum spq_mode {
  46         QED_SPQ_MODE_BLOCK,     /* Client will poll a designated mem. address */
  47         QED_SPQ_MODE_CB,        /* Client supplies a callback */
  48         QED_SPQ_MODE_EBLOCK,    /* QED should block until completion */
  49 };
  50
  51 struct qed_spq_comp_cb {
  52         void    (*function)(struct qed_hwfn *,
  53                             void *,
  54                             union event_ring_data *,
  55                             u8 fw_return_code);
  56         void    *cookie;
  57 };
  58
  59 /**
  60  * @brief qed_eth_cqe_completion - handles the completion of a
  61  *        ramrod on the cqe ring
  62  *
  63  * @param p_hwfn
  64  * @param cqe
  65  *
  66  * @return int
  67  */
  68 int qed_eth_cqe_completion(struct qed_hwfn *p_hwfn,
  69                            struct eth_slow_path_rx_cqe *cqe);
  70
  71 /**
  72  *  @file
  73  *
  74  *  QED Slow-hwfn queue interface
  75  */
  76
  77 union ramrod_data {
  78         struct pf_start_ramrod_data pf_start;
  79         struct pf_update_ramrod_data pf_update;
  80         struct rx_queue_start_ramrod_data rx_queue_start;
  81         struct rx_queue_update_ramrod_data rx_queue_update;
  82         struct rx_queue_stop_ramrod_data rx_queue_stop;
  83         struct tx_queue_start_ramrod_data tx_queue_start;
  84         struct tx_queue_stop_ramrod_data tx_queue_stop;
  85         struct vport_start_ramrod_data vport_start;
  86         struct vport_stop_ramrod_data vport_stop;
  87         struct rx_update_gft_filter_data rx_update_gft;
  88         struct vport_update_ramrod_data vport_update;
  89         struct core_rx_start_ramrod_data core_rx_queue_start;
  90         struct core_rx_stop_ramrod_data core_rx_queue_stop;
  91         struct core_tx_start_ramrod_data core_tx_queue_start;
  92         struct core_tx_stop_ramrod_data core_tx_queue_stop;
  93         struct vport_filter_update_ramrod_data vport_filter_update;
  94
  95         struct rdma_init_func_ramrod_data rdma_init_func;
  96         struct rdma_close_func_ramrod_data rdma_close_func;
  97         struct rdma_register_tid_ramrod_data rdma_register_tid;
  98         struct rdma_deregister_tid_ramrod_data rdma_deregister_tid;
  99         struct roce_create_qp_resp_ramrod_data roce_create_qp_resp;
 100         struct roce_create_qp_req_ramrod_data roce_create_qp_req;
 101         struct roce_modify_qp_resp_ramrod_data roce_modify_qp_resp;
 102         struct roce_modify_qp_req_ramrod_data roce_modify_qp_req;
 103         struct roce_query_qp_resp_ramrod_data roce_query_qp_resp;
 104         struct roce_query_qp_req_ramrod_data roce_query_qp_req;
 105         struct roce_destroy_qp_resp_ramrod_data roce_destroy_qp_resp;
 106         struct roce_destroy_qp_req_ramrod_data roce_destroy_qp_req;
 107         struct rdma_create_cq_ramrod_data rdma_create_cq;
 108         struct rdma_destroy_cq_ramrod_data rdma_destroy_cq;
 109         struct rdma_srq_create_ramrod_data rdma_create_srq;
 110         struct rdma_srq_destroy_ramrod_data rdma_destroy_srq;
 111         struct rdma_srq_modify_ramrod_data rdma_modify_srq;
 112         struct roce_init_func_ramrod_data roce_init_func;
 113         struct fcoe_init_ramrod_params fcoe_init;
 114         struct fcoe_conn_offload_ramrod_params fcoe_conn_ofld;
 115         struct fcoe_conn_terminate_ramrod_params fcoe_conn_terminate;
 116         struct fcoe_stat_ramrod_params fcoe_stat;
 117
 118         struct iscsi_slow_path_hdr iscsi_empty;
 119         struct iscsi_init_ramrod_params iscsi_init;
 120         struct iscsi_spe_func_dstry iscsi_destroy;
 121         struct iscsi_spe_conn_offload iscsi_conn_offload;
 122         struct iscsi_conn_update_ramrod_params iscsi_conn_update;
 123         struct iscsi_spe_conn_termination iscsi_conn_terminate;
 124
 125         struct vf_start_ramrod_data vf_start;
 126         struct vf_stop_ramrod_data vf_stop;
 127 };
 128
 129 #define EQ_MAX_CREDIT   0xffffffff
 130
 131 enum spq_priority {
 132         QED_SPQ_PRIORITY_NORMAL,
 133         QED_SPQ_PRIORITY_HIGH,
 134 };
 135
 136 union qed_spq_req_comp {
 137         struct qed_spq_comp_cb  cb;
 138         u64                     *done_addr;
 139 };
 140
 141 struct qed_spq_comp_done {
 142         unsigned int    done;
 143         u8              fw_return_code;
 144 };
 145
 146 struct qed_spq_entry {
 147         struct list_head                list;
 148
 149         u8                              flags;
 150
 151         /* HSI slow path element */
 152         struct slow_path_element        elem;
 153
 154         union ramrod_data               ramrod;
 155
 156         enum spq_priority               priority;
 157
 158         /* pending queue for this entry */
 159         struct list_head                *queue;
 160
 161         enum spq_mode                   comp_mode;
 162         struct qed_spq_comp_cb          comp_cb;
 163         struct qed_spq_comp_done        comp_done; /* SPQ_MODE_EBLOCK */
 164 };
 165
 166 struct qed_eq {
 167         struct qed_chain        chain;
 168         u8                      eq_sb_index;    /* index within the SB */
 169         __le16                  *p_fw_cons;     /* ptr to index value */
 170 };
 171
 172 struct qed_consq {
 173         struct qed_chain chain;
 174 };
 175
 176 struct qed_spq {
 177         spinlock_t              lock; /* SPQ lock */
 178
 179         struct list_head        unlimited_pending;
 180         struct list_head        pending;
 181         struct list_head        completion_pending;
 182         struct list_head        free_pool;
 183
 184         struct qed_chain        chain;
 185
 186         /* allocated dma-able memory for spq entries (+ramrod data) */
 187         dma_addr_t              p_phys;
 188         struct qed_spq_entry    *p_virt;
 189
 190 #define SPQ_RING_SIZE \
 191         (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
 192
 193         /* Bitmap for handling out-of-order completions */
 194         DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE);
 195         u8                      comp_bitmap_idx;
 196
 197         /* Statistics */
 198         u32                     unlimited_pending_count;
 199         u32                     normal_count;
 200         u32                     high_count;
 201         u32                     comp_sent_count;
 202         u32                     comp_count;
 203
 204         u32                     cid;
 205 };
 206
 207 /**
 208  * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that
 209  *        Pends it to the future list.
 210  *
 211  * @param p_hwfn
 212  * @param p_req
 213  *
 214  * @return int
 215  */
 216 int qed_spq_post(struct qed_hwfn *p_hwfn,
 217                  struct qed_spq_entry *p_ent,
 218                  u8 *fw_return_code);
 219
 220 /**
 221  * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ.
 222  *
 223  * @param p_hwfn
 224  *
 225  * @return int
 226  */
 227 int qed_spq_alloc(struct qed_hwfn *p_hwfn);
 228
 229 /**
 230  * @brief qed_spq_setup - Reset the SPQ to its start state.
 231  *
 232  * @param p_hwfn
 233  */
 234 void qed_spq_setup(struct qed_hwfn *p_hwfn);
 235
 236 /**
 237  * @brief qed_spq_deallocate - Deallocates the given SPQ struct.
 238  *
 239  * @param p_hwfn
 240  */
 241 void qed_spq_free(struct qed_hwfn *p_hwfn);
 242
 243 /**
 244  * @brief qed_spq_get_entry - Obtain an entrry from the spq
 245  *        free pool list.
 246  *
 247  *
 248  *
 249  * @param p_hwfn
 250  * @param pp_ent
 251  *
 252  * @return int
 253  */
 254 int
 255 qed_spq_get_entry(struct qed_hwfn *p_hwfn,
 256                   struct qed_spq_entry **pp_ent);
 257
 258 /**
 259  * @brief qed_spq_return_entry - Return an entry to spq free
 260  *                                 pool list
 261  *
 262  * @param p_hwfn
 263  * @param p_ent
 264  */
 265 void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
 266                           struct qed_spq_entry *p_ent);
 267 /**
 268  * @brief qed_eq_allocate - Allocates & initializes an EQ struct
 269  *
 270  * @param p_hwfn
 271  * @param num_elem number of elements in the eq
 272  *
 273  * @return int
 274  */
 275 int qed_eq_alloc(struct qed_hwfn *p_hwfn, u16 num_elem);
 276
 277 /**
 278  * @brief qed_eq_setup - Reset the EQ to its start state.
 279  *
 280  * @param p_hwfn
 281  */
 282 void qed_eq_setup(struct qed_hwfn *p_hwfn);
 283
 284 /**
 285  * @brief qed_eq_free - deallocates the given EQ struct.
 286  *
 287  * @param p_hwfn
 288  */
 289 void qed_eq_free(struct qed_hwfn *p_hwfn);
 290
 291 /**
 292  * @brief qed_eq_prod_update - update the FW with default EQ producer
 293  *
 294  * @param p_hwfn
 295  * @param prod
 296  */
 297 void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
 298                         u16 prod);
 299
 300 /**
 301  * @brief qed_eq_completion - Completes currently pending EQ elements
 302  *
 303  * @param p_hwfn
 304  * @param cookie
 305  *
 306  * @return int
 307  */
 308 int qed_eq_completion(struct qed_hwfn *p_hwfn,
 309                       void *cookie);
 310
 311 /**
 312  * @brief qed_spq_completion - Completes a single event
 313  *
 314  * @param p_hwfn
 315  * @param echo - echo value from cookie (used for determining completion)
 316  * @param p_data - data from cookie (used in callback function if applicable)
 317  *
 318  * @return int
 319  */
 320 int qed_spq_completion(struct qed_hwfn *p_hwfn,
 321                        __le16 echo,
 322                        u8 fw_return_code,
 323                        union event_ring_data *p_data);
 324
 325 /**
 326  * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
 327  *
 328  * @param p_hwfn
 329  *
 330  * @return u32 - SPQ CID
 331  */
 332 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn);
 333
 334 /**
 335  * @brief qed_consq_alloc - Allocates & initializes an ConsQ
 336  *        struct
 337  *
 338  * @param p_hwfn
 339  *
 340  * @return int
 341  */
 342 int qed_consq_alloc(struct qed_hwfn *p_hwfn);
 343
 344 /**
 345  * @brief qed_consq_setup - Reset the ConsQ to its start state.
 346  *
 347  * @param p_hwfn
 348  */
 349 void qed_consq_setup(struct qed_hwfn *p_hwfn);
 350
 351 /**
 352  * @brief qed_consq_free - deallocates the given ConsQ struct.
 353  *
 354  * @param p_hwfn
 355  */
 356 void qed_consq_free(struct qed_hwfn *p_hwfn);
 357
 358 /**
 359  * @file
 360  *
 361  * @brief Slow-hwfn low-level commands (Ramrods) function definitions.
 362  */
 363
 364 #define QED_SP_EQ_COMPLETION  0x01
 365 #define QED_SP_CQE_COMPLETION 0x02
 366
 367 struct qed_sp_init_data {
 368         u32                     cid;
 369         u16                     opaque_fid;
 370
 371         /* Information regarding operation upon sending & completion */
 372         enum spq_mode           comp_mode;
 373         struct qed_spq_comp_cb *p_comp_data;
 374 };
 375
 376 int qed_sp_init_request(struct qed_hwfn *p_hwfn,
 377                         struct qed_spq_entry **pp_ent,
 378                         u8 cmd,
 379                         u8 protocol,
 380                         struct qed_sp_init_data *p_data);
 381
 382 /**
 383  * @brief qed_sp_pf_start - PF Function Start Ramrod
 384  *
 385  * This ramrod is sent to initialize a physical function (PF). It will
 386  * configure the function related parameters and write its completion to the
 387  * event ring specified in the parameters.
 388  *
 389  * Ramrods complete on the common event ring for the PF. This ring is
 390  * allocated by the driver on host memory and its parameters are written
 391  * to the internal RAM of the UStorm by the Function Start Ramrod.
 392  *
 393  * @param p_hwfn
 394  * @param p_tunn
 395  * @param mode
 396  * @param allow_npar_tx_switch
 397  *
 398  * @return int
 399  */
 400
 401 int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
 402                     struct qed_tunnel_info *p_tunn,
 403                     enum qed_mf_mode mode, bool allow_npar_tx_switch);
 404
 405 /**
 406  * @brief qed_sp_pf_update - PF Function Update Ramrod
 407  *
 408  * This ramrod updates function-related parameters. Every parameter can be
 409  * updated independently, according to configuration flags.
 410  *
 411  * @param p_hwfn
 412  *
 413  * @return int
 414  */
 415
 416 int qed_sp_pf_update(struct qed_hwfn *p_hwfn);
 417
 418 /**
 419  * @brief qed_sp_pf_stop - PF Function Stop Ramrod
 420  *
 421  * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
 422  * sent and the last completion written to the PFs Event Ring. This ramrod also
 423  * deletes the context for the Slowhwfn connection on this PF.
 424  *
 425  * @note Not required for first packet.
 426  *
 427  * @param p_hwfn
 428  *
 429  * @return int
 430  */
 431
 432 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);
 433
 434 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn,
 435                               struct qed_tunnel_info *p_tunn,
 436                               enum spq_mode comp_mode,
 437                               struct qed_spq_comp_cb *p_comp_data);
 438 /**
 439  * @brief qed_sp_heartbeat_ramrod - Send empty Ramrod
 440  *
 441  * @param p_hwfn
 442  *
 443  * @return int
 444  */
 445
 446 int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn);
 447
 448 #endif