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 pf_update_ramrod_data pf_update;
56 struct rx_queue_start_ramrod_data rx_queue_start;
57 struct rx_queue_update_ramrod_data rx_queue_update;
58 struct rx_queue_stop_ramrod_data rx_queue_stop;
59 struct tx_queue_start_ramrod_data tx_queue_start;
60 struct tx_queue_stop_ramrod_data tx_queue_stop;
61 struct vport_start_ramrod_data vport_start;
62 struct vport_stop_ramrod_data vport_stop;
63 struct vport_update_ramrod_data vport_update;
64 struct vport_filter_update_ramrod_data vport_filter_update;
67 #define EQ_MAX_CREDIT 0xffffffff
70 QED_SPQ_PRIORITY_NORMAL,
71 QED_SPQ_PRIORITY_HIGH,
74 union qed_spq_req_comp {
75 struct qed_spq_comp_cb cb;
79 struct qed_spq_comp_done {
84 struct qed_spq_entry {
85 struct list_head list;
89 /* HSI slow path element */
90 struct slow_path_element elem;
92 union ramrod_data ramrod;
94 enum spq_priority priority;
96 /* pending queue for this entry */
97 struct list_head *queue;
99 enum spq_mode comp_mode;
100 struct qed_spq_comp_cb comp_cb;
101 struct qed_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */
105 struct qed_chain chain;
106 u8 eq_sb_index; /* index within the SB */
107 __le16 *p_fw_cons; /* ptr to index value */
111 struct qed_chain chain;
115 spinlock_t lock; /* SPQ lock */
117 struct list_head unlimited_pending;
118 struct list_head pending;
119 struct list_head completion_pending;
120 struct list_head free_pool;
122 struct qed_chain chain;
124 /* allocated dma-able memory for spq entries (+ramrod data) */
126 struct qed_spq_entry *p_virt;
128 #define SPQ_RING_SIZE \
129 (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
131 /* Bitmap for handling out-of-order completions */
132 DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE);
136 u32 unlimited_pending_count;
146 * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that
147 * Pends it to the future list.
154 int qed_spq_post(struct qed_hwfn *p_hwfn,
155 struct qed_spq_entry *p_ent,
159 * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ.
165 int qed_spq_alloc(struct qed_hwfn *p_hwfn);
168 * @brief qed_spq_setup - Reset the SPQ to its start state.
172 void qed_spq_setup(struct qed_hwfn *p_hwfn);
175 * @brief qed_spq_deallocate - Deallocates the given SPQ struct.
179 void qed_spq_free(struct qed_hwfn *p_hwfn);
182 * @brief qed_spq_get_entry - Obtain an entrry from the spq
193 qed_spq_get_entry(struct qed_hwfn *p_hwfn,
194 struct qed_spq_entry **pp_ent);
197 * @brief qed_spq_return_entry - Return an entry to spq free
203 void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
204 struct qed_spq_entry *p_ent);
206 * @brief qed_eq_allocate - Allocates & initializes an EQ struct
209 * @param num_elem number of elements in the eq
211 * @return struct qed_eq* - a newly allocated structure; NULL upon error.
213 struct qed_eq *qed_eq_alloc(struct qed_hwfn *p_hwfn,
217 * @brief qed_eq_setup - Reset the SPQ to its start state.
222 void qed_eq_setup(struct qed_hwfn *p_hwfn,
223 struct qed_eq *p_eq);
226 * @brief qed_eq_deallocate - deallocates the given EQ struct.
231 void qed_eq_free(struct qed_hwfn *p_hwfn,
232 struct qed_eq *p_eq);
235 * @brief qed_eq_prod_update - update the FW with default EQ producer
240 void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
244 * @brief qed_eq_completion - Completes currently pending EQ elements
251 int qed_eq_completion(struct qed_hwfn *p_hwfn,
255 * @brief qed_spq_completion - Completes a single event
258 * @param echo - echo value from cookie (used for determining completion)
259 * @param p_data - data from cookie (used in callback function if applicable)
263 int qed_spq_completion(struct qed_hwfn *p_hwfn,
266 union event_ring_data *p_data);
269 * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
273 * @return u32 - SPQ CID
275 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn);
278 * @brief qed_consq_alloc - Allocates & initializes an ConsQ
283 * @return struct qed_eq* - a newly allocated structure; NULL upon error.
285 struct qed_consq *qed_consq_alloc(struct qed_hwfn *p_hwfn);
288 * @brief qed_consq_setup - Reset the ConsQ to its start
294 void qed_consq_setup(struct qed_hwfn *p_hwfn,
295 struct qed_consq *p_consq);
298 * @brief qed_consq_free - deallocates the given ConsQ struct.
303 void qed_consq_free(struct qed_hwfn *p_hwfn,
304 struct qed_consq *p_consq);
309 * @brief Slow-hwfn low-level commands (Ramrods) function definitions.
312 #define QED_SP_EQ_COMPLETION 0x01
313 #define QED_SP_CQE_COMPLETION 0x02
315 struct qed_sp_init_data {
319 /* Information regarding operation upon sending & completion */
320 enum spq_mode comp_mode;
321 struct qed_spq_comp_cb *p_comp_data;
324 int qed_sp_init_request(struct qed_hwfn *p_hwfn,
325 struct qed_spq_entry **pp_ent,
328 struct qed_sp_init_data *p_data);
331 * @brief qed_sp_pf_start - PF Function Start Ramrod
333 * This ramrod is sent to initialize a physical function (PF). It will
334 * configure the function related parameters and write its completion to the
335 * event ring specified in the parameters.
337 * Ramrods complete on the common event ring for the PF. This ring is
338 * allocated by the driver on host memory and its parameters are written
339 * to the internal RAM of the UStorm by the Function Start Ramrod.
348 int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
349 struct qed_tunn_start_params *p_tunn,
350 enum qed_mf_mode mode);
353 * @brief qed_sp_pf_stop - PF Function Stop Ramrod
355 * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
356 * sent and the last completion written to the PFs Event Ring. This ramrod also
357 * deletes the context for the Slowhwfn connection on this PF.
359 * @note Not required for first packet.
366 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);
368 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn,
369 struct qed_tunn_update_params *p_tunn,
370 enum spq_mode comp_mode,
371 struct qed_spq_comp_cb *p_comp_data);