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