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 rx_queue_start_ramrod_data rx_queue_start;
22 struct rx_queue_update_ramrod_data rx_queue_update;
23 struct rx_queue_stop_ramrod_data rx_queue_stop;
24 struct tx_queue_start_ramrod_data tx_queue_start;
25 struct tx_queue_stop_ramrod_data tx_queue_stop;
26 struct vport_start_ramrod_data vport_start;
27 struct vport_stop_ramrod_data vport_stop;
28 struct vport_update_ramrod_data vport_update;
29 struct core_rx_start_ramrod_data core_rx_queue_start;
30 struct core_rx_stop_ramrod_data core_rx_queue_stop;
31 struct core_tx_start_ramrod_data core_tx_queue_start;
32 struct core_tx_stop_ramrod_data core_tx_queue_stop;
33 struct vport_filter_update_ramrod_data vport_filter_update;
35 struct vf_start_ramrod_data vf_start;
36 struct vf_stop_ramrod_data vf_stop;
39 #define EQ_MAX_CREDIT 0xffffffff
42 ECORE_SPQ_PRIORITY_NORMAL,
43 ECORE_SPQ_PRIORITY_HIGH,
46 union ecore_spq_req_comp {
47 struct ecore_spq_comp_cb cb;
52 struct ecore_spq_comp_done {
57 struct ecore_spq_entry {
58 osal_list_entry_t list;
62 /* HSI slow path element */
63 struct slow_path_element elem;
65 union ramrod_data ramrod;
67 enum spq_priority priority;
69 /* pending queue for this entry */
72 enum spq_mode comp_mode;
73 struct ecore_spq_comp_cb comp_cb;
74 struct ecore_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */
78 struct ecore_chain chain;
79 u8 eq_sb_index; /* index within the SB */
80 __le16 *p_fw_cons; /* ptr to index value */
84 struct ecore_chain chain;
90 osal_list_t unlimited_pending;
92 osal_list_t completion_pending;
93 osal_list_t free_pool;
95 struct ecore_chain chain;
97 /* allocated dma-able memory for spq entries (+ramrod data) */
99 struct ecore_spq_entry *p_virt;
101 /* Bitmap for handling out-of-order completions */
102 #define SPQ_RING_SIZE \
103 (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
104 #define SPQ_COMP_BMAP_SIZE \
105 (SPQ_RING_SIZE / (sizeof(unsigned long) * 8 /* BITS_PER_LONG */))
106 unsigned long p_comp_bitmap[SPQ_COMP_BMAP_SIZE];
108 #define SPQ_COMP_BMAP_SET_BIT(p_spq, idx) \
109 (OSAL_SET_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
111 #define SPQ_COMP_BMAP_CLEAR_BIT(p_spq, idx) \
112 (OSAL_CLEAR_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
114 #define SPQ_COMP_BMAP_TEST_BIT(p_spq, idx) \
115 (OSAL_TEST_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap))
118 u32 unlimited_pending_count;
131 * @brief ecore_spq_post - Posts a Slow hwfn request to FW, or lacking that
132 * Pends it to the future list.
137 * @return enum _ecore_status_t
139 enum _ecore_status_t ecore_spq_post(struct ecore_hwfn *p_hwfn,
140 struct ecore_spq_entry *p_ent,
144 * @brief ecore_spq_allocate - Alloocates & initializes the SPQ and EQ.
148 * @return enum _ecore_status_t
150 enum _ecore_status_t ecore_spq_alloc(struct ecore_hwfn *p_hwfn);
153 * @brief ecore_spq_setup - Reset the SPQ to its start state.
157 void ecore_spq_setup(struct ecore_hwfn *p_hwfn);
160 * @brief ecore_spq_deallocate - Deallocates the given SPQ struct.
164 void ecore_spq_free(struct ecore_hwfn *p_hwfn);
167 * @brief ecore_spq_get_entry - Obtain an entrry from the spq
175 * @return enum _ecore_status_t
178 ecore_spq_get_entry(struct ecore_hwfn *p_hwfn, struct ecore_spq_entry **pp_ent);
181 * @brief ecore_spq_return_entry - Return an entry to spq free
187 void ecore_spq_return_entry(struct ecore_hwfn *p_hwfn,
188 struct ecore_spq_entry *p_ent);
190 * @brief ecore_eq_allocate - Allocates & initializes an EQ struct
193 * @param num_elem number of elements in the eq
195 * @return struct ecore_eq* - a newly allocated structure; NULL upon error.
197 struct ecore_eq *ecore_eq_alloc(struct ecore_hwfn *p_hwfn, u16 num_elem);
200 * @brief ecore_eq_setup - Reset the SPQ to its start state.
205 void ecore_eq_setup(struct ecore_hwfn *p_hwfn, struct ecore_eq *p_eq);
208 * @brief ecore_eq_deallocate - deallocates the given EQ struct.
213 void ecore_eq_free(struct ecore_hwfn *p_hwfn, struct ecore_eq *p_eq);
216 * @brief ecore_eq_prod_update - update the FW with default EQ producer
221 void ecore_eq_prod_update(struct ecore_hwfn *p_hwfn, u16 prod);
224 * @brief ecore_eq_completion - Completes currently pending EQ elements
229 * @return enum _ecore_status_t
231 enum _ecore_status_t ecore_eq_completion(struct ecore_hwfn *p_hwfn,
235 * @brief ecore_spq_completion - Completes a single event
238 * @param echo - echo value from cookie (used for determining completion)
239 * @param p_data - data from cookie (used in callback function if applicable)
241 * @return enum _ecore_status_t
243 enum _ecore_status_t ecore_spq_completion(struct ecore_hwfn *p_hwfn,
246 union event_ring_data *p_data);
249 * @brief ecore_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
253 * @return u32 - SPQ CID
255 u32 ecore_spq_get_cid(struct ecore_hwfn *p_hwfn);
258 * @brief ecore_consq_alloc - Allocates & initializes an ConsQ
263 * @return struct ecore_eq* - a newly allocated structure; NULL upon error.
265 struct ecore_consq *ecore_consq_alloc(struct ecore_hwfn *p_hwfn);
268 * @brief ecore_consq_setup - Reset the ConsQ to its start
274 void ecore_consq_setup(struct ecore_hwfn *p_hwfn, struct ecore_consq *p_consq);
277 * @brief ecore_consq_free - deallocates the given ConsQ struct.
282 void ecore_consq_free(struct ecore_hwfn *p_hwfn, struct ecore_consq *p_consq);
284 #endif /* __ECORE_SPQ_H__ */