drivers/net/ethernet/qlogic/qed/qed_dev_api.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_DEV_API_H
  34 #define _QED_DEV_API_H
  35
  36 #include <linux/types.h>
  37 #include <linux/kernel.h>
  38 #include <linux/slab.h>
  39 #include <linux/qed/qed_chain.h>
  40 #include <linux/qed/qed_if.h>
  41 #include "qed_int.h"
  42
  43 /**
  44  * @brief qed_init_dp - initialize the debug level
  45  *
  46  * @param cdev
  47  * @param dp_module
  48  * @param dp_level
  49  */
  50 void qed_init_dp(struct qed_dev *cdev,
  51                  u32 dp_module,
  52                  u8 dp_level);
  53
  54 /**
  55  * @brief qed_init_struct - initialize the device structure to
  56  *        its defaults
  57  *
  58  * @param cdev
  59  */
  60 void qed_init_struct(struct qed_dev *cdev);
  61
  62 /**
  63  * @brief qed_resc_free -
  64  *
  65  * @param cdev
  66  */
  67 void qed_resc_free(struct qed_dev *cdev);
  68
  69 /**
  70  * @brief qed_resc_alloc -
  71  *
  72  * @param cdev
  73  *
  74  * @return int
  75  */
  76 int qed_resc_alloc(struct qed_dev *cdev);
  77
  78 /**
  79  * @brief qed_resc_setup -
  80  *
  81  * @param cdev
  82  */
  83 void qed_resc_setup(struct qed_dev *cdev);
  84
  85 enum qed_override_force_load {
  86         QED_OVERRIDE_FORCE_LOAD_NONE,
  87         QED_OVERRIDE_FORCE_LOAD_ALWAYS,
  88         QED_OVERRIDE_FORCE_LOAD_NEVER,
  89 };
  90
  91 struct qed_drv_load_params {
  92         /* Indicates whether the driver is running over a crash kernel.
  93          * As part of the load request, this will be used for providing the
  94          * driver role to the MFW.
  95          * In case of a crash kernel over PDA - this should be set to false.
  96          */
  97         bool is_crash_kernel;
  98
  99         /* The timeout value that the MFW should use when locking the engine for
 100          * the driver load process.
 101          * A value of '0' means the default value, and '255' means no timeout.
 102          */
 103         u8 mfw_timeout_val;
 104 #define QED_LOAD_REQ_LOCK_TO_DEFAULT    0
 105 #define QED_LOAD_REQ_LOCK_TO_NONE       255
 106
 107         /* Avoid engine reset when first PF loads on it */
 108         bool avoid_eng_reset;
 109
 110         /* Allow overriding the default force load behavior */
 111         enum qed_override_force_load override_force_load;
 112 };
 113
 114 struct qed_hw_init_params {
 115         /* Tunneling parameters */
 116         struct qed_tunnel_info *p_tunn;
 117
 118         bool b_hw_start;
 119
 120         /* Interrupt mode [msix, inta, etc.] to use */
 121         enum qed_int_mode int_mode;
 122
 123         /* NPAR tx switching to be used for vports for tx-switching */
 124         bool allow_npar_tx_switch;
 125
 126         /* Binary fw data pointer in binary fw file */
 127         const u8 *bin_fw_data;
 128
 129         /* Driver load parameters */
 130         struct qed_drv_load_params *p_drv_load_params;
 131 };
 132
 133 /**
 134  * @brief qed_hw_init -
 135  *
 136  * @param cdev
 137  * @param p_params
 138  *
 139  * @return int
 140  */
 141 int qed_hw_init(struct qed_dev *cdev, struct qed_hw_init_params *p_params);
 142
 143 /**
 144  * @brief qed_hw_timers_stop_all - stop the timers HW block
 145  *
 146  * @param cdev
 147  *
 148  * @return void
 149  */
 150 void qed_hw_timers_stop_all(struct qed_dev *cdev);
 151
 152 /**
 153  * @brief qed_hw_stop -
 154  *
 155  * @param cdev
 156  *
 157  * @return int
 158  */
 159 int qed_hw_stop(struct qed_dev *cdev);
 160
 161 /**
 162  * @brief qed_hw_stop_fastpath -should be called incase
 163  *              slowpath is still required for the device,
 164  *              but fastpath is not.
 165  *
 166  * @param cdev
 167  *
 168  * @return int
 169  */
 170 int qed_hw_stop_fastpath(struct qed_dev *cdev);
 171
 172 /**
 173  * @brief qed_hw_start_fastpath -restart fastpath traffic,
 174  *              only if hw_stop_fastpath was called
 175  *
 176  * @param p_hwfn
 177  *
 178  * @return int
 179  */
 180 int qed_hw_start_fastpath(struct qed_hwfn *p_hwfn);
 181
 182
 183 /**
 184  * @brief qed_hw_prepare -
 185  *
 186  * @param cdev
 187  * @param personality - personality to initialize
 188  *
 189  * @return int
 190  */
 191 int qed_hw_prepare(struct qed_dev *cdev,
 192                    int personality);
 193
 194 /**
 195  * @brief qed_hw_remove -
 196  *
 197  * @param cdev
 198  */
 199 void qed_hw_remove(struct qed_dev *cdev);
 200
 201 /**
 202  * @brief qed_ptt_acquire - Allocate a PTT window
 203  *
 204  * Should be called at the entry point to the driver (at the beginning of an
 205  * exported function)
 206  *
 207  * @param p_hwfn
 208  *
 209  * @return struct qed_ptt
 210  */
 211 struct qed_ptt *qed_ptt_acquire(struct qed_hwfn *p_hwfn);
 212
 213 /**
 214  * @brief qed_ptt_release - Release PTT Window
 215  *
 216  * Should be called at the end of a flow - at the end of the function that
 217  * acquired the PTT.
 218  *
 219  *
 220  * @param p_hwfn
 221  * @param p_ptt
 222  */
 223 void qed_ptt_release(struct qed_hwfn *p_hwfn,
 224                      struct qed_ptt *p_ptt);
 225 void qed_reset_vport_stats(struct qed_dev *cdev);
 226
 227 enum qed_dmae_address_type_t {
 228         QED_DMAE_ADDRESS_HOST_VIRT,
 229         QED_DMAE_ADDRESS_HOST_PHYS,
 230         QED_DMAE_ADDRESS_GRC
 231 };
 232
 233 /* value of flags If QED_DMAE_FLAG_RW_REPL_SRC flag is set and the
 234  * source is a block of length DMAE_MAX_RW_SIZE and the
 235  * destination is larger, the source block will be duplicated as
 236  * many times as required to fill the destination block. This is
 237  * used mostly to write a zeroed buffer to destination address
 238  * using DMA
 239  */
 240 #define QED_DMAE_FLAG_RW_REPL_SRC       0x00000001
 241 #define QED_DMAE_FLAG_VF_SRC            0x00000002
 242 #define QED_DMAE_FLAG_VF_DST            0x00000004
 243 #define QED_DMAE_FLAG_COMPLETION_DST    0x00000008
 244
 245 struct qed_dmae_params {
 246         u32 flags; /* consists of QED_DMAE_FLAG_* values */
 247         u8 src_vfid;
 248         u8 dst_vfid;
 249 };
 250
 251 /**
 252  * @brief qed_dmae_host2grc - copy data from source addr to
 253  * dmae registers using the given ptt
 254  *
 255  * @param p_hwfn
 256  * @param p_ptt
 257  * @param source_addr
 258  * @param grc_addr (dmae_data_offset)
 259  * @param size_in_dwords
 260  * @param flags (one of the flags defined above)
 261  */
 262 int
 263 qed_dmae_host2grc(struct qed_hwfn *p_hwfn,
 264                   struct qed_ptt *p_ptt,
 265                   u64 source_addr,
 266                   u32 grc_addr,
 267                   u32 size_in_dwords,
 268                   u32 flags);
 269
 270  /**
 271  * @brief qed_dmae_grc2host - Read data from dmae data offset
 272  * to source address using the given ptt
 273  *
 274  * @param p_ptt
 275  * @param grc_addr (dmae_data_offset)
 276  * @param dest_addr
 277  * @param size_in_dwords
 278  * @param flags - one of the flags defined above
 279  */
 280 int qed_dmae_grc2host(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt,
 281                       u32 grc_addr, dma_addr_t dest_addr, u32 size_in_dwords,
 282                       u32 flags);
 283
 284 /**
 285  * @brief qed_dmae_host2host - copy data from to source address
 286  * to a destination adress (for SRIOV) using the given ptt
 287  *
 288  * @param p_hwfn
 289  * @param p_ptt
 290  * @param source_addr
 291  * @param dest_addr
 292  * @param size_in_dwords
 293  * @param params
 294  */
 295 int qed_dmae_host2host(struct qed_hwfn *p_hwfn,
 296                        struct qed_ptt *p_ptt,
 297                        dma_addr_t source_addr,
 298                        dma_addr_t dest_addr,
 299                        u32 size_in_dwords, struct qed_dmae_params *p_params);
 300
 301 /**
 302  * @brief qed_chain_alloc - Allocate and initialize a chain
 303  *
 304  * @param p_hwfn
 305  * @param intended_use
 306  * @param mode
 307  * @param num_elems
 308  * @param elem_size
 309  * @param p_chain
 310  * @param ext_pbl - a possible external PBL
 311  *
 312  * @return int
 313  */
 314 int
 315 qed_chain_alloc(struct qed_dev *cdev,
 316                 enum qed_chain_use_mode intended_use,
 317                 enum qed_chain_mode mode,
 318                 enum qed_chain_cnt_type cnt_type,
 319                 u32 num_elems,
 320                 size_t elem_size,
 321                 struct qed_chain *p_chain, struct qed_chain_ext_pbl *ext_pbl);
 322
 323 /**
 324  * @brief qed_chain_free - Free chain DMA memory
 325  *
 326  * @param p_hwfn
 327  * @param p_chain
 328  */
 329 void qed_chain_free(struct qed_dev *cdev, struct qed_chain *p_chain);
 330
 331 /**
 332  * @@brief qed_fw_l2_queue - Get absolute L2 queue ID
 333  *
 334  *  @param p_hwfn
 335  *  @param src_id - relative to p_hwfn
 336  *  @param dst_id - absolute per engine
 337  *
 338  *  @return int
 339  */
 340 int qed_fw_l2_queue(struct qed_hwfn *p_hwfn,
 341                     u16 src_id,
 342                     u16 *dst_id);
 343
 344 /**
 345  * @@brief qed_fw_vport - Get absolute vport ID
 346  *
 347  *  @param p_hwfn
 348  *  @param src_id - relative to p_hwfn
 349  *  @param dst_id - absolute per engine
 350  *
 351  *  @return int
 352  */
 353 int qed_fw_vport(struct qed_hwfn *p_hwfn,
 354                  u8 src_id,
 355                  u8 *dst_id);
 356
 357 /**
 358  * @@brief qed_fw_rss_eng - Get absolute RSS engine ID
 359  *
 360  *  @param p_hwfn
 361  *  @param src_id - relative to p_hwfn
 362  *  @param dst_id - absolute per engine
 363  *
 364  *  @return int
 365  */
 366 int qed_fw_rss_eng(struct qed_hwfn *p_hwfn,
 367                    u8 src_id,
 368                    u8 *dst_id);
 369
 370 /**
 371  * @brief qed_llh_add_mac_filter - configures a MAC filter in llh
 372  *
 373  * @param p_hwfn
 374  * @param p_ptt
 375  * @param p_filter - MAC to add
 376  */
 377 int qed_llh_add_mac_filter(struct qed_hwfn *p_hwfn,
 378                            struct qed_ptt *p_ptt, u8 *p_filter);
 379
 380 /**
 381  * @brief qed_llh_remove_mac_filter - removes a MAC filter from llh
 382  *
 383  * @param p_hwfn
 384  * @param p_ptt
 385  * @param p_filter - MAC to remove
 386  */
 387 void qed_llh_remove_mac_filter(struct qed_hwfn *p_hwfn,
 388                                struct qed_ptt *p_ptt, u8 *p_filter);
 389
 390 enum qed_llh_port_filter_type_t {
 391         QED_LLH_FILTER_ETHERTYPE,
 392         QED_LLH_FILTER_TCP_SRC_PORT,
 393         QED_LLH_FILTER_TCP_DEST_PORT,
 394         QED_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
 395         QED_LLH_FILTER_UDP_SRC_PORT,
 396         QED_LLH_FILTER_UDP_DEST_PORT,
 397         QED_LLH_FILTER_UDP_SRC_AND_DEST_PORT
 398 };
 399
 400 /**
 401  * @brief qed_llh_add_protocol_filter - configures a protocol filter in llh
 402  *
 403  * @param p_hwfn
 404  * @param p_ptt
 405  * @param source_port_or_eth_type - source port or ethertype to add
 406  * @param dest_port - destination port to add
 407  * @param type - type of filters and comparing
 408  */
 409 int
 410 qed_llh_add_protocol_filter(struct qed_hwfn *p_hwfn,
 411                             struct qed_ptt *p_ptt,
 412                             u16 source_port_or_eth_type,
 413                             u16 dest_port,
 414                             enum qed_llh_port_filter_type_t type);
 415
 416 /**
 417  * @brief qed_llh_remove_protocol_filter - remove a protocol filter in llh
 418  *
 419  * @param p_hwfn
 420  * @param p_ptt
 421  * @param source_port_or_eth_type - source port or ethertype to add
 422  * @param dest_port - destination port to add
 423  * @param type - type of filters and comparing
 424  */
 425 void
 426 qed_llh_remove_protocol_filter(struct qed_hwfn *p_hwfn,
 427                                struct qed_ptt *p_ptt,
 428                                u16 source_port_or_eth_type,
 429                                u16 dest_port,
 430                                enum qed_llh_port_filter_type_t type);
 431
 432 /**
 433  * *@brief Cleanup of previous driver remains prior to load
 434  *
 435  * @param p_hwfn
 436  * @param p_ptt
 437  * @param id - For PF, engine-relative. For VF, PF-relative.
 438  * @param is_vf - true iff cleanup is made for a VF.
 439  *
 440  * @return int
 441  */
 442 int qed_final_cleanup(struct qed_hwfn *p_hwfn,
 443                       struct qed_ptt *p_ptt, u16 id, bool is_vf);
 444
 445 /**
 446  * @brief qed_get_queue_coalesce - Retrieve coalesce value for a given queue.
 447  *
 448  * @param p_hwfn
 449  * @param p_coal - store coalesce value read from the hardware.
 450  * @param p_handle
 451  *
 452  * @return int
 453  **/
 454 int qed_get_queue_coalesce(struct qed_hwfn *p_hwfn, u16 *coal, void *handle);
 455
 456 /**
 457  * @brief qed_set_queue_coalesce - Configure coalesce parameters for Rx and
 458  *    Tx queue. The fact that we can configure coalescing to up to 511, but on
 459  *    varying accuracy [the bigger the value the less accurate] up to a mistake
 460  *    of 3usec for the highest values.
 461  *    While the API allows setting coalescing per-qid, all queues sharing a SB
 462  *    should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
 463  *    otherwise configuration would break.
 464  *
 465  *
 466  * @param rx_coal - Rx Coalesce value in micro seconds.
 467  * @param tx_coal - TX Coalesce value in micro seconds.
 468  * @param p_handle
 469  *
 470  * @return int
 471  **/
 472 int
 473 qed_set_queue_coalesce(u16 rx_coal, u16 tx_coal, void *p_handle);
 474
 475
 476 const char *qed_hw_get_resc_name(enum qed_resources res_id);
 477 #endif