1 /* QLogic qed NIC Driver
2 * Copyright (c) 2015-2017 QLogic Corporation
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and /or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 #include <linux/types.h>
37 #include <linux/kernel.h>
38 #include <linux/list.h>
39 #include <linux/slab.h>
40 #include <linux/spinlock.h>
41 #include <linux/qed/qed_chain.h>
46 QED_SPQ_MODE_BLOCK, /* Client will poll a designated mem. address */
47 QED_SPQ_MODE_CB, /* Client supplies a callback */
48 QED_SPQ_MODE_EBLOCK, /* QED should block until completion */
51 struct qed_spq_comp_cb {
52 void (*function)(struct qed_hwfn *,
54 union event_ring_data *,
60 * @brief qed_eth_cqe_completion - handles the completion of a
61 * ramrod on the cqe ring
68 int qed_eth_cqe_completion(struct qed_hwfn *p_hwfn,
69 struct eth_slow_path_rx_cqe *cqe);
74 * QED Slow-hwfn queue interface
78 struct pf_start_ramrod_data pf_start;
79 struct pf_update_ramrod_data pf_update;
80 struct rx_queue_start_ramrod_data rx_queue_start;
81 struct rx_queue_update_ramrod_data rx_queue_update;
82 struct rx_queue_stop_ramrod_data rx_queue_stop;
83 struct tx_queue_start_ramrod_data tx_queue_start;
84 struct tx_queue_stop_ramrod_data tx_queue_stop;
85 struct vport_start_ramrod_data vport_start;
86 struct vport_stop_ramrod_data vport_stop;
87 struct rx_update_gft_filter_data rx_update_gft;
88 struct vport_update_ramrod_data vport_update;
89 struct core_rx_start_ramrod_data core_rx_queue_start;
90 struct core_rx_stop_ramrod_data core_rx_queue_stop;
91 struct core_tx_start_ramrod_data core_tx_queue_start;
92 struct core_tx_stop_ramrod_data core_tx_queue_stop;
93 struct vport_filter_update_ramrod_data vport_filter_update;
95 struct rdma_init_func_ramrod_data rdma_init_func;
96 struct rdma_close_func_ramrod_data rdma_close_func;
97 struct rdma_register_tid_ramrod_data rdma_register_tid;
98 struct rdma_deregister_tid_ramrod_data rdma_deregister_tid;
99 struct roce_create_qp_resp_ramrod_data roce_create_qp_resp;
100 struct roce_create_qp_req_ramrod_data roce_create_qp_req;
101 struct roce_modify_qp_resp_ramrod_data roce_modify_qp_resp;
102 struct roce_modify_qp_req_ramrod_data roce_modify_qp_req;
103 struct roce_query_qp_resp_ramrod_data roce_query_qp_resp;
104 struct roce_query_qp_req_ramrod_data roce_query_qp_req;
105 struct roce_destroy_qp_resp_ramrod_data roce_destroy_qp_resp;
106 struct roce_destroy_qp_req_ramrod_data roce_destroy_qp_req;
107 struct roce_init_func_ramrod_data roce_init_func;
108 struct rdma_create_cq_ramrod_data rdma_create_cq;
109 struct rdma_destroy_cq_ramrod_data rdma_destroy_cq;
110 struct rdma_srq_create_ramrod_data rdma_create_srq;
111 struct rdma_srq_destroy_ramrod_data rdma_destroy_srq;
112 struct rdma_srq_modify_ramrod_data rdma_modify_srq;
113 struct iwarp_create_qp_ramrod_data iwarp_create_qp;
114 struct iwarp_tcp_offload_ramrod_data iwarp_tcp_offload;
115 struct iwarp_mpa_offload_ramrod_data iwarp_mpa_offload;
116 struct iwarp_modify_qp_ramrod_data iwarp_modify_qp;
117 struct iwarp_init_func_ramrod_data iwarp_init_func;
118 struct fcoe_init_ramrod_params fcoe_init;
119 struct fcoe_conn_offload_ramrod_params fcoe_conn_ofld;
120 struct fcoe_conn_terminate_ramrod_params fcoe_conn_terminate;
121 struct fcoe_stat_ramrod_params fcoe_stat;
123 struct iscsi_slow_path_hdr iscsi_empty;
124 struct iscsi_init_ramrod_params iscsi_init;
125 struct iscsi_spe_func_dstry iscsi_destroy;
126 struct iscsi_spe_conn_offload iscsi_conn_offload;
127 struct iscsi_conn_update_ramrod_params iscsi_conn_update;
128 struct iscsi_spe_conn_mac_update iscsi_conn_mac_update;
129 struct iscsi_spe_conn_termination iscsi_conn_terminate;
131 struct vf_start_ramrod_data vf_start;
132 struct vf_stop_ramrod_data vf_stop;
135 #define EQ_MAX_CREDIT 0xffffffff
138 QED_SPQ_PRIORITY_NORMAL,
139 QED_SPQ_PRIORITY_HIGH,
142 union qed_spq_req_comp {
143 struct qed_spq_comp_cb cb;
147 struct qed_spq_comp_done {
152 struct qed_spq_entry {
153 struct list_head list;
157 /* HSI slow path element */
158 struct slow_path_element elem;
160 union ramrod_data ramrod;
162 enum spq_priority priority;
164 /* pending queue for this entry */
165 struct list_head *queue;
167 enum spq_mode comp_mode;
168 struct qed_spq_comp_cb comp_cb;
169 struct qed_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */
171 /* Posted entry for unlimited list entry in EBLOCK mode */
172 struct qed_spq_entry *post_ent;
176 struct qed_chain chain;
177 u8 eq_sb_index; /* index within the SB */
178 __le16 *p_fw_cons; /* ptr to index value */
182 struct qed_chain chain;
186 (*qed_spq_async_comp_cb)(struct qed_hwfn *p_hwfn,
189 union event_ring_data *data,
193 qed_spq_register_async_cb(struct qed_hwfn *p_hwfn,
194 enum protocol_type protocol_id,
195 qed_spq_async_comp_cb cb);
198 qed_spq_unregister_async_cb(struct qed_hwfn *p_hwfn,
199 enum protocol_type protocol_id);
202 spinlock_t lock; /* SPQ lock */
204 struct list_head unlimited_pending;
205 struct list_head pending;
206 struct list_head completion_pending;
207 struct list_head free_pool;
209 struct qed_chain chain;
211 /* allocated dma-able memory for spq entries (+ramrod data) */
213 struct qed_spq_entry *p_virt;
215 #define SPQ_RING_SIZE \
216 (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element))
218 /* Bitmap for handling out-of-order completions */
219 DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE);
223 u32 unlimited_pending_count;
230 qed_spq_async_comp_cb async_comp_cb[MAX_PROTOCOL_TYPE];
234 * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that
235 * Pends it to the future list.
242 int qed_spq_post(struct qed_hwfn *p_hwfn,
243 struct qed_spq_entry *p_ent,
247 * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ.
253 int qed_spq_alloc(struct qed_hwfn *p_hwfn);
256 * @brief qed_spq_setup - Reset the SPQ to its start state.
260 void qed_spq_setup(struct qed_hwfn *p_hwfn);
263 * @brief qed_spq_deallocate - Deallocates the given SPQ struct.
267 void qed_spq_free(struct qed_hwfn *p_hwfn);
270 * @brief qed_spq_get_entry - Obtain an entrry from the spq
281 qed_spq_get_entry(struct qed_hwfn *p_hwfn,
282 struct qed_spq_entry **pp_ent);
285 * @brief qed_spq_return_entry - Return an entry to spq free
291 void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
292 struct qed_spq_entry *p_ent);
294 * @brief qed_eq_allocate - Allocates & initializes an EQ struct
297 * @param num_elem number of elements in the eq
301 int qed_eq_alloc(struct qed_hwfn *p_hwfn, u16 num_elem);
304 * @brief qed_eq_setup - Reset the EQ to its start state.
308 void qed_eq_setup(struct qed_hwfn *p_hwfn);
311 * @brief qed_eq_free - deallocates the given EQ struct.
315 void qed_eq_free(struct qed_hwfn *p_hwfn);
318 * @brief qed_eq_prod_update - update the FW with default EQ producer
323 void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
327 * @brief qed_eq_completion - Completes currently pending EQ elements
334 int qed_eq_completion(struct qed_hwfn *p_hwfn,
338 * @brief qed_spq_completion - Completes a single event
341 * @param echo - echo value from cookie (used for determining completion)
342 * @param p_data - data from cookie (used in callback function if applicable)
346 int qed_spq_completion(struct qed_hwfn *p_hwfn,
349 union event_ring_data *p_data);
352 * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ
356 * @return u32 - SPQ CID
358 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn);
361 * @brief qed_consq_alloc - Allocates & initializes an ConsQ
368 int qed_consq_alloc(struct qed_hwfn *p_hwfn);
371 * @brief qed_consq_setup - Reset the ConsQ to its start state.
375 void qed_consq_setup(struct qed_hwfn *p_hwfn);
378 * @brief qed_consq_free - deallocates the given ConsQ struct.
382 void qed_consq_free(struct qed_hwfn *p_hwfn);
387 * @brief Slow-hwfn low-level commands (Ramrods) function definitions.
390 #define QED_SP_EQ_COMPLETION 0x01
391 #define QED_SP_CQE_COMPLETION 0x02
393 struct qed_sp_init_data {
397 /* Information regarding operation upon sending & completion */
398 enum spq_mode comp_mode;
399 struct qed_spq_comp_cb *p_comp_data;
403 * @brief Returns a SPQ entry to the pool / frees the entry if allocated.
404 * Should be called on in error flows after initializing the SPQ entry
405 * and before posting it.
410 void qed_sp_destroy_request(struct qed_hwfn *p_hwfn,
411 struct qed_spq_entry *p_ent);
413 int qed_sp_init_request(struct qed_hwfn *p_hwfn,
414 struct qed_spq_entry **pp_ent,
417 struct qed_sp_init_data *p_data);
420 * @brief qed_sp_pf_start - PF Function Start Ramrod
422 * This ramrod is sent to initialize a physical function (PF). It will
423 * configure the function related parameters and write its completion to the
424 * event ring specified in the parameters.
426 * Ramrods complete on the common event ring for the PF. This ring is
427 * allocated by the driver on host memory and its parameters are written
428 * to the internal RAM of the UStorm by the Function Start Ramrod.
433 * @param allow_npar_tx_switch
438 int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
439 struct qed_ptt *p_ptt,
440 struct qed_tunnel_info *p_tunn,
441 bool allow_npar_tx_switch);
444 * @brief qed_sp_pf_update - PF Function Update Ramrod
446 * This ramrod updates function-related parameters. Every parameter can be
447 * updated independently, according to configuration flags.
454 int qed_sp_pf_update(struct qed_hwfn *p_hwfn);
457 * @brief qed_sp_pf_update_stag - Update firmware of new outer tag
463 int qed_sp_pf_update_stag(struct qed_hwfn *p_hwfn);
466 * @brief qed_sp_pf_stop - PF Function Stop Ramrod
468 * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
469 * sent and the last completion written to the PFs Event Ring. This ramrod also
470 * deletes the context for the Slowhwfn connection on this PF.
472 * @note Not required for first packet.
480 * @brief qed_sp_pf_update_ufp - PF ufp update Ramrod
486 int qed_sp_pf_update_ufp(struct qed_hwfn *p_hwfn);
488 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);
490 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn,
491 struct qed_ptt *p_ptt,
492 struct qed_tunnel_info *p_tunn,
493 enum spq_mode comp_mode,
494 struct qed_spq_comp_cb *p_comp_data);
496 * @brief qed_sp_heartbeat_ramrod - Send empty Ramrod
503 int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn);