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);
161 * @brief ecore_hw_start_fastpath -restart fastpath traffic,
162 * only if hw_stop_fastpath was called
166 * @return enum _ecore_status_t
168 enum _ecore_status_t ecore_hw_start_fastpath(struct ecore_hwfn *p_hwfn);
170 enum ecore_hw_prepare_result {
171 ECORE_HW_PREPARE_SUCCESS,
173 /* FAILED results indicate probe has failed & cleaned up */
174 ECORE_HW_PREPARE_FAILED_ENG2,
175 ECORE_HW_PREPARE_FAILED_ME,
176 ECORE_HW_PREPARE_FAILED_MEM,
177 ECORE_HW_PREPARE_FAILED_DEV,
178 ECORE_HW_PREPARE_FAILED_NVM,
180 /* BAD results indicate probe is passed even though some wrongness
181 * has occurred; Trying to actually use [I.e., hw_init()] might have
182 * dire reprecautions.
184 ECORE_HW_PREPARE_BAD_IOV,
185 ECORE_HW_PREPARE_BAD_MCP,
186 ECORE_HW_PREPARE_BAD_IGU,
189 struct ecore_hw_prepare_params {
190 /* Personality to initialize */
193 /* Force the driver's default resource allocation */
196 /* Check the reg_fifo after any register access */
199 /* Request the MFW to initiate PF FLR */
200 bool initiate_pf_flr;
202 /* The OS Epoch time in seconds */
205 /* Allow the MFW to collect a crash dump */
208 /* Allow prepare to pass even if some initializations are failing.
209 * If set, the `p_prepare_res' field would be set with the return,
210 * and might allow probe to pass even if there are certain issues.
212 bool b_relaxed_probe;
213 enum ecore_hw_prepare_result p_relaxed_res;
217 * @brief ecore_hw_prepare -
222 * @return enum _ecore_status_t
224 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev,
225 struct ecore_hw_prepare_params *p_params);
228 * @brief ecore_hw_remove -
232 void ecore_hw_remove(struct ecore_dev *p_dev);
235 * @brief ecore_ptt_acquire - Allocate a PTT window
237 * Should be called at the entry point to the driver (at the beginning of an
242 * @return struct ecore_ptt
244 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn);
247 * @brief ecore_ptt_release - Release PTT Window
249 * Should be called at the end of a flow - at the end of the function that
256 void ecore_ptt_release(struct ecore_hwfn *p_hwfn,
257 struct ecore_ptt *p_ptt);
259 #ifndef __EXTRACT__LINUX__
260 struct ecore_eth_stats_common {
261 u64 no_buff_discards;
262 u64 packet_too_big_discard;
270 u64 mftag_filter_discards;
271 u64 mac_filter_discards;
278 u64 tx_err_drop_pkts;
279 u64 tpa_coalesced_pkts;
280 u64 tpa_coalesced_events;
282 u64 tpa_not_coalesced_pkts;
283 u64 tpa_coalesced_bytes;
286 u64 rx_64_byte_packets;
287 u64 rx_65_to_127_byte_packets;
288 u64 rx_128_to_255_byte_packets;
289 u64 rx_256_to_511_byte_packets;
290 u64 rx_512_to_1023_byte_packets;
291 u64 rx_1024_to_1518_byte_packets;
293 u64 rx_mac_crtl_frames;
297 u64 rx_carrier_errors;
298 u64 rx_oversize_packets;
300 u64 rx_undersize_packets;
302 u64 tx_64_byte_packets;
303 u64 tx_65_to_127_byte_packets;
304 u64 tx_128_to_255_byte_packets;
305 u64 tx_256_to_511_byte_packets;
306 u64 tx_512_to_1023_byte_packets;
307 u64 tx_1024_to_1518_byte_packets;
313 u64 rx_mac_uc_packets;
314 u64 rx_mac_mc_packets;
315 u64 rx_mac_bc_packets;
316 u64 rx_mac_frames_ok;
318 u64 tx_mac_uc_packets;
319 u64 tx_mac_mc_packets;
320 u64 tx_mac_bc_packets;
321 u64 tx_mac_ctrl_frames;
324 struct ecore_eth_stats_bb {
325 u64 rx_1519_to_1522_byte_packets;
326 u64 rx_1519_to_2047_byte_packets;
327 u64 rx_2048_to_4095_byte_packets;
328 u64 rx_4096_to_9216_byte_packets;
329 u64 rx_9217_to_16383_byte_packets;
330 u64 tx_1519_to_2047_byte_packets;
331 u64 tx_2048_to_4095_byte_packets;
332 u64 tx_4096_to_9216_byte_packets;
333 u64 tx_9217_to_16383_byte_packets;
334 u64 tx_lpi_entry_count;
335 u64 tx_total_collisions;
338 struct ecore_eth_stats_ah {
339 u64 rx_1519_to_max_byte_packets;
340 u64 tx_1519_to_max_byte_packets;
343 struct ecore_eth_stats {
344 struct ecore_eth_stats_common common;
346 struct ecore_eth_stats_bb bb;
347 struct ecore_eth_stats_ah ah;
352 enum ecore_dmae_address_type_t {
353 ECORE_DMAE_ADDRESS_HOST_VIRT,
354 ECORE_DMAE_ADDRESS_HOST_PHYS,
355 ECORE_DMAE_ADDRESS_GRC
358 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the
359 * source is a block of length DMAE_MAX_RW_SIZE and the
360 * destination is larger, the source block will be duplicated as
361 * many times as required to fill the destination block. This is
362 * used mostly to write a zeroed buffer to destination address
365 #define ECORE_DMAE_FLAG_RW_REPL_SRC 0x00000001
366 #define ECORE_DMAE_FLAG_VF_SRC 0x00000002
367 #define ECORE_DMAE_FLAG_VF_DST 0x00000004
368 #define ECORE_DMAE_FLAG_COMPLETION_DST 0x00000008
370 struct ecore_dmae_params {
371 u32 flags; /* consists of ECORE_DMAE_FLAG_* values */
377 * @brief ecore_dmae_host2grc - copy data from source addr to
378 * dmae registers using the given ptt
383 * @param grc_addr (dmae_data_offset)
384 * @param size_in_dwords
385 * @param flags (one of the flags defined above)
388 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
389 struct ecore_ptt *p_ptt,
396 * @brief ecore_dmae_grc2host - Read data from dmae data offset
397 * to source address using the given ptt
400 * @param grc_addr (dmae_data_offset)
402 * @param size_in_dwords
403 * @param flags - one of the flags defined above
406 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
407 struct ecore_ptt *p_ptt,
409 dma_addr_t dest_addr,
414 * @brief ecore_dmae_host2host - copy data from to source address
415 * to a destination address (for SRIOV) using the given ptt
421 * @param size_in_dwords
425 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
426 struct ecore_ptt *p_ptt,
427 dma_addr_t source_addr,
428 dma_addr_t dest_addr,
430 struct ecore_dmae_params *p_params);
433 * @brief ecore_chain_alloc - Allocate and initialize a chain
436 * @param intended_use
442 * @return enum _ecore_status_t
445 ecore_chain_alloc(struct ecore_dev *p_dev,
446 enum ecore_chain_use_mode intended_use,
447 enum ecore_chain_mode mode,
448 enum ecore_chain_cnt_type cnt_type,
450 osal_size_t elem_size,
451 struct ecore_chain *p_chain,
452 struct ecore_chain_ext_pbl *ext_pbl);
455 * @brief ecore_chain_free - Free chain DMA memory
460 void ecore_chain_free(struct ecore_dev *p_dev,
461 struct ecore_chain *p_chain);
464 * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID
467 * @param src_id - relative to p_hwfn
468 * @param dst_id - absolute per engine
470 * @return enum _ecore_status_t
472 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn,
477 * @@brief ecore_fw_vport - Get absolute vport ID
480 * @param src_id - relative to p_hwfn
481 * @param dst_id - absolute per engine
483 * @return enum _ecore_status_t
485 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn,
490 * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID
493 * @param src_id - relative to p_hwfn
494 * @param dst_id - absolute per engine
496 * @return enum _ecore_status_t
498 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn,
503 * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh
507 * @param p_filter - MAC to add
509 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn,
510 struct ecore_ptt *p_ptt,
514 * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh
518 * @param p_filter - MAC to remove
520 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn,
521 struct ecore_ptt *p_ptt,
524 enum ecore_llh_port_filter_type_t {
525 ECORE_LLH_FILTER_ETHERTYPE,
526 ECORE_LLH_FILTER_TCP_SRC_PORT,
527 ECORE_LLH_FILTER_TCP_DEST_PORT,
528 ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
529 ECORE_LLH_FILTER_UDP_SRC_PORT,
530 ECORE_LLH_FILTER_UDP_DEST_PORT,
531 ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT
535 * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh
539 * @param source_port_or_eth_type - source port or ethertype to add
540 * @param dest_port - destination port to add
541 * @param type - type of filters and comparing
544 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn,
545 struct ecore_ptt *p_ptt,
546 u16 source_port_or_eth_type,
548 enum ecore_llh_port_filter_type_t type);
551 * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh
555 * @param source_port_or_eth_type - source port or ethertype to add
556 * @param dest_port - destination port to add
557 * @param type - type of filters and comparing
560 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn,
561 struct ecore_ptt *p_ptt,
562 u16 source_port_or_eth_type,
564 enum ecore_llh_port_filter_type_t type);
567 * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh
572 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn,
573 struct ecore_ptt *p_ptt);
576 * @brief ecore_llh_set_function_as_default - set function as default per port
582 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn,
583 struct ecore_ptt *p_ptt);
586 *@brief Cleanup of previous driver remains prior to load
590 * @param id - For PF, engine-relative. For VF, PF-relative.
591 * @param is_vf - true iff cleanup is made for a VF.
593 * @return enum _ecore_status_t
595 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn *p_hwfn,
596 struct ecore_ptt *p_ptt,
600 * @brief ecore_set_queue_coalesce - Configure coalesce parameters for Rx and
601 * Tx queue. The fact that we can configure coalescing to up to 511, but on
602 * varying accuracy [the bigger the value the less accurate] up to a mistake
603 * of 3usec for the highest values.
604 * While the API allows setting coalescing per-qid, all queues sharing a SB
605 * should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
606 * otherwise configuration would break.
609 * @param rx_coal - Rx Coalesce value in micro seconds.
610 * @param tx_coal - TX Coalesce value in micro seconds.
613 * @return enum _ecore_status_t
616 ecore_set_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 rx_coal,
617 u16 tx_coal, void *p_handle);
620 * @brief ecore_pglueb_set_pfid_enable - Enable or disable PCI BUS MASTER
624 * @param b_enable - true/false
626 * @return enum _ecore_status_t
628 enum _ecore_status_t ecore_pglueb_set_pfid_enable(struct ecore_hwfn *p_hwfn,
629 struct ecore_ptt *p_ptt,