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;
66 struct vf_start_ramrod_data vf_start;
69 #define EQ_MAX_CREDIT 0xffffffff
72 QED_SPQ_PRIORITY_NORMAL,
73 QED_SPQ_PRIORITY_HIGH,
76 union qed_spq_req_comp {
77 struct qed_spq_comp_cb cb;
81 struct qed_spq_comp_done {
86 struct qed_spq_entry {
87 struct list_head list;
91 /* HSI slow path element */
92 struct slow_path_element elem;
94 union ramrod_data ramrod;
96 enum spq_priority priority;
98 /* pending queue for this entry */
99 struct list_head *queue;
101 enum spq_mode comp_mode;
102 struct qed_spq_comp_cb comp_cb;
103 struct qed_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */
107 struct qed_chain chain;
108 u8 eq_sb_index; /* index within the SB */
109 __le16 *p_fw_cons; /* ptr to index value */
113 struct qed_chain chain;
117 spinlock_t lock; /* SPQ lock */
119 struct list_head unlimited_pending;
120 struct list_head pending;
121 struct list_head completion_pending;
122 struct list_head free_pool;
124 struct qed_chain chain;
126 /* allocated dma-able memory for spq entries (+ramrod data) */
128 struct qed_spq_entry *p_virt;
130 #define SPQ_RING_SIZE \
131 (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
133 /* Bitmap for handling out-of-order completions */
134 DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE);
138 u32 unlimited_pending_count;
148 * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that
149 * Pends it to the future list.
156 int qed_spq_post(struct qed_hwfn *p_hwfn,
157 struct qed_spq_entry *p_ent,
161 * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ.
167 int qed_spq_alloc(struct qed_hwfn *p_hwfn);
170 * @brief qed_spq_setup - Reset the SPQ to its start state.
174 void qed_spq_setup(struct qed_hwfn *p_hwfn);
177 * @brief qed_spq_deallocate - Deallocates the given SPQ struct.
181 void qed_spq_free(struct qed_hwfn *p_hwfn);
184 * @brief qed_spq_get_entry - Obtain an entrry from the spq
195 qed_spq_get_entry(struct qed_hwfn *p_hwfn,
196 struct qed_spq_entry **pp_ent);
199 * @brief qed_spq_return_entry - Return an entry to spq free
205 void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
206 struct qed_spq_entry *p_ent);
208 * @brief qed_eq_allocate - Allocates & initializes an EQ struct
211 * @param num_elem number of elements in the eq
213 * @return struct qed_eq* - a newly allocated structure; NULL upon error.
215 struct qed_eq *qed_eq_alloc(struct qed_hwfn *p_hwfn,
219 * @brief qed_eq_setup - Reset the SPQ to its start state.
224 void qed_eq_setup(struct qed_hwfn *p_hwfn,
225 struct qed_eq *p_eq);
228 * @brief qed_eq_deallocate - deallocates the given EQ struct.
233 void qed_eq_free(struct qed_hwfn *p_hwfn,
234 struct qed_eq *p_eq);
237 * @brief qed_eq_prod_update - update the FW with default EQ producer
242 void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
246 * @brief qed_eq_completion - Completes currently pending EQ elements
253 int qed_eq_completion(struct qed_hwfn *p_hwfn,
257 * @brief qed_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)
265 int qed_spq_completion(struct qed_hwfn *p_hwfn,
268 union event_ring_data *p_data);
271 * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
275 * @return u32 - SPQ CID
277 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn);
280 * @brief qed_consq_alloc - Allocates & initializes an ConsQ
285 * @return struct qed_eq* - a newly allocated structure; NULL upon error.
287 struct qed_consq *qed_consq_alloc(struct qed_hwfn *p_hwfn);
290 * @brief qed_consq_setup - Reset the ConsQ to its start
296 void qed_consq_setup(struct qed_hwfn *p_hwfn,
297 struct qed_consq *p_consq);
300 * @brief qed_consq_free - deallocates the given ConsQ struct.
305 void qed_consq_free(struct qed_hwfn *p_hwfn,
306 struct qed_consq *p_consq);
311 * @brief Slow-hwfn low-level commands (Ramrods) function definitions.
314 #define QED_SP_EQ_COMPLETION 0x01
315 #define QED_SP_CQE_COMPLETION 0x02
317 struct qed_sp_init_data {
321 /* Information regarding operation upon sending & completion */
322 enum spq_mode comp_mode;
323 struct qed_spq_comp_cb *p_comp_data;
326 int qed_sp_init_request(struct qed_hwfn *p_hwfn,
327 struct qed_spq_entry **pp_ent,
330 struct qed_sp_init_data *p_data);
333 * @brief qed_sp_pf_start - PF Function Start Ramrod
335 * This ramrod is sent to initialize a physical function (PF). It will
336 * configure the function related parameters and write its completion to the
337 * event ring specified in the parameters.
339 * Ramrods complete on the common event ring for the PF. This ring is
340 * allocated by the driver on host memory and its parameters are written
341 * to the internal RAM of the UStorm by the Function Start Ramrod.
350 int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
351 struct qed_tunn_start_params *p_tunn,
352 enum qed_mf_mode mode);
355 * @brief qed_sp_pf_stop - PF Function Stop Ramrod
357 * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
358 * sent and the last completion written to the PFs Event Ring. This ramrod also
359 * deletes the context for the Slowhwfn connection on this PF.
361 * @note Not required for first packet.
368 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);
370 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn,
371 struct qed_tunn_update_params *p_tunn,
372 enum spq_mode comp_mode,
373 struct qed_spq_comp_cb *p_comp_data);
375 * @brief qed_sp_heartbeat_ramrod - Send empty Ramrod
382 int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn);