2 * Copyright (c) 2017-2018 Cavium, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
31 #ifndef __ECORE_VF_H__
32 #define __ECORE_VF_H__
34 #include "ecore_status.h"
35 #include "ecore_vf_api.h"
36 #include "ecore_l2_api.h"
37 #include "ecore_vfpf_if.h"
39 /* Default number of CIDs [total of both Rx and Tx] to be requested
40 * by default, and maximum possible number.
42 #define ECORE_ETH_VF_DEFAULT_NUM_CIDS (32)
43 #define ECORE_ETH_VF_MAX_NUM_CIDS (255)
45 /* This data is held in the ecore_hwfn structure for VFs only. */
47 union vfpf_tlvs *vf2pf_request;
48 dma_addr_t vf2pf_request_phys;
49 union pfvf_tlvs *pf2vf_reply;
50 dma_addr_t pf2vf_reply_phys;
52 /* Should be taken whenever the mailbox buffers are accessed */
57 struct ecore_bulletin bulletin;
58 struct ecore_bulletin_content bulletin_shadow;
60 /* we set aside a copy of the acquire response */
61 struct pfvf_acquire_resp_tlv acquire_resp;
63 /* In case PF originates prior to the fp-hsi version comparison,
64 * this has to be propagated as it affects the fastpath.
68 /* Current day VFs are passing the SBs physical address on vport
69 * start, and as they lack an IGU mapping they need to store the
70 * addresses of previously registered SBs.
71 * Even if we were to change configuration flow, due to backward
72 * compatability [with older PFs] we'd still need to store these.
74 struct ecore_sb_info *sbs_info[PFVF_MAX_SBS_PER_VF];
76 #ifdef CONFIG_ECORE_SW_CHANNEL
77 /* Would be set if the VF is to try communicating with it PF
83 /* Determines whether VF utilizes doorbells via limited register
84 * bar or via the doorbell bar.
90 * @brief VF - Get coalesce per VF's relative queue.
93 * @param p_coal - coalesce value in micro second for VF queues.
94 * @param p_cid - queue cid
97 enum _ecore_status_t ecore_vf_pf_get_coalesce(struct ecore_hwfn *p_hwfn,
99 struct ecore_queue_cid *p_cid);
101 * @brief VF - Set Rx/Tx coalesce per VF's relative queue.
102 * Coalesce value '0' will omit the configuration.
105 * @param rx_coal - coalesce value in micro second for rx queue
106 * @param tx_coal - coalesce value in micro second for tx queue
107 * @param p_cid - queue cid
110 enum _ecore_status_t ecore_vf_pf_set_coalesce(struct ecore_hwfn *p_hwfn,
111 u16 rx_coal, u16 tx_coal,
112 struct ecore_queue_cid *p_cid);
114 #ifdef CONFIG_ECORE_SRIOV
116 * @brief hw preparation for VF
117 * sends ACQUIRE message
121 * @return enum _ecore_status_t
123 enum _ecore_status_t ecore_vf_hw_prepare(struct ecore_hwfn *p_hwfn);
126 * @brief VF - start the RX Queue by sending a message to the PF
129 * @param p_cid - Only relative fields are relevant
130 * @param bd_max_bytes - maximum number of bytes per bd
131 * @param bd_chain_phys_addr - physical address of bd chain
132 * @param cqe_pbl_addr - physical address of pbl
133 * @param cqe_pbl_size - pbl size
134 * @param pp_prod - pointer to the producer to be
137 * @return enum _ecore_status_t
139 enum _ecore_status_t ecore_vf_pf_rxq_start(struct ecore_hwfn *p_hwfn,
140 struct ecore_queue_cid *p_cid,
142 dma_addr_t bd_chain_phys_addr,
143 dma_addr_t cqe_pbl_addr,
145 void OSAL_IOMEM **pp_prod);
148 * @brief VF - start the TX queue by sending a message to the
153 * @param bd_chain_phys_addr - physical address of tx chain
154 * @param pp_doorbell - pointer to address to which to
155 * write the doorbell too..
157 * @return enum _ecore_status_t
160 ecore_vf_pf_txq_start(struct ecore_hwfn *p_hwfn,
161 struct ecore_queue_cid *p_cid,
162 dma_addr_t pbl_addr, u16 pbl_size,
163 void OSAL_IOMEM **pp_doorbell);
166 * @brief VF - stop the RX queue by sending a message to the PF
170 * @param cqe_completion
172 * @return enum _ecore_status_t
174 enum _ecore_status_t ecore_vf_pf_rxq_stop(struct ecore_hwfn *p_hwfn,
175 struct ecore_queue_cid *p_cid,
176 bool cqe_completion);
179 * @brief VF - stop the TX queue by sending a message to the PF
184 * @return enum _ecore_status_t
186 enum _ecore_status_t ecore_vf_pf_txq_stop(struct ecore_hwfn *p_hwfn,
187 struct ecore_queue_cid *p_cid);
189 /* TODO - fix all the !SRIOV prototypes */
193 * @brief VF - update the RX queue by sending a message to the
197 * @param pp_cid - list of queue-cids which we want to update
199 * @param comp_cqe_flg
200 * @param comp_event_flg
202 * @return enum _ecore_status_t
204 enum _ecore_status_t ecore_vf_pf_rxqs_update(struct ecore_hwfn *p_hwfn,
205 struct ecore_queue_cid **pp_cid,
212 * @brief VF - send a vport update command
217 * @return enum _ecore_status_t
219 enum _ecore_status_t ecore_vf_pf_vport_update(struct ecore_hwfn *p_hwfn,
220 struct ecore_sp_vport_update_params *p_params);
223 * @brief VF - send a close message to PF
227 * @return enum _ecore_status
229 enum _ecore_status_t ecore_vf_pf_reset(struct ecore_hwfn *p_hwfn);
232 * @brief VF - free vf`s memories
236 * @return enum _ecore_status
238 enum _ecore_status_t ecore_vf_pf_release(struct ecore_hwfn *p_hwfn);
241 * @brief ecore_vf_get_igu_sb_id - Get the IGU SB ID for a given
242 * sb_id. For VFs igu sbs don't have to be contiguous
249 u16 ecore_vf_get_igu_sb_id(struct ecore_hwfn *p_hwfn,
253 * @brief Stores [or removes] a configured sb_info.
256 * @param sb_id - zero-based SB index [for fastpath]
257 * @param sb_info - may be OSAL_NULL [during removal].
259 void ecore_vf_set_sb_info(struct ecore_hwfn *p_hwfn,
260 u16 sb_id, struct ecore_sb_info *p_sb);
263 * @brief ecore_vf_pf_vport_start - perform vport start for VF.
268 * @param inner_vlan_removal
270 * @param max_buffers_per_cqe,
271 * @param only_untagged - default behavior regarding vlan acceptance
272 * @param zero_placement_offset - if set, zero padding will be inserted
274 * @return enum _ecore_status
276 enum _ecore_status_t ecore_vf_pf_vport_start(
277 struct ecore_hwfn *p_hwfn,
280 u8 inner_vlan_removal,
281 enum ecore_tpa_mode tpa_mode,
282 u8 max_buffers_per_cqe,
284 u8 zero_placement_offset);
287 * @brief ecore_vf_pf_vport_stop - stop the VF's vport
291 * @return enum _ecore_status
293 enum _ecore_status_t ecore_vf_pf_vport_stop(struct ecore_hwfn *p_hwfn);
295 enum _ecore_status_t ecore_vf_pf_filter_ucast(
296 struct ecore_hwfn *p_hwfn,
297 struct ecore_filter_ucast *p_param);
299 void ecore_vf_pf_filter_mcast(struct ecore_hwfn *p_hwfn,
300 struct ecore_filter_mcast *p_filter_cmd);
303 * @brief ecore_vf_pf_int_cleanup - clean the SB of the VF
307 * @return enum _ecore_status
309 enum _ecore_status_t ecore_vf_pf_int_cleanup(struct ecore_hwfn *p_hwfn);
312 * @brief - return the link params in a given bulletin board
314 * @param p_params - pointer to a struct to fill with link params
317 void __ecore_vf_get_link_params(struct ecore_mcp_link_params *p_params,
318 struct ecore_bulletin_content *p_bulletin);
321 * @brief - return the link state in a given bulletin board
323 * @param p_link - pointer to a struct to fill with link state
326 void __ecore_vf_get_link_state(struct ecore_mcp_link_state *p_link,
327 struct ecore_bulletin_content *p_bulletin);
330 * @brief - return the link capabilities in a given bulletin board
332 * @param p_link - pointer to a struct to fill with link capabilities
335 void __ecore_vf_get_link_caps(struct ecore_mcp_link_capabilities *p_link_caps,
336 struct ecore_bulletin_content *p_bulletin);
338 ecore_vf_pf_tunnel_param_update(struct ecore_hwfn *p_hwfn,
339 struct ecore_tunnel_info *p_tunn);
340 void ecore_vf_set_vf_start_tunn_update_param(struct ecore_tunnel_info *p_tun);
342 u32 ecore_vf_hw_bar_size(struct ecore_hwfn *p_hwfn, enum BAR_ID bar_id);
344 static OSAL_INLINE enum _ecore_status_t ecore_vf_hw_prepare(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
345 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_rxq_start(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_queue_cid OSAL_UNUSED *p_cid, u16 OSAL_UNUSED bd_max_bytes, dma_addr_t OSAL_UNUSED bd_chain_phys_addr, dma_addr_t OSAL_UNUSED cqe_pbl_addr, u16 OSAL_UNUSED cqe_pbl_size, void OSAL_IOMEM OSAL_UNUSED **pp_prod) {return ECORE_INVAL;}
346 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_txq_start(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_queue_cid OSAL_UNUSED *p_cid, dma_addr_t OSAL_UNUSED pbl_addr, u16 OSAL_UNUSED pbl_size, void OSAL_IOMEM OSAL_UNUSED **pp_doorbell) {return ECORE_INVAL;}
348 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_rxq_stop(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_queue_cid OSAL_UNUSED *p_cid, bool OSAL_UNUSED cqe_completion) {return ECORE_INVAL;}
349 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_txq_stop(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_queue_cid OSAL_UNUSED *p_cid) {return ECORE_INVAL;}
351 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_rxqs_update(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_queue_cid OSAL_UNUSED **pp_cid, u8 OSAL_UNUSED num_rxqs, u8 OSAL_UNUSED comp_cqe_flg, u8 OSAL_UNUSED comp_event_flg) {return ECORE_INVAL;}
353 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_vport_update(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_sp_vport_update_params OSAL_UNUSED *p_params) {return ECORE_INVAL;}
354 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_reset(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
355 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_release(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
356 static OSAL_INLINE u16 ecore_vf_get_igu_sb_id(struct ecore_hwfn OSAL_UNUSED *p_hwfn, u16 OSAL_UNUSED sb_id) {return 0;}
357 static OSAL_INLINE void ecore_vf_set_sb_info(struct ecore_hwfn OSAL_UNUSED *p_hwfn, u16 OSAL_UNUSED sb_id, struct ecore_sb_info OSAL_UNUSED *p_sb) {}
359 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_vport_start(struct ecore_hwfn OSAL_UNUSED *p_hwfn, u8 OSAL_UNUSED vport_id, u16 OSAL_UNUSED mtu, u8 OSAL_UNUSED inner_vlan_removal, enum ecore_tpa_mode OSAL_UNUSED tpa_mode, u8 OSAL_UNUSED max_buffers_per_cqe, u8 OSAL_UNUSED only_untagged, u8 OSAL_UNUSED zero_placement_offset) {return ECORE_INVAL;}
360 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_vport_stop(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
361 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_filter_ucast(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_filter_ucast OSAL_UNUSED *p_param) {return ECORE_INVAL;}
362 static OSAL_INLINE void ecore_vf_pf_filter_mcast(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_filter_mcast OSAL_UNUSED *p_filter_cmd) {}
363 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_int_cleanup(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
364 static OSAL_INLINE void __ecore_vf_get_link_params(struct ecore_mcp_link_params OSAL_UNUSED *p_params, struct ecore_bulletin_content OSAL_UNUSED *p_bulletin) {}
365 static OSAL_INLINE void __ecore_vf_get_link_state(struct ecore_mcp_link_state OSAL_UNUSED *p_link, struct ecore_bulletin_content OSAL_UNUSED *p_bulletin) {}
366 static OSAL_INLINE void __ecore_vf_get_link_caps(struct ecore_mcp_link_capabilities OSAL_UNUSED *p_link_caps, struct ecore_bulletin_content OSAL_UNUSED *p_bulletin) {}
367 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_tunnel_param_update(struct ecore_hwfn OSAL_UNUSED *p_hwfn, struct ecore_tunnel_info OSAL_UNUSED *p_tunn) { return ECORE_INVAL; }
368 static OSAL_INLINE void ecore_vf_set_vf_start_tunn_update_param(struct ecore_tunnel_info OSAL_UNUSED *p_tun) { return; }
370 static OSAL_INLINE u32
371 ecore_vf_hw_bar_size(struct ecore_hwfn OSAL_UNUSED *p_hwfn,
372 enum BAR_ID OSAL_UNUSED bar_id)
378 #endif /* __ECORE_VF_H__ */