1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (c) 2018, Intel Corporation. */
3 
4 #ifndef _ICE_SWITCH_H_
5 #define _ICE_SWITCH_H_
6 
7 #include "ice_common.h"
8 
9 #define ICE_SW_CFG_MAX_BUF_LEN 2048
10 #define ICE_DFLT_VSI_INVAL 0xff
11 #define ICE_FLTR_RX BIT(0)
12 #define ICE_FLTR_TX BIT(1)
13 #define ICE_FLTR_TX_RX (ICE_FLTR_RX | ICE_FLTR_TX)
14 #define ICE_VSI_INVAL_ID 0xffff
15 #define ICE_INVAL_Q_HANDLE 0xFFFF
16 
17 /* Switch Profile IDs for Profile related switch rules */
18 #define ICE_PROFID_IPV4_GTPC_TEID			41
19 #define ICE_PROFID_IPV4_GTPC_NO_TEID			42
20 #define ICE_PROFID_IPV4_GTPU_TEID			43
21 #define ICE_PROFID_IPV6_GTPC_TEID			44
22 #define ICE_PROFID_IPV6_GTPC_NO_TEID			45
23 #define ICE_PROFID_IPV6_GTPU_TEID			46
24 #define ICE_PROFID_IPV6_GTPU_IPV6_TCP_INNER		70
25 
26 #define ICE_SW_RULE_RX_TX_NO_HDR_SIZE \
27 	(offsetof(struct ice_aqc_sw_rules_elem, pdata.lkup_tx_rx.hdr))
28 
29 /* VSI context structure for add/get/update/free operations */
30 struct ice_vsi_ctx {
31 	u16 vsi_num;
32 	u16 vsis_allocd;
33 	u16 vsis_unallocated;
34 	u16 flags;
35 	struct ice_aqc_vsi_props info;
36 	struct ice_sched_vsi_info sched;
37 	u8 alloc_from_pool;
38 	u8 vf_num;
39 	u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
40 	struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
41 	u16 num_rdma_q_entries[ICE_MAX_TRAFFIC_CLASS];
42 	struct ice_q_ctx *rdma_q_ctx[ICE_MAX_TRAFFIC_CLASS];
43 };
44 
45 /* Switch recipe ID enum values are specific to hardware */
46 enum ice_sw_lkup_type {
47 	ICE_SW_LKUP_ETHERTYPE = 0,
48 	ICE_SW_LKUP_MAC = 1,
49 	ICE_SW_LKUP_MAC_VLAN = 2,
50 	ICE_SW_LKUP_PROMISC = 3,
51 	ICE_SW_LKUP_VLAN = 4,
52 	ICE_SW_LKUP_DFLT = 5,
53 	ICE_SW_LKUP_ETHERTYPE_MAC = 8,
54 	ICE_SW_LKUP_PROMISC_VLAN = 9,
55 	ICE_SW_LKUP_LAST
56 };
57 
58 /* type of filter src ID */
59 enum ice_src_id {
60 	ICE_SRC_ID_UNKNOWN = 0,
61 	ICE_SRC_ID_VSI,
62 	ICE_SRC_ID_QUEUE,
63 	ICE_SRC_ID_LPORT,
64 };
65 
66 struct ice_fltr_info {
67 	/* Look up information: how to look up packet */
68 	enum ice_sw_lkup_type lkup_type;
69 	/* Forward action: filter action to do after lookup */
70 	enum ice_sw_fwd_act_type fltr_act;
71 	/* rule ID returned by firmware once filter rule is created */
72 	u16 fltr_rule_id;
73 	u16 flag;
74 
75 	/* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
76 	u16 src;
77 	enum ice_src_id src_id;
78 
79 	union {
80 		struct {
81 			u8 mac_addr[ETH_ALEN];
82 		} mac;
83 		struct {
84 			u8 mac_addr[ETH_ALEN];
85 			u16 vlan_id;
86 		} mac_vlan;
87 		struct {
88 			u16 vlan_id;
89 			u16 tpid;
90 			u8 tpid_valid;
91 		} vlan;
92 		/* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
93 		 * if just using ethertype as filter. Set lkup_type as
94 		 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
95 		 * passed in as filter.
96 		 */
97 		struct {
98 			u16 ethertype;
99 			u8 mac_addr[ETH_ALEN]; /* optional */
100 		} ethertype_mac;
101 	} l_data; /* Make sure to zero out the memory of l_data before using
102 		   * it or only set the data associated with lookup match
103 		   * rest everything should be zero
104 		   */
105 
106 	/* Depending on filter action */
107 	union {
108 		/* queue ID in case of ICE_FWD_TO_Q and starting
109 		 * queue ID in case of ICE_FWD_TO_QGRP.
110 		 */
111 		u16 q_id:11;
112 		u16 hw_vsi_id:10;
113 		u16 vsi_list_id:10;
114 	} fwd_id;
115 
116 	/* Sw VSI handle */
117 	u16 vsi_handle;
118 
119 	/* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
120 	 * determines the range of queues the packet needs to be forwarded to.
121 	 * Note that qgrp_size must be set to a power of 2.
122 	 */
123 	u8 qgrp_size;
124 
125 	/* Rule creations populate these indicators basing on the switch type */
126 	u8 lb_en;	/* Indicate if packet can be looped back */
127 	u8 lan_en;	/* Indicate if packet can be forwarded to the uplink */
128 };
129 
130 struct ice_update_recipe_lkup_idx_params {
131 	u16 rid;
132 	u16 fv_idx;
133 	bool ignore_valid;
134 	u16 mask;
135 	bool mask_valid;
136 	u8 lkup_idx;
137 };
138 
139 struct ice_adv_lkup_elem {
140 	enum ice_protocol_type type;
141 	union ice_prot_hdr h_u;	/* Header values */
142 	union ice_prot_hdr m_u;	/* Mask of header values to match */
143 };
144 
145 struct ice_sw_act_ctrl {
146 	/* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
147 	u16 src;
148 	u16 flag;
149 	enum ice_sw_fwd_act_type fltr_act;
150 	/* Depending on filter action */
151 	union {
152 		/* This is a queue ID in case of ICE_FWD_TO_Q and starting
153 		 * queue ID in case of ICE_FWD_TO_QGRP.
154 		 */
155 		u16 q_id:11;
156 		u16 vsi_id:10;
157 		u16 hw_vsi_id:10;
158 		u16 vsi_list_id:10;
159 	} fwd_id;
160 	/* software VSI handle */
161 	u16 vsi_handle;
162 	u8 qgrp_size;
163 };
164 
165 struct ice_rule_query_data {
166 	/* Recipe ID for which the requested rule was added */
167 	u16 rid;
168 	/* Rule ID that was added or is supposed to be removed */
169 	u16 rule_id;
170 	/* vsi_handle for which Rule was added or is supposed to be removed */
171 	u16 vsi_handle;
172 };
173 
174 /* This structure allows to pass info about lb_en and lan_en
175  * flags to ice_add_adv_rule. Values in act would be used
176  * only if act_valid was set to true, otherwise default
177  * values would be used.
178  */
179 struct ice_adv_rule_flags_info {
180 	u32 act;
181 	u8 act_valid;		/* indicate if flags in act are valid */
182 };
183 
184 struct ice_adv_rule_info {
185 	enum ice_sw_tunnel_type tun_type;
186 	struct ice_sw_act_ctrl sw_act;
187 	u32 priority;
188 	u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
189 	u16 fltr_rule_id;
190 	struct ice_adv_rule_flags_info flags_info;
191 };
192 
193 /* A collection of one or more four word recipe */
194 struct ice_sw_recipe {
195 	/* For a chained recipe the root recipe is what should be used for
196 	 * programming rules
197 	 */
198 	u8 is_root;
199 	u8 root_rid;
200 	u8 recp_created;
201 
202 	/* Number of extraction words */
203 	u8 n_ext_words;
204 	/* Protocol ID and Offset pair (extraction word) to describe the
205 	 * recipe
206 	 */
207 	struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
208 	u16 word_masks[ICE_MAX_CHAIN_WORDS];
209 
210 	/* if this recipe is a collection of other recipe */
211 	u8 big_recp;
212 
213 	/* if this recipe is part of another bigger recipe then chain index
214 	 * corresponding to this recipe
215 	 */
216 	u8 chain_idx;
217 
218 	/* if this recipe is a collection of other recipe then count of other
219 	 * recipes and recipe IDs of those recipes
220 	 */
221 	u8 n_grp_count;
222 
223 	/* Bit map specifying the IDs associated with this group of recipe */
224 	DECLARE_BITMAP(r_bitmap, ICE_MAX_NUM_RECIPES);
225 
226 	enum ice_sw_tunnel_type tun_type;
227 
228 	/* List of type ice_fltr_mgmt_list_entry or adv_rule */
229 	u8 adv_rule;
230 	struct list_head filt_rules;
231 	struct list_head filt_replay_rules;
232 
233 	struct mutex filt_rule_lock;	/* protect filter rule structure */
234 
235 	/* Profiles this recipe should be associated with */
236 	struct list_head fv_list;
237 
238 	/* Profiles this recipe is associated with */
239 	u8 num_profs, *prof_ids;
240 
241 	/* Bit map for possible result indexes */
242 	DECLARE_BITMAP(res_idxs, ICE_MAX_FV_WORDS);
243 
244 	/* This allows user to specify the recipe priority.
245 	 * For now, this becomes 'fwd_priority' when recipe
246 	 * is created, usually recipes can have 'fwd' and 'join'
247 	 * priority.
248 	 */
249 	u8 priority;
250 
251 	struct list_head rg_list;
252 
253 	/* AQ buffer associated with this recipe */
254 	struct ice_aqc_recipe_data_elem *root_buf;
255 	/* This struct saves the fv_words for a given lookup */
256 	struct ice_prot_lkup_ext lkup_exts;
257 };
258 
259 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
260 struct ice_vsi_list_map_info {
261 	struct list_head list_entry;
262 	DECLARE_BITMAP(vsi_map, ICE_MAX_VSI);
263 	u16 vsi_list_id;
264 	/* counter to track how many rules are reusing this VSI list */
265 	u16 ref_cnt;
266 };
267 
268 struct ice_fltr_list_entry {
269 	struct list_head list_entry;
270 	int status;
271 	struct ice_fltr_info fltr_info;
272 };
273 
274 /* This defines an entry in the list that maintains MAC or VLAN membership
275  * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
276  * VLAN. As an optimization the VSI list should be created only when a
277  * second VSI becomes a subscriber to the same MAC address. VSI lists are always
278  * used for VLAN membership.
279  */
280 struct ice_fltr_mgmt_list_entry {
281 	/* back pointer to VSI list ID to VSI list mapping */
282 	struct ice_vsi_list_map_info *vsi_list_info;
283 	u16 vsi_count;
284 #define ICE_INVAL_LG_ACT_INDEX 0xffff
285 	u16 lg_act_idx;
286 #define ICE_INVAL_SW_MARKER_ID 0xffff
287 	u16 sw_marker_id;
288 	struct list_head list_entry;
289 	struct ice_fltr_info fltr_info;
290 #define ICE_INVAL_COUNTER_ID 0xff
291 	u8 counter_index;
292 };
293 
294 struct ice_adv_fltr_mgmt_list_entry {
295 	struct list_head list_entry;
296 
297 	struct ice_adv_lkup_elem *lkups;
298 	struct ice_adv_rule_info rule_info;
299 	u16 lkups_cnt;
300 	struct ice_vsi_list_map_info *vsi_list_info;
301 	u16 vsi_count;
302 };
303 
304 enum ice_promisc_flags {
305 	ICE_PROMISC_UCAST_RX = 0x1,
306 	ICE_PROMISC_UCAST_TX = 0x2,
307 	ICE_PROMISC_MCAST_RX = 0x4,
308 	ICE_PROMISC_MCAST_TX = 0x8,
309 	ICE_PROMISC_BCAST_RX = 0x10,
310 	ICE_PROMISC_BCAST_TX = 0x20,
311 	ICE_PROMISC_VLAN_RX = 0x40,
312 	ICE_PROMISC_VLAN_TX = 0x80,
313 };
314 
315 /* VSI related commands */
316 int
317 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
318 	    struct ice_sq_cd *cd);
319 int
320 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
321 	     bool keep_vsi_alloc, struct ice_sq_cd *cd);
322 int
323 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
324 	       struct ice_sq_cd *cd);
325 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
326 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
327 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
328 /* Switch config */
329 int ice_get_initial_sw_cfg(struct ice_hw *hw);
330 
331 int
332 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
333 		   u16 *counter_id);
334 int
335 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
336 		  u16 counter_id);
337 
338 /* Switch/bridge related commands */
339 int
340 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
341 		 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
342 		 struct ice_rule_query_data *added_entry);
343 int ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
344 int ice_add_vlan(struct ice_hw *hw, struct list_head *m_list);
345 int ice_remove_vlan(struct ice_hw *hw, struct list_head *v_list);
346 int ice_add_mac(struct ice_hw *hw, struct list_head *m_lst);
347 int ice_remove_mac(struct ice_hw *hw, struct list_head *m_lst);
348 bool ice_mac_fltr_exist(struct ice_hw *hw, u8 *mac, u16 vsi_handle);
349 bool ice_vlan_fltr_exist(struct ice_hw *hw, u16 vlan_id, u16 vsi_handle);
350 int ice_add_eth_mac(struct ice_hw *hw, struct list_head *em_list);
351 int ice_remove_eth_mac(struct ice_hw *hw, struct list_head *em_list);
352 int ice_cfg_rdma_fltr(struct ice_hw *hw, u16 vsi_handle, bool enable);
353 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
354 
355 /* Promisc/defport setup for VSIs */
356 int ice_cfg_dflt_vsi(struct ice_hw *hw, u16 vsi_handle, bool set, u8 direction);
357 int
358 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
359 		    u16 vid);
360 int
361 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
362 		      u16 vid);
363 int
364 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
365 			 bool rm_vlan_promisc);
366 
367 int ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
368 int
369 ice_rem_adv_rule_by_id(struct ice_hw *hw,
370 		       struct ice_rule_query_data *remove_entry);
371 
372 int ice_init_def_sw_recp(struct ice_hw *hw);
373 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
374 
375 int ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle);
376 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
377 
378 int
379 ice_aq_sw_rules(struct ice_hw *hw, void *rule_list, u16 rule_list_sz,
380 		u8 num_rules, enum ice_adminq_opc opc, struct ice_sq_cd *cd);
381 int
382 ice_update_recipe_lkup_idx(struct ice_hw *hw,
383 			   struct ice_update_recipe_lkup_idx_params *params);
384 void ice_change_proto_id_to_dvm(void);
385 #endif /* _ICE_SWITCH_H_ */
386