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 enum _ecore_status_t 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_mfw_timeout_fallback {
61 ECORE_TO_FALLBACK_TO_NONE,
62 ECORE_TO_FALLBACK_TO_DEFAULT,
63 ECORE_TO_FALLBACK_FAIL_LOAD,
66 enum ecore_override_force_load {
67 ECORE_OVERRIDE_FORCE_LOAD_NONE,
68 ECORE_OVERRIDE_FORCE_LOAD_ALWAYS,
69 ECORE_OVERRIDE_FORCE_LOAD_NEVER,
72 struct ecore_drv_load_params {
73 /* Indicates whether the driver is running over a crash kernel.
74 * As part of the load request, this will be used for providing the
75 * driver role to the MFW.
76 * In case of a crash kernel over PDA - this should be set to false.
80 /* The timeout value that the MFW should use when locking the engine for
81 * the driver load process.
82 * A value of '0' means the default value, and '255' means no timeout.
85 #define ECORE_LOAD_REQ_LOCK_TO_DEFAULT 0
86 #define ECORE_LOAD_REQ_LOCK_TO_NONE 255
88 /* Action to take in case the MFW doesn't support timeout values other
89 * than default and none.
91 enum ecore_mfw_timeout_fallback mfw_timeout_fallback;
93 /* Avoid engine reset when first PF loads on it */
96 /* Allow overriding the default force load behavior */
97 enum ecore_override_force_load override_force_load;
100 struct ecore_hw_init_params {
101 /* Tunneling parameters */
102 struct ecore_tunnel_info *p_tunn;
106 /* Interrupt mode [msix, inta, etc.] to use */
107 enum ecore_int_mode int_mode;
109 /* NPAR tx switching to be used for vports configured for tx-switching
111 bool allow_npar_tx_switch;
113 /* Binary fw data pointer in binary fw file */
114 const u8 *bin_fw_data;
116 /* Driver load parameters */
117 struct ecore_drv_load_params *p_drv_load_params;
119 /* SPQ block timeout in msec */
124 * @brief ecore_hw_init -
129 * @return enum _ecore_status_t
131 enum _ecore_status_t ecore_hw_init(struct ecore_dev *p_dev,
132 struct ecore_hw_init_params *p_params);
135 * @brief ecore_hw_timers_stop_all -
141 void ecore_hw_timers_stop_all(struct ecore_dev *p_dev);
144 * @brief ecore_hw_stop -
148 * @return enum _ecore_status_t
150 enum _ecore_status_t ecore_hw_stop(struct ecore_dev *p_dev);
153 * @brief ecore_hw_stop_fastpath -should be called incase
154 * slowpath is still required for the device,
155 * but fastpath is not.
159 * @return enum _ecore_status_t
161 enum _ecore_status_t ecore_hw_stop_fastpath(struct ecore_dev *p_dev);
165 * @brief ecore_prepare_hibernate -should be called when
166 * the system is going into the hibernate state
171 void ecore_prepare_hibernate(struct ecore_dev *p_dev);
173 enum ecore_db_rec_width {
178 enum ecore_db_rec_space {
184 * @brief db_recovery_add - add doorbell information to the doorbell
185 * recovery mechanism.
188 * @param db_addr - doorbell address
189 * @param db_data - address of where db_data is stored
190 * @param db_width - doorbell is 32b pr 64b
191 * @param db_space - doorbell recovery addresses are user or kernel space
193 enum _ecore_status_t ecore_db_recovery_add(struct ecore_dev *p_dev,
194 void OSAL_IOMEM *db_addr,
196 enum ecore_db_rec_width db_width,
197 enum ecore_db_rec_space db_space);
200 * @brief db_recovery_del - remove doorbell information from the doorbell
201 * recovery mechanism. db_data serves as key (db_addr is not unique).
204 * @param db_addr - doorbell address
205 * @param db_data - address where db_data is stored. Serves as key for the
208 enum _ecore_status_t ecore_db_recovery_del(struct ecore_dev *p_dev,
209 void OSAL_IOMEM *db_addr,
212 static OSAL_INLINE bool ecore_is_mf_ufp(struct ecore_hwfn *p_hwfn)
214 return !!OSAL_TEST_BIT(ECORE_MF_UFP_SPECIFIC, &p_hwfn->p_dev->mf_bits);
220 * @brief ecore_hw_start_fastpath -restart fastpath traffic,
221 * only if hw_stop_fastpath was called
225 * @return enum _ecore_status_t
227 enum _ecore_status_t ecore_hw_start_fastpath(struct ecore_hwfn *p_hwfn);
229 enum ecore_hw_prepare_result {
230 ECORE_HW_PREPARE_SUCCESS,
232 /* FAILED results indicate probe has failed & cleaned up */
233 ECORE_HW_PREPARE_FAILED_ENG2,
234 ECORE_HW_PREPARE_FAILED_ME,
235 ECORE_HW_PREPARE_FAILED_MEM,
236 ECORE_HW_PREPARE_FAILED_DEV,
237 ECORE_HW_PREPARE_FAILED_NVM,
239 /* BAD results indicate probe is passed even though some wrongness
240 * has occurred; Trying to actually use [I.e., hw_init()] might have
241 * dire reprecautions.
243 ECORE_HW_PREPARE_BAD_IOV,
244 ECORE_HW_PREPARE_BAD_MCP,
245 ECORE_HW_PREPARE_BAD_IGU,
248 struct ecore_hw_prepare_params {
249 /* Personality to initialize */
252 /* Force the driver's default resource allocation */
255 /* Check the reg_fifo after any register access */
258 /* Request the MFW to initiate PF FLR */
259 bool initiate_pf_flr;
261 /* The OS Epoch time in seconds */
264 /* Allow the MFW to collect a crash dump */
267 /* Allow prepare to pass even if some initializations are failing.
268 * If set, the `p_prepare_res' field would be set with the return,
269 * and might allow probe to pass even if there are certain issues.
271 bool b_relaxed_probe;
272 enum ecore_hw_prepare_result p_relaxed_res;
276 * @brief ecore_hw_prepare -
281 * @return enum _ecore_status_t
283 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev,
284 struct ecore_hw_prepare_params *p_params);
287 * @brief ecore_hw_remove -
291 void ecore_hw_remove(struct ecore_dev *p_dev);
294 * @brief ecore_ptt_acquire - Allocate a PTT window
296 * Should be called at the entry point to the driver (at the beginning of an
301 * @return struct ecore_ptt
303 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn);
306 * @brief ecore_ptt_release - Release PTT Window
308 * Should be called at the end of a flow - at the end of the function that
315 void ecore_ptt_release(struct ecore_hwfn *p_hwfn,
316 struct ecore_ptt *p_ptt);
318 struct ecore_eth_stats_common {
319 u64 no_buff_discards;
320 u64 packet_too_big_discard;
328 u64 mftag_filter_discards;
329 u64 mac_filter_discards;
336 u64 tx_err_drop_pkts;
337 u64 tpa_coalesced_pkts;
338 u64 tpa_coalesced_events;
340 u64 tpa_not_coalesced_pkts;
341 u64 tpa_coalesced_bytes;
344 u64 rx_64_byte_packets;
345 u64 rx_65_to_127_byte_packets;
346 u64 rx_128_to_255_byte_packets;
347 u64 rx_256_to_511_byte_packets;
348 u64 rx_512_to_1023_byte_packets;
349 u64 rx_1024_to_1518_byte_packets;
351 u64 rx_mac_crtl_frames;
355 u64 rx_carrier_errors;
356 u64 rx_oversize_packets;
358 u64 rx_undersize_packets;
360 u64 tx_64_byte_packets;
361 u64 tx_65_to_127_byte_packets;
362 u64 tx_128_to_255_byte_packets;
363 u64 tx_256_to_511_byte_packets;
364 u64 tx_512_to_1023_byte_packets;
365 u64 tx_1024_to_1518_byte_packets;
371 u64 rx_mac_uc_packets;
372 u64 rx_mac_mc_packets;
373 u64 rx_mac_bc_packets;
374 u64 rx_mac_frames_ok;
376 u64 tx_mac_uc_packets;
377 u64 tx_mac_mc_packets;
378 u64 tx_mac_bc_packets;
379 u64 tx_mac_ctrl_frames;
382 struct ecore_eth_stats_bb {
383 u64 rx_1519_to_1522_byte_packets;
384 u64 rx_1519_to_2047_byte_packets;
385 u64 rx_2048_to_4095_byte_packets;
386 u64 rx_4096_to_9216_byte_packets;
387 u64 rx_9217_to_16383_byte_packets;
388 u64 tx_1519_to_2047_byte_packets;
389 u64 tx_2048_to_4095_byte_packets;
390 u64 tx_4096_to_9216_byte_packets;
391 u64 tx_9217_to_16383_byte_packets;
392 u64 tx_lpi_entry_count;
393 u64 tx_total_collisions;
396 struct ecore_eth_stats_ah {
397 u64 rx_1519_to_max_byte_packets;
398 u64 tx_1519_to_max_byte_packets;
401 struct ecore_eth_stats {
402 struct ecore_eth_stats_common common;
404 struct ecore_eth_stats_bb bb;
405 struct ecore_eth_stats_ah ah;
409 enum ecore_dmae_address_type_t {
410 ECORE_DMAE_ADDRESS_HOST_VIRT,
411 ECORE_DMAE_ADDRESS_HOST_PHYS,
412 ECORE_DMAE_ADDRESS_GRC
415 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the
416 * source is a block of length DMAE_MAX_RW_SIZE and the
417 * destination is larger, the source block will be duplicated as
418 * many times as required to fill the destination block. This is
419 * used mostly to write a zeroed buffer to destination address
422 #define ECORE_DMAE_FLAG_RW_REPL_SRC 0x00000001
423 #define ECORE_DMAE_FLAG_VF_SRC 0x00000002
424 #define ECORE_DMAE_FLAG_VF_DST 0x00000004
425 #define ECORE_DMAE_FLAG_COMPLETION_DST 0x00000008
427 struct ecore_dmae_params {
428 u32 flags; /* consists of ECORE_DMAE_FLAG_* values */
434 * @brief ecore_dmae_host2grc - copy data from source addr to
435 * dmae registers using the given ptt
440 * @param grc_addr (dmae_data_offset)
441 * @param size_in_dwords
442 * @param flags (one of the flags defined above)
445 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
446 struct ecore_ptt *p_ptt,
453 * @brief ecore_dmae_grc2host - Read data from dmae data offset
454 * to source address using the given ptt
457 * @param grc_addr (dmae_data_offset)
459 * @param size_in_dwords
460 * @param flags - one of the flags defined above
463 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
464 struct ecore_ptt *p_ptt,
466 dma_addr_t dest_addr,
471 * @brief ecore_dmae_host2host - copy data from to source address
472 * to a destination address (for SRIOV) using the given ptt
478 * @param size_in_dwords
482 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
483 struct ecore_ptt *p_ptt,
484 dma_addr_t source_addr,
485 dma_addr_t dest_addr,
487 struct ecore_dmae_params *p_params);
490 * @brief ecore_chain_alloc - Allocate and initialize a chain
493 * @param intended_use
499 * @return enum _ecore_status_t
502 ecore_chain_alloc(struct ecore_dev *p_dev,
503 enum ecore_chain_use_mode intended_use,
504 enum ecore_chain_mode mode,
505 enum ecore_chain_cnt_type cnt_type,
507 osal_size_t elem_size,
508 struct ecore_chain *p_chain,
509 struct ecore_chain_ext_pbl *ext_pbl);
512 * @brief ecore_chain_free - Free chain DMA memory
517 void ecore_chain_free(struct ecore_dev *p_dev,
518 struct ecore_chain *p_chain);
521 * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID
524 * @param src_id - relative to p_hwfn
525 * @param dst_id - absolute per engine
527 * @return enum _ecore_status_t
529 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn,
534 * @@brief ecore_fw_vport - Get absolute vport ID
537 * @param src_id - relative to p_hwfn
538 * @param dst_id - absolute per engine
540 * @return enum _ecore_status_t
542 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn,
547 * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID
550 * @param src_id - relative to p_hwfn
551 * @param dst_id - absolute per engine
553 * @return enum _ecore_status_t
555 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn,
560 * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh
564 * @param p_filter - MAC to add
566 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn,
567 struct ecore_ptt *p_ptt,
571 * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh
575 * @param p_filter - MAC to remove
577 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn,
578 struct ecore_ptt *p_ptt,
581 enum ecore_llh_port_filter_type_t {
582 ECORE_LLH_FILTER_ETHERTYPE,
583 ECORE_LLH_FILTER_TCP_SRC_PORT,
584 ECORE_LLH_FILTER_TCP_DEST_PORT,
585 ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
586 ECORE_LLH_FILTER_UDP_SRC_PORT,
587 ECORE_LLH_FILTER_UDP_DEST_PORT,
588 ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT
592 * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh
596 * @param source_port_or_eth_type - source port or ethertype to add
597 * @param dest_port - destination port to add
598 * @param type - type of filters and comparing
601 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn,
602 struct ecore_ptt *p_ptt,
603 u16 source_port_or_eth_type,
605 enum ecore_llh_port_filter_type_t type);
608 * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh
612 * @param source_port_or_eth_type - source port or ethertype to add
613 * @param dest_port - destination port to add
614 * @param type - type of filters and comparing
617 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn,
618 struct ecore_ptt *p_ptt,
619 u16 source_port_or_eth_type,
621 enum ecore_llh_port_filter_type_t type);
624 * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh
629 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn,
630 struct ecore_ptt *p_ptt);
633 * @brief ecore_llh_set_function_as_default - set function as default per port
639 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn,
640 struct ecore_ptt *p_ptt);
643 *@brief Cleanup of previous driver remains prior to load
647 * @param id - For PF, engine-relative. For VF, PF-relative.
648 * @param is_vf - true iff cleanup is made for a VF.
650 * @return enum _ecore_status_t
652 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn *p_hwfn,
653 struct ecore_ptt *p_ptt,
658 * @brief ecore_get_queue_coalesce - Retrieve coalesce value for a given queue.
661 * @param p_coal - store coalesce value read from the hardware.
664 * @return enum _ecore_status_t
667 ecore_get_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 *coal,
671 * @brief ecore_set_queue_coalesce - Configure coalesce parameters for Rx and
672 * Tx queue. The fact that we can configure coalescing to up to 511, but on
673 * varying accuracy [the bigger the value the less accurate] up to a mistake
674 * of 3usec for the highest values.
675 * While the API allows setting coalescing per-qid, all queues sharing a SB
676 * should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
677 * otherwise configuration would break.
680 * @param rx_coal - Rx Coalesce value in micro seconds.
681 * @param tx_coal - TX Coalesce value in micro seconds.
684 * @return enum _ecore_status_t
687 ecore_set_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 rx_coal,
688 u16 tx_coal, void *p_handle);
691 * @brief ecore_pglueb_set_pfid_enable - Enable or disable PCI BUS MASTER
695 * @param b_enable - true/false
697 * @return enum _ecore_status_t
699 enum _ecore_status_t ecore_pglueb_set_pfid_enable(struct ecore_hwfn *p_hwfn,
700 struct ecore_ptt *p_ptt,