2 * Copyright (c) 2016 QLogic Corporation.
6 * See LICENSE.qede_pmd for copyright and licensing details.
9 #ifndef __ECORE_SPQ_H__
10 #define __ECORE_SPQ_H__
12 #include "ecore_hsi_common.h"
13 #include "ecore_status.h"
14 #include "ecore_hsi_eth.h"
15 #include "ecore_chain.h"
16 #include "ecore_sp_api.h"
19 struct pf_start_ramrod_data pf_start;
20 struct pf_update_ramrod_data pf_update;
21 struct rl_update_ramrod_data rl_update;
22 struct rx_queue_start_ramrod_data rx_queue_start;
23 struct rx_queue_update_ramrod_data rx_queue_update;
24 struct rx_queue_stop_ramrod_data rx_queue_stop;
25 struct tx_queue_start_ramrod_data tx_queue_start;
26 struct tx_queue_stop_ramrod_data tx_queue_stop;
27 struct vport_start_ramrod_data vport_start;
28 struct vport_stop_ramrod_data vport_stop;
29 struct rx_update_gft_filter_data rx_update_gft;
30 struct vport_update_ramrod_data vport_update;
31 struct core_rx_start_ramrod_data core_rx_queue_start;
32 struct core_rx_stop_ramrod_data core_rx_queue_stop;
33 struct core_tx_start_ramrod_data core_tx_queue_start;
34 struct core_tx_stop_ramrod_data core_tx_queue_stop;
35 struct vport_filter_update_ramrod_data vport_filter_update;
37 struct vf_start_ramrod_data vf_start;
38 struct vf_stop_ramrod_data vf_stop;
41 #define EQ_MAX_CREDIT 0xffffffff
44 ECORE_SPQ_PRIORITY_NORMAL,
45 ECORE_SPQ_PRIORITY_HIGH,
48 union ecore_spq_req_comp {
49 struct ecore_spq_comp_cb cb;
54 struct ecore_spq_comp_done {
59 struct ecore_spq_entry {
60 osal_list_entry_t list;
64 /* HSI slow path element */
65 struct slow_path_element elem;
67 union ramrod_data ramrod;
69 enum spq_priority priority;
71 /* pending queue for this entry */
74 enum spq_mode comp_mode;
75 struct ecore_spq_comp_cb comp_cb;
76 struct ecore_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */
80 struct ecore_chain chain;
81 u8 eq_sb_index; /* index within the SB */
82 __le16 *p_fw_cons; /* ptr to index value */
86 struct ecore_chain chain;
89 typedef enum _ecore_status_t
90 (*ecore_spq_async_comp_cb)(struct ecore_hwfn *p_hwfn,
93 union event_ring_data *data,
97 ecore_spq_register_async_cb(struct ecore_hwfn *p_hwfn,
98 enum protocol_type protocol_id,
99 ecore_spq_async_comp_cb cb);
102 ecore_spq_unregister_async_cb(struct ecore_hwfn *p_hwfn,
103 enum protocol_type protocol_id);
106 osal_spinlock_t lock;
108 osal_list_t unlimited_pending;
110 osal_list_t completion_pending;
111 osal_list_t free_pool;
113 struct ecore_chain chain;
115 /* allocated dma-able memory for spq entries (+ramrod data) */
117 struct ecore_spq_entry *p_virt;
119 /* Bitmap for handling out-of-order completions */
120 #define SPQ_RING_SIZE \
121 (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
123 #define SPQ_COMP_BMAP_SIZE (SPQ_RING_SIZE / (sizeof(unsigned long) * 8))
124 unsigned long p_comp_bitmap[SPQ_COMP_BMAP_SIZE];
126 #define SPQ_COMP_BMAP_SET_BIT(p_spq, idx) \
127 (OSAL_SET_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
129 #define SPQ_COMP_BMAP_CLEAR_BIT(p_spq, idx) \
130 (OSAL_CLEAR_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
132 #define SPQ_COMP_BMAP_TEST_BIT(p_spq, idx) \
133 (OSAL_TEST_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
136 u32 unlimited_pending_count;
145 struct core_db_data db_data;
146 ecore_spq_async_comp_cb async_comp_cb[MAX_PROTOCOL_TYPE];
153 * @brief ecore_spq_post - Posts a Slow hwfn request to FW, or lacking that
154 * Pends it to the future list.
159 * @return enum _ecore_status_t
161 enum _ecore_status_t ecore_spq_post(struct ecore_hwfn *p_hwfn,
162 struct ecore_spq_entry *p_ent,
166 * @brief ecore_spq_allocate - Alloocates & initializes the SPQ and EQ.
170 * @return enum _ecore_status_t
172 enum _ecore_status_t ecore_spq_alloc(struct ecore_hwfn *p_hwfn);
175 * @brief ecore_spq_setup - Reset the SPQ to its start state.
179 void ecore_spq_setup(struct ecore_hwfn *p_hwfn);
182 * @brief ecore_spq_deallocate - Deallocates the given SPQ struct.
186 void ecore_spq_free(struct ecore_hwfn *p_hwfn);
189 * @brief ecore_spq_get_entry - Obtain an entrry from the spq
197 * @return enum _ecore_status_t
200 ecore_spq_get_entry(struct ecore_hwfn *p_hwfn,
201 struct ecore_spq_entry **pp_ent);
204 * @brief ecore_spq_return_entry - Return an entry to spq free
210 void ecore_spq_return_entry(struct ecore_hwfn *p_hwfn,
211 struct ecore_spq_entry *p_ent);
213 * @brief ecore_eq_allocate - Allocates & initializes an EQ struct
216 * @param num_elem number of elements in the eq
218 * @return enum _ecore_status_t
220 enum _ecore_status_t ecore_eq_alloc(struct ecore_hwfn *p_hwfn, u16 num_elem);
223 * @brief ecore_eq_setup - Reset the EQ to its start state.
227 void ecore_eq_setup(struct ecore_hwfn *p_hwfn);
230 * @brief ecore_eq_free - deallocates the given EQ struct.
234 void ecore_eq_free(struct ecore_hwfn *p_hwfn);
237 * @brief ecore_eq_prod_update - update the FW with default EQ producer
242 void ecore_eq_prod_update(struct ecore_hwfn *p_hwfn,
246 * @brief ecore_eq_completion - Completes currently pending EQ elements
251 * @return enum _ecore_status_t
253 enum _ecore_status_t ecore_eq_completion(struct ecore_hwfn *p_hwfn,
257 * @brief ecore_spq_completion - Completes a single event
260 * @param echo - echo value from cookie (used for determining completion)
261 * @param p_data - data from cookie (used in callback function if applicable)
263 * @return enum _ecore_status_t
265 enum _ecore_status_t ecore_spq_completion(struct ecore_hwfn *p_hwfn,
268 union event_ring_data *p_data);
271 * @brief ecore_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
275 * @return u32 - SPQ CID
277 u32 ecore_spq_get_cid(struct ecore_hwfn *p_hwfn);
280 * @brief ecore_consq_alloc - Allocates & initializes an ConsQ struct
284 * @return enum _ecore_status_t
286 enum _ecore_status_t ecore_consq_alloc(struct ecore_hwfn *p_hwfn);
289 * @brief ecore_consq_setup - Reset the ConsQ to its start state.
293 void ecore_consq_setup(struct ecore_hwfn *p_hwfn);
296 * @brief ecore_consq_free - deallocates the given ConsQ struct.
300 void ecore_consq_free(struct ecore_hwfn *p_hwfn);
302 #endif /* __ECORE_SPQ_H__ */