1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2018-2021, Intel Corporation. */
3
4 #ifndef _ICE_VF_LIB_H_
5 #define _ICE_VF_LIB_H_
6
7 #include <linux/types.h>
8 #include <linux/hashtable.h>
9 #include <linux/bitmap.h>
10 #include <linux/mutex.h>
11 #include <linux/pci.h>
12 #include <net/devlink.h>
13 #include <linux/avf/virtchnl.h>
14 #include "ice_type.h"
15 #include "ice_virtchnl_fdir.h"
16 #include "ice_vsi_vlan_ops.h"
17
18 #define ICE_MAX_SRIOV_VFS 256
19
20 /* VF resource constraints */
21 #define ICE_MAX_RSS_QS_PER_VF 16
22
23 struct ice_pf;
24 struct ice_vf;
25 struct ice_virtchnl_ops;
26
27 /* VF capabilities */
28 enum ice_virtchnl_cap {
29 ICE_VIRTCHNL_VF_CAP_PRIVILEGE = 0,
30 };
31
32 /* Specific VF states */
33 enum ice_vf_states {
34 ICE_VF_STATE_INIT = 0, /* PF is initializing VF */
35 ICE_VF_STATE_ACTIVE, /* VF resources are allocated for use */
36 ICE_VF_STATE_QS_ENA, /* VF queue(s) enabled */
37 ICE_VF_STATE_DIS,
38 ICE_VF_STATE_MC_PROMISC,
39 ICE_VF_STATE_UC_PROMISC,
40 ICE_VF_STATES_NBITS
41 };
42
43 struct ice_time_mac {
44 unsigned long time_modified;
45 u8 addr[ETH_ALEN];
46 };
47
48 /* VF MDD events print structure */
49 struct ice_mdd_vf_events {
50 u16 count; /* total count of Rx|Tx events */
51 /* count number of the last printed event */
52 u16 last_printed;
53 };
54
55 /* VF operations */
56 struct ice_vf_ops {
57 enum ice_disq_rst_src reset_type;
58 void (*free)(struct ice_vf *vf);
59 void (*clear_reset_state)(struct ice_vf *vf);
60 void (*clear_mbx_register)(struct ice_vf *vf);
61 void (*trigger_reset_register)(struct ice_vf *vf, bool is_vflr);
62 bool (*poll_reset_status)(struct ice_vf *vf);
63 void (*clear_reset_trigger)(struct ice_vf *vf);
64 void (*irq_close)(struct ice_vf *vf);
65 void (*post_vsi_rebuild)(struct ice_vf *vf);
66 };
67
68 /* Virtchnl/SR-IOV config info */
69 struct ice_vfs {
70 DECLARE_HASHTABLE(table, 8); /* table of VF entries */
71 struct mutex table_lock; /* Lock for protecting the hash table */
72 u16 num_supported; /* max supported VFs on this PF */
73 u16 num_qps_per; /* number of queue pairs per VF */
74 u16 num_msix_per; /* default MSI-X vectors per VF */
75 unsigned long last_printed_mdd_jiffies; /* MDD message rate limit */
76 };
77
78 /* VF information structure */
79 struct ice_vf {
80 struct hlist_node entry;
81 struct rcu_head rcu;
82 struct kref refcnt;
83 struct ice_pf *pf;
84 struct pci_dev *vfdev;
85 /* Used during virtchnl message handling and NDO ops against the VF
86 * that will trigger a VFR
87 */
88 struct mutex cfg_lock;
89
90 u16 vf_id; /* VF ID in the PF space */
91 u16 lan_vsi_idx; /* index into PF struct */
92 u16 ctrl_vsi_idx;
93 struct ice_vf_fdir fdir;
94 /* first vector index of this VF in the PF space */
95 int first_vector_idx;
96 struct ice_sw *vf_sw_id; /* switch ID the VF VSIs connect to */
97 struct virtchnl_version_info vf_ver;
98 u32 driver_caps; /* reported by VF driver */
99 u8 dev_lan_addr[ETH_ALEN];
100 u8 hw_lan_addr[ETH_ALEN];
101 struct ice_time_mac legacy_last_added_umac;
102 DECLARE_BITMAP(txq_ena, ICE_MAX_RSS_QS_PER_VF);
103 DECLARE_BITMAP(rxq_ena, ICE_MAX_RSS_QS_PER_VF);
104 struct ice_vlan port_vlan_info; /* Port VLAN ID, QoS, and TPID */
105 struct virtchnl_vlan_caps vlan_v2_caps;
106 struct ice_mbx_vf_info mbx_info;
107 u8 pf_set_mac:1; /* VF MAC address set by VMM admin */
108 u8 trusted:1;
109 u8 spoofchk:1;
110 u8 link_forced:1;
111 u8 link_up:1; /* only valid if VF link is forced */
112 /* VSI indices - actual VSI pointers are maintained in the PF structure
113 * When assigned, these will be non-zero, because VSI 0 is always
114 * the main LAN VSI for the PF.
115 */
116 u16 lan_vsi_num; /* ID as used by firmware */
117 unsigned int min_tx_rate; /* Minimum Tx bandwidth limit in Mbps */
118 unsigned int max_tx_rate; /* Maximum Tx bandwidth limit in Mbps */
119 DECLARE_BITMAP(vf_states, ICE_VF_STATES_NBITS); /* VF runtime states */
120
121 unsigned long vf_caps; /* VF's adv. capabilities */
122 u8 num_req_qs; /* num of queue pairs requested by VF */
123 u16 num_mac;
124 u16 num_vf_qs; /* num of queue configured per VF */
125 u8 vlan_strip_ena; /* Outer and Inner VLAN strip enable */
126 #define ICE_INNER_VLAN_STRIP_ENA BIT(0)
127 #define ICE_OUTER_VLAN_STRIP_ENA BIT(1)
128 struct ice_mdd_vf_events mdd_rx_events;
129 struct ice_mdd_vf_events mdd_tx_events;
130 DECLARE_BITMAP(opcodes_allowlist, VIRTCHNL_OP_MAX);
131
132 unsigned long repr_id;
133 const struct ice_virtchnl_ops *virtchnl_ops;
134 const struct ice_vf_ops *vf_ops;
135
136 /* devlink port data */
137 struct devlink_port devlink_port;
138
139 u16 num_msix; /* num of MSI-X configured on this VF */
140 };
141
142 /* Flags for controlling behavior of ice_reset_vf */
143 enum ice_vf_reset_flags {
144 ICE_VF_RESET_VFLR = BIT(0), /* Indicate a VFLR reset */
145 ICE_VF_RESET_NOTIFY = BIT(1), /* Notify VF prior to reset */
146 ICE_VF_RESET_LOCK = BIT(2), /* Acquire the VF cfg_lock */
147 };
148
ice_vf_get_port_vlan_id(struct ice_vf * vf)149 static inline u16 ice_vf_get_port_vlan_id(struct ice_vf *vf)
150 {
151 return vf->port_vlan_info.vid;
152 }
153
ice_vf_get_port_vlan_prio(struct ice_vf * vf)154 static inline u8 ice_vf_get_port_vlan_prio(struct ice_vf *vf)
155 {
156 return vf->port_vlan_info.prio;
157 }
158
ice_vf_is_port_vlan_ena(struct ice_vf * vf)159 static inline bool ice_vf_is_port_vlan_ena(struct ice_vf *vf)
160 {
161 return (ice_vf_get_port_vlan_id(vf) || ice_vf_get_port_vlan_prio(vf));
162 }
163
ice_vf_get_port_vlan_tpid(struct ice_vf * vf)164 static inline u16 ice_vf_get_port_vlan_tpid(struct ice_vf *vf)
165 {
166 return vf->port_vlan_info.tpid;
167 }
168
169 /* VF Hash Table access functions
170 *
171 * These functions provide abstraction for interacting with the VF hash table.
172 * In general, direct access to the hash table should be avoided outside of
173 * these functions where possible.
174 *
175 * The VF entries in the hash table are protected by reference counting to
176 * track lifetime of accesses from the table. The ice_get_vf_by_id() function
177 * obtains a reference to the VF structure which must be dropped by using
178 * ice_put_vf().
179 */
180
181 /**
182 * ice_for_each_vf - Iterate over each VF entry
183 * @pf: pointer to the PF private structure
184 * @bkt: bucket index used for iteration
185 * @vf: pointer to the VF entry currently being processed in the loop
186 *
187 * The bkt variable is an unsigned integer iterator used to traverse the VF
188 * entries. It is *not* guaranteed to be the VF's vf_id. Do not assume it is.
189 * Use vf->vf_id to get the id number if needed.
190 *
191 * The caller is expected to be under the table_lock mutex for the entire
192 * loop. Use this iterator if your loop is long or if it might sleep.
193 */
194 #define ice_for_each_vf(pf, bkt, vf) \
195 hash_for_each((pf)->vfs.table, (bkt), (vf), entry)
196
197 /**
198 * ice_for_each_vf_rcu - Iterate over each VF entry protected by RCU
199 * @pf: pointer to the PF private structure
200 * @bkt: bucket index used for iteration
201 * @vf: pointer to the VF entry currently being processed in the loop
202 *
203 * The bkt variable is an unsigned integer iterator used to traverse the VF
204 * entries. It is *not* guaranteed to be the VF's vf_id. Do not assume it is.
205 * Use vf->vf_id to get the id number if needed.
206 *
207 * The caller is expected to be under rcu_read_lock() for the entire loop.
208 * Only use this iterator if your loop is short and you can guarantee it does
209 * not sleep.
210 */
211 #define ice_for_each_vf_rcu(pf, bkt, vf) \
212 hash_for_each_rcu((pf)->vfs.table, (bkt), (vf), entry)
213
214 #ifdef CONFIG_PCI_IOV
215 struct ice_vf *ice_get_vf_by_id(struct ice_pf *pf, u16 vf_id);
216 void ice_put_vf(struct ice_vf *vf);
217 bool ice_has_vfs(struct ice_pf *pf);
218 u16 ice_get_num_vfs(struct ice_pf *pf);
219 struct ice_vsi *ice_get_vf_vsi(struct ice_vf *vf);
220 bool ice_is_vf_disabled(struct ice_vf *vf);
221 int ice_check_vf_ready_for_cfg(struct ice_vf *vf);
222 void ice_set_vf_state_dis(struct ice_vf *vf);
223 bool ice_is_any_vf_in_unicast_promisc(struct ice_pf *pf);
224 void
225 ice_vf_get_promisc_masks(struct ice_vf *vf, struct ice_vsi *vsi,
226 u8 *ucast_m, u8 *mcast_m);
227 int
228 ice_vf_set_vsi_promisc(struct ice_vf *vf, struct ice_vsi *vsi, u8 promisc_m);
229 int
230 ice_vf_clear_vsi_promisc(struct ice_vf *vf, struct ice_vsi *vsi, u8 promisc_m);
231 int ice_reset_vf(struct ice_vf *vf, u32 flags);
232 void ice_reset_all_vfs(struct ice_pf *pf);
233 struct ice_vsi *ice_get_vf_ctrl_vsi(struct ice_pf *pf, struct ice_vsi *vsi);
234 #else /* CONFIG_PCI_IOV */
ice_get_vf_by_id(struct ice_pf * pf,u16 vf_id)235 static inline struct ice_vf *ice_get_vf_by_id(struct ice_pf *pf, u16 vf_id)
236 {
237 return NULL;
238 }
239
ice_put_vf(struct ice_vf * vf)240 static inline void ice_put_vf(struct ice_vf *vf)
241 {
242 }
243
ice_has_vfs(struct ice_pf * pf)244 static inline bool ice_has_vfs(struct ice_pf *pf)
245 {
246 return false;
247 }
248
ice_get_num_vfs(struct ice_pf * pf)249 static inline u16 ice_get_num_vfs(struct ice_pf *pf)
250 {
251 return 0;
252 }
253
ice_get_vf_vsi(struct ice_vf * vf)254 static inline struct ice_vsi *ice_get_vf_vsi(struct ice_vf *vf)
255 {
256 return NULL;
257 }
258
ice_is_vf_disabled(struct ice_vf * vf)259 static inline bool ice_is_vf_disabled(struct ice_vf *vf)
260 {
261 return true;
262 }
263
ice_check_vf_ready_for_cfg(struct ice_vf * vf)264 static inline int ice_check_vf_ready_for_cfg(struct ice_vf *vf)
265 {
266 return -EOPNOTSUPP;
267 }
268
ice_set_vf_state_dis(struct ice_vf * vf)269 static inline void ice_set_vf_state_dis(struct ice_vf *vf)
270 {
271 }
272
ice_is_any_vf_in_unicast_promisc(struct ice_pf * pf)273 static inline bool ice_is_any_vf_in_unicast_promisc(struct ice_pf *pf)
274 {
275 return false;
276 }
277
278 static inline int
ice_vf_set_vsi_promisc(struct ice_vf * vf,struct ice_vsi * vsi,u8 promisc_m)279 ice_vf_set_vsi_promisc(struct ice_vf *vf, struct ice_vsi *vsi, u8 promisc_m)
280 {
281 return -EOPNOTSUPP;
282 }
283
284 static inline int
ice_vf_clear_vsi_promisc(struct ice_vf * vf,struct ice_vsi * vsi,u8 promisc_m)285 ice_vf_clear_vsi_promisc(struct ice_vf *vf, struct ice_vsi *vsi, u8 promisc_m)
286 {
287 return -EOPNOTSUPP;
288 }
289
ice_reset_vf(struct ice_vf * vf,u32 flags)290 static inline int ice_reset_vf(struct ice_vf *vf, u32 flags)
291 {
292 return 0;
293 }
294
ice_reset_all_vfs(struct ice_pf * pf)295 static inline void ice_reset_all_vfs(struct ice_pf *pf)
296 {
297 }
298
299 static inline struct ice_vsi *
ice_get_vf_ctrl_vsi(struct ice_pf * pf,struct ice_vsi * vsi)300 ice_get_vf_ctrl_vsi(struct ice_pf *pf, struct ice_vsi *vsi)
301 {
302 return NULL;
303 }
304 #endif /* !CONFIG_PCI_IOV */
305
306 #endif /* _ICE_VF_LIB_H_ */
307