1 /*
2 * Copyright (c) 2017-2018 Cavium, Inc.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
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.
14 *
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.
26 *
27 */
28
29 #ifndef __ECORE_VF_H__
30 #define __ECORE_VF_H__
31
32 #include "ecore_status.h"
33 #include "ecore_vf_api.h"
34 #include "ecore_l2_api.h"
35 #include "ecore_vfpf_if.h"
36
37 /* Default number of CIDs [total of both Rx and Tx] to be requested
38 * by default, and maximum possible number.
39 */
40 #define ECORE_ETH_VF_DEFAULT_NUM_CIDS (32)
41 #define ECORE_ETH_VF_MAX_NUM_CIDS (255)
42
43 /* This data is held in the ecore_hwfn structure for VFs only. */
44 struct ecore_vf_iov {
45 union vfpf_tlvs *vf2pf_request;
46 dma_addr_t vf2pf_request_phys;
47 union pfvf_tlvs *pf2vf_reply;
48 dma_addr_t pf2vf_reply_phys;
49
50 /* Should be taken whenever the mailbox buffers are accessed */
51 osal_mutex_t mutex;
52 u8 *offset;
53
54 /* Bulletin Board */
55 struct ecore_bulletin bulletin;
56 struct ecore_bulletin_content bulletin_shadow;
57
58 /* we set aside a copy of the acquire response */
59 struct pfvf_acquire_resp_tlv acquire_resp;
60
61 /* In case PF originates prior to the fp-hsi version comparison,
62 * this has to be propagated as it affects the fastpath.
63 */
64 bool b_pre_fp_hsi;
65
66 /* Current day VFs are passing the SBs physical address on vport
67 * start, and as they lack an IGU mapping they need to store the
68 * addresses of previously registered SBs.
69 * Even if we were to change configuration flow, due to backward
70 * compatability [with older PFs] we'd still need to store these.
71 */
72 struct ecore_sb_info *sbs_info[PFVF_MAX_SBS_PER_VF];
73
74 #ifdef CONFIG_ECORE_SW_CHANNEL
75 /* Would be set if the VF is to try communicating with it PF
76 * using a hw channel.
77 */
78 bool b_hw_channel;
79 #endif
80
81 /* Determines whether VF utilizes doorbells via limited register
82 * bar or via the doorbell bar.
83 */
84 bool b_doorbell_bar;
85 };
86
87 /**
88 * @brief VF - Get coalesce per VF's relative queue.
89 *
90 * @param p_hwfn
91 * @param p_coal - coalesce value in micro second for VF queues.
92 * @param p_cid - queue cid
93 *
94 **/
95 enum _ecore_status_t ecore_vf_pf_get_coalesce(struct ecore_hwfn *p_hwfn,
96 u16 *p_coal,
97 struct ecore_queue_cid *p_cid);
98 /**
99 * @brief VF - Set Rx/Tx coalesce per VF's relative queue.
100 * Coalesce value '0' will omit the configuration.
101 *
102 * @param p_hwfn
103 * @param rx_coal - coalesce value in micro second for rx queue
104 * @param tx_coal - coalesce value in micro second for tx queue
105 * @param p_cid - queue cid
106 *
107 **/
108 enum _ecore_status_t ecore_vf_pf_set_coalesce(struct ecore_hwfn *p_hwfn,
109 u16 rx_coal, u16 tx_coal,
110 struct ecore_queue_cid *p_cid);
111
112 #ifdef CONFIG_ECORE_SRIOV
113 /**
114 * @brief hw preparation for VF
115 * sends ACQUIRE message
116 *
117 * @param p_hwfn
118 *
119 * @return enum _ecore_status_t
120 */
121 enum _ecore_status_t ecore_vf_hw_prepare(struct ecore_hwfn *p_hwfn);
122
123 /**
124 * @brief VF - start the RX Queue by sending a message to the PF
125 *
126 * @param p_hwfn
127 * @param p_cid - Only relative fields are relevant
128 * @param bd_max_bytes - maximum number of bytes per bd
129 * @param bd_chain_phys_addr - physical address of bd chain
130 * @param cqe_pbl_addr - physical address of pbl
131 * @param cqe_pbl_size - pbl size
132 * @param pp_prod - pointer to the producer to be
133 * used in fasthpath
134 *
135 * @return enum _ecore_status_t
136 */
137 enum _ecore_status_t ecore_vf_pf_rxq_start(struct ecore_hwfn *p_hwfn,
138 struct ecore_queue_cid *p_cid,
139 u16 bd_max_bytes,
140 dma_addr_t bd_chain_phys_addr,
141 dma_addr_t cqe_pbl_addr,
142 u16 cqe_pbl_size,
143 void OSAL_IOMEM **pp_prod);
144
145 /**
146 * @brief VF - start the TX queue by sending a message to the
147 * PF.
148 *
149 * @param p_hwfn
150 * @param p_cid
151 * @param bd_chain_phys_addr - physical address of tx chain
152 * @param pp_doorbell - pointer to address to which to
153 * write the doorbell too..
154 *
155 * @return enum _ecore_status_t
156 */
157 enum _ecore_status_t
158 ecore_vf_pf_txq_start(struct ecore_hwfn *p_hwfn,
159 struct ecore_queue_cid *p_cid,
160 dma_addr_t pbl_addr, u16 pbl_size,
161 void OSAL_IOMEM **pp_doorbell);
162
163 /**
164 * @brief VF - stop the RX queue by sending a message to the PF
165 *
166 * @param p_hwfn
167 * @param p_cid
168 * @param cqe_completion
169 *
170 * @return enum _ecore_status_t
171 */
172 enum _ecore_status_t ecore_vf_pf_rxq_stop(struct ecore_hwfn *p_hwfn,
173 struct ecore_queue_cid *p_cid,
174 bool cqe_completion);
175
176 /**
177 * @brief VF - stop the TX queue by sending a message to the PF
178 *
179 * @param p_hwfn
180 * @param p_cid
181 *
182 * @return enum _ecore_status_t
183 */
184 enum _ecore_status_t ecore_vf_pf_txq_stop(struct ecore_hwfn *p_hwfn,
185 struct ecore_queue_cid *p_cid);
186
187 /* TODO - fix all the !SRIOV prototypes */
188
189 #ifndef LINUX_REMOVE
190 /**
191 * @brief VF - update the RX queue by sending a message to the
192 * PF
193 *
194 * @param p_hwfn
195 * @param pp_cid - list of queue-cids which we want to update
196 * @param num_rxqs
197 * @param comp_cqe_flg
198 * @param comp_event_flg
199 *
200 * @return enum _ecore_status_t
201 */
202 enum _ecore_status_t ecore_vf_pf_rxqs_update(struct ecore_hwfn *p_hwfn,
203 struct ecore_queue_cid **pp_cid,
204 u8 num_rxqs,
205 u8 comp_cqe_flg,
206 u8 comp_event_flg);
207 #endif
208
209 /**
210 * @brief VF - send a vport update command
211 *
212 * @param p_hwfn
213 * @param params
214 *
215 * @return enum _ecore_status_t
216 */
217 enum _ecore_status_t ecore_vf_pf_vport_update(struct ecore_hwfn *p_hwfn,
218 struct ecore_sp_vport_update_params *p_params);
219
220 /**
221 * @brief VF - send a close message to PF
222 *
223 * @param p_hwfn
224 *
225 * @return enum _ecore_status
226 */
227 enum _ecore_status_t ecore_vf_pf_reset(struct ecore_hwfn *p_hwfn);
228
229 /**
230 * @brief VF - free vf`s memories
231 *
232 * @param p_hwfn
233 *
234 * @return enum _ecore_status
235 */
236 enum _ecore_status_t ecore_vf_pf_release(struct ecore_hwfn *p_hwfn);
237
238 /**
239 * @brief ecore_vf_get_igu_sb_id - Get the IGU SB ID for a given
240 * sb_id. For VFs igu sbs don't have to be contiguous
241 *
242 * @param p_hwfn
243 * @param sb_id
244 *
245 * @return INLINE u16
246 */
247 u16 ecore_vf_get_igu_sb_id(struct ecore_hwfn *p_hwfn,
248 u16 sb_id);
249
250 /**
251 * @brief Stores [or removes] a configured sb_info.
252 *
253 * @param p_hwfn
254 * @param sb_id - zero-based SB index [for fastpath]
255 * @param sb_info - may be OSAL_NULL [during removal].
256 */
257 void ecore_vf_set_sb_info(struct ecore_hwfn *p_hwfn,
258 u16 sb_id, struct ecore_sb_info *p_sb);
259
260 /**
261 * @brief ecore_vf_pf_vport_start - perform vport start for VF.
262 *
263 * @param p_hwfn
264 * @param vport_id
265 * @param mtu
266 * @param inner_vlan_removal
267 * @param tpa_mode
268 * @param max_buffers_per_cqe,
269 * @param only_untagged - default behavior regarding vlan acceptance
270 * @param zero_placement_offset - if set, zero padding will be inserted
271 *
272 * @return enum _ecore_status
273 */
274 enum _ecore_status_t ecore_vf_pf_vport_start(
275 struct ecore_hwfn *p_hwfn,
276 u8 vport_id,
277 u16 mtu,
278 u8 inner_vlan_removal,
279 enum ecore_tpa_mode tpa_mode,
280 u8 max_buffers_per_cqe,
281 u8 only_untagged,
282 u8 zero_placement_offset);
283
284 /**
285 * @brief ecore_vf_pf_vport_stop - stop the VF's vport
286 *
287 * @param p_hwfn
288 *
289 * @return enum _ecore_status
290 */
291 enum _ecore_status_t ecore_vf_pf_vport_stop(struct ecore_hwfn *p_hwfn);
292
293 enum _ecore_status_t ecore_vf_pf_filter_ucast(
294 struct ecore_hwfn *p_hwfn,
295 struct ecore_filter_ucast *p_param);
296
297 void ecore_vf_pf_filter_mcast(struct ecore_hwfn *p_hwfn,
298 struct ecore_filter_mcast *p_filter_cmd);
299
300 /**
301 * @brief ecore_vf_pf_int_cleanup - clean the SB of the VF
302 *
303 * @param p_hwfn
304 *
305 * @return enum _ecore_status
306 */
307 enum _ecore_status_t ecore_vf_pf_int_cleanup(struct ecore_hwfn *p_hwfn);
308
309 /**
310 * @brief - return the link params in a given bulletin board
311 *
312 * @param p_params - pointer to a struct to fill with link params
313 * @param p_bulletin
314 */
315 void __ecore_vf_get_link_params(struct ecore_mcp_link_params *p_params,
316 struct ecore_bulletin_content *p_bulletin);
317
318 /**
319 * @brief - return the link state in a given bulletin board
320 *
321 * @param p_link - pointer to a struct to fill with link state
322 * @param p_bulletin
323 */
324 void __ecore_vf_get_link_state(struct ecore_mcp_link_state *p_link,
325 struct ecore_bulletin_content *p_bulletin);
326
327 /**
328 * @brief - return the link capabilities in a given bulletin board
329 *
330 * @param p_link - pointer to a struct to fill with link capabilities
331 * @param p_bulletin
332 */
333 void __ecore_vf_get_link_caps(struct ecore_mcp_link_capabilities *p_link_caps,
334 struct ecore_bulletin_content *p_bulletin);
335 enum _ecore_status_t
336 ecore_vf_pf_tunnel_param_update(struct ecore_hwfn *p_hwfn,
337 struct ecore_tunnel_info *p_tunn);
338 void ecore_vf_set_vf_start_tunn_update_param(struct ecore_tunnel_info *p_tun);
339
340 u32 ecore_vf_hw_bar_size(struct ecore_hwfn *p_hwfn, enum BAR_ID bar_id);
341 #else
ecore_vf_hw_prepare(struct ecore_hwfn OSAL_UNUSED * p_hwfn)342 static OSAL_INLINE enum _ecore_status_t ecore_vf_hw_prepare(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
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)343 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;}
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)344 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;}
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)345 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;}
ecore_vf_pf_txq_stop(struct ecore_hwfn OSAL_UNUSED * p_hwfn,struct ecore_queue_cid OSAL_UNUSED * p_cid)346 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;}
347 #ifndef LINUX_REMOVE
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)348 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;}
349 #endif
ecore_vf_pf_vport_update(struct ecore_hwfn OSAL_UNUSED * p_hwfn,struct ecore_sp_vport_update_params OSAL_UNUSED * p_params)350 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;}
ecore_vf_pf_reset(struct ecore_hwfn OSAL_UNUSED * p_hwfn)351 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_reset(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
ecore_vf_pf_release(struct ecore_hwfn OSAL_UNUSED * p_hwfn)352 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_release(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
ecore_vf_get_igu_sb_id(struct ecore_hwfn OSAL_UNUSED * p_hwfn,u16 OSAL_UNUSED sb_id)353 static OSAL_INLINE u16 ecore_vf_get_igu_sb_id(struct ecore_hwfn OSAL_UNUSED *p_hwfn, u16 OSAL_UNUSED sb_id) {return 0;}
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)354 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) {}
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)355 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;}
ecore_vf_pf_vport_stop(struct ecore_hwfn OSAL_UNUSED * p_hwfn)356 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_vport_stop(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
ecore_vf_pf_filter_ucast(struct ecore_hwfn OSAL_UNUSED * p_hwfn,struct ecore_filter_ucast OSAL_UNUSED * p_param)357 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;}
ecore_vf_pf_filter_mcast(struct ecore_hwfn OSAL_UNUSED * p_hwfn,struct ecore_filter_mcast OSAL_UNUSED * p_filter_cmd)358 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) {}
ecore_vf_pf_int_cleanup(struct ecore_hwfn OSAL_UNUSED * p_hwfn)359 static OSAL_INLINE enum _ecore_status_t ecore_vf_pf_int_cleanup(struct ecore_hwfn OSAL_UNUSED *p_hwfn) {return ECORE_INVAL;}
__ecore_vf_get_link_params(struct ecore_mcp_link_params OSAL_UNUSED * p_params,struct ecore_bulletin_content OSAL_UNUSED * p_bulletin)360 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) {}
__ecore_vf_get_link_state(struct ecore_mcp_link_state OSAL_UNUSED * p_link,struct ecore_bulletin_content OSAL_UNUSED * p_bulletin)361 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) {}
__ecore_vf_get_link_caps(struct ecore_mcp_link_capabilities OSAL_UNUSED * p_link_caps,struct ecore_bulletin_content OSAL_UNUSED * p_bulletin)362 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) {}
ecore_vf_pf_tunnel_param_update(struct ecore_hwfn OSAL_UNUSED * p_hwfn,struct ecore_tunnel_info OSAL_UNUSED * p_tunn)363 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; }
ecore_vf_set_vf_start_tunn_update_param(struct ecore_tunnel_info OSAL_UNUSED * p_tun)364 static OSAL_INLINE void ecore_vf_set_vf_start_tunn_update_param(struct ecore_tunnel_info OSAL_UNUSED *p_tun) { return; }
365
366 static OSAL_INLINE u32
ecore_vf_hw_bar_size(struct ecore_hwfn OSAL_UNUSED * p_hwfn,enum BAR_ID OSAL_UNUSED bar_id)367 ecore_vf_hw_bar_size(struct ecore_hwfn OSAL_UNUSED *p_hwfn,
368 enum BAR_ID OSAL_UNUSED bar_id)
369 {
370 return 0;
371 }
372 #endif
373
374 #endif /* __ECORE_VF_H__ */
375