drivers/net/qede/base/ecore_dev_api.h

   1 /*
   2  * Copyright (c) 2016 QLogic Corporation.
   3  * All rights reserved.
   4  * www.qlogic.com
   5  *
   6  * See LICENSE.qede_pmd for copyright and licensing details.
   7  */
   8
   9 #ifndef __ECORE_DEV_API_H__
  10 #define __ECORE_DEV_API_H__
  11
  12 #include "ecore_status.h"
  13 #include "ecore_chain.h"
  14 #include "ecore_int_api.h"
  15
  16 /**
  17  * @brief ecore_init_dp - initialize the debug level
  18  *
  19  * @param p_dev
  20  * @param dp_module
  21  * @param dp_level
  22  * @param dp_ctx
  23  */
  24 void ecore_init_dp(struct ecore_dev *p_dev,
  25                    u32 dp_module,
  26                    u8 dp_level,
  27                    void *dp_ctx);
  28
  29 /**
  30  * @brief ecore_init_struct - initialize the device structure to
  31  *        its defaults
  32  *
  33  * @param p_dev
  34  */
  35 void ecore_init_struct(struct ecore_dev *p_dev);
  36
  37 /**
  38  * @brief ecore_resc_free -
  39  *
  40  * @param p_dev
  41  */
  42 void ecore_resc_free(struct ecore_dev *p_dev);
  43
  44 /**
  45  * @brief ecore_resc_alloc -
  46  *
  47  * @param p_dev
  48  *
  49  * @return enum _ecore_status_t
  50  */
  51 enum _ecore_status_t ecore_resc_alloc(struct ecore_dev *p_dev);
  52
  53 /**
  54  * @brief ecore_resc_setup -
  55  *
  56  * @param p_dev
  57  */
  58 void ecore_resc_setup(struct ecore_dev *p_dev);
  59
  60 struct ecore_hw_init_params {
  61         /* Tunnelling parameters */
  62         struct ecore_tunnel_info *p_tunn;
  63
  64         bool b_hw_start;
  65
  66         /* Interrupt mode [msix, inta, etc.] to use */
  67         enum ecore_int_mode int_mode;
  68
  69         /* NPAR tx switching to be used for vports configured for tx-switching
  70          */
  71         bool allow_npar_tx_switch;
  72
  73         /* Binary fw data pointer in binary fw file */
  74         const u8 *bin_fw_data;
  75
  76         /* Indicates whether the driver is running over a crash kernel.
  77          * As part of the load request, this will be used for providing the
  78          * driver role to the MFW.
  79          * In case of a crash kernel over PDA - this should be set to false.
  80          */
  81         bool is_crash_kernel;
  82
  83         /* The timeout value that the MFW should use when locking the engine for
  84          * the driver load process.
  85          * A value of '0' means the default value, and '255' means no timeout.
  86          */
  87         u8 mfw_timeout_val;
  88 #define ECORE_LOAD_REQ_LOCK_TO_DEFAULT  0
  89 #define ECORE_LOAD_REQ_LOCK_TO_NONE     255
  90
  91         /* Avoid engine reset when first PF loads on it */
  92         bool avoid_eng_reset;
  93 };
  94
  95 /**
  96  * @brief ecore_hw_init -
  97  *
  98  * @param p_dev
  99  * @param p_params
 100  *
 101  * @return enum _ecore_status_t
 102  */
 103 enum _ecore_status_t ecore_hw_init(struct ecore_dev *p_dev,
 104                                    struct ecore_hw_init_params *p_params);
 105
 106 /**
 107  * @brief ecore_hw_timers_stop_all -
 108  *
 109  * @param p_dev
 110  *
 111  * @return void
 112  */
 113 void ecore_hw_timers_stop_all(struct ecore_dev *p_dev);
 114
 115 /**
 116  * @brief ecore_hw_stop -
 117  *
 118  * @param p_dev
 119  *
 120  * @return enum _ecore_status_t
 121  */
 122 enum _ecore_status_t ecore_hw_stop(struct ecore_dev *p_dev);
 123
 124 /**
 125  * @brief ecore_hw_stop_fastpath -should be called incase
 126  *        slowpath is still required for the device,
 127  *        but fastpath is not.
 128  *
 129  * @param p_dev
 130  *
 131  */
 132 void ecore_hw_stop_fastpath(struct ecore_dev *p_dev);
 133
 134 #ifndef LINUX_REMOVE
 135 /**
 136  * @brief ecore_prepare_hibernate -should be called when
 137  *        the system is going into the hibernate state
 138  *
 139  * @param p_dev
 140  *
 141  */
 142 void ecore_prepare_hibernate(struct ecore_dev *p_dev);
 143 #endif
 144
 145 /**
 146  * @brief ecore_hw_start_fastpath -restart fastpath traffic,
 147  *        only if hw_stop_fastpath was called
 148
 149  * @param p_dev
 150  *
 151  */
 152 void ecore_hw_start_fastpath(struct ecore_hwfn *p_hwfn);
 153
 154 enum ecore_hw_prepare_result {
 155         ECORE_HW_PREPARE_SUCCESS,
 156
 157         /* FAILED results indicate probe has failed & cleaned up */
 158         ECORE_HW_PREPARE_FAILED_ENG2,
 159         ECORE_HW_PREPARE_FAILED_ME,
 160         ECORE_HW_PREPARE_FAILED_MEM,
 161         ECORE_HW_PREPARE_FAILED_DEV,
 162         ECORE_HW_PREPARE_FAILED_NVM,
 163
 164         /* BAD results indicate probe is passed even though some wrongness
 165          * has occurred; Trying to actually use [I.e., hw_init()] might have
 166          * dire reprecautions.
 167          */
 168         ECORE_HW_PREPARE_BAD_IOV,
 169         ECORE_HW_PREPARE_BAD_MCP,
 170         ECORE_HW_PREPARE_BAD_IGU,
 171 };
 172
 173 struct ecore_hw_prepare_params {
 174         /* Personality to initialize */
 175         int personality;
 176
 177         /* Force the driver's default resource allocation */
 178         bool drv_resc_alloc;
 179
 180         /* Check the reg_fifo after any register access */
 181         bool chk_reg_fifo;
 182
 183         /* Request the MFW to initiate PF FLR */
 184         bool initiate_pf_flr;
 185
 186         /* The OS Epoch time in seconds */
 187         u32 epoch;
 188
 189         /* Allow prepare to pass even if some initializations are failing.
 190          * If set, the `p_prepare_res' field would be set with the return,
 191          * and might allow probe to pass even if there are certain issues.
 192          */
 193         bool b_relaxed_probe;
 194         enum ecore_hw_prepare_result p_relaxed_res;
 195 };
 196
 197 /**
 198  * @brief ecore_hw_prepare -
 199  *
 200  * @param p_dev
 201  * @param p_params
 202  *
 203  * @return enum _ecore_status_t
 204  */
 205 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev,
 206                                       struct ecore_hw_prepare_params *p_params);
 207
 208 /**
 209  * @brief ecore_hw_remove -
 210  *
 211  * @param p_dev
 212  */
 213 void ecore_hw_remove(struct ecore_dev *p_dev);
 214
 215 /**
 216  * @brief ecore_ptt_acquire - Allocate a PTT window
 217  *
 218  * Should be called at the entry point to the driver (at the beginning of an
 219  * exported function)
 220  *
 221  * @param p_hwfn
 222  *
 223  * @return struct ecore_ptt
 224  */
 225 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn);
 226
 227 /**
 228  * @brief ecore_ptt_release - Release PTT Window
 229  *
 230  * Should be called at the end of a flow - at the end of the function that
 231  * acquired the PTT.
 232  *
 233  *
 234  * @param p_hwfn
 235  * @param p_ptt
 236  */
 237 void ecore_ptt_release(struct ecore_hwfn *p_hwfn,
 238                        struct ecore_ptt *p_ptt);
 239
 240 #ifndef __EXTRACT__LINUX__
 241 struct ecore_eth_stats {
 242         u64 no_buff_discards;
 243         u64 packet_too_big_discard;
 244         u64 ttl0_discard;
 245         u64 rx_ucast_bytes;
 246         u64 rx_mcast_bytes;
 247         u64 rx_bcast_bytes;
 248         u64 rx_ucast_pkts;
 249         u64 rx_mcast_pkts;
 250         u64 rx_bcast_pkts;
 251         u64 mftag_filter_discards;
 252         u64 mac_filter_discards;
 253         u64 tx_ucast_bytes;
 254         u64 tx_mcast_bytes;
 255         u64 tx_bcast_bytes;
 256         u64 tx_ucast_pkts;
 257         u64 tx_mcast_pkts;
 258         u64 tx_bcast_pkts;
 259         u64 tx_err_drop_pkts;
 260         u64 tpa_coalesced_pkts;
 261         u64 tpa_coalesced_events;
 262         u64 tpa_aborts_num;
 263         u64 tpa_not_coalesced_pkts;
 264         u64 tpa_coalesced_bytes;
 265
 266         /* port */
 267         u64 rx_64_byte_packets;
 268         u64 rx_65_to_127_byte_packets;
 269         u64 rx_128_to_255_byte_packets;
 270         u64 rx_256_to_511_byte_packets;
 271         u64 rx_512_to_1023_byte_packets;
 272         u64 rx_1024_to_1518_byte_packets;
 273         u64 rx_1519_to_1522_byte_packets;
 274         u64 rx_1519_to_2047_byte_packets;
 275         u64 rx_2048_to_4095_byte_packets;
 276         u64 rx_4096_to_9216_byte_packets;
 277         u64 rx_9217_to_16383_byte_packets;
 278         u64 rx_crc_errors;
 279         u64 rx_mac_crtl_frames;
 280         u64 rx_pause_frames;
 281         u64 rx_pfc_frames;
 282         u64 rx_align_errors;
 283         u64 rx_carrier_errors;
 284         u64 rx_oversize_packets;
 285         u64 rx_jabbers;
 286         u64 rx_undersize_packets;
 287         u64 rx_fragments;
 288         u64 tx_64_byte_packets;
 289         u64 tx_65_to_127_byte_packets;
 290         u64 tx_128_to_255_byte_packets;
 291         u64 tx_256_to_511_byte_packets;
 292         u64 tx_512_to_1023_byte_packets;
 293         u64 tx_1024_to_1518_byte_packets;
 294         u64 tx_1519_to_2047_byte_packets;
 295         u64 tx_2048_to_4095_byte_packets;
 296         u64 tx_4096_to_9216_byte_packets;
 297         u64 tx_9217_to_16383_byte_packets;
 298         u64 tx_pause_frames;
 299         u64 tx_pfc_frames;
 300         u64 tx_lpi_entry_count;
 301         u64 tx_total_collisions;
 302         u64 brb_truncates;
 303         u64 brb_discards;
 304         u64 rx_mac_bytes;
 305         u64 rx_mac_uc_packets;
 306         u64 rx_mac_mc_packets;
 307         u64 rx_mac_bc_packets;
 308         u64 rx_mac_frames_ok;
 309         u64 tx_mac_bytes;
 310         u64 tx_mac_uc_packets;
 311         u64 tx_mac_mc_packets;
 312         u64 tx_mac_bc_packets;
 313         u64 tx_mac_ctrl_frames;
 314 };
 315 #endif
 316
 317 enum ecore_dmae_address_type_t {
 318         ECORE_DMAE_ADDRESS_HOST_VIRT,
 319         ECORE_DMAE_ADDRESS_HOST_PHYS,
 320         ECORE_DMAE_ADDRESS_GRC
 321 };
 322
 323 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the
 324  * source is a block of length DMAE_MAX_RW_SIZE and the
 325  * destination is larger, the source block will be duplicated as
 326  * many times as required to fill the destination block. This is
 327  * used mostly to write a zeroed buffer to destination address
 328  * using DMA
 329  */
 330 #define ECORE_DMAE_FLAG_RW_REPL_SRC     0x00000001
 331 #define ECORE_DMAE_FLAG_VF_SRC          0x00000002
 332 #define ECORE_DMAE_FLAG_VF_DST          0x00000004
 333 #define ECORE_DMAE_FLAG_COMPLETION_DST  0x00000008
 334
 335 struct ecore_dmae_params {
 336         u32 flags; /* consists of ECORE_DMAE_FLAG_* values */
 337         u8 src_vfid;
 338         u8 dst_vfid;
 339 };
 340
 341 /**
 342  * @brief ecore_dmae_host2grc - copy data from source addr to
 343  * dmae registers using the given ptt
 344  *
 345  * @param p_hwfn
 346  * @param p_ptt
 347  * @param source_addr
 348  * @param grc_addr (dmae_data_offset)
 349  * @param size_in_dwords
 350  * @param flags (one of the flags defined above)
 351  */
 352 enum _ecore_status_t
 353 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
 354                     struct ecore_ptt *p_ptt,
 355                     u64 source_addr,
 356                     u32 grc_addr,
 357                     u32 size_in_dwords,
 358                     u32 flags);
 359
 360 /**
 361  * @brief ecore_dmae_grc2host - Read data from dmae data offset
 362  * to source address using the given ptt
 363  *
 364  * @param p_ptt
 365  * @param grc_addr (dmae_data_offset)
 366  * @param dest_addr
 367  * @param size_in_dwords
 368  * @param flags - one of the flags defined above
 369  */
 370 enum _ecore_status_t
 371 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
 372                     struct ecore_ptt *p_ptt,
 373                     u32 grc_addr,
 374                     dma_addr_t dest_addr,
 375                     u32 size_in_dwords,
 376                     u32 flags);
 377
 378 /**
 379  * @brief ecore_dmae_host2host - copy data from to source address
 380  * to a destination address (for SRIOV) using the given ptt
 381  *
 382  * @param p_hwfn
 383  * @param p_ptt
 384  * @param source_addr
 385  * @param dest_addr
 386  * @param size_in_dwords
 387  * @param params
 388  */
 389 enum _ecore_status_t
 390 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
 391                      struct ecore_ptt *p_ptt,
 392                      dma_addr_t source_addr,
 393                      dma_addr_t dest_addr,
 394                      u32 size_in_dwords,
 395                      struct ecore_dmae_params *p_params);
 396
 397 /**
 398  * @brief ecore_chain_alloc - Allocate and initialize a chain
 399  *
 400  * @param p_hwfn
 401  * @param intended_use
 402  * @param mode
 403  * @param num_elems
 404  * @param elem_size
 405  * @param p_chain
 406  *
 407  * @return enum _ecore_status_t
 408  */
 409 enum _ecore_status_t
 410 ecore_chain_alloc(struct ecore_dev *p_dev,
 411                   enum ecore_chain_use_mode intended_use,
 412                   enum ecore_chain_mode mode,
 413                   enum ecore_chain_cnt_type cnt_type,
 414                   u32 num_elems,
 415                   osal_size_t elem_size,
 416                   struct ecore_chain *p_chain,
 417                   struct ecore_chain_ext_pbl *ext_pbl);
 418
 419 /**
 420  * @brief ecore_chain_free - Free chain DMA memory
 421  *
 422  * @param p_hwfn
 423  * @param p_chain
 424  */
 425 void ecore_chain_free(struct ecore_dev *p_dev,
 426                       struct ecore_chain *p_chain);
 427
 428 /**
 429  * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID
 430  *
 431  *  @param p_hwfn
 432  *  @param src_id - relative to p_hwfn
 433  *  @param dst_id - absolute per engine
 434  *
 435  *  @return enum _ecore_status_t
 436  */
 437 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn,
 438                                        u16 src_id,
 439                                        u16 *dst_id);
 440
 441 /**
 442  * @@brief ecore_fw_vport - Get absolute vport ID
 443  *
 444  *  @param p_hwfn
 445  *  @param src_id - relative to p_hwfn
 446  *  @param dst_id - absolute per engine
 447  *
 448  *  @return enum _ecore_status_t
 449  */
 450 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn,
 451                                     u8 src_id,
 452                                     u8 *dst_id);
 453
 454 /**
 455  * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID
 456  *
 457  *  @param p_hwfn
 458  *  @param src_id - relative to p_hwfn
 459  *  @param dst_id - absolute per engine
 460  *
 461  *  @return enum _ecore_status_t
 462  */
 463 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn,
 464                                       u8 src_id,
 465                                       u8 *dst_id);
 466
 467 /**
 468  * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh
 469  *
 470  * @param p_hwfn
 471  * @param p_ptt
 472  * @param p_filter - MAC to add
 473  */
 474 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn,
 475                                           struct ecore_ptt *p_ptt,
 476                                           u8 *p_filter);
 477
 478 /**
 479  * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh
 480  *
 481  * @param p_hwfn
 482  * @param p_ptt
 483  * @param p_filter - MAC to remove
 484  */
 485 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn,
 486                              struct ecore_ptt *p_ptt,
 487                              u8 *p_filter);
 488
 489 enum ecore_llh_port_filter_type_t {
 490         ECORE_LLH_FILTER_ETHERTYPE,
 491         ECORE_LLH_FILTER_TCP_SRC_PORT,
 492         ECORE_LLH_FILTER_TCP_DEST_PORT,
 493         ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
 494         ECORE_LLH_FILTER_UDP_SRC_PORT,
 495         ECORE_LLH_FILTER_UDP_DEST_PORT,
 496         ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT
 497 };
 498
 499 /**
 500  * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh
 501  *
 502  * @param p_hwfn
 503  * @param p_ptt
 504  * @param source_port_or_eth_type - source port or ethertype to add
 505  * @param dest_port - destination port to add
 506  * @param type - type of filters and comparing
 507  */
 508 enum _ecore_status_t
 509 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn,
 510                               struct ecore_ptt *p_ptt,
 511                               u16 source_port_or_eth_type,
 512                               u16 dest_port,
 513                               enum ecore_llh_port_filter_type_t type);
 514
 515 /**
 516  * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh
 517  *
 518  * @param p_hwfn
 519  * @param p_ptt
 520  * @param source_port_or_eth_type - source port or ethertype to add
 521  * @param dest_port - destination port to add
 522  * @param type - type of filters and comparing
 523  */
 524 void
 525 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn,
 526                                  struct ecore_ptt *p_ptt,
 527                                  u16 source_port_or_eth_type,
 528                                  u16 dest_port,
 529                                  enum ecore_llh_port_filter_type_t type);
 530
 531 /**
 532  * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh
 533  *
 534  * @param p_hwfn
 535  * @param p_ptt
 536  */
 537 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn,
 538                              struct ecore_ptt *p_ptt);
 539
 540 /**
 541  * @brief ecore_llh_set_function_as_default - set function as default per port
 542  *
 543  * @param p_hwfn
 544  * @param p_ptt
 545  */
 546 enum _ecore_status_t
 547 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn,
 548                                   struct ecore_ptt *p_ptt);
 549
 550 /**
 551  *@brief Cleanup of previous driver remains prior to load
 552  *
 553  * @param p_hwfn
 554  * @param p_ptt
 555  * @param id - For PF, engine-relative. For VF, PF-relative.
 556  * @param is_vf - true iff cleanup is made for a VF.
 557  *
 558  * @return enum _ecore_status_t
 559  */
 560 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn      *p_hwfn,
 561                                          struct ecore_ptt       *p_ptt,
 562                                          u16                    id,
 563                                          bool                   is_vf);
 564 /**
 565  * @brief ecore_set_queue_coalesce - Configure coalesce parameters for Rx and
 566  *    Tx queue. The fact that we can configure coalescing to up to 511, but on
 567  *    varying accuracy [the bigger the value the less accurate] up to a mistake
 568  *    of 3usec for the highest values.
 569  *    While the API allows setting coalescing per-qid, all queues sharing a SB
 570  *    should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
 571  *    otherwise configuration would break.
 572  *
 573  * @param p_hwfn
 574  * @param rx_coal - Rx Coalesce value in micro seconds.
 575  * @param tx_coal - TX Coalesce value in micro seconds.
 576  * @param p_handle
 577  *
 578  * @return enum _ecore_status_t
 579  **/
 580 enum _ecore_status_t
 581 ecore_set_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 rx_coal,
 582                          u16 tx_coal, void *p_handle);
 583
 584 #endif