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 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; 94 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_modify_qp_ramrod_data iwarp_modify_qp; 115 struct iwarp_init_func_ramrod_data iwarp_init_func; 116 struct fcoe_init_ramrod_params fcoe_init; 117 struct fcoe_conn_offload_ramrod_params fcoe_conn_ofld; 118 struct fcoe_conn_terminate_ramrod_params fcoe_conn_terminate; 119 struct fcoe_stat_ramrod_params fcoe_stat; 120 121 struct iscsi_slow_path_hdr iscsi_empty; 122 struct iscsi_init_ramrod_params iscsi_init; 123 struct iscsi_spe_func_dstry iscsi_destroy; 124 struct iscsi_spe_conn_offload iscsi_conn_offload; 125 struct iscsi_conn_update_ramrod_params iscsi_conn_update; 126 struct iscsi_spe_conn_mac_update iscsi_conn_mac_update; 127 struct iscsi_spe_conn_termination iscsi_conn_terminate; 128 129 struct vf_start_ramrod_data vf_start; 130 struct vf_stop_ramrod_data vf_stop; 131 }; 132 133 #define EQ_MAX_CREDIT 0xffffffff 134 135 enum spq_priority { 136 QED_SPQ_PRIORITY_NORMAL, 137 QED_SPQ_PRIORITY_HIGH, 138 }; 139 140 union qed_spq_req_comp { 141 struct qed_spq_comp_cb cb; 142 u64 *done_addr; 143 }; 144 145 struct qed_spq_comp_done { 146 unsigned int done; 147 u8 fw_return_code; 148 }; 149 150 struct qed_spq_entry { 151 struct list_head list; 152 153 u8 flags; 154 155 /* HSI slow path element */ 156 struct slow_path_element elem; 157 158 union ramrod_data ramrod; 159 160 enum spq_priority priority; 161 162 /* pending queue for this entry */ 163 struct list_head *queue; 164 165 enum spq_mode comp_mode; 166 struct qed_spq_comp_cb comp_cb; 167 struct qed_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */ 168 }; 169 170 struct qed_eq { 171 struct qed_chain chain; 172 u8 eq_sb_index; /* index within the SB */ 173 __le16 *p_fw_cons; /* ptr to index value */ 174 }; 175 176 struct qed_consq { 177 struct qed_chain chain; 178 }; 179 180 typedef int 181 (*qed_spq_async_comp_cb)(struct qed_hwfn *p_hwfn, 182 u8 opcode, 183 u16 echo, 184 union event_ring_data *data, 185 u8 fw_return_code); 186 187 int 188 qed_spq_register_async_cb(struct qed_hwfn *p_hwfn, 189 enum protocol_type protocol_id, 190 qed_spq_async_comp_cb cb); 191 192 void 193 qed_spq_unregister_async_cb(struct qed_hwfn *p_hwfn, 194 enum protocol_type protocol_id); 195 196 struct qed_spq { 197 spinlock_t lock; /* SPQ lock */ 198 199 struct list_head unlimited_pending; 200 struct list_head pending; 201 struct list_head completion_pending; 202 struct list_head free_pool; 203 204 struct qed_chain chain; 205 206 /* allocated dma-able memory for spq entries (+ramrod data) */ 207 dma_addr_t p_phys; 208 struct qed_spq_entry *p_virt; 209 210 #define SPQ_RING_SIZE \ 211 (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element)) 212 213 /* Bitmap for handling out-of-order completions */ 214 DECLARE_BITMAP(p_comp_bitmap, SPQ_RING_SIZE); 215 u8 comp_bitmap_idx; 216 217 /* Statistics */ 218 u32 unlimited_pending_count; 219 u32 normal_count; 220 u32 high_count; 221 u32 comp_sent_count; 222 u32 comp_count; 223 224 u32 cid; 225 qed_spq_async_comp_cb async_comp_cb[MAX_PROTOCOL_TYPE]; 226 }; 227 228 /** 229 * @brief qed_spq_post - Posts a Slow hwfn request to FW, or lacking that 230 * Pends it to the future list. 231 * 232 * @param p_hwfn 233 * @param p_req 234 * 235 * @return int 236 */ 237 int qed_spq_post(struct qed_hwfn *p_hwfn, 238 struct qed_spq_entry *p_ent, 239 u8 *fw_return_code); 240 241 /** 242 * @brief qed_spq_allocate - Alloocates & initializes the SPQ and EQ. 243 * 244 * @param p_hwfn 245 * 246 * @return int 247 */ 248 int qed_spq_alloc(struct qed_hwfn *p_hwfn); 249 250 /** 251 * @brief qed_spq_setup - Reset the SPQ to its start state. 252 * 253 * @param p_hwfn 254 */ 255 void qed_spq_setup(struct qed_hwfn *p_hwfn); 256 257 /** 258 * @brief qed_spq_deallocate - Deallocates the given SPQ struct. 259 * 260 * @param p_hwfn 261 */ 262 void qed_spq_free(struct qed_hwfn *p_hwfn); 263 264 /** 265 * @brief qed_spq_get_entry - Obtain an entrry from the spq 266 * free pool list. 267 * 268 * 269 * 270 * @param p_hwfn 271 * @param pp_ent 272 * 273 * @return int 274 */ 275 int 276 qed_spq_get_entry(struct qed_hwfn *p_hwfn, 277 struct qed_spq_entry **pp_ent); 278 279 /** 280 * @brief qed_spq_return_entry - Return an entry to spq free 281 * pool list 282 * 283 * @param p_hwfn 284 * @param p_ent 285 */ 286 void qed_spq_return_entry(struct qed_hwfn *p_hwfn, 287 struct qed_spq_entry *p_ent); 288 /** 289 * @brief qed_eq_allocate - Allocates & initializes an EQ struct 290 * 291 * @param p_hwfn 292 * @param num_elem number of elements in the eq 293 * 294 * @return int 295 */ 296 int qed_eq_alloc(struct qed_hwfn *p_hwfn, u16 num_elem); 297 298 /** 299 * @brief qed_eq_setup - Reset the EQ to its start state. 300 * 301 * @param p_hwfn 302 */ 303 void qed_eq_setup(struct qed_hwfn *p_hwfn); 304 305 /** 306 * @brief qed_eq_free - deallocates the given EQ struct. 307 * 308 * @param p_hwfn 309 */ 310 void qed_eq_free(struct qed_hwfn *p_hwfn); 311 312 /** 313 * @brief qed_eq_prod_update - update the FW with default EQ producer 314 * 315 * @param p_hwfn 316 * @param prod 317 */ 318 void qed_eq_prod_update(struct qed_hwfn *p_hwfn, 319 u16 prod); 320 321 /** 322 * @brief qed_eq_completion - Completes currently pending EQ elements 323 * 324 * @param p_hwfn 325 * @param cookie 326 * 327 * @return int 328 */ 329 int qed_eq_completion(struct qed_hwfn *p_hwfn, 330 void *cookie); 331 332 /** 333 * @brief qed_spq_completion - Completes a single event 334 * 335 * @param p_hwfn 336 * @param echo - echo value from cookie (used for determining completion) 337 * @param p_data - data from cookie (used in callback function if applicable) 338 * 339 * @return int 340 */ 341 int qed_spq_completion(struct qed_hwfn *p_hwfn, 342 __le16 echo, 343 u8 fw_return_code, 344 union event_ring_data *p_data); 345 346 /** 347 * @brief qed_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ 348 * 349 * @param p_hwfn 350 * 351 * @return u32 - SPQ CID 352 */ 353 u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn); 354 355 /** 356 * @brief qed_consq_alloc - Allocates & initializes an ConsQ 357 * struct 358 * 359 * @param p_hwfn 360 * 361 * @return int 362 */ 363 int qed_consq_alloc(struct qed_hwfn *p_hwfn); 364 365 /** 366 * @brief qed_consq_setup - Reset the ConsQ to its start state. 367 * 368 * @param p_hwfn 369 */ 370 void qed_consq_setup(struct qed_hwfn *p_hwfn); 371 372 /** 373 * @brief qed_consq_free - deallocates the given ConsQ struct. 374 * 375 * @param p_hwfn 376 */ 377 void qed_consq_free(struct qed_hwfn *p_hwfn); 378 379 /** 380 * @file 381 * 382 * @brief Slow-hwfn low-level commands (Ramrods) function definitions. 383 */ 384 385 #define QED_SP_EQ_COMPLETION 0x01 386 #define QED_SP_CQE_COMPLETION 0x02 387 388 struct qed_sp_init_data { 389 u32 cid; 390 u16 opaque_fid; 391 392 /* Information regarding operation upon sending & completion */ 393 enum spq_mode comp_mode; 394 struct qed_spq_comp_cb *p_comp_data; 395 }; 396 397 int qed_sp_init_request(struct qed_hwfn *p_hwfn, 398 struct qed_spq_entry **pp_ent, 399 u8 cmd, 400 u8 protocol, 401 struct qed_sp_init_data *p_data); 402 403 /** 404 * @brief qed_sp_pf_start - PF Function Start Ramrod 405 * 406 * This ramrod is sent to initialize a physical function (PF). It will 407 * configure the function related parameters and write its completion to the 408 * event ring specified in the parameters. 409 * 410 * Ramrods complete on the common event ring for the PF. This ring is 411 * allocated by the driver on host memory and its parameters are written 412 * to the internal RAM of the UStorm by the Function Start Ramrod. 413 * 414 * @param p_hwfn 415 * @param p_ptt 416 * @param p_tunn 417 * @param mode 418 * @param allow_npar_tx_switch 419 * 420 * @return int 421 */ 422 423 int qed_sp_pf_start(struct qed_hwfn *p_hwfn, 424 struct qed_ptt *p_ptt, 425 struct qed_tunnel_info *p_tunn, 426 enum qed_mf_mode mode, bool allow_npar_tx_switch); 427 428 /** 429 * @brief qed_sp_pf_update - PF Function Update Ramrod 430 * 431 * This ramrod updates function-related parameters. Every parameter can be 432 * updated independently, according to configuration flags. 433 * 434 * @param p_hwfn 435 * 436 * @return int 437 */ 438 439 int qed_sp_pf_update(struct qed_hwfn *p_hwfn); 440 441 /** 442 * @brief qed_sp_pf_update_stag - Update firmware of new outer tag 443 * 444 * @param p_hwfn 445 * 446 * @return int 447 */ 448 int qed_sp_pf_update_stag(struct qed_hwfn *p_hwfn); 449 450 /** 451 * @brief qed_sp_pf_stop - PF Function Stop Ramrod 452 * 453 * This ramrod is sent to close a Physical Function (PF). It is the last ramrod 454 * sent and the last completion written to the PFs Event Ring. This ramrod also 455 * deletes the context for the Slowhwfn connection on this PF. 456 * 457 * @note Not required for first packet. 458 * 459 * @param p_hwfn 460 * 461 * @return int 462 */ 463 464 int qed_sp_pf_stop(struct qed_hwfn *p_hwfn); 465 466 int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn, 467 struct qed_ptt *p_ptt, 468 struct qed_tunnel_info *p_tunn, 469 enum spq_mode comp_mode, 470 struct qed_spq_comp_cb *p_comp_data); 471 /** 472 * @brief qed_sp_heartbeat_ramrod - Send empty Ramrod 473 * 474 * @param p_hwfn 475 * 476 * @return int 477 */ 478 479 int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn); 480 481 #endif 482