/* * Copyright (c) 2017-2018 Cavium, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * */ #ifndef __ECORE_SPQ_H__ #define __ECORE_SPQ_H__ #include "ecore_hsi_common.h" #include "ecore_status.h" #include "ecore_hsi_eth.h" #include "ecore_hsi_fcoe.h" #include "tcp_common.h" #include "ecore_hsi_iscsi.h" #include "ecore_hsi_roce.h" #include "ecore_hsi_iwarp.h" #include "ecore_chain.h" #include "ecore_sp_api.h" union ramrod_data { struct pf_start_ramrod_data pf_start; struct pf_update_ramrod_data pf_update; struct rl_update_ramrod_data rl_update; struct rx_queue_start_ramrod_data rx_queue_start; struct rx_queue_update_ramrod_data rx_queue_update; struct rx_queue_stop_ramrod_data rx_queue_stop; struct tx_queue_start_ramrod_data tx_queue_start; struct tx_queue_stop_ramrod_data tx_queue_stop; struct vport_start_ramrod_data vport_start; struct vport_stop_ramrod_data vport_stop; struct rx_update_gft_filter_data rx_update_gft; struct vport_update_ramrod_data vport_update; struct core_rx_start_ramrod_data core_rx_queue_start; struct core_rx_stop_ramrod_data core_rx_queue_stop; struct core_tx_start_ramrod_data core_tx_queue_start; struct core_tx_stop_ramrod_data core_tx_queue_stop; struct vport_filter_update_ramrod_data vport_filter_update; struct rdma_init_func_ramrod_data rdma_init_func; struct rdma_close_func_ramrod_data rdma_close_func; struct rdma_register_tid_ramrod_data rdma_register_tid; struct rdma_deregister_tid_ramrod_data rdma_deregister_tid; struct roce_create_qp_resp_ramrod_data roce_create_qp_resp; struct roce_create_qp_req_ramrod_data roce_create_qp_req; struct roce_modify_qp_resp_ramrod_data roce_modify_qp_resp; struct roce_modify_qp_req_ramrod_data roce_modify_qp_req; struct roce_query_qp_resp_ramrod_data roce_query_qp_resp; struct roce_query_qp_req_ramrod_data roce_query_qp_req; struct roce_destroy_qp_resp_ramrod_data roce_destroy_qp_resp; struct roce_destroy_qp_req_ramrod_data roce_destroy_qp_req; struct roce_init_func_ramrod_data roce_init_func; struct rdma_create_cq_ramrod_data rdma_create_cq; struct rdma_resize_cq_ramrod_data rdma_resize_cq; struct rdma_destroy_cq_ramrod_data rdma_destroy_cq; struct rdma_srq_create_ramrod_data rdma_create_srq; struct rdma_srq_destroy_ramrod_data rdma_destroy_srq; struct rdma_srq_modify_ramrod_data rdma_modify_srq; struct iwarp_create_qp_ramrod_data iwarp_create_qp; struct iwarp_tcp_offload_ramrod_data iwarp_tcp_offload; struct iwarp_mpa_offload_ramrod_data iwarp_mpa_offload; struct iwarp_modify_qp_ramrod_data iwarp_modify_qp; struct iwarp_query_qp_ramrod_data iwarp_query_qp; struct iwarp_init_func_ramrod_data iwarp_init_func; struct fcoe_init_ramrod_params fcoe_init; struct fcoe_conn_offload_ramrod_params fcoe_conn_ofld; struct fcoe_conn_terminate_ramrod_params fcoe_conn_terminate; struct fcoe_stat_ramrod_params fcoe_stat; struct iscsi_slow_path_hdr iscsi_empty; struct iscsi_init_ramrod_params iscsi_init; struct iscsi_spe_func_dstry iscsi_destroy; struct iscsi_spe_conn_offload iscsi_conn_offload; struct iscsi_conn_update_ramrod_params iscsi_conn_update; struct iscsi_spe_conn_mac_update iscsi_conn_mac_update; struct iscsi_spe_conn_termination iscsi_conn_terminate; struct iscsi_spe_conn_statistics iscsi_conn_statistics; struct vf_start_ramrod_data vf_start; struct vf_stop_ramrod_data vf_stop; }; #define EQ_MAX_CREDIT 0xffffffff enum spq_priority { ECORE_SPQ_PRIORITY_NORMAL, ECORE_SPQ_PRIORITY_HIGH, }; union ecore_spq_req_comp { struct ecore_spq_comp_cb cb; u64 *done_addr; }; /* SPQ_MODE_EBLOCK */ struct ecore_spq_comp_done { u64 done; u8 fw_return_code; }; struct ecore_spq_entry { osal_list_entry_t list; u8 flags; /* HSI slow path element */ struct slow_path_element elem; union ramrod_data ramrod; enum spq_priority priority; /* pending queue for this entry */ osal_list_t *queue; enum spq_mode comp_mode; struct ecore_spq_comp_cb comp_cb; struct ecore_spq_comp_done comp_done; /* SPQ_MODE_EBLOCK */ }; struct ecore_eq { struct ecore_chain chain; u8 eq_sb_index; /* index within the SB */ __le16 *p_fw_cons; /* ptr to index value */ }; struct ecore_consq { struct ecore_chain chain; }; typedef enum _ecore_status_t (*ecore_spq_async_comp_cb)(struct ecore_hwfn *p_hwfn, u8 opcode, u16 echo, union event_ring_data *data, u8 fw_return_code); enum _ecore_status_t ecore_spq_register_async_cb(struct ecore_hwfn *p_hwfn, enum protocol_type protocol_id, ecore_spq_async_comp_cb cb); void ecore_spq_unregister_async_cb(struct ecore_hwfn *p_hwfn, enum protocol_type protocol_id); struct ecore_spq { osal_spinlock_t lock; osal_list_t unlimited_pending; osal_list_t pending; osal_list_t completion_pending; osal_list_t free_pool; struct ecore_chain chain; /* allocated dma-able memory for spq entries (+ramrod data) */ dma_addr_t p_phys; struct ecore_spq_entry *p_virt; /* Bitmap for handling out-of-order completions */ #define SPQ_RING_SIZE \ (CORE_SPQE_PAGE_SIZE_BYTES / sizeof(struct slow_path_element)) #define SPQ_COMP_BMAP_SIZE (SPQ_RING_SIZE / (sizeof(unsigned long) * 8 /* BITS_PER_LONG */)) unsigned long p_comp_bitmap[SPQ_COMP_BMAP_SIZE]; u8 comp_bitmap_idx; #define SPQ_COMP_BMAP_SET_BIT(p_spq, idx) \ do { \ OSAL_SET_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap); \ } while (0) #define SPQ_COMP_BMAP_CLEAR_BIT(p_spq, idx) \ do { \ OSAL_CLEAR_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap); \ } while (0) #define SPQ_COMP_BMAP_TEST_BIT(p_spq, idx) \ (OSAL_TEST_BIT(((idx) % SPQ_RING_SIZE), (p_spq)->p_comp_bitmap)) /* Statistics */ u32 unlimited_pending_count; u32 normal_count; u32 high_count; u32 comp_sent_count; u32 comp_count; u32 cid; u32 db_addr_offset; struct core_db_data db_data; ecore_spq_async_comp_cb async_comp_cb[MAX_PROTOCOL_TYPE]; }; struct ecore_port; struct ecore_hwfn; /** * @brief ecore_spq_post - Posts a Slow hwfn request to FW, or lacking that * Pends it to the future list. * * @param p_hwfn * @param p_req * * @return enum _ecore_status_t */ enum _ecore_status_t ecore_spq_post(struct ecore_hwfn *p_hwfn, struct ecore_spq_entry *p_ent, u8 *fw_return_code); /** * @brief ecore_spq_allocate - Alloocates & initializes the SPQ and EQ. * * @param p_hwfn * * @return enum _ecore_status_t */ enum _ecore_status_t ecore_spq_alloc(struct ecore_hwfn *p_hwfn); /** * @brief ecore_spq_setup - Reset the SPQ to its start state. * * @param p_hwfn */ void ecore_spq_setup(struct ecore_hwfn *p_hwfn); /** * @brief ecore_spq_deallocate - Deallocates the given SPQ struct. * * @param p_hwfn */ void ecore_spq_free(struct ecore_hwfn *p_hwfn); /** * @brief ecore_spq_get_entry - Obtain an entrry from the spq * free pool list. * * * * @param p_hwfn * @param pp_ent * * @return enum _ecore_status_t */ enum _ecore_status_t ecore_spq_get_entry(struct ecore_hwfn *p_hwfn, struct ecore_spq_entry **pp_ent); /** * @brief ecore_spq_return_entry - Return an entry to spq free * pool list * * @param p_hwfn * @param p_ent */ void ecore_spq_return_entry(struct ecore_hwfn *p_hwfn, struct ecore_spq_entry *p_ent); /** * @brief ecore_eq_allocate - Allocates & initializes an EQ struct * * @param p_hwfn * @param num_elem number of elements in the eq * * @return enum _ecore_status_t */ enum _ecore_status_t ecore_eq_alloc(struct ecore_hwfn *p_hwfn, u16 num_elem); /** * @brief ecore_eq_setup - Reset the EQ to its start state. * * @param p_hwfn */ void ecore_eq_setup(struct ecore_hwfn *p_hwfn); /** * @brief ecore_eq_free - deallocates the given EQ struct. * * @param p_hwfn */ void ecore_eq_free(struct ecore_hwfn *p_hwfn); /** * @brief ecore_eq_prod_update - update the FW with default EQ producer * * @param p_hwfn * @param prod */ void ecore_eq_prod_update(struct ecore_hwfn *p_hwfn, u16 prod); /** * @brief ecore_eq_completion - Completes currently pending EQ elements * * @param p_hwfn * @param cookie * * @return enum _ecore_status_t */ enum _ecore_status_t ecore_eq_completion(struct ecore_hwfn *p_hwfn, void *cookie); /** * @brief ecore_spq_completion - Completes a single event * * @param p_hwfn * @param echo - echo value from cookie (used for determining completion) * @param p_data - data from cookie (used in callback function if applicable) * * @return enum _ecore_status_t */ enum _ecore_status_t ecore_spq_completion(struct ecore_hwfn *p_hwfn, __le16 echo, u8 fw_return_code, union event_ring_data *p_data); /** * @brief ecore_spq_get_cid - Given p_hwfn, return cid for the hwfn's SPQ * * @param p_hwfn * * @return u32 - SPQ CID */ u32 ecore_spq_get_cid(struct ecore_hwfn *p_hwfn); /** * @brief ecore_consq_alloc - Allocates & initializes an ConsQ struct * * @param p_hwfn * * @return enum _ecore_status_t */ enum _ecore_status_t ecore_consq_alloc(struct ecore_hwfn *p_hwfn); /** * @brief ecore_consq_setup - Reset the ConsQ to its start state. * * @param p_hwfn */ void ecore_consq_setup(struct ecore_hwfn *p_hwfn); /** * @brief ecore_consq_free - deallocates the given ConsQ struct. * * @param p_hwfn */ void ecore_consq_free(struct ecore_hwfn *p_hwfn); enum _ecore_status_t ecore_spq_pend_post(struct ecore_hwfn *p_hwfn); #endif /* __ECORE_SPQ_H__ */