2 * Copyright (c) 2016 QLogic Corporation.
6 * See LICENSE.qede_pmd for copyright and licensing details.
9 #ifndef __ECORE_DEV_API_H__
10 #define __ECORE_DEV_API_H__
12 #include "ecore_status.h"
13 #include "ecore_chain.h"
14 #include "ecore_int_api.h"
17 * @brief ecore_init_dp - initialize the debug level
24 void ecore_init_dp(struct ecore_dev *p_dev,
30 * @brief ecore_init_struct - initialize the device structure to
35 void ecore_init_struct(struct ecore_dev *p_dev);
38 * @brief ecore_resc_free -
42 void ecore_resc_free(struct ecore_dev *p_dev);
45 * @brief ecore_resc_alloc -
49 * @return enum _ecore_status_t
51 enum _ecore_status_t ecore_resc_alloc(struct ecore_dev *p_dev);
54 * @brief ecore_resc_setup -
58 void ecore_resc_setup(struct ecore_dev *p_dev);
60 enum ecore_override_force_load {
61 ECORE_OVERRIDE_FORCE_LOAD_NONE,
62 ECORE_OVERRIDE_FORCE_LOAD_ALWAYS,
63 ECORE_OVERRIDE_FORCE_LOAD_NEVER,
66 struct ecore_drv_load_params {
67 /* Indicates whether the driver is running over a crash kernel.
68 * As part of the load request, this will be used for providing the
69 * driver role to the MFW.
70 * In case of a crash kernel over PDA - this should be set to false.
74 /* The timeout value that the MFW should use when locking the engine for
75 * the driver load process.
76 * A value of '0' means the default value, and '255' means no timeout.
79 #define ECORE_LOAD_REQ_LOCK_TO_DEFAULT 0
80 #define ECORE_LOAD_REQ_LOCK_TO_NONE 255
82 /* Avoid engine reset when first PF loads on it */
85 /* Allow overriding the default force load behavior */
86 enum ecore_override_force_load override_force_load;
89 struct ecore_hw_init_params {
90 /* Tunneling parameters */
91 struct ecore_tunnel_info *p_tunn;
95 /* Interrupt mode [msix, inta, etc.] to use */
96 enum ecore_int_mode int_mode;
98 /* NPAR tx switching to be used for vports configured for tx-switching
100 bool allow_npar_tx_switch;
102 /* Binary fw data pointer in binary fw file */
103 const u8 *bin_fw_data;
105 /* Driver load parameters */
106 struct ecore_drv_load_params *p_drv_load_params;
110 * @brief ecore_hw_init -
115 * @return enum _ecore_status_t
117 enum _ecore_status_t ecore_hw_init(struct ecore_dev *p_dev,
118 struct ecore_hw_init_params *p_params);
121 * @brief ecore_hw_timers_stop_all -
127 void ecore_hw_timers_stop_all(struct ecore_dev *p_dev);
130 * @brief ecore_hw_stop -
134 * @return enum _ecore_status_t
136 enum _ecore_status_t ecore_hw_stop(struct ecore_dev *p_dev);
139 * @brief ecore_hw_stop_fastpath -should be called incase
140 * slowpath is still required for the device,
141 * but fastpath is not.
145 * @return enum _ecore_status_t
147 enum _ecore_status_t ecore_hw_stop_fastpath(struct ecore_dev *p_dev);
151 * @brief ecore_prepare_hibernate -should be called when
152 * the system is going into the hibernate state
157 void ecore_prepare_hibernate(struct ecore_dev *p_dev);
159 enum ecore_db_rec_width {
164 enum ecore_db_rec_space {
170 * @brief db_recovery_add - add doorbell information to the doorbell
171 * recovery mechanism.
174 * @param db_addr - doorbell address
175 * @param db_data - address of where db_data is stored
176 * @param db_width - doorbell is 32b pr 64b
177 * @param db_space - doorbell recovery addresses are user or kernel space
179 enum _ecore_status_t ecore_db_recovery_add(struct ecore_dev *p_dev,
180 void OSAL_IOMEM *db_addr,
182 enum ecore_db_rec_width db_width,
183 enum ecore_db_rec_space db_space);
186 * @brief db_recovery_del - remove doorbell information from the doorbell
187 * recovery mechanism. db_data serves as key (db_addr is not unique).
190 * @param db_addr - doorbell address
191 * @param db_data - address where db_data is stored. Serves as key for the
194 enum _ecore_status_t ecore_db_recovery_del(struct ecore_dev *p_dev,
195 void OSAL_IOMEM *db_addr,
200 * @brief ecore_hw_start_fastpath -restart fastpath traffic,
201 * only if hw_stop_fastpath was called
205 * @return enum _ecore_status_t
207 enum _ecore_status_t ecore_hw_start_fastpath(struct ecore_hwfn *p_hwfn);
209 enum ecore_hw_prepare_result {
210 ECORE_HW_PREPARE_SUCCESS,
212 /* FAILED results indicate probe has failed & cleaned up */
213 ECORE_HW_PREPARE_FAILED_ENG2,
214 ECORE_HW_PREPARE_FAILED_ME,
215 ECORE_HW_PREPARE_FAILED_MEM,
216 ECORE_HW_PREPARE_FAILED_DEV,
217 ECORE_HW_PREPARE_FAILED_NVM,
219 /* BAD results indicate probe is passed even though some wrongness
220 * has occurred; Trying to actually use [I.e., hw_init()] might have
221 * dire reprecautions.
223 ECORE_HW_PREPARE_BAD_IOV,
224 ECORE_HW_PREPARE_BAD_MCP,
225 ECORE_HW_PREPARE_BAD_IGU,
228 struct ecore_hw_prepare_params {
229 /* Personality to initialize */
232 /* Force the driver's default resource allocation */
235 /* Check the reg_fifo after any register access */
238 /* Request the MFW to initiate PF FLR */
239 bool initiate_pf_flr;
241 /* The OS Epoch time in seconds */
244 /* Allow the MFW to collect a crash dump */
247 /* Allow prepare to pass even if some initializations are failing.
248 * If set, the `p_prepare_res' field would be set with the return,
249 * and might allow probe to pass even if there are certain issues.
251 bool b_relaxed_probe;
252 enum ecore_hw_prepare_result p_relaxed_res;
256 * @brief ecore_hw_prepare -
261 * @return enum _ecore_status_t
263 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev,
264 struct ecore_hw_prepare_params *p_params);
267 * @brief ecore_hw_remove -
271 void ecore_hw_remove(struct ecore_dev *p_dev);
274 * @brief ecore_ptt_acquire - Allocate a PTT window
276 * Should be called at the entry point to the driver (at the beginning of an
281 * @return struct ecore_ptt
283 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn);
286 * @brief ecore_ptt_release - Release PTT Window
288 * Should be called at the end of a flow - at the end of the function that
295 void ecore_ptt_release(struct ecore_hwfn *p_hwfn,
296 struct ecore_ptt *p_ptt);
298 #ifndef __EXTRACT__LINUX__
299 struct ecore_eth_stats_common {
300 u64 no_buff_discards;
301 u64 packet_too_big_discard;
309 u64 mftag_filter_discards;
310 u64 mac_filter_discards;
317 u64 tx_err_drop_pkts;
318 u64 tpa_coalesced_pkts;
319 u64 tpa_coalesced_events;
321 u64 tpa_not_coalesced_pkts;
322 u64 tpa_coalesced_bytes;
325 u64 rx_64_byte_packets;
326 u64 rx_65_to_127_byte_packets;
327 u64 rx_128_to_255_byte_packets;
328 u64 rx_256_to_511_byte_packets;
329 u64 rx_512_to_1023_byte_packets;
330 u64 rx_1024_to_1518_byte_packets;
332 u64 rx_mac_crtl_frames;
336 u64 rx_carrier_errors;
337 u64 rx_oversize_packets;
339 u64 rx_undersize_packets;
341 u64 tx_64_byte_packets;
342 u64 tx_65_to_127_byte_packets;
343 u64 tx_128_to_255_byte_packets;
344 u64 tx_256_to_511_byte_packets;
345 u64 tx_512_to_1023_byte_packets;
346 u64 tx_1024_to_1518_byte_packets;
352 u64 rx_mac_uc_packets;
353 u64 rx_mac_mc_packets;
354 u64 rx_mac_bc_packets;
355 u64 rx_mac_frames_ok;
357 u64 tx_mac_uc_packets;
358 u64 tx_mac_mc_packets;
359 u64 tx_mac_bc_packets;
360 u64 tx_mac_ctrl_frames;
363 struct ecore_eth_stats_bb {
364 u64 rx_1519_to_1522_byte_packets;
365 u64 rx_1519_to_2047_byte_packets;
366 u64 rx_2048_to_4095_byte_packets;
367 u64 rx_4096_to_9216_byte_packets;
368 u64 rx_9217_to_16383_byte_packets;
369 u64 tx_1519_to_2047_byte_packets;
370 u64 tx_2048_to_4095_byte_packets;
371 u64 tx_4096_to_9216_byte_packets;
372 u64 tx_9217_to_16383_byte_packets;
373 u64 tx_lpi_entry_count;
374 u64 tx_total_collisions;
377 struct ecore_eth_stats_ah {
378 u64 rx_1519_to_max_byte_packets;
379 u64 tx_1519_to_max_byte_packets;
382 struct ecore_eth_stats {
383 struct ecore_eth_stats_common common;
385 struct ecore_eth_stats_bb bb;
386 struct ecore_eth_stats_ah ah;
391 enum ecore_dmae_address_type_t {
392 ECORE_DMAE_ADDRESS_HOST_VIRT,
393 ECORE_DMAE_ADDRESS_HOST_PHYS,
394 ECORE_DMAE_ADDRESS_GRC
397 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the
398 * source is a block of length DMAE_MAX_RW_SIZE and the
399 * destination is larger, the source block will be duplicated as
400 * many times as required to fill the destination block. This is
401 * used mostly to write a zeroed buffer to destination address
404 #define ECORE_DMAE_FLAG_RW_REPL_SRC 0x00000001
405 #define ECORE_DMAE_FLAG_VF_SRC 0x00000002
406 #define ECORE_DMAE_FLAG_VF_DST 0x00000004
407 #define ECORE_DMAE_FLAG_COMPLETION_DST 0x00000008
409 struct ecore_dmae_params {
410 u32 flags; /* consists of ECORE_DMAE_FLAG_* values */
416 * @brief ecore_dmae_host2grc - copy data from source addr to
417 * dmae registers using the given ptt
422 * @param grc_addr (dmae_data_offset)
423 * @param size_in_dwords
424 * @param flags (one of the flags defined above)
427 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
428 struct ecore_ptt *p_ptt,
435 * @brief ecore_dmae_grc2host - Read data from dmae data offset
436 * to source address using the given ptt
439 * @param grc_addr (dmae_data_offset)
441 * @param size_in_dwords
442 * @param flags - one of the flags defined above
445 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
446 struct ecore_ptt *p_ptt,
448 dma_addr_t dest_addr,
453 * @brief ecore_dmae_host2host - copy data from to source address
454 * to a destination address (for SRIOV) using the given ptt
460 * @param size_in_dwords
464 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
465 struct ecore_ptt *p_ptt,
466 dma_addr_t source_addr,
467 dma_addr_t dest_addr,
469 struct ecore_dmae_params *p_params);
472 * @brief ecore_chain_alloc - Allocate and initialize a chain
475 * @param intended_use
481 * @return enum _ecore_status_t
484 ecore_chain_alloc(struct ecore_dev *p_dev,
485 enum ecore_chain_use_mode intended_use,
486 enum ecore_chain_mode mode,
487 enum ecore_chain_cnt_type cnt_type,
489 osal_size_t elem_size,
490 struct ecore_chain *p_chain,
491 struct ecore_chain_ext_pbl *ext_pbl);
494 * @brief ecore_chain_free - Free chain DMA memory
499 void ecore_chain_free(struct ecore_dev *p_dev,
500 struct ecore_chain *p_chain);
503 * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID
506 * @param src_id - relative to p_hwfn
507 * @param dst_id - absolute per engine
509 * @return enum _ecore_status_t
511 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn,
516 * @@brief ecore_fw_vport - Get absolute vport ID
519 * @param src_id - relative to p_hwfn
520 * @param dst_id - absolute per engine
522 * @return enum _ecore_status_t
524 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn,
529 * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID
532 * @param src_id - relative to p_hwfn
533 * @param dst_id - absolute per engine
535 * @return enum _ecore_status_t
537 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn,
542 * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh
546 * @param p_filter - MAC to add
548 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn,
549 struct ecore_ptt *p_ptt,
553 * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh
557 * @param p_filter - MAC to remove
559 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn,
560 struct ecore_ptt *p_ptt,
563 enum ecore_llh_port_filter_type_t {
564 ECORE_LLH_FILTER_ETHERTYPE,
565 ECORE_LLH_FILTER_TCP_SRC_PORT,
566 ECORE_LLH_FILTER_TCP_DEST_PORT,
567 ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
568 ECORE_LLH_FILTER_UDP_SRC_PORT,
569 ECORE_LLH_FILTER_UDP_DEST_PORT,
570 ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT
574 * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh
578 * @param source_port_or_eth_type - source port or ethertype to add
579 * @param dest_port - destination port to add
580 * @param type - type of filters and comparing
583 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn,
584 struct ecore_ptt *p_ptt,
585 u16 source_port_or_eth_type,
587 enum ecore_llh_port_filter_type_t type);
590 * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh
594 * @param source_port_or_eth_type - source port or ethertype to add
595 * @param dest_port - destination port to add
596 * @param type - type of filters and comparing
599 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn,
600 struct ecore_ptt *p_ptt,
601 u16 source_port_or_eth_type,
603 enum ecore_llh_port_filter_type_t type);
606 * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh
611 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn,
612 struct ecore_ptt *p_ptt);
615 * @brief ecore_llh_set_function_as_default - set function as default per port
621 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn,
622 struct ecore_ptt *p_ptt);
625 *@brief Cleanup of previous driver remains prior to load
629 * @param id - For PF, engine-relative. For VF, PF-relative.
630 * @param is_vf - true iff cleanup is made for a VF.
632 * @return enum _ecore_status_t
634 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn *p_hwfn,
635 struct ecore_ptt *p_ptt,
640 * @brief ecore_get_queue_coalesce - Retrieve coalesce value for a given queue.
643 * @param p_coal - store coalesce value read from the hardware.
646 * @return enum _ecore_status_t
649 ecore_get_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 *coal,
653 * @brief ecore_set_queue_coalesce - Configure coalesce parameters for Rx and
654 * Tx queue. The fact that we can configure coalescing to up to 511, but on
655 * varying accuracy [the bigger the value the less accurate] up to a mistake
656 * of 3usec for the highest values.
657 * While the API allows setting coalescing per-qid, all queues sharing a SB
658 * should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
659 * otherwise configuration would break.
662 * @param rx_coal - Rx Coalesce value in micro seconds.
663 * @param tx_coal - TX Coalesce value in micro seconds.
666 * @return enum _ecore_status_t
669 ecore_set_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 rx_coal,
670 u16 tx_coal, void *p_handle);
673 * @brief ecore_pglueb_set_pfid_enable - Enable or disable PCI BUS MASTER
677 * @param b_enable - true/false
679 * @return enum _ecore_status_t
681 enum _ecore_status_t ecore_pglueb_set_pfid_enable(struct ecore_hwfn *p_hwfn,
682 struct ecore_ptt *p_ptt,