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 the MFW to collect a crash dump */
 190         bool allow_mdump;
 191
 192         /* Allow prepare to pass even if some initializations are failing.
 193          * If set, the `p_prepare_res' field would be set with the return,
 194          * and might allow probe to pass even if there are certain issues.
 195          */
 196         bool b_relaxed_probe;
 197         enum ecore_hw_prepare_result p_relaxed_res;
 198 };
 199
 200 /**
 201  * @brief ecore_hw_prepare -
 202  *
 203  * @param p_dev
 204  * @param p_params
 205  *
 206  * @return enum _ecore_status_t
 207  */
 208 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev,
 209                                       struct ecore_hw_prepare_params *p_params);
 210
 211 /**
 212  * @brief ecore_hw_remove -
 213  *
 214  * @param p_dev
 215  */
 216 void ecore_hw_remove(struct ecore_dev *p_dev);
 217
 218 /**
 219  * @brief ecore_ptt_acquire - Allocate a PTT window
 220  *
 221  * Should be called at the entry point to the driver (at the beginning of an
 222  * exported function)
 223  *
 224  * @param p_hwfn
 225  *
 226  * @return struct ecore_ptt
 227  */
 228 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn);
 229
 230 /**
 231  * @brief ecore_ptt_release - Release PTT Window
 232  *
 233  * Should be called at the end of a flow - at the end of the function that
 234  * acquired the PTT.
 235  *
 236  *
 237  * @param p_hwfn
 238  * @param p_ptt
 239  */
 240 void ecore_ptt_release(struct ecore_hwfn *p_hwfn,
 241                        struct ecore_ptt *p_ptt);
 242
 243 #ifndef __EXTRACT__LINUX__
 244 struct ecore_eth_stats {
 245         u64 no_buff_discards;
 246         u64 packet_too_big_discard;
 247         u64 ttl0_discard;
 248         u64 rx_ucast_bytes;
 249         u64 rx_mcast_bytes;
 250         u64 rx_bcast_bytes;
 251         u64 rx_ucast_pkts;
 252         u64 rx_mcast_pkts;
 253         u64 rx_bcast_pkts;
 254         u64 mftag_filter_discards;
 255         u64 mac_filter_discards;
 256         u64 tx_ucast_bytes;
 257         u64 tx_mcast_bytes;
 258         u64 tx_bcast_bytes;
 259         u64 tx_ucast_pkts;
 260         u64 tx_mcast_pkts;
 261         u64 tx_bcast_pkts;
 262         u64 tx_err_drop_pkts;
 263         u64 tpa_coalesced_pkts;
 264         u64 tpa_coalesced_events;
 265         u64 tpa_aborts_num;
 266         u64 tpa_not_coalesced_pkts;
 267         u64 tpa_coalesced_bytes;
 268
 269         /* port */
 270         u64 rx_64_byte_packets;
 271         u64 rx_65_to_127_byte_packets;
 272         u64 rx_128_to_255_byte_packets;
 273         u64 rx_256_to_511_byte_packets;
 274         u64 rx_512_to_1023_byte_packets;
 275         u64 rx_1024_to_1518_byte_packets;
 276         u64 rx_1519_to_1522_byte_packets;
 277         u64 rx_1519_to_2047_byte_packets;
 278         u64 rx_2048_to_4095_byte_packets;
 279         u64 rx_4096_to_9216_byte_packets;
 280         u64 rx_9217_to_16383_byte_packets;
 281         u64 rx_crc_errors;
 282         u64 rx_mac_crtl_frames;
 283         u64 rx_pause_frames;
 284         u64 rx_pfc_frames;
 285         u64 rx_align_errors;
 286         u64 rx_carrier_errors;
 287         u64 rx_oversize_packets;
 288         u64 rx_jabbers;
 289         u64 rx_undersize_packets;
 290         u64 rx_fragments;
 291         u64 tx_64_byte_packets;
 292         u64 tx_65_to_127_byte_packets;
 293         u64 tx_128_to_255_byte_packets;
 294         u64 tx_256_to_511_byte_packets;
 295         u64 tx_512_to_1023_byte_packets;
 296         u64 tx_1024_to_1518_byte_packets;
 297         u64 tx_1519_to_2047_byte_packets;
 298         u64 tx_2048_to_4095_byte_packets;
 299         u64 tx_4096_to_9216_byte_packets;
 300         u64 tx_9217_to_16383_byte_packets;
 301         u64 tx_pause_frames;
 302         u64 tx_pfc_frames;
 303         u64 tx_lpi_entry_count;
 304         u64 tx_total_collisions;
 305         u64 brb_truncates;
 306         u64 brb_discards;
 307         u64 rx_mac_bytes;
 308         u64 rx_mac_uc_packets;
 309         u64 rx_mac_mc_packets;
 310         u64 rx_mac_bc_packets;
 311         u64 rx_mac_frames_ok;
 312         u64 tx_mac_bytes;
 313         u64 tx_mac_uc_packets;
 314         u64 tx_mac_mc_packets;
 315         u64 tx_mac_bc_packets;
 316         u64 tx_mac_ctrl_frames;
 317 };
 318 #endif
 319
 320 enum ecore_dmae_address_type_t {
 321         ECORE_DMAE_ADDRESS_HOST_VIRT,
 322         ECORE_DMAE_ADDRESS_HOST_PHYS,
 323         ECORE_DMAE_ADDRESS_GRC
 324 };
 325
 326 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the
 327  * source is a block of length DMAE_MAX_RW_SIZE and the
 328  * destination is larger, the source block will be duplicated as
 329  * many times as required to fill the destination block. This is
 330  * used mostly to write a zeroed buffer to destination address
 331  * using DMA
 332  */
 333 #define ECORE_DMAE_FLAG_RW_REPL_SRC     0x00000001
 334 #define ECORE_DMAE_FLAG_VF_SRC          0x00000002
 335 #define ECORE_DMAE_FLAG_VF_DST          0x00000004
 336 #define ECORE_DMAE_FLAG_COMPLETION_DST  0x00000008
 337
 338 struct ecore_dmae_params {
 339         u32 flags; /* consists of ECORE_DMAE_FLAG_* values */
 340         u8 src_vfid;
 341         u8 dst_vfid;
 342 };
 343
 344 /**
 345  * @brief ecore_dmae_host2grc - copy data from source addr to
 346  * dmae registers using the given ptt
 347  *
 348  * @param p_hwfn
 349  * @param p_ptt
 350  * @param source_addr
 351  * @param grc_addr (dmae_data_offset)
 352  * @param size_in_dwords
 353  * @param flags (one of the flags defined above)
 354  */
 355 enum _ecore_status_t
 356 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
 357                     struct ecore_ptt *p_ptt,
 358                     u64 source_addr,
 359                     u32 grc_addr,
 360                     u32 size_in_dwords,
 361                     u32 flags);
 362
 363 /**
 364  * @brief ecore_dmae_grc2host - Read data from dmae data offset
 365  * to source address using the given ptt
 366  *
 367  * @param p_ptt
 368  * @param grc_addr (dmae_data_offset)
 369  * @param dest_addr
 370  * @param size_in_dwords
 371  * @param flags - one of the flags defined above
 372  */
 373 enum _ecore_status_t
 374 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
 375                     struct ecore_ptt *p_ptt,
 376                     u32 grc_addr,
 377                     dma_addr_t dest_addr,
 378                     u32 size_in_dwords,
 379                     u32 flags);
 380
 381 /**
 382  * @brief ecore_dmae_host2host - copy data from to source address
 383  * to a destination address (for SRIOV) using the given ptt
 384  *
 385  * @param p_hwfn
 386  * @param p_ptt
 387  * @param source_addr
 388  * @param dest_addr
 389  * @param size_in_dwords
 390  * @param params
 391  */
 392 enum _ecore_status_t
 393 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
 394                      struct ecore_ptt *p_ptt,
 395                      dma_addr_t source_addr,
 396                      dma_addr_t dest_addr,
 397                      u32 size_in_dwords,
 398                      struct ecore_dmae_params *p_params);
 399
 400 /**
 401  * @brief ecore_chain_alloc - Allocate and initialize a chain
 402  *
 403  * @param p_hwfn
 404  * @param intended_use
 405  * @param mode
 406  * @param num_elems
 407  * @param elem_size
 408  * @param p_chain
 409  *
 410  * @return enum _ecore_status_t
 411  */
 412 enum _ecore_status_t
 413 ecore_chain_alloc(struct ecore_dev *p_dev,
 414                   enum ecore_chain_use_mode intended_use,
 415                   enum ecore_chain_mode mode,
 416                   enum ecore_chain_cnt_type cnt_type,
 417                   u32 num_elems,
 418                   osal_size_t elem_size,
 419                   struct ecore_chain *p_chain,
 420                   struct ecore_chain_ext_pbl *ext_pbl);
 421
 422 /**
 423  * @brief ecore_chain_free - Free chain DMA memory
 424  *
 425  * @param p_hwfn
 426  * @param p_chain
 427  */
 428 void ecore_chain_free(struct ecore_dev *p_dev,
 429                       struct ecore_chain *p_chain);
 430
 431 /**
 432  * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID
 433  *
 434  *  @param p_hwfn
 435  *  @param src_id - relative to p_hwfn
 436  *  @param dst_id - absolute per engine
 437  *
 438  *  @return enum _ecore_status_t
 439  */
 440 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn,
 441                                        u16 src_id,
 442                                        u16 *dst_id);
 443
 444 /**
 445  * @@brief ecore_fw_vport - Get absolute vport ID
 446  *
 447  *  @param p_hwfn
 448  *  @param src_id - relative to p_hwfn
 449  *  @param dst_id - absolute per engine
 450  *
 451  *  @return enum _ecore_status_t
 452  */
 453 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn,
 454                                     u8 src_id,
 455                                     u8 *dst_id);
 456
 457 /**
 458  * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID
 459  *
 460  *  @param p_hwfn
 461  *  @param src_id - relative to p_hwfn
 462  *  @param dst_id - absolute per engine
 463  *
 464  *  @return enum _ecore_status_t
 465  */
 466 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn,
 467                                       u8 src_id,
 468                                       u8 *dst_id);
 469
 470 /**
 471  * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh
 472  *
 473  * @param p_hwfn
 474  * @param p_ptt
 475  * @param p_filter - MAC to add
 476  */
 477 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn,
 478                                           struct ecore_ptt *p_ptt,
 479                                           u8 *p_filter);
 480
 481 /**
 482  * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh
 483  *
 484  * @param p_hwfn
 485  * @param p_ptt
 486  * @param p_filter - MAC to remove
 487  */
 488 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn,
 489                              struct ecore_ptt *p_ptt,
 490                              u8 *p_filter);
 491
 492 enum ecore_llh_port_filter_type_t {
 493         ECORE_LLH_FILTER_ETHERTYPE,
 494         ECORE_LLH_FILTER_TCP_SRC_PORT,
 495         ECORE_LLH_FILTER_TCP_DEST_PORT,
 496         ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
 497         ECORE_LLH_FILTER_UDP_SRC_PORT,
 498         ECORE_LLH_FILTER_UDP_DEST_PORT,
 499         ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT
 500 };
 501
 502 /**
 503  * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh
 504  *
 505  * @param p_hwfn
 506  * @param p_ptt
 507  * @param source_port_or_eth_type - source port or ethertype to add
 508  * @param dest_port - destination port to add
 509  * @param type - type of filters and comparing
 510  */
 511 enum _ecore_status_t
 512 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn,
 513                               struct ecore_ptt *p_ptt,
 514                               u16 source_port_or_eth_type,
 515                               u16 dest_port,
 516                               enum ecore_llh_port_filter_type_t type);
 517
 518 /**
 519  * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh
 520  *
 521  * @param p_hwfn
 522  * @param p_ptt
 523  * @param source_port_or_eth_type - source port or ethertype to add
 524  * @param dest_port - destination port to add
 525  * @param type - type of filters and comparing
 526  */
 527 void
 528 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn,
 529                                  struct ecore_ptt *p_ptt,
 530                                  u16 source_port_or_eth_type,
 531                                  u16 dest_port,
 532                                  enum ecore_llh_port_filter_type_t type);
 533
 534 /**
 535  * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh
 536  *
 537  * @param p_hwfn
 538  * @param p_ptt
 539  */
 540 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn,
 541                              struct ecore_ptt *p_ptt);
 542
 543 /**
 544  * @brief ecore_llh_set_function_as_default - set function as default per port
 545  *
 546  * @param p_hwfn
 547  * @param p_ptt
 548  */
 549 enum _ecore_status_t
 550 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn,
 551                                   struct ecore_ptt *p_ptt);
 552
 553 /**
 554  *@brief Cleanup of previous driver remains prior to load
 555  *
 556  * @param p_hwfn
 557  * @param p_ptt
 558  * @param id - For PF, engine-relative. For VF, PF-relative.
 559  * @param is_vf - true iff cleanup is made for a VF.
 560  *
 561  * @return enum _ecore_status_t
 562  */
 563 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn      *p_hwfn,
 564                                          struct ecore_ptt       *p_ptt,
 565                                          u16                    id,
 566                                          bool                   is_vf);
 567 /**
 568  * @brief ecore_set_queue_coalesce - Configure coalesce parameters for Rx and
 569  *    Tx queue. The fact that we can configure coalescing to up to 511, but on
 570  *    varying accuracy [the bigger the value the less accurate] up to a mistake
 571  *    of 3usec for the highest values.
 572  *    While the API allows setting coalescing per-qid, all queues sharing a SB
 573  *    should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
 574  *    otherwise configuration would break.
 575  *
 576  * @param p_hwfn
 577  * @param rx_coal - Rx Coalesce value in micro seconds.
 578  * @param tx_coal - TX Coalesce value in micro seconds.
 579  * @param p_handle
 580  *
 581  * @return enum _ecore_status_t
 582  **/
 583 enum _ecore_status_t
 584 ecore_set_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 rx_coal,
 585                          u16 tx_coal, void *p_handle);
 586
 587 #endif