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_tunn_start_params *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;
71 /* the OS Epoch time in seconds */
76 * @brief ecore_hw_init -
81 * @return enum _ecore_status_t
83 enum _ecore_status_t ecore_hw_init(struct ecore_dev *p_dev,
84 struct ecore_hw_init_params *p_params);
87 * @brief ecore_hw_timers_stop_all -
93 void ecore_hw_timers_stop_all(struct ecore_dev *p_dev);
96 * @brief ecore_hw_stop -
100 * @return enum _ecore_status_t
102 enum _ecore_status_t ecore_hw_stop(struct ecore_dev *p_dev);
105 * @brief ecore_hw_stop_fastpath -should be called incase
106 * slowpath is still required for the device,
107 * but fastpath is not.
112 void ecore_hw_stop_fastpath(struct ecore_dev *p_dev);
116 * @brief ecore_prepare_hibernate -should be called when
117 * the system is going into the hibernate state
122 void ecore_prepare_hibernate(struct ecore_dev *p_dev);
126 * @brief ecore_hw_start_fastpath -restart fastpath traffic,
127 * only if hw_stop_fastpath was called
132 void ecore_hw_start_fastpath(struct ecore_hwfn *p_hwfn);
135 * @brief ecore_hw_reset -
139 * @return enum _ecore_status_t
141 enum _ecore_status_t ecore_hw_reset(struct ecore_dev *p_dev);
143 struct ecore_hw_prepare_params {
144 /* personality to initialize */
146 /* force the driver's default resource allocation */
148 /* check the reg_fifo after any register access */
153 * @brief ecore_hw_prepare -
158 * @return enum _ecore_status_t
160 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev,
161 struct ecore_hw_prepare_params *p_params);
164 * @brief ecore_hw_remove -
168 void ecore_hw_remove(struct ecore_dev *p_dev);
171 * @brief ecore_ptt_acquire - Allocate a PTT window
173 * Should be called at the entry point to the driver (at the beginning of an
178 * @return struct ecore_ptt
180 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn);
183 * @brief ecore_ptt_release - Release PTT Window
185 * Should be called at the end of a flow - at the end of the function that
192 void ecore_ptt_release(struct ecore_hwfn *p_hwfn,
193 struct ecore_ptt *p_ptt);
195 #ifndef __EXTRACT__LINUX__
196 struct ecore_eth_stats {
197 u64 no_buff_discards;
198 u64 packet_too_big_discard;
206 u64 mftag_filter_discards;
207 u64 mac_filter_discards;
214 u64 tx_err_drop_pkts;
215 u64 tpa_coalesced_pkts;
216 u64 tpa_coalesced_events;
218 u64 tpa_not_coalesced_pkts;
219 u64 tpa_coalesced_bytes;
222 u64 rx_64_byte_packets;
223 u64 rx_65_to_127_byte_packets;
224 u64 rx_128_to_255_byte_packets;
225 u64 rx_256_to_511_byte_packets;
226 u64 rx_512_to_1023_byte_packets;
227 u64 rx_1024_to_1518_byte_packets;
228 u64 rx_1519_to_1522_byte_packets;
229 u64 rx_1519_to_2047_byte_packets;
230 u64 rx_2048_to_4095_byte_packets;
231 u64 rx_4096_to_9216_byte_packets;
232 u64 rx_9217_to_16383_byte_packets;
234 u64 rx_mac_crtl_frames;
238 u64 rx_carrier_errors;
239 u64 rx_oversize_packets;
241 u64 rx_undersize_packets;
243 u64 tx_64_byte_packets;
244 u64 tx_65_to_127_byte_packets;
245 u64 tx_128_to_255_byte_packets;
246 u64 tx_256_to_511_byte_packets;
247 u64 tx_512_to_1023_byte_packets;
248 u64 tx_1024_to_1518_byte_packets;
249 u64 tx_1519_to_2047_byte_packets;
250 u64 tx_2048_to_4095_byte_packets;
251 u64 tx_4096_to_9216_byte_packets;
252 u64 tx_9217_to_16383_byte_packets;
255 u64 tx_lpi_entry_count;
256 u64 tx_total_collisions;
260 u64 rx_mac_uc_packets;
261 u64 rx_mac_mc_packets;
262 u64 rx_mac_bc_packets;
263 u64 rx_mac_frames_ok;
265 u64 tx_mac_uc_packets;
266 u64 tx_mac_mc_packets;
267 u64 tx_mac_bc_packets;
268 u64 tx_mac_ctrl_frames;
272 enum ecore_dmae_address_type_t {
273 ECORE_DMAE_ADDRESS_HOST_VIRT,
274 ECORE_DMAE_ADDRESS_HOST_PHYS,
275 ECORE_DMAE_ADDRESS_GRC
278 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the
279 * source is a block of length DMAE_MAX_RW_SIZE and the
280 * destination is larger, the source block will be duplicated as
281 * many times as required to fill the destination block. This is
282 * used mostly to write a zeroed buffer to destination address
285 #define ECORE_DMAE_FLAG_RW_REPL_SRC 0x00000001
286 #define ECORE_DMAE_FLAG_VF_SRC 0x00000002
287 #define ECORE_DMAE_FLAG_VF_DST 0x00000004
288 #define ECORE_DMAE_FLAG_COMPLETION_DST 0x00000008
290 struct ecore_dmae_params {
291 u32 flags; /* consists of ECORE_DMAE_FLAG_* values */
297 * @brief ecore_dmae_host2grc - copy data from source addr to
298 * dmae registers using the given ptt
303 * @param grc_addr (dmae_data_offset)
304 * @param size_in_dwords
305 * @param flags (one of the flags defined above)
308 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
309 struct ecore_ptt *p_ptt,
316 * @brief ecore_dmae_grc2host - Read data from dmae data offset
317 * to source address using the given ptt
320 * @param grc_addr (dmae_data_offset)
322 * @param size_in_dwords
323 * @param flags - one of the flags defined above
326 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
327 struct ecore_ptt *p_ptt,
329 dma_addr_t dest_addr,
334 * @brief ecore_dmae_host2host - copy data from to source address
335 * to a destination address (for SRIOV) using the given ptt
341 * @param size_in_dwords
345 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
346 struct ecore_ptt *p_ptt,
347 dma_addr_t source_addr,
348 dma_addr_t dest_addr,
350 struct ecore_dmae_params *p_params);
353 * @brief ecore_chain_alloc - Allocate and initialize a chain
356 * @param intended_use
362 * @return enum _ecore_status_t
365 ecore_chain_alloc(struct ecore_dev *p_dev,
366 enum ecore_chain_use_mode intended_use,
367 enum ecore_chain_mode mode,
368 enum ecore_chain_cnt_type cnt_type,
370 osal_size_t elem_size,
371 struct ecore_chain *p_chain);
374 * @brief ecore_chain_free - Free chain DMA memory
379 void ecore_chain_free(struct ecore_dev *p_dev,
380 struct ecore_chain *p_chain);
383 * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID
386 * @param src_id - relative to p_hwfn
387 * @param dst_id - absolute per engine
389 * @return enum _ecore_status_t
391 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn,
396 * @@brief ecore_fw_vport - Get absolute vport ID
399 * @param src_id - relative to p_hwfn
400 * @param dst_id - absolute per engine
402 * @return enum _ecore_status_t
404 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn,
409 * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID
412 * @param src_id - relative to p_hwfn
413 * @param dst_id - absolute per engine
415 * @return enum _ecore_status_t
417 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn,
422 * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh
426 * @param p_filter - MAC to add
428 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn,
429 struct ecore_ptt *p_ptt,
433 * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh
437 * @param p_filter - MAC to remove
439 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn,
440 struct ecore_ptt *p_ptt,
443 enum ecore_llh_port_filter_type_t {
444 ECORE_LLH_FILTER_ETHERTYPE,
445 ECORE_LLH_FILTER_TCP_SRC_PORT,
446 ECORE_LLH_FILTER_TCP_DEST_PORT,
447 ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
448 ECORE_LLH_FILTER_UDP_SRC_PORT,
449 ECORE_LLH_FILTER_UDP_DEST_PORT,
450 ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT
454 * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh
458 * @param source_port_or_eth_type - source port or ethertype to add
459 * @param dest_port - destination port to add
460 * @param type - type of filters and comparing
463 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn,
464 struct ecore_ptt *p_ptt,
465 u16 source_port_or_eth_type,
467 enum ecore_llh_port_filter_type_t type);
470 * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh
474 * @param source_port_or_eth_type - source port or ethertype to add
475 * @param dest_port - destination port to add
476 * @param type - type of filters and comparing
479 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn,
480 struct ecore_ptt *p_ptt,
481 u16 source_port_or_eth_type,
483 enum ecore_llh_port_filter_type_t type);
486 * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh
491 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn,
492 struct ecore_ptt *p_ptt);
495 * @brief ecore_llh_set_function_as_default - set function as default per port
501 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn,
502 struct ecore_ptt *p_ptt);
505 *@brief Cleanup of previous driver remains prior to load
509 * @param id - For PF, engine-relative. For VF, PF-relative.
510 * @param is_vf - true iff cleanup is made for a VF.
512 * @return enum _ecore_status_t
514 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn *p_hwfn,
515 struct ecore_ptt *p_ptt,
520 * @brief ecore_set_rxq_coalesce - Configure coalesce parameters for an Rx queue
521 * The fact that we can configure coalescing to up to 511, but on varying
522 * accuracy [the bigger the value the less accurate] up to a mistake of 3usec
523 * for the highest values.
527 * @param coalesce - Coalesce value in micro seconds.
528 * @param qid - Queue index.
531 * @return enum _ecore_status_t
533 enum _ecore_status_t ecore_set_rxq_coalesce(struct ecore_hwfn *p_hwfn,
534 struct ecore_ptt *p_ptt,
535 u16 coalesce, u8 qid, u16 sb_id);
538 * @brief ecore_set_txq_coalesce - Configure coalesce parameters for a Tx queue
539 * While the API allows setting coalescing per-qid, all tx queues sharing a
540 * SB should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
541 * otherwise configuration would break.
545 * @param coalesce - Coalesce value in micro seconds.
546 * @param qid - Queue index.
549 * @return enum _ecore_status_t
551 enum _ecore_status_t ecore_set_txq_coalesce(struct ecore_hwfn *p_hwfn,
552 struct ecore_ptt *p_ptt,
553 u16 coalesce, u8 qid, u16 sb_id);