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;
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 struct ecore_hw_prepare_params {
142 /* personality to initialize */
144 /* force the driver's default resource allocation */
146 /* check the reg_fifo after any register access */
148 /* request the MFW to initiate PF FLR */
149 bool initiate_pf_flr;
150 /* the OS Epoch time in seconds */
155 * @brief ecore_hw_prepare -
160 * @return enum _ecore_status_t
162 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev,
163 struct ecore_hw_prepare_params *p_params);
166 * @brief ecore_hw_remove -
170 void ecore_hw_remove(struct ecore_dev *p_dev);
173 * @brief ecore_ptt_acquire - Allocate a PTT window
175 * Should be called at the entry point to the driver (at the beginning of an
180 * @return struct ecore_ptt
182 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn);
185 * @brief ecore_ptt_release - Release PTT Window
187 * Should be called at the end of a flow - at the end of the function that
194 void ecore_ptt_release(struct ecore_hwfn *p_hwfn,
195 struct ecore_ptt *p_ptt);
197 #ifndef __EXTRACT__LINUX__
198 struct ecore_eth_stats {
199 u64 no_buff_discards;
200 u64 packet_too_big_discard;
208 u64 mftag_filter_discards;
209 u64 mac_filter_discards;
216 u64 tx_err_drop_pkts;
217 u64 tpa_coalesced_pkts;
218 u64 tpa_coalesced_events;
220 u64 tpa_not_coalesced_pkts;
221 u64 tpa_coalesced_bytes;
224 u64 rx_64_byte_packets;
225 u64 rx_65_to_127_byte_packets;
226 u64 rx_128_to_255_byte_packets;
227 u64 rx_256_to_511_byte_packets;
228 u64 rx_512_to_1023_byte_packets;
229 u64 rx_1024_to_1518_byte_packets;
230 u64 rx_1519_to_1522_byte_packets;
231 u64 rx_1519_to_2047_byte_packets;
232 u64 rx_2048_to_4095_byte_packets;
233 u64 rx_4096_to_9216_byte_packets;
234 u64 rx_9217_to_16383_byte_packets;
236 u64 rx_mac_crtl_frames;
240 u64 rx_carrier_errors;
241 u64 rx_oversize_packets;
243 u64 rx_undersize_packets;
245 u64 tx_64_byte_packets;
246 u64 tx_65_to_127_byte_packets;
247 u64 tx_128_to_255_byte_packets;
248 u64 tx_256_to_511_byte_packets;
249 u64 tx_512_to_1023_byte_packets;
250 u64 tx_1024_to_1518_byte_packets;
251 u64 tx_1519_to_2047_byte_packets;
252 u64 tx_2048_to_4095_byte_packets;
253 u64 tx_4096_to_9216_byte_packets;
254 u64 tx_9217_to_16383_byte_packets;
257 u64 tx_lpi_entry_count;
258 u64 tx_total_collisions;
262 u64 rx_mac_uc_packets;
263 u64 rx_mac_mc_packets;
264 u64 rx_mac_bc_packets;
265 u64 rx_mac_frames_ok;
267 u64 tx_mac_uc_packets;
268 u64 tx_mac_mc_packets;
269 u64 tx_mac_bc_packets;
270 u64 tx_mac_ctrl_frames;
274 enum ecore_dmae_address_type_t {
275 ECORE_DMAE_ADDRESS_HOST_VIRT,
276 ECORE_DMAE_ADDRESS_HOST_PHYS,
277 ECORE_DMAE_ADDRESS_GRC
280 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the
281 * source is a block of length DMAE_MAX_RW_SIZE and the
282 * destination is larger, the source block will be duplicated as
283 * many times as required to fill the destination block. This is
284 * used mostly to write a zeroed buffer to destination address
287 #define ECORE_DMAE_FLAG_RW_REPL_SRC 0x00000001
288 #define ECORE_DMAE_FLAG_VF_SRC 0x00000002
289 #define ECORE_DMAE_FLAG_VF_DST 0x00000004
290 #define ECORE_DMAE_FLAG_COMPLETION_DST 0x00000008
292 struct ecore_dmae_params {
293 u32 flags; /* consists of ECORE_DMAE_FLAG_* values */
299 * @brief ecore_dmae_host2grc - copy data from source addr to
300 * dmae registers using the given ptt
305 * @param grc_addr (dmae_data_offset)
306 * @param size_in_dwords
307 * @param flags (one of the flags defined above)
310 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
311 struct ecore_ptt *p_ptt,
318 * @brief ecore_dmae_grc2host - Read data from dmae data offset
319 * to source address using the given ptt
322 * @param grc_addr (dmae_data_offset)
324 * @param size_in_dwords
325 * @param flags - one of the flags defined above
328 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
329 struct ecore_ptt *p_ptt,
331 dma_addr_t dest_addr,
336 * @brief ecore_dmae_host2host - copy data from to source address
337 * to a destination address (for SRIOV) using the given ptt
343 * @param size_in_dwords
347 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
348 struct ecore_ptt *p_ptt,
349 dma_addr_t source_addr,
350 dma_addr_t dest_addr,
352 struct ecore_dmae_params *p_params);
355 * @brief ecore_chain_alloc - Allocate and initialize a chain
358 * @param intended_use
364 * @return enum _ecore_status_t
367 ecore_chain_alloc(struct ecore_dev *p_dev,
368 enum ecore_chain_use_mode intended_use,
369 enum ecore_chain_mode mode,
370 enum ecore_chain_cnt_type cnt_type,
372 osal_size_t elem_size,
373 struct ecore_chain *p_chain,
374 struct ecore_chain_ext_pbl *ext_pbl);
377 * @brief ecore_chain_free - Free chain DMA memory
382 void ecore_chain_free(struct ecore_dev *p_dev,
383 struct ecore_chain *p_chain);
386 * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID
389 * @param src_id - relative to p_hwfn
390 * @param dst_id - absolute per engine
392 * @return enum _ecore_status_t
394 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn,
399 * @@brief ecore_fw_vport - Get absolute vport ID
402 * @param src_id - relative to p_hwfn
403 * @param dst_id - absolute per engine
405 * @return enum _ecore_status_t
407 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn,
412 * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID
415 * @param src_id - relative to p_hwfn
416 * @param dst_id - absolute per engine
418 * @return enum _ecore_status_t
420 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn,
425 * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh
429 * @param p_filter - MAC to add
431 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn,
432 struct ecore_ptt *p_ptt,
436 * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh
440 * @param p_filter - MAC to remove
442 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn,
443 struct ecore_ptt *p_ptt,
446 enum ecore_llh_port_filter_type_t {
447 ECORE_LLH_FILTER_ETHERTYPE,
448 ECORE_LLH_FILTER_TCP_SRC_PORT,
449 ECORE_LLH_FILTER_TCP_DEST_PORT,
450 ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT,
451 ECORE_LLH_FILTER_UDP_SRC_PORT,
452 ECORE_LLH_FILTER_UDP_DEST_PORT,
453 ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT
457 * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh
461 * @param source_port_or_eth_type - source port or ethertype to add
462 * @param dest_port - destination port to add
463 * @param type - type of filters and comparing
466 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn,
467 struct ecore_ptt *p_ptt,
468 u16 source_port_or_eth_type,
470 enum ecore_llh_port_filter_type_t type);
473 * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh
477 * @param source_port_or_eth_type - source port or ethertype to add
478 * @param dest_port - destination port to add
479 * @param type - type of filters and comparing
482 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn,
483 struct ecore_ptt *p_ptt,
484 u16 source_port_or_eth_type,
486 enum ecore_llh_port_filter_type_t type);
489 * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh
494 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn,
495 struct ecore_ptt *p_ptt);
498 * @brief ecore_llh_set_function_as_default - set function as default per port
504 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn,
505 struct ecore_ptt *p_ptt);
508 *@brief Cleanup of previous driver remains prior to load
512 * @param id - For PF, engine-relative. For VF, PF-relative.
513 * @param is_vf - true iff cleanup is made for a VF.
515 * @return enum _ecore_status_t
517 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn *p_hwfn,
518 struct ecore_ptt *p_ptt,
523 * @brief ecore_set_rxq_coalesce - Configure coalesce parameters for an Rx queue
524 * The fact that we can configure coalescing to up to 511, but on varying
525 * accuracy [the bigger the value the less accurate] up to a mistake of 3usec
526 * for the highest values.
530 * @param coalesce - Coalesce value in micro seconds.
531 * @param qid - Queue index.
534 * @return enum _ecore_status_t
536 enum _ecore_status_t ecore_set_rxq_coalesce(struct ecore_hwfn *p_hwfn,
537 struct ecore_ptt *p_ptt,
538 u16 coalesce, u8 qid, u16 sb_id);
541 * @brief ecore_set_txq_coalesce - Configure coalesce parameters for a Tx queue
542 * While the API allows setting coalescing per-qid, all tx queues sharing a
543 * SB should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff]
544 * otherwise configuration would break.
548 * @param coalesce - Coalesce value in micro seconds.
549 * @param qid - Queue index.
552 * @return enum _ecore_status_t
554 enum _ecore_status_t ecore_set_txq_coalesce(struct ecore_hwfn *p_hwfn,
555 struct ecore_ptt *p_ptt,
556 u16 coalesce, u8 qid, u16 sb_id);