1 /* QLogic qed NIC Driver 2 * Copyright (c) 2015-2017 QLogic Corporation 3 * 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: 9 * 10 * Redistribution and use in source and binary forms, with or 11 * without modification, are permitted provided that the following 12 * conditions are met: 13 * 14 * - Redistributions of source code must retain the above 15 * copyright notice, this list of conditions and the following 16 * disclaimer. 17 * 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. 22 * 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 30 * SOFTWARE. 31 */ 32 33 #ifndef _QED_SP_H 34 #define _QED_SP_H 35 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> 42 #include "qed.h" 43 #include "qed_hsi.h" 44 45 enum spq_mode { 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 */ 49 }; 50 51 struct qed_spq_comp_cb { 52 void (*function)(struct qed_hwfn *, 53 void *, 54 union event_ring_data *, 55 u8 fw_return_code); 56 void *cookie; 57 }; 58 59 /** 60 * @brief qed_eth_cqe_completion - handles the completion of a 61 * ramrod on the cqe ring 62 * 63 * @param p_hwfn 64 * @param cqe 65 * 66 * @return int 67 */ 68 int qed_eth_cqe_completion(struct qed_hwfn *p_hwfn, 69 struct eth_slow_path_rx_cqe *cqe); 70 71 /** 72 * @file 73 * 74 * QED Slow-hwfn queue interface 75 */ 76 77 union ramrod_data { 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 vport_update_ramrod_data vport_update; 88 struct core_rx_start_ramrod_data core_rx_queue_start; 89 struct core_rx_stop_ramrod_data core_rx_queue_stop; 90 struct core_tx_start_ramrod_data core_tx_queue_start; 91 struct core_tx_stop_ramrod_data core_tx_queue_stop; 92 struct vport_filter_update_ramrod_data vport_filter_update; 93 94 struct rdma_init_func_ramrod_data rdma_init_func; 95 struct rdma_close_func_ramrod_data rdma_close_func; 96 struct rdma_register_tid_ramrod_data rdma_register_tid; 97 struct rdma_deregister_tid_ramrod_data rdma_deregister_tid; 98 struct roce_create_qp_resp_ramrod_data roce_create_qp_resp; 99 struct roce_create_qp_req_ramrod_data roce_create_qp_req; 100 struct roce_modify_qp_resp_ramrod_data roce_modify_qp_resp; 101 struct roce_modify_qp_req_ramrod_data roce_modify_qp_req; 102 struct roce_query_qp_resp_ramrod_data roce_query_qp_resp; 103 struct roce_query_qp_req_ramrod_data roce_query_qp_req; 104 struct roce_destroy_qp_resp_ramrod_data roce_destroy_qp_resp; 105 struct roce_destroy_qp_req_ramrod_data roce_destroy_qp_req; 106 struct rdma_create_cq_ramrod_data rdma_create_cq; 107 struct rdma_destroy_cq_ramrod_data rdma_destroy_cq; 108 struct rdma_srq_create_ramrod_data rdma_create_srq; 109 struct rdma_srq_destroy_ramrod_data rdma_destroy_srq; 110 struct rdma_srq_modify_ramrod_data rdma_modify_srq; 111 struct roce_init_func_ramrod_data roce_init_func; 112 struct fcoe_init_ramrod_params fcoe_init; 113 struct fcoe_conn_offload_ramrod_params fcoe_conn_ofld; 114 struct fcoe_conn_terminate_ramrod_params fcoe_conn_terminate; 115 struct fcoe_stat_ramrod_params fcoe_stat; 116 117 struct iscsi_slow_path_hdr iscsi_empty; 118 struct iscsi_init_ramrod_params iscsi_init; 119 struct iscsi_spe_func_dstry iscsi_destroy; 120 struct iscsi_spe_conn_offload iscsi_conn_offload; 121 struct iscsi_conn_update_ramrod_params iscsi_conn_update; 122 struct iscsi_spe_conn_termination iscsi_conn_terminate; 123 124 struct vf_start_ramrod_data vf_start; 125 struct vf_stop_ramrod_data vf_stop; 126 }; 127 128 #define EQ_MAX_CREDIT 0xffffffff 129 130 enum spq_priority { 131 QED_SPQ_PRIORITY_NORMAL, 132 QED_SPQ_PRIORITY_HIGH, 133 }; 134 135 union qed_spq_req_comp { 136 struct qed_spq_comp_cb cb; 137 u64 *done_addr; 138 }; 139 140 struct qed_spq_comp_done { 141 unsigned int done; 142 u8 fw_return_code; 143 }; 144 145 struct qed_spq_entry { 146 struct list_head list; 147 148 u8 flags; 149 150 /* HSI slow path element */ 151 struct slow_path_element elem; 152 153 union ramrod_data ramrod; 154 155 enum spq_priority priority; 156 157 /* pending queue for this entry */ 158 struct list_head *queue; 159 160 enum spq_mode comp_mode; 161 struct qed_spq_comp_cb comp_cb; 162 struct qed_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */ 163 }; 164 165 struct qed_eq { 166 struct qed_chain chain; 167 u8 eq_sb_index; /* index within the SB */ 168 __le16 *p_fw_cons; /* ptr to index value */ 169 }; 170 171 struct qed_consq { 172 struct qed_chain chain; 173 }; 174 175 struct qed_spq { 176 spinlock_t lock; /* SPQ lock */ 177 178 struct list_head unlimited_pending; 179 struct list_head pending; 180 struct list_head completion_pending; 181 struct list_head free_pool; 182 183 struct qed_chain chain; 184 185 /* allocated dma-able memory for spq entries (+ramrod data) */ 186 dma_addr_t p_phys; 187 struct qed_spq_entry *p_virt; 188 189 #define SPQ_RING_SIZE \ 190 (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element)) 191 192 /* Bitmap for handling out-of-order completions */ 193 DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE); 194 u8 comp_bitmap_idx; 195 196 /* Statistics */ 197 u32 unlimited_pending_count; 198 u32 normal_count; 199 u32 high_count; 200 u32 comp_sent_count; 201 u32 comp_count; 202 203 u32 cid; 204 }; 205 206 /** 207 * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that 208 * Pends it to the future list. 209 * 210 * @param p_hwfn 211 * @param p_req 212 * 213 * @return int 214 */ 215 int qed_spq_post(struct qed_hwfn *p_hwfn, 216 struct qed_spq_entry *p_ent, 217 u8 *fw_return_code); 218 219 /** 220 * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ. 221 * 222 * @param p_hwfn 223 * 224 * @return int 225 */ 226 int qed_spq_alloc(struct qed_hwfn *p_hwfn); 227 228 /** 229 * @brief qed_spq_setup - Reset the SPQ to its start state. 230 * 231 * @param p_hwfn 232 */ 233 void qed_spq_setup(struct qed_hwfn *p_hwfn); 234 235 /** 236 * @brief qed_spq_deallocate - Deallocates the given SPQ struct. 237 * 238 * @param p_hwfn 239 */ 240 void qed_spq_free(struct qed_hwfn *p_hwfn); 241 242 /** 243 * @brief qed_spq_get_entry - Obtain an entrry from the spq 244 * free pool list. 245 * 246 * 247 * 248 * @param p_hwfn 249 * @param pp_ent 250 * 251 * @return int 252 */ 253 int 254 qed_spq_get_entry(struct qed_hwfn *p_hwfn, 255 struct qed_spq_entry **pp_ent); 256 257 /** 258 * @brief qed_spq_return_entry - Return an entry to spq free 259 * pool list 260 * 261 * @param p_hwfn 262 * @param p_ent 263 */ 264 void qed_spq_return_entry(struct qed_hwfn *p_hwfn, 265 struct qed_spq_entry *p_ent); 266 /** 267 * @brief qed_eq_allocate - Allocates & initializes an EQ struct 268 * 269 * @param p_hwfn 270 * @param num_elem number of elements in the eq 271 * 272 * @return struct qed_eq* - a newly allocated structure; NULL upon error. 273 */ 274 struct qed_eq *qed_eq_alloc(struct qed_hwfn *p_hwfn, 275 u16 num_elem); 276 277 /** 278 * @brief qed_eq_setup - Reset the SPQ to its start state. 279 * 280 * @param p_hwfn 281 * @param p_eq 282 */ 283 void qed_eq_setup(struct qed_hwfn *p_hwfn, 284 struct qed_eq *p_eq); 285 286 /** 287 * @brief qed_eq_deallocate - deallocates the given EQ struct. 288 * 289 * @param p_hwfn 290 * @param p_eq 291 */ 292 void qed_eq_free(struct qed_hwfn *p_hwfn, 293 struct qed_eq *p_eq); 294 295 /** 296 * @brief qed_eq_prod_update - update the FW with default EQ producer 297 * 298 * @param p_hwfn 299 * @param prod 300 */ 301 void qed_eq_prod_update(struct qed_hwfn *p_hwfn, 302 u16 prod); 303 304 /** 305 * @brief qed_eq_completion - Completes currently pending EQ elements 306 * 307 * @param p_hwfn 308 * @param cookie 309 * 310 * @return int 311 */ 312 int qed_eq_completion(struct qed_hwfn *p_hwfn, 313 void *cookie); 314 315 /** 316 * @brief qed_spq_completion - Completes a single event 317 * 318 * @param p_hwfn 319 * @param echo - echo value from cookie (used for determining completion) 320 * @param p_data - data from cookie (used in callback function if applicable) 321 * 322 * @return int 323 */ 324 int qed_spq_completion(struct qed_hwfn *p_hwfn, 325 __le16 echo, 326 u8 fw_return_code, 327 union event_ring_data *p_data); 328 329 /** 330 * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ 331 * 332 * @param p_hwfn 333 * 334 * @return u32 - SPQ CID 335 */ 336 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn); 337 338 /** 339 * @brief qed_consq_alloc - Allocates & initializes an ConsQ 340 * struct 341 * 342 * @param p_hwfn 343 * 344 * @return struct qed_eq* - a newly allocated structure; NULL upon error. 345 */ 346 struct qed_consq *qed_consq_alloc(struct qed_hwfn *p_hwfn); 347 348 /** 349 * @brief qed_consq_setup - Reset the ConsQ to its start 350 * state. 351 * 352 * @param p_hwfn 353 * @param p_eq 354 */ 355 void qed_consq_setup(struct qed_hwfn *p_hwfn, 356 struct qed_consq *p_consq); 357 358 /** 359 * @brief qed_consq_free - deallocates the given ConsQ struct. 360 * 361 * @param p_hwfn 362 * @param p_eq 363 */ 364 void qed_consq_free(struct qed_hwfn *p_hwfn, 365 struct qed_consq *p_consq); 366 367 /** 368 * @file 369 * 370 * @brief Slow-hwfn low-level commands (Ramrods) function definitions. 371 */ 372 373 #define QED_SP_EQ_COMPLETION 0x01 374 #define QED_SP_CQE_COMPLETION 0x02 375 376 struct qed_sp_init_data { 377 u32 cid; 378 u16 opaque_fid; 379 380 /* Information regarding operation upon sending & completion */ 381 enum spq_mode comp_mode; 382 struct qed_spq_comp_cb *p_comp_data; 383 }; 384 385 int qed_sp_init_request(struct qed_hwfn *p_hwfn, 386 struct qed_spq_entry **pp_ent, 387 u8 cmd, 388 u8 protocol, 389 struct qed_sp_init_data *p_data); 390 391 /** 392 * @brief qed_sp_pf_start - PF Function Start Ramrod 393 * 394 * This ramrod is sent to initialize a physical function (PF). It will 395 * configure the function related parameters and write its completion to the 396 * event ring specified in the parameters. 397 * 398 * Ramrods complete on the common event ring for the PF. This ring is 399 * allocated by the driver on host memory and its parameters are written 400 * to the internal RAM of the UStorm by the Function Start Ramrod. 401 * 402 * @param p_hwfn 403 * @param p_tunn 404 * @param mode 405 * @param allow_npar_tx_switch 406 * 407 * @return int 408 */ 409 410 int qed_sp_pf_start(struct qed_hwfn *p_hwfn, 411 struct qed_tunn_start_params *p_tunn, 412 enum qed_mf_mode mode, bool allow_npar_tx_switch); 413 414 /** 415 * @brief qed_sp_pf_update - PF Function Update Ramrod 416 * 417 * This ramrod updates function-related parameters. Every parameter can be 418 * updated independently, according to configuration flags. 419 * 420 * @param p_hwfn 421 * 422 * @return int 423 */ 424 425 int qed_sp_pf_update(struct qed_hwfn *p_hwfn); 426 427 /** 428 * @brief qed_sp_pf_stop - PF Function Stop Ramrod 429 * 430 * This ramrod is sent to close a Physical Function (PF). It is the last ramrod 431 * sent and the last completion written to the PFs Event Ring. This ramrod also 432 * deletes the context for the Slowhwfn connection on this PF. 433 * 434 * @note Not required for first packet. 435 * 436 * @param p_hwfn 437 * 438 * @return int 439 */ 440 441 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn); 442 443 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn, 444 struct qed_tunn_update_params *p_tunn, 445 enum spq_mode comp_mode, 446 struct qed_spq_comp_cb *p_comp_data); 447 /** 448 * @brief qed_sp_heartbeat_ramrod - Send empty Ramrod 449 * 450 * @param p_hwfn 451 * 452 * @return int 453 */ 454 455 int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn); 456 457 #endif 458