1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2020
8 #include "ice_common.h"
9 #include "ice_protocol_type.h"
11 #define ICE_SW_CFG_MAX_BUF_LEN 2048
12 #define ICE_MAX_SW 256
13 #define ICE_DFLT_VSI_INVAL 0xff
14 #define ICE_FLTR_RX BIT(0)
15 #define ICE_FLTR_TX BIT(1)
16 #define ICE_FLTR_TX_RX (ICE_FLTR_RX | ICE_FLTR_TX)
18 /* Switch Profile IDs for Profile related switch rules */
19 #define ICE_PROFID_IPV6_ESP 72
20 #define ICE_PROFID_IPV6_AH 74
21 #define ICE_PROFID_IPV4_NAT_T 75
22 #define ICE_PROFID_IPV6_NAT_T 76
23 #define ICE_PROFID_MAC_IPV6_L2TPV3 78
24 #define ICE_PROFID_IPV4_PFCP_NODE 79
25 #define ICE_PROFID_IPV4_PFCP_SESSION 80
26 #define ICE_PROFID_IPV6_PFCP_NODE 81
27 #define ICE_PROFID_IPV6_PFCP_SESSION 82
29 #define DUMMY_ETH_HDR_LEN 16
30 #define ICE_SW_RULE_RX_TX_ETH_HDR_SIZE \
31 (sizeof(struct ice_aqc_sw_rules_elem) - \
32 sizeof(((struct ice_aqc_sw_rules_elem *)0)->pdata) + \
33 sizeof(struct ice_sw_rule_lkup_rx_tx) + DUMMY_ETH_HDR_LEN - 1)
34 #define ICE_SW_RULE_RX_TX_NO_HDR_SIZE \
35 (sizeof(struct ice_aqc_sw_rules_elem) - \
36 sizeof(((struct ice_aqc_sw_rules_elem *)0)->pdata) + \
37 sizeof(struct ice_sw_rule_lkup_rx_tx) - 1)
38 #define ICE_SW_RULE_LG_ACT_SIZE(n) \
39 (sizeof(struct ice_aqc_sw_rules_elem) - \
40 sizeof(((struct ice_aqc_sw_rules_elem *)0)->pdata) + \
41 sizeof(struct ice_sw_rule_lg_act) - \
42 sizeof(((struct ice_sw_rule_lg_act *)0)->act) + \
43 ((n) * sizeof(((struct ice_sw_rule_lg_act *)0)->act)))
44 #define ICE_SW_RULE_VSI_LIST_SIZE(n) \
45 (sizeof(struct ice_aqc_sw_rules_elem) - \
46 sizeof(((struct ice_aqc_sw_rules_elem *)0)->pdata) + \
47 sizeof(struct ice_sw_rule_vsi_list) - \
48 sizeof(((struct ice_sw_rule_vsi_list *)0)->vsi) + \
49 ((n) * sizeof(((struct ice_sw_rule_vsi_list *)0)->vsi)))
51 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
52 #define ICE_MAX_RES_TYPES 0x80
53 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
54 (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
56 #define ICE_VSI_INVAL_ID 0xFFFF
57 #define ICE_INVAL_Q_HANDLE 0xFFFF
59 /* VSI context structure for add/get/update/free operations */
65 struct ice_aqc_vsi_props info;
66 struct ice_sched_vsi_info sched;
68 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
69 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
72 /* This is to be used by add/update mirror rule Admin Queue command */
73 struct ice_mir_rule_buf {
74 u16 vsi_idx; /* VSI index */
76 /* For each VSI, user can specify whether corresponding VSI
77 * should be added/removed to/from mirror rule
79 * add mirror rule: this should always be TRUE.
80 * update mirror rule: add(true) or remove(false) VSI to/from
86 /* Switch recipe ID enum values are specific to hardware */
87 enum ice_sw_lkup_type {
88 ICE_SW_LKUP_ETHERTYPE = 0,
90 ICE_SW_LKUP_MAC_VLAN = 2,
91 ICE_SW_LKUP_PROMISC = 3,
94 ICE_SW_LKUP_ETHERTYPE_MAC = 8,
95 ICE_SW_LKUP_PROMISC_VLAN = 9,
99 /* type of filter src ID */
101 ICE_SRC_ID_UNKNOWN = 0,
107 struct ice_fltr_info {
108 /* Look up information: how to look up packet */
109 enum ice_sw_lkup_type lkup_type;
110 /* Forward action: filter action to do after lookup */
111 enum ice_sw_fwd_act_type fltr_act;
112 /* rule ID returned by firmware once filter rule is created */
116 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
118 enum ice_src_id src_id;
122 u8 mac_addr[ETH_ALEN];
125 u8 mac_addr[ETH_ALEN];
131 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
132 * if just using ethertype as filter. Set lkup_type as
133 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
134 * passed in as filter.
138 u8 mac_addr[ETH_ALEN]; /* optional */
140 } l_data; /* Make sure to zero out the memory of l_data before using
141 * it or only set the data associated with lookup match
142 * rest everything should be zero
145 /* Depending on filter action */
147 /* queue ID in case of ICE_FWD_TO_Q and starting
148 * queue ID in case of ICE_FWD_TO_QGRP.
159 /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
160 * determines the range of queues the packet needs to be forwarded to.
161 * Note that qgrp_size must be set to a power of 2.
165 /* Rule creations populate these indicators basing on the switch type */
166 u8 lb_en; /* Indicate if packet can be looped back */
167 u8 lan_en; /* Indicate if packet can be forwarded to the uplink */
170 struct ice_adv_lkup_elem {
171 enum ice_protocol_type type;
172 union ice_prot_hdr h_u; /* Header values */
173 union ice_prot_hdr m_u; /* Mask of header values to match */
176 struct ice_sw_act_ctrl {
177 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
180 enum ice_sw_fwd_act_type fltr_act;
181 /* Depending on filter action */
183 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
184 * queue ID in case of ICE_FWD_TO_QGRP.
191 /* software VSI handle */
196 struct ice_rule_query_data {
197 /* Recipe ID for which the requested rule was added */
199 /* Rule ID that was added or is supposed to be removed */
201 /* vsi_handle for which Rule was added or is supposed to be removed */
205 struct ice_adv_rule_info {
206 enum ice_sw_tunnel_type tun_type;
207 struct ice_sw_act_ctrl sw_act;
209 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
213 /* A collection of one or more four word recipe */
214 struct ice_sw_recipe {
215 /* For a chained recipe the root recipe is what should be used for
222 /* Number of extraction words */
224 /* Protocol ID and Offset pair (extraction word) to describe the
227 struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
228 u16 word_masks[ICE_MAX_CHAIN_WORDS];
230 /* if this recipe is a collection of other recipe */
233 /* if this recipe is part of another bigger recipe then chain index
234 * corresponding to this recipe
238 /* if this recipe is a collection of other recipe then count of other
239 * recipes and recipe IDs of those recipes
243 /* Bit map specifying the IDs associated with this group of recipe */
244 ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
246 enum ice_sw_tunnel_type tun_type;
248 /* List of type ice_fltr_mgmt_list_entry or adv_rule */
250 struct LIST_HEAD_TYPE filt_rules;
251 struct LIST_HEAD_TYPE filt_replay_rules;
253 struct ice_lock filt_rule_lock; /* protect filter rule structure */
255 /* Profiles this recipe should be associated with */
256 struct LIST_HEAD_TYPE fv_list;
258 /* Profiles this recipe is associated with */
259 u8 num_profs, *prof_ids;
261 /* Possible result indexes are 44, 45, 46 and 47 */
262 #define ICE_POSSIBLE_RES_IDX 0x0000F00000000000ULL
263 ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
265 /* This allows user to specify the recipe priority.
266 * For now, this becomes 'fwd_priority' when recipe
267 * is created, usually recipes can have 'fwd' and 'join'
272 struct LIST_HEAD_TYPE rg_list;
274 /* AQ buffer associated with this recipe */
275 struct ice_aqc_recipe_data_elem *root_buf;
276 /* This struct saves the fv_words for a given lookup */
277 struct ice_prot_lkup_ext lkup_exts;
280 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
281 struct ice_vsi_list_map_info {
282 struct LIST_ENTRY_TYPE list_entry;
283 ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
285 /* counter to track how many rules are reusing this VSI list */
289 struct ice_fltr_list_entry {
290 struct LIST_ENTRY_TYPE list_entry;
291 enum ice_status status;
292 struct ice_fltr_info fltr_info;
295 /* This defines an entry in the list that maintains MAC or VLAN membership
296 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
297 * VLAN. As an optimization the VSI list should be created only when a
298 * second VSI becomes a subscriber to the same MAC address. VSI lists are always
299 * used for VLAN membership.
301 struct ice_fltr_mgmt_list_entry {
302 /* back pointer to VSI list ID to VSI list mapping */
303 struct ice_vsi_list_map_info *vsi_list_info;
305 #define ICE_INVAL_LG_ACT_INDEX 0xffff
307 #define ICE_INVAL_SW_MARKER_ID 0xffff
309 struct LIST_ENTRY_TYPE list_entry;
310 struct ice_fltr_info fltr_info;
311 #define ICE_INVAL_COUNTER_ID 0xff
315 struct ice_adv_fltr_mgmt_list_entry {
316 struct LIST_ENTRY_TYPE list_entry;
318 struct ice_adv_lkup_elem *lkups;
319 struct ice_adv_rule_info rule_info;
321 struct ice_vsi_list_map_info *vsi_list_info;
325 enum ice_promisc_flags {
326 ICE_PROMISC_UCAST_RX = 0x1,
327 ICE_PROMISC_UCAST_TX = 0x2,
328 ICE_PROMISC_MCAST_RX = 0x4,
329 ICE_PROMISC_MCAST_TX = 0x8,
330 ICE_PROMISC_BCAST_RX = 0x10,
331 ICE_PROMISC_BCAST_TX = 0x20,
332 ICE_PROMISC_VLAN_RX = 0x40,
333 ICE_PROMISC_VLAN_TX = 0x80,
336 /* VSI related commands */
338 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
339 struct ice_sq_cd *cd);
341 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
342 bool keep_vsi_alloc, struct ice_sq_cd *cd);
344 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
345 struct ice_sq_cd *cd);
347 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
348 struct ice_sq_cd *cd);
350 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
351 bool keep_vsi_alloc, struct ice_sq_cd *cd);
353 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
354 struct ice_sq_cd *cd);
355 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
356 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
358 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
359 struct ice_sq_cd *cd);
361 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
362 u16 count, struct ice_mir_rule_buf *mr_buf,
363 struct ice_sq_cd *cd, u16 *rule_id);
365 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
366 struct ice_sq_cd *cd);
368 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
371 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
374 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
377 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
379 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
381 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
384 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
387 /* Switch/bridge related commands */
388 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
390 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
393 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
395 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
396 u16 buf_size, struct ice_sq_cd *cd);
398 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
399 struct ice_aqc_get_allocd_res_desc_resp *buf,
400 u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
401 struct ice_sq_cd *cd);
403 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
405 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
406 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
407 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
408 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
410 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
412 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
414 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
416 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
419 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
422 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
423 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
425 /* Promisc/defport setup for VSIs */
427 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
430 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
433 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
436 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
437 bool rm_vlan_promisc);
439 /* Get VSIs Promisc/defport settings */
441 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
444 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
448 ice_aq_add_recipe(struct ice_hw *hw,
449 struct ice_aqc_recipe_data_elem *s_recipe_list,
450 u16 num_recipes, struct ice_sq_cd *cd);
453 ice_aq_get_recipe(struct ice_hw *hw,
454 struct ice_aqc_recipe_data_elem *s_recipe_list,
455 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
457 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
458 struct ice_sq_cd *cd);
461 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
462 struct ice_sq_cd *cd);
464 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
466 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
467 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
468 struct ice_rule_query_data *added_entry);
470 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
472 ice_rem_adv_rule_by_id(struct ice_hw *hw,
473 struct ice_rule_query_data *remove_entry);
475 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
476 u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
478 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
481 ice_init_def_sw_recp(struct ice_hw *hw, struct ice_sw_recipe **recp_list);
482 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
483 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
485 enum ice_status ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle);
486 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
487 bool ice_is_prof_rule(enum ice_sw_tunnel_type type);
489 #endif /* _ICE_SWITCH_H_ */