1 /* QLogic qed NIC Driver
2 * Copyright (c) 2015 QLogic Corporation
4 * This software is available under the terms of the GNU General Public License
5 * (GPL) Version 2, available from the file COPYING in the main directory of
12 #include <linux/types.h>
13 #include <linux/kernel.h>
14 #include <linux/list.h>
15 #include <linux/slab.h>
16 #include <linux/spinlock.h>
17 #include <linux/qed/qed_chain.h>
22 QED_SPQ_MODE_BLOCK, /* Client will poll a designated mem. address */
23 QED_SPQ_MODE_CB, /* Client supplies a callback */
24 QED_SPQ_MODE_EBLOCK, /* QED should block until completion */
27 struct qed_spq_comp_cb {
28 void (*function)(struct qed_hwfn *,
30 union event_ring_data *,
36 * @brief qed_eth_cqe_completion - handles the completion of a
37 * ramrod on the cqe ring
44 int qed_eth_cqe_completion(struct qed_hwfn *p_hwfn,
45 struct eth_slow_path_rx_cqe *cqe);
50 * QED Slow-hwfn queue interface
54 struct pf_start_ramrod_data pf_start;
55 struct rx_queue_start_ramrod_data rx_queue_start;
56 struct rx_queue_update_ramrod_data rx_queue_update;
57 struct rx_queue_stop_ramrod_data rx_queue_stop;
58 struct tx_queue_start_ramrod_data tx_queue_start;
59 struct tx_queue_stop_ramrod_data tx_queue_stop;
60 struct vport_start_ramrod_data vport_start;
61 struct vport_stop_ramrod_data vport_stop;
62 struct vport_update_ramrod_data vport_update;
63 struct vport_filter_update_ramrod_data vport_filter_update;
66 #define EQ_MAX_CREDIT 0xffffffff
69 QED_SPQ_PRIORITY_NORMAL,
70 QED_SPQ_PRIORITY_HIGH,
73 union qed_spq_req_comp {
74 struct qed_spq_comp_cb cb;
78 struct qed_spq_comp_done {
83 struct qed_spq_entry {
84 struct list_head list;
88 /* HSI slow path element */
89 struct slow_path_element elem;
91 union ramrod_data ramrod;
93 enum spq_priority priority;
95 /* pending queue for this entry */
96 struct list_head *queue;
98 enum spq_mode comp_mode;
99 struct qed_spq_comp_cb comp_cb;
100 struct qed_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */
104 struct qed_chain chain;
105 u8 eq_sb_index; /* index within the SB */
106 __le16 *p_fw_cons; /* ptr to index value */
110 struct qed_chain chain;
114 spinlock_t lock; /* SPQ lock */
116 struct list_head unlimited_pending;
117 struct list_head pending;
118 struct list_head completion_pending;
119 struct list_head free_pool;
121 struct qed_chain chain;
123 /* allocated dma-able memory for spq entries (+ramrod data) */
125 struct qed_spq_entry *p_virt;
127 #define SPQ_RING_SIZE \
128 (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
130 /* Bitmap for handling out-of-order completions */
131 DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE);
135 u32 unlimited_pending_count;
145 * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that
146 * Pends it to the future list.
153 int qed_spq_post(struct qed_hwfn *p_hwfn,
154 struct qed_spq_entry *p_ent,
158 * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ.
164 int qed_spq_alloc(struct qed_hwfn *p_hwfn);
167 * @brief qed_spq_setup - Reset the SPQ to its start state.
171 void qed_spq_setup(struct qed_hwfn *p_hwfn);
174 * @brief qed_spq_deallocate - Deallocates the given SPQ struct.
178 void qed_spq_free(struct qed_hwfn *p_hwfn);
181 * @brief qed_spq_get_entry - Obtain an entrry from the spq
192 qed_spq_get_entry(struct qed_hwfn *p_hwfn,
193 struct qed_spq_entry **pp_ent);
196 * @brief qed_spq_return_entry - Return an entry to spq free
202 void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
203 struct qed_spq_entry *p_ent);
205 * @brief qed_eq_allocate - Allocates & initializes an EQ struct
208 * @param num_elem number of elements in the eq
210 * @return struct qed_eq* - a newly allocated structure; NULL upon error.
212 struct qed_eq *qed_eq_alloc(struct qed_hwfn *p_hwfn,
216 * @brief qed_eq_setup - Reset the SPQ to its start state.
221 void qed_eq_setup(struct qed_hwfn *p_hwfn,
222 struct qed_eq *p_eq);
225 * @brief qed_eq_deallocate - deallocates the given EQ struct.
230 void qed_eq_free(struct qed_hwfn *p_hwfn,
231 struct qed_eq *p_eq);
234 * @brief qed_eq_prod_update - update the FW with default EQ producer
239 void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
243 * @brief qed_eq_completion - Completes currently pending EQ elements
250 int qed_eq_completion(struct qed_hwfn *p_hwfn,
254 * @brief qed_spq_completion - Completes a single event
257 * @param echo - echo value from cookie (used for determining completion)
258 * @param p_data - data from cookie (used in callback function if applicable)
262 int qed_spq_completion(struct qed_hwfn *p_hwfn,
265 union event_ring_data *p_data);
268 * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
272 * @return u32 - SPQ CID
274 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn);
277 * @brief qed_consq_alloc - Allocates & initializes an ConsQ
282 * @return struct qed_eq* - a newly allocated structure; NULL upon error.
284 struct qed_consq *qed_consq_alloc(struct qed_hwfn *p_hwfn);
287 * @brief qed_consq_setup - Reset the ConsQ to its start
293 void qed_consq_setup(struct qed_hwfn *p_hwfn,
294 struct qed_consq *p_consq);
297 * @brief qed_consq_free - deallocates the given ConsQ struct.
302 void qed_consq_free(struct qed_hwfn *p_hwfn,
303 struct qed_consq *p_consq);
308 * @brief Slow-hwfn low-level commands (Ramrods) function definitions.
311 #define QED_SP_EQ_COMPLETION 0x01
312 #define QED_SP_CQE_COMPLETION 0x02
314 struct qed_sp_init_request_params {
315 size_t ramrod_data_size;
316 enum spq_mode comp_mode;
317 struct qed_spq_comp_cb *p_comp_data;
320 int qed_sp_init_request(struct qed_hwfn *p_hwfn,
321 struct qed_spq_entry **pp_ent,
326 struct qed_sp_init_request_params *p_params);
329 * @brief qed_sp_pf_start - PF Function Start Ramrod
331 * This ramrod is sent to initialize a physical function (PF). It will
332 * configure the function related parameters and write its completion to the
333 * event ring specified in the parameters.
335 * Ramrods complete on the common event ring for the PF. This ring is
336 * allocated by the driver on host memory and its parameters are written
337 * to the internal RAM of the UStorm by the Function Start Ramrod.
345 int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
349 * @brief qed_sp_pf_stop - PF Function Stop Ramrod
351 * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
352 * sent and the last completion written to the PFs Event Ring. This ramrod also
353 * deletes the context for the Slowhwfn connection on this PF.
355 * @note Not required for first packet.
362 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);