1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2020 Intel Corporation
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_IPV4_ESP 71
20 #define ICE_PROFID_IPV6_ESP 72
21 #define ICE_PROFID_IPV4_AH 73
22 #define ICE_PROFID_IPV6_AH 74
23 #define ICE_PROFID_IPV4_NAT_T 75
24 #define ICE_PROFID_IPV6_NAT_T 76
25 #define ICE_PROFID_MAC_IPV4_L2TPV3 77
26 #define ICE_PROFID_MAC_IPV6_L2TPV3 78
27 #define ICE_PROFID_IPV4_PFCP_NODE 79
28 #define ICE_PROFID_IPV4_PFCP_SESSION 80
29 #define ICE_PROFID_IPV6_PFCP_NODE 81
30 #define ICE_PROFID_IPV6_PFCP_SESSION 82
32 #define DUMMY_ETH_HDR_LEN 16
33 #define ICE_SW_RULE_RX_TX_ETH_HDR_SIZE \
34 (sizeof(struct ice_aqc_sw_rules_elem) - \
35 sizeof(((struct ice_aqc_sw_rules_elem *)0)->pdata) + \
36 sizeof(struct ice_sw_rule_lkup_rx_tx) + DUMMY_ETH_HDR_LEN - 1)
37 #define ICE_SW_RULE_RX_TX_NO_HDR_SIZE \
38 (sizeof(struct ice_aqc_sw_rules_elem) - \
39 sizeof(((struct ice_aqc_sw_rules_elem *)0)->pdata) + \
40 sizeof(struct ice_sw_rule_lkup_rx_tx) - 1)
41 #define ICE_SW_RULE_LG_ACT_SIZE(n) \
42 (sizeof(struct ice_aqc_sw_rules_elem) - \
43 sizeof(((struct ice_aqc_sw_rules_elem *)0)->pdata) + \
44 sizeof(struct ice_sw_rule_lg_act) - \
45 sizeof(((struct ice_sw_rule_lg_act *)0)->act) + \
46 ((n) * sizeof(((struct ice_sw_rule_lg_act *)0)->act)))
47 #define ICE_SW_RULE_VSI_LIST_SIZE(n) \
48 (sizeof(struct ice_aqc_sw_rules_elem) - \
49 sizeof(((struct ice_aqc_sw_rules_elem *)0)->pdata) + \
50 sizeof(struct ice_sw_rule_vsi_list) - \
51 sizeof(((struct ice_sw_rule_vsi_list *)0)->vsi) + \
52 ((n) * sizeof(((struct ice_sw_rule_vsi_list *)0)->vsi)))
54 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
55 #define ICE_MAX_RES_TYPES 0x80
56 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
57 (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
59 #define ICE_VSI_INVAL_ID 0xFFFF
60 #define ICE_INVAL_Q_HANDLE 0xFFFF
62 /* VSI context structure for add/get/update/free operations */
68 struct ice_aqc_vsi_props info;
69 struct ice_sched_vsi_info sched;
71 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
72 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
75 /* This is to be used by add/update mirror rule Admin Queue command */
76 struct ice_mir_rule_buf {
77 u16 vsi_idx; /* VSI index */
79 /* For each VSI, user can specify whether corresponding VSI
80 * should be added/removed to/from mirror rule
82 * add mirror rule: this should always be TRUE.
83 * update mirror rule: add(true) or remove(false) VSI to/from
89 /* Switch recipe ID enum values are specific to hardware */
90 enum ice_sw_lkup_type {
91 ICE_SW_LKUP_ETHERTYPE = 0,
93 ICE_SW_LKUP_MAC_VLAN = 2,
94 ICE_SW_LKUP_PROMISC = 3,
97 ICE_SW_LKUP_ETHERTYPE_MAC = 8,
98 ICE_SW_LKUP_PROMISC_VLAN = 9,
102 /* type of filter src ID */
104 ICE_SRC_ID_UNKNOWN = 0,
110 struct ice_fltr_info {
111 /* Look up information: how to look up packet */
112 enum ice_sw_lkup_type lkup_type;
113 /* Forward action: filter action to do after lookup */
114 enum ice_sw_fwd_act_type fltr_act;
115 /* rule ID returned by firmware once filter rule is created */
119 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
121 enum ice_src_id src_id;
125 u8 mac_addr[ETH_ALEN];
128 u8 mac_addr[ETH_ALEN];
134 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
135 * if just using ethertype as filter. Set lkup_type as
136 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
137 * passed in as filter.
141 u8 mac_addr[ETH_ALEN]; /* optional */
143 } l_data; /* Make sure to zero out the memory of l_data before using
144 * it or only set the data associated with lookup match
145 * rest everything should be zero
148 /* Depending on filter action */
150 /* queue ID in case of ICE_FWD_TO_Q and starting
151 * queue ID in case of ICE_FWD_TO_QGRP.
162 /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
163 * determines the range of queues the packet needs to be forwarded to.
164 * Note that qgrp_size must be set to a power of 2.
168 /* Rule creations populate these indicators basing on the switch type */
169 u8 lb_en; /* Indicate if packet can be looped back */
170 u8 lan_en; /* Indicate if packet can be forwarded to the uplink */
173 struct ice_adv_lkup_elem {
174 enum ice_protocol_type type;
175 union ice_prot_hdr h_u; /* Header values */
176 union ice_prot_hdr m_u; /* Mask of header values to match */
179 struct ice_sw_act_ctrl {
180 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
183 enum ice_sw_fwd_act_type fltr_act;
184 /* Depending on filter action */
186 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
187 * queue ID in case of ICE_FWD_TO_QGRP.
194 /* software VSI handle */
199 struct ice_rule_query_data {
200 /* Recipe ID for which the requested rule was added */
202 /* Rule ID that was added or is supposed to be removed */
204 /* vsi_handle for which Rule was added or is supposed to be removed */
208 struct ice_adv_rule_info {
209 enum ice_sw_tunnel_type tun_type;
210 struct ice_sw_act_ctrl sw_act;
212 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
216 /* A collection of one or more four word recipe */
217 struct ice_sw_recipe {
218 /* For a chained recipe the root recipe is what should be used for
225 /* Number of extraction words */
227 /* Protocol ID and Offset pair (extraction word) to describe the
230 struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
231 u16 word_masks[ICE_MAX_CHAIN_WORDS];
233 /* if this recipe is a collection of other recipe */
236 /* if this recipe is part of another bigger recipe then chain index
237 * corresponding to this recipe
241 /* if this recipe is a collection of other recipe then count of other
242 * recipes and recipe IDs of those recipes
246 /* Bit map specifying the IDs associated with this group of recipe */
247 ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
249 enum ice_sw_tunnel_type tun_type;
251 /* List of type ice_fltr_mgmt_list_entry or adv_rule */
253 struct LIST_HEAD_TYPE filt_rules;
254 struct LIST_HEAD_TYPE filt_replay_rules;
256 struct ice_lock filt_rule_lock; /* protect filter rule structure */
258 /* Profiles this recipe should be associated with */
259 struct LIST_HEAD_TYPE fv_list;
261 /* Profiles this recipe is associated with */
262 u8 num_profs, *prof_ids;
264 /* Bit map for possible result indexes */
265 ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
267 /* This allows user to specify the recipe priority.
268 * For now, this becomes 'fwd_priority' when recipe
269 * is created, usually recipes can have 'fwd' and 'join'
274 struct LIST_HEAD_TYPE rg_list;
276 /* AQ buffer associated with this recipe */
277 struct ice_aqc_recipe_data_elem *root_buf;
278 /* This struct saves the fv_words for a given lookup */
279 struct ice_prot_lkup_ext lkup_exts;
282 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
283 struct ice_vsi_list_map_info {
284 struct LIST_ENTRY_TYPE list_entry;
285 ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
287 /* counter to track how many rules are reusing this VSI list */
291 struct ice_fltr_list_entry {
292 struct LIST_ENTRY_TYPE list_entry;
293 enum ice_status status;
294 struct ice_fltr_info fltr_info;
297 /* This defines an entry in the list that maintains MAC or VLAN membership
298 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
299 * VLAN. As an optimization the VSI list should be created only when a
300 * second VSI becomes a subscriber to the same MAC address. VSI lists are always
301 * used for VLAN membership.
303 struct ice_fltr_mgmt_list_entry {
304 /* back pointer to VSI list ID to VSI list mapping */
305 struct ice_vsi_list_map_info *vsi_list_info;
307 #define ICE_INVAL_LG_ACT_INDEX 0xffff
309 #define ICE_INVAL_SW_MARKER_ID 0xffff
311 struct LIST_ENTRY_TYPE list_entry;
312 struct ice_fltr_info fltr_info;
313 #define ICE_INVAL_COUNTER_ID 0xff
317 struct ice_adv_fltr_mgmt_list_entry {
318 struct LIST_ENTRY_TYPE list_entry;
320 struct ice_adv_lkup_elem *lkups;
321 struct ice_adv_rule_info rule_info;
323 struct ice_vsi_list_map_info *vsi_list_info;
327 enum ice_promisc_flags {
328 ICE_PROMISC_UCAST_RX = 0x1,
329 ICE_PROMISC_UCAST_TX = 0x2,
330 ICE_PROMISC_MCAST_RX = 0x4,
331 ICE_PROMISC_MCAST_TX = 0x8,
332 ICE_PROMISC_BCAST_RX = 0x10,
333 ICE_PROMISC_BCAST_TX = 0x20,
334 ICE_PROMISC_VLAN_RX = 0x40,
335 ICE_PROMISC_VLAN_TX = 0x80,
338 /* VSI related commands */
340 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
341 struct ice_sq_cd *cd);
343 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
344 bool keep_vsi_alloc, struct ice_sq_cd *cd);
346 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
347 struct ice_sq_cd *cd);
349 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
350 struct ice_sq_cd *cd);
352 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
353 bool keep_vsi_alloc, struct ice_sq_cd *cd);
355 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
356 struct ice_sq_cd *cd);
357 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
358 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
360 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
361 struct ice_sq_cd *cd);
363 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
364 u16 count, struct ice_mir_rule_buf *mr_buf,
365 struct ice_sq_cd *cd, u16 *rule_id);
367 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
368 struct ice_sq_cd *cd);
370 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
373 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
376 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
379 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
381 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
383 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
386 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
389 /* Switch/bridge related commands */
390 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
392 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
395 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
397 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
398 u16 buf_size, struct ice_sq_cd *cd);
400 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
401 struct ice_aqc_get_allocd_res_desc_resp *buf,
402 u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
403 struct ice_sq_cd *cd);
405 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
407 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
408 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
409 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
410 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
412 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
414 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
416 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
418 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
421 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
424 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
425 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
427 /* Promisc/defport setup for VSIs */
429 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
432 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
435 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
438 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
439 bool rm_vlan_promisc);
441 /* Get VSIs Promisc/defport settings */
443 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
446 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
450 ice_aq_add_recipe(struct ice_hw *hw,
451 struct ice_aqc_recipe_data_elem *s_recipe_list,
452 u16 num_recipes, struct ice_sq_cd *cd);
455 ice_aq_get_recipe(struct ice_hw *hw,
456 struct ice_aqc_recipe_data_elem *s_recipe_list,
457 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
459 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
460 struct ice_sq_cd *cd);
463 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
464 struct ice_sq_cd *cd);
466 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
468 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
469 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
470 struct ice_rule_query_data *added_entry);
472 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
474 ice_rem_adv_rule_by_id(struct ice_hw *hw,
475 struct ice_rule_query_data *remove_entry);
477 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
478 u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
480 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
483 ice_init_def_sw_recp(struct ice_hw *hw, struct ice_sw_recipe **recp_list);
484 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
485 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
488 ice_replay_vsi_all_fltr(struct ice_hw *hw, struct ice_port_info *pi,
490 void ice_rm_sw_replay_rule_info(struct ice_hw *hw, struct ice_switch_info *sw);
491 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
492 bool ice_is_prof_rule(enum ice_sw_tunnel_type type);
494 #endif /* _ICE_SWITCH_H_ */