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 roce_init_func_ramrod_data roce_init_func;
 108         struct rdma_create_cq_ramrod_data rdma_create_cq;
 109         struct rdma_destroy_cq_ramrod_data rdma_destroy_cq;
 110         struct rdma_srq_create_ramrod_data rdma_create_srq;
 111         struct rdma_srq_destroy_ramrod_data rdma_destroy_srq;
 112         struct rdma_srq_modify_ramrod_data rdma_modify_srq;
 113         struct iwarp_create_qp_ramrod_data iwarp_create_qp;
 114         struct iwarp_tcp_offload_ramrod_data iwarp_tcp_offload;
 115         struct iwarp_mpa_offload_ramrod_data iwarp_mpa_offload;
 116         struct iwarp_modify_qp_ramrod_data iwarp_modify_qp;
 117         struct iwarp_init_func_ramrod_data iwarp_init_func;
 118         struct fcoe_init_ramrod_params fcoe_init;
 119         struct fcoe_conn_offload_ramrod_params fcoe_conn_ofld;
 120         struct fcoe_conn_terminate_ramrod_params fcoe_conn_terminate;
 121         struct fcoe_stat_ramrod_params fcoe_stat;
 122
 123         struct iscsi_slow_path_hdr iscsi_empty;
 124         struct iscsi_init_ramrod_params iscsi_init;
 125         struct iscsi_spe_func_dstry iscsi_destroy;
 126         struct iscsi_spe_conn_offload iscsi_conn_offload;
 127         struct iscsi_conn_update_ramrod_params iscsi_conn_update;
 128         struct iscsi_spe_conn_mac_update iscsi_conn_mac_update;
 129         struct iscsi_spe_conn_termination iscsi_conn_terminate;
 130
 131         struct vf_start_ramrod_data vf_start;
 132         struct vf_stop_ramrod_data vf_stop;
 133 };
 134
 135 #define EQ_MAX_CREDIT   0xffffffff
 136
 137 enum spq_priority {
 138         QED_SPQ_PRIORITY_NORMAL,
 139         QED_SPQ_PRIORITY_HIGH,
 140 };
 141
 142 union qed_spq_req_comp {
 143         struct qed_spq_comp_cb  cb;
 144         u64                     *done_addr;
 145 };
 146
 147 struct qed_spq_comp_done {
 148         unsigned int    done;
 149         u8              fw_return_code;
 150 };
 151
 152 struct qed_spq_entry {
 153         struct list_head                list;
 154
 155         u8                              flags;
 156
 157         /* HSI slow path element */
 158         struct slow_path_element        elem;
 159
 160         union ramrod_data               ramrod;
 161
 162         enum spq_priority               priority;
 163
 164         /* pending queue for this entry */
 165         struct list_head                *queue;
 166
 167         enum spq_mode                   comp_mode;
 168         struct qed_spq_comp_cb          comp_cb;
 169         struct qed_spq_comp_done        comp_done; /* SPQ_MODE_EBLOCK */
 170 };
 171
 172 struct qed_eq {
 173         struct qed_chain        chain;
 174         u8                      eq_sb_index;    /* index within the SB */
 175         __le16                  *p_fw_cons;     /* ptr to index value */
 176 };
 177
 178 struct qed_consq {
 179         struct qed_chain chain;
 180 };
 181
 182 typedef int
 183 (*qed_spq_async_comp_cb)(struct qed_hwfn *p_hwfn,
 184                          u8 opcode,
 185                          u16 echo,
 186                          union event_ring_data *data,
 187                          u8 fw_return_code);
 188
 189 int
 190 qed_spq_register_async_cb(struct qed_hwfn *p_hwfn,
 191                           enum protocol_type protocol_id,
 192                           qed_spq_async_comp_cb cb);
 193
 194 void
 195 qed_spq_unregister_async_cb(struct qed_hwfn *p_hwfn,
 196                             enum protocol_type protocol_id);
 197
 198 struct qed_spq {
 199         spinlock_t              lock; /* SPQ lock */
 200
 201         struct list_head        unlimited_pending;
 202         struct list_head        pending;
 203         struct list_head        completion_pending;
 204         struct list_head        free_pool;
 205
 206         struct qed_chain        chain;
 207
 208         /* allocated dma-able memory for spq entries (+ramrod data) */
 209         dma_addr_t              p_phys;
 210         struct qed_spq_entry    *p_virt;
 211
 212 #define SPQ_RING_SIZE \
 213         (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
 214
 215         /* Bitmap for handling out-of-order completions */
 216         DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE);
 217         u8                      comp_bitmap_idx;
 218
 219         /* Statistics */
 220         u32                     unlimited_pending_count;
 221         u32                     normal_count;
 222         u32                     high_count;
 223         u32                     comp_sent_count;
 224         u32                     comp_count;
 225
 226         u32                     cid;
 227         qed_spq_async_comp_cb async_comp_cb[MAX_PROTOCOL_TYPE];
 228 };
 229
 230 /**
 231  * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that
 232  *        Pends it to the future list.
 233  *
 234  * @param p_hwfn
 235  * @param p_req
 236  *
 237  * @return int
 238  */
 239 int qed_spq_post(struct qed_hwfn *p_hwfn,
 240                  struct qed_spq_entry *p_ent,
 241                  u8 *fw_return_code);
 242
 243 /**
 244  * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ.
 245  *
 246  * @param p_hwfn
 247  *
 248  * @return int
 249  */
 250 int qed_spq_alloc(struct qed_hwfn *p_hwfn);
 251
 252 /**
 253  * @brief qed_spq_setup - Reset the SPQ to its start state.
 254  *
 255  * @param p_hwfn
 256  */
 257 void qed_spq_setup(struct qed_hwfn *p_hwfn);
 258
 259 /**
 260  * @brief qed_spq_deallocate - Deallocates the given SPQ struct.
 261  *
 262  * @param p_hwfn
 263  */
 264 void qed_spq_free(struct qed_hwfn *p_hwfn);
 265
 266 /**
 267  * @brief qed_spq_get_entry - Obtain an entrry from the spq
 268  *        free pool list.
 269  *
 270  *
 271  *
 272  * @param p_hwfn
 273  * @param pp_ent
 274  *
 275  * @return int
 276  */
 277 int
 278 qed_spq_get_entry(struct qed_hwfn *p_hwfn,
 279                   struct qed_spq_entry **pp_ent);
 280
 281 /**
 282  * @brief qed_spq_return_entry - Return an entry to spq free
 283  *                                 pool list
 284  *
 285  * @param p_hwfn
 286  * @param p_ent
 287  */
 288 void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
 289                           struct qed_spq_entry *p_ent);
 290 /**
 291  * @brief qed_eq_allocate - Allocates & initializes an EQ struct
 292  *
 293  * @param p_hwfn
 294  * @param num_elem number of elements in the eq
 295  *
 296  * @return int
 297  */
 298 int qed_eq_alloc(struct qed_hwfn *p_hwfn, u16 num_elem);
 299
 300 /**
 301  * @brief qed_eq_setup - Reset the EQ to its start state.
 302  *
 303  * @param p_hwfn
 304  */
 305 void qed_eq_setup(struct qed_hwfn *p_hwfn);
 306
 307 /**
 308  * @brief qed_eq_free - deallocates the given EQ struct.
 309  *
 310  * @param p_hwfn
 311  */
 312 void qed_eq_free(struct qed_hwfn *p_hwfn);
 313
 314 /**
 315  * @brief qed_eq_prod_update - update the FW with default EQ producer
 316  *
 317  * @param p_hwfn
 318  * @param prod
 319  */
 320 void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
 321                         u16 prod);
 322
 323 /**
 324  * @brief qed_eq_completion - Completes currently pending EQ elements
 325  *
 326  * @param p_hwfn
 327  * @param cookie
 328  *
 329  * @return int
 330  */
 331 int qed_eq_completion(struct qed_hwfn *p_hwfn,
 332                       void *cookie);
 333
 334 /**
 335  * @brief qed_spq_completion - Completes a single event
 336  *
 337  * @param p_hwfn
 338  * @param echo - echo value from cookie (used for determining completion)
 339  * @param p_data - data from cookie (used in callback function if applicable)
 340  *
 341  * @return int
 342  */
 343 int qed_spq_completion(struct qed_hwfn *p_hwfn,
 344                        __le16 echo,
 345                        u8 fw_return_code,
 346                        union event_ring_data *p_data);
 347
 348 /**
 349  * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
 350  *
 351  * @param p_hwfn
 352  *
 353  * @return u32 - SPQ CID
 354  */
 355 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn);
 356
 357 /**
 358  * @brief qed_consq_alloc - Allocates & initializes an ConsQ
 359  *        struct
 360  *
 361  * @param p_hwfn
 362  *
 363  * @return int
 364  */
 365 int qed_consq_alloc(struct qed_hwfn *p_hwfn);
 366
 367 /**
 368  * @brief qed_consq_setup - Reset the ConsQ to its start state.
 369  *
 370  * @param p_hwfn
 371  */
 372 void qed_consq_setup(struct qed_hwfn *p_hwfn);
 373
 374 /**
 375  * @brief qed_consq_free - deallocates the given ConsQ struct.
 376  *
 377  * @param p_hwfn
 378  */
 379 void qed_consq_free(struct qed_hwfn *p_hwfn);
 380
 381 /**
 382  * @file
 383  *
 384  * @brief Slow-hwfn low-level commands (Ramrods) function definitions.
 385  */
 386
 387 #define QED_SP_EQ_COMPLETION  0x01
 388 #define QED_SP_CQE_COMPLETION 0x02
 389
 390 struct qed_sp_init_data {
 391         u32                     cid;
 392         u16                     opaque_fid;
 393
 394         /* Information regarding operation upon sending & completion */
 395         enum spq_mode           comp_mode;
 396         struct qed_spq_comp_cb *p_comp_data;
 397 };
 398
 399 int qed_sp_init_request(struct qed_hwfn *p_hwfn,
 400                         struct qed_spq_entry **pp_ent,
 401                         u8 cmd,
 402                         u8 protocol,
 403                         struct qed_sp_init_data *p_data);
 404
 405 /**
 406  * @brief qed_sp_pf_start - PF Function Start Ramrod
 407  *
 408  * This ramrod is sent to initialize a physical function (PF). It will
 409  * configure the function related parameters and write its completion to the
 410  * event ring specified in the parameters.
 411  *
 412  * Ramrods complete on the common event ring for the PF. This ring is
 413  * allocated by the driver on host memory and its parameters are written
 414  * to the internal RAM of the UStorm by the Function Start Ramrod.
 415  *
 416  * @param p_hwfn
 417  * @param p_ptt
 418  * @param p_tunn
 419  * @param mode
 420  * @param allow_npar_tx_switch
 421  *
 422  * @return int
 423  */
 424
 425 int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
 426                     struct qed_ptt *p_ptt,
 427                     struct qed_tunnel_info *p_tunn,
 428                     enum qed_mf_mode mode, bool allow_npar_tx_switch);
 429
 430 /**
 431  * @brief qed_sp_pf_update - PF Function Update Ramrod
 432  *
 433  * This ramrod updates function-related parameters. Every parameter can be
 434  * updated independently, according to configuration flags.
 435  *
 436  * @param p_hwfn
 437  *
 438  * @return int
 439  */
 440
 441 int qed_sp_pf_update(struct qed_hwfn *p_hwfn);
 442
 443 /**
 444  * @brief qed_sp_pf_update_stag - Update firmware of new outer tag
 445  *
 446  * @param p_hwfn
 447  *
 448  * @return int
 449  */
 450 int qed_sp_pf_update_stag(struct qed_hwfn *p_hwfn);
 451
 452 /**
 453  * @brief qed_sp_pf_stop - PF Function Stop Ramrod
 454  *
 455  * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
 456  * sent and the last completion written to the PFs Event Ring. This ramrod also
 457  * deletes the context for the Slowhwfn connection on this PF.
 458  *
 459  * @note Not required for first packet.
 460  *
 461  * @param p_hwfn
 462  *
 463  * @return int
 464  */
 465
 466 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);
 467
 468 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn,
 469                               struct qed_ptt *p_ptt,
 470                               struct qed_tunnel_info *p_tunn,
 471                               enum spq_mode comp_mode,
 472                               struct qed_spq_comp_cb *p_comp_data);
 473 /**
 474  * @brief qed_sp_heartbeat_ramrod - Send empty Ramrod
 475  *
 476  * @param p_hwfn
 477  *
 478  * @return int
 479  */
 480
 481 int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn);
 482
 483 #endif