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 struct ecore_hw_init_params {
61 /* tunnelling parameters */
62 struct ecore_tunnel_info *p_tunn;
64 /* interrupt mode [msix, inta, etc.] to use */
65 enum ecore_int_mode int_mode;
66 /* npar tx switching to be used for vports configured for tx-switching */
68 bool allow_npar_tx_switch;
69 /* binary fw data pointer in binary fw file */
70 const u8 *bin_fw_data;
74 * @brief ecore_hw_init -
79 * @return enum _ecore_status_t
81 enum _ecore_status_t ecore_hw_init(struct ecore_dev *p_dev,
82 struct ecore_hw_init_params *p_params);
85 * @brief ecore_hw_timers_stop_all -
91 void ecore_hw_timers_stop_all(struct ecore_dev *p_dev);
94 * @brief ecore_hw_stop -
98 * @return enum _ecore_status_t
100 enum _ecore_status_t ecore_hw_stop(struct ecore_dev *p_dev);
103 * @brief ecore_hw_stop_fastpath -should be called incase
104 * slowpath is still required for the device,
105 * but fastpath is not.
110 void ecore_hw_stop_fastpath(struct ecore_dev *p_dev);
114 * @brief ecore_prepare_hibernate -should be called when
115 * the system is going into the hibernate state
120 void ecore_prepare_hibernate(struct ecore_dev *p_dev);
124 * @brief ecore_hw_start_fastpath -restart fastpath traffic,
125 * only if hw_stop_fastpath was called
130 void ecore_hw_start_fastpath(struct ecore_hwfn *p_hwfn);
133 * @brief ecore_hw_reset -
137 * @return enum _ecore_status_t
139 enum _ecore_status_t ecore_hw_reset(struct ecore_dev *p_dev);
141 enum ecore_hw_prepare_result {
142 ECORE_HW_PREPARE_SUCCESS,
144 /* FAILED results indicate probe has failed & cleaned up */
145 ECORE_HW_PREPARE_FAILED_ENG2,
146 ECORE_HW_PREPARE_FAILED_ME,
147 ECORE_HW_PREPARE_FAILED_MEM,
148 ECORE_HW_PREPARE_FAILED_DEV,
149 ECORE_HW_PREPARE_FAILED_NVM,
151 /* BAD results indicate probe is passed even though some wrongness
152 * has occurred; Trying to actually use [I.e., hw_init()] might have
153 * dire reprecautions.
155 ECORE_HW_PREPARE_BAD_IOV,
156 ECORE_HW_PREPARE_BAD_MCP,
157 ECORE_HW_PREPARE_BAD_IGU,
160 struct ecore_hw_prepare_params {
161 /* Personality to initialize */
164 /* Force the driver's default resource allocation */
167 /* Check the reg_fifo after any register access */
170 /* Request the MFW to initiate PF FLR */
171 bool initiate_pf_flr;
173 /* The OS Epoch time in seconds */
176 /* Allow prepare to pass even if some initializations are failing.
177 * If set, the `p_prepare_res' field would be set with the return,
178 * and might allow probe to pass even if there are certain issues.
180 bool b_relaxed_probe;
181 enum ecore_hw_prepare_result p_relaxed_res;
185 * @brief ecore_hw_prepare -
190 * @return enum _ecore_status_t
192 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev,
193 struct ecore_hw_prepare_params *p_params);
196 * @brief ecore_hw_remove -
200 void ecore_hw_remove(struct ecore_dev *p_dev);
203 * @brief ecore_ptt_acquire - Allocate a PTT window
205 * Should be called at the entry point to the driver (at the beginning of an
210 * @return struct ecore_ptt
212 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn);
215 * @brief ecore_ptt_release - Release PTT Window
217 * Should be called at the end of a flow - at the end of the function that
224 void ecore_ptt_release(struct ecore_hwfn *p_hwfn,
225 struct ecore_ptt *p_ptt);
227 #ifndef __EXTRACT__LINUX__
228 struct ecore_eth_stats {
229 u64 no_buff_discards;
230 u64 packet_too_big_discard;
238 u64 mftag_filter_discards;
239 u64 mac_filter_discards;
246 u64 tx_err_drop_pkts;
247 u64 tpa_coalesced_pkts;
248 u64 tpa_coalesced_events;
250 u64 tpa_not_coalesced_pkts;
251 u64 tpa_coalesced_bytes;
254 u64 rx_64_byte_packets;
255 u64 rx_65_to_127_byte_packets;
256 u64 rx_128_to_255_byte_packets;
257 u64 rx_256_to_511_byte_packets;
258 u64 rx_512_to_1023_byte_packets;
259 u64 rx_1024_to_1518_byte_packets;
260 u64 rx_1519_to_1522_byte_packets;
261 u64 rx_1519_to_2047_byte_packets;
262 u64 rx_2048_to_4095_byte_packets;
263 u64 rx_4096_to_9216_byte_packets;
264 u64 rx_9217_to_16383_byte_packets;
266 u64 rx_mac_crtl_frames;
270 u64 rx_carrier_errors;
271 u64 rx_oversize_packets;
273 u64 rx_undersize_packets;
275 u64 tx_64_byte_packets;
276 u64 tx_65_to_127_byte_packets;
277 u64 tx_128_to_255_byte_packets;
278 u64 tx_256_to_511_byte_packets;
279 u64 tx_512_to_1023_byte_packets;
280 u64 tx_1024_to_1518_byte_packets;
281 u64 tx_1519_to_2047_byte_packets;
282 u64 tx_2048_to_4095_byte_packets;
283 u64 tx_4096_to_9216_byte_packets;
284 u64 tx_9217_to_16383_byte_packets;
287 u64 tx_lpi_entry_count;
288 u64 tx_total_collisions;
292 u64 rx_mac_uc_packets;
293 u64 rx_mac_mc_packets;
294 u64 rx_mac_bc_packets;
295 u64 rx_mac_frames_ok;
297 u64 tx_mac_uc_packets;
298 u64 tx_mac_mc_packets;
299 u64 tx_mac_bc_packets;
300 u64 tx_mac_ctrl_frames;
304 enum ecore_dmae_address_type_t {
305 ECORE_DMAE_ADDRESS_HOST_VIRT,
306 ECORE_DMAE_ADDRESS_HOST_PHYS,
307 ECORE_DMAE_ADDRESS_GRC
310 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the
311 * source is a block of length DMAE_MAX_RW_SIZE and the
312 * destination is larger, the source block will be duplicated as
313 * many times as required to fill the destination block. This is
314 * used mostly to write a zeroed buffer to destination address
317 #define ECORE_DMAE_FLAG_RW_REPL_SRC 0x00000001
318 #define ECORE_DMAE_FLAG_VF_SRC 0x00000002
319 #define ECORE_DMAE_FLAG_VF_DST 0x00000004
320 #define ECORE_DMAE_FLAG_COMPLETION_DST 0x00000008
322 struct ecore_dmae_params {
323 u32 flags; /* consists of ECORE_DMAE_FLAG_* values */
329 * @brief ecore_dmae_host2grc - copy data from source addr to
330 * dmae registers using the given ptt
335 * @param grc_addr (dmae_data_offset)
336 * @param size_in_dwords
337 * @param flags (one of the flags defined above)
340 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
341 struct ecore_ptt *p_ptt,
348 * @brief ecore_dmae_grc2host - Read data from dmae data offset
349 * to source address using the given ptt
352 * @param grc_addr (dmae_data_offset)
354 * @param size_in_dwords
355 * @param flags - one of the flags defined above
358 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
359 struct ecore_ptt *p_ptt,
361 dma_addr_t dest_addr,
366 * @brief ecore_dmae_host2host - copy data from to source address
367 * to a destination address (for SRIOV) using the given ptt
373 * @param size_in_dwords
377 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
378 struct ecore_ptt *p_ptt,
379 dma_addr_t source_addr,
380 dma_addr_t dest_addr,
382 struct ecore_dmae_params *p_params);
385 * @brief ecore_chain_alloc - Allocate and initialize a chain
388 * @param intended_use
394 * @return enum _ecore_status_t
397 ecore_chain_alloc(struct ecore_dev *p_dev,
398 enum ecore_chain_use_mode intended_use,
399 enum ecore_chain_mode mode,
400 enum ecore_chain_cnt_type cnt_type,
402 osal_size_t elem_size,
403 struct ecore_chain *p_chain,
404 struct ecore_chain_ext_pbl *ext_pbl);
407 * @brief ecore_chain_free - Free chain DMA memory
412 void ecore_chain_free(struct ecore_dev *p_dev,
413 struct ecore_chain *p_chain);
416 * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID
419 * @param src_id - relative to p_hwfn
420 * @param dst_id - absolute per engine
422 * @return enum _ecore_status_t
424 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn,
429 * @@brief ecore_fw_vport - Get absolute vport ID
432 * @param src_id - relative to p_hwfn
433 * @param dst_id - absolute per engine
435 * @return enum _ecore_status_t
437 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn,
442 * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID
445 * @param src_id - relative to p_hwfn
446 * @param dst_id - absolute per engine
448 * @return enum _ecore_status_t
450 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn,
455 * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh
459 * @param p_filter - MAC to add
461 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn,
462 struct ecore_ptt *p_ptt,
466 * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh
470 * @param p_filter - MAC to remove
472 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn,
473 struct ecore_ptt *p_ptt,
476 enum ecore_llh_port_filter_type_t {
477 ECORE_LLH_FILTER_ETHERTYPE,
478 ECORE_LLH_FILTER_TCP_SRC_PORT,
479 ECORE_LLH_FILTER_TCP_DEST_PORT,
480 ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
481 ECORE_LLH_FILTER_UDP_SRC_PORT,
482 ECORE_LLH_FILTER_UDP_DEST_PORT,
483 ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT
487 * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh
491 * @param source_port_or_eth_type - source port or ethertype to add
492 * @param dest_port - destination port to add
493 * @param type - type of filters and comparing
496 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn,
497 struct ecore_ptt *p_ptt,
498 u16 source_port_or_eth_type,
500 enum ecore_llh_port_filter_type_t type);
503 * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh
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
512 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn,
513 struct ecore_ptt *p_ptt,
514 u16 source_port_or_eth_type,
516 enum ecore_llh_port_filter_type_t type);
519 * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh
524 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn,
525 struct ecore_ptt *p_ptt);
528 * @brief ecore_llh_set_function_as_default - set function as default per port
534 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn,
535 struct ecore_ptt *p_ptt);
538 *@brief Cleanup of previous driver remains prior to load
542 * @param id - For PF, engine-relative. For VF, PF-relative.
543 * @param is_vf - true iff cleanup is made for a VF.
545 * @return enum _ecore_status_t
547 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn *p_hwfn,
548 struct ecore_ptt *p_ptt,
553 * @brief ecore_set_rxq_coalesce - Configure coalesce parameters for an Rx queue
554 * The fact that we can configure coalescing to up to 511, but on varying
555 * accuracy [the bigger the value the less accurate] up to a mistake of 3usec
556 * for the highest values.
560 * @param coalesce - Coalesce value in micro seconds.
561 * @param qid - Queue index.
564 * @return enum _ecore_status_t
566 enum _ecore_status_t ecore_set_rxq_coalesce(struct ecore_hwfn *p_hwfn,
567 struct ecore_ptt *p_ptt,
568 u16 coalesce, u16 qid, u16 sb_id);
571 * @brief ecore_set_txq_coalesce - Configure coalesce parameters for a Tx queue
572 * While the API allows setting coalescing per-qid, all tx queues sharing a
573 * SB should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
574 * otherwise configuration would break.
578 * @param coalesce - Coalesce value in micro seconds.
579 * @param qid - Queue index.
582 * @return enum _ecore_status_t
584 enum _ecore_status_t ecore_set_txq_coalesce(struct ecore_hwfn *p_hwfn,
585 struct ecore_ptt *p_ptt,
586 u16 coalesce, u16 qid, u16 sb_id);