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_PPPOE_PAY 34
20 #define ICE_PROFID_PPPOE_IPV4_TCP 35
21 #define ICE_PROFID_PPPOE_IPV4_UDP 36
22 #define ICE_PROFID_PPPOE_IPV4_OTHER 37
23 #define ICE_PROFID_PPPOE_IPV6_TCP 38
24 #define ICE_PROFID_PPPOE_IPV6_UDP 39
25 #define ICE_PROFID_PPPOE_IPV6_OTHER 40
26 #define ICE_PROFID_IPV4_ESP 71
27 #define ICE_PROFID_IPV6_ESP 72
28 #define ICE_PROFID_IPV4_AH 73
29 #define ICE_PROFID_IPV6_AH 74
30 #define ICE_PROFID_IPV4_NAT_T 75
31 #define ICE_PROFID_IPV6_NAT_T 76
32 #define ICE_PROFID_MAC_IPV4_L2TPV3 77
33 #define ICE_PROFID_MAC_IPV6_L2TPV3 78
34 #define ICE_PROFID_IPV4_PFCP_NODE 79
35 #define ICE_PROFID_IPV4_PFCP_SESSION 80
36 #define ICE_PROFID_IPV6_PFCP_NODE 81
37 #define ICE_PROFID_IPV6_PFCP_SESSION 82
39 #define DUMMY_ETH_HDR_LEN 16
40 #define ICE_SW_RULE_RX_TX_ETH_HDR_SIZE \
41 (sizeof(struct ice_aqc_sw_rules_elem) - \
42 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
43 sizeof(struct ice_sw_rule_lkup_rx_tx) + DUMMY_ETH_HDR_LEN - 1)
44 #define ICE_SW_RULE_RX_TX_NO_HDR_SIZE \
45 (sizeof(struct ice_aqc_sw_rules_elem) - \
46 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
47 sizeof(struct ice_sw_rule_lkup_rx_tx) - 1)
48 #define ICE_SW_RULE_LG_ACT_SIZE(n) \
49 (sizeof(struct ice_aqc_sw_rules_elem) - \
50 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
51 sizeof(struct ice_sw_rule_lg_act) - \
52 FIELD_SIZEOF(struct ice_sw_rule_lg_act, act) + \
53 ((n) * FIELD_SIZEOF(struct ice_sw_rule_lg_act, act)))
54 #define ICE_SW_RULE_VSI_LIST_SIZE(n) \
55 (sizeof(struct ice_aqc_sw_rules_elem) - \
56 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
57 sizeof(struct ice_sw_rule_vsi_list) - \
58 FIELD_SIZEOF(struct ice_sw_rule_vsi_list, vsi) + \
59 ((n) * FIELD_SIZEOF(struct ice_sw_rule_vsi_list, vsi)))
61 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
62 #define ICE_MAX_RES_TYPES 0x80
63 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
64 (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
66 #define ICE_VSI_INVAL_ID 0xFFFF
67 #define ICE_INVAL_Q_HANDLE 0xFFFF
69 /* VSI context structure for add/get/update/free operations */
75 struct ice_aqc_vsi_props info;
76 struct ice_sched_vsi_info sched;
78 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
79 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
82 /* This is to be used by add/update mirror rule Admin Queue command */
83 struct ice_mir_rule_buf {
84 u16 vsi_idx; /* VSI index */
86 /* For each VSI, user can specify whether corresponding VSI
87 * should be added/removed to/from mirror rule
89 * add mirror rule: this should always be TRUE.
90 * update mirror rule: add(true) or remove(false) VSI to/from
96 /* Switch recipe ID enum values are specific to hardware */
97 enum ice_sw_lkup_type {
98 ICE_SW_LKUP_ETHERTYPE = 0,
100 ICE_SW_LKUP_MAC_VLAN = 2,
101 ICE_SW_LKUP_PROMISC = 3,
102 ICE_SW_LKUP_VLAN = 4,
103 ICE_SW_LKUP_DFLT = 5,
104 ICE_SW_LKUP_ETHERTYPE_MAC = 8,
105 ICE_SW_LKUP_PROMISC_VLAN = 9,
109 /* type of filter src ID */
111 ICE_SRC_ID_UNKNOWN = 0,
117 struct ice_fltr_info {
118 /* Look up information: how to look up packet */
119 enum ice_sw_lkup_type lkup_type;
120 /* Forward action: filter action to do after lookup */
121 enum ice_sw_fwd_act_type fltr_act;
122 /* rule ID returned by firmware once filter rule is created */
126 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
128 enum ice_src_id src_id;
132 u8 mac_addr[ETH_ALEN];
135 u8 mac_addr[ETH_ALEN];
141 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
142 * if just using ethertype as filter. Set lkup_type as
143 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
144 * passed in as filter.
148 u8 mac_addr[ETH_ALEN]; /* optional */
150 } l_data; /* Make sure to zero out the memory of l_data before using
151 * it or only set the data associated with lookup match
152 * rest everything should be zero
155 /* Depending on filter action */
157 /* queue ID in case of ICE_FWD_TO_Q and starting
158 * queue ID in case of ICE_FWD_TO_QGRP.
169 /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
170 * determines the range of queues the packet needs to be forwarded to.
171 * Note that qgrp_size must be set to a power of 2.
175 /* Rule creations populate these indicators basing on the switch type */
176 u8 lb_en; /* Indicate if packet can be looped back */
177 u8 lan_en; /* Indicate if packet can be forwarded to the uplink */
180 struct ice_adv_lkup_elem {
181 enum ice_protocol_type type;
182 union ice_prot_hdr h_u; /* Header values */
183 union ice_prot_hdr m_u; /* Mask of header values to match */
186 struct ice_sw_act_ctrl {
187 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
190 enum ice_sw_fwd_act_type fltr_act;
191 /* Depending on filter action */
193 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
194 * queue ID in case of ICE_FWD_TO_QGRP.
201 /* software VSI handle */
206 struct ice_rule_query_data {
207 /* Recipe ID for which the requested rule was added */
209 /* Rule ID that was added or is supposed to be removed */
211 /* vsi_handle for which Rule was added or is supposed to be removed */
215 struct ice_adv_rule_info {
216 enum ice_sw_tunnel_type tun_type;
217 struct ice_sw_act_ctrl sw_act;
219 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
223 /* A collection of one or more four word recipe */
224 struct ice_sw_recipe {
225 /* For a chained recipe the root recipe is what should be used for
232 /* Number of extraction words */
234 /* Protocol ID and Offset pair (extraction word) to describe the
237 struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
238 u16 word_masks[ICE_MAX_CHAIN_WORDS];
240 /* if this recipe is a collection of other recipe */
243 /* if this recipe is part of another bigger recipe then chain index
244 * corresponding to this recipe
248 /* if this recipe is a collection of other recipe then count of other
249 * recipes and recipe IDs of those recipes
253 /* Bit map specifying the IDs associated with this group of recipe */
254 ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
256 enum ice_sw_tunnel_type tun_type;
258 /* List of type ice_fltr_mgmt_list_entry or adv_rule */
260 struct LIST_HEAD_TYPE filt_rules;
261 struct LIST_HEAD_TYPE filt_replay_rules;
263 struct ice_lock filt_rule_lock; /* protect filter rule structure */
265 /* Profiles this recipe should be associated with */
266 struct LIST_HEAD_TYPE fv_list;
268 /* Profiles this recipe is associated with */
269 u8 num_profs, *prof_ids;
271 /* Bit map for possible result indexes */
272 ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
274 /* This allows user to specify the recipe priority.
275 * For now, this becomes 'fwd_priority' when recipe
276 * is created, usually recipes can have 'fwd' and 'join'
281 struct LIST_HEAD_TYPE rg_list;
283 /* AQ buffer associated with this recipe */
284 struct ice_aqc_recipe_data_elem *root_buf;
285 /* This struct saves the fv_words for a given lookup */
286 struct ice_prot_lkup_ext lkup_exts;
289 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
290 struct ice_vsi_list_map_info {
291 struct LIST_ENTRY_TYPE list_entry;
292 ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
294 /* counter to track how many rules are reusing this VSI list */
298 struct ice_fltr_list_entry {
299 struct LIST_ENTRY_TYPE list_entry;
300 enum ice_status status;
301 struct ice_fltr_info fltr_info;
304 /* This defines an entry in the list that maintains MAC or VLAN membership
305 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
306 * VLAN. As an optimization the VSI list should be created only when a
307 * second VSI becomes a subscriber to the same MAC address. VSI lists are always
308 * used for VLAN membership.
310 struct ice_fltr_mgmt_list_entry {
311 /* back pointer to VSI list ID to VSI list mapping */
312 struct ice_vsi_list_map_info *vsi_list_info;
314 #define ICE_INVAL_LG_ACT_INDEX 0xffff
316 #define ICE_INVAL_SW_MARKER_ID 0xffff
318 struct LIST_ENTRY_TYPE list_entry;
319 struct ice_fltr_info fltr_info;
320 #define ICE_INVAL_COUNTER_ID 0xff
324 struct ice_adv_fltr_mgmt_list_entry {
325 struct LIST_ENTRY_TYPE list_entry;
327 struct ice_adv_lkup_elem *lkups;
328 struct ice_adv_rule_info rule_info;
330 struct ice_vsi_list_map_info *vsi_list_info;
334 enum ice_promisc_flags {
335 ICE_PROMISC_UCAST_RX = 0x1,
336 ICE_PROMISC_UCAST_TX = 0x2,
337 ICE_PROMISC_MCAST_RX = 0x4,
338 ICE_PROMISC_MCAST_TX = 0x8,
339 ICE_PROMISC_BCAST_RX = 0x10,
340 ICE_PROMISC_BCAST_TX = 0x20,
341 ICE_PROMISC_VLAN_RX = 0x40,
342 ICE_PROMISC_VLAN_TX = 0x80,
345 /* VSI related commands */
347 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
348 struct ice_sq_cd *cd);
350 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
351 bool keep_vsi_alloc, struct ice_sq_cd *cd);
353 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
354 struct ice_sq_cd *cd);
356 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
357 struct ice_sq_cd *cd);
359 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
360 bool keep_vsi_alloc, struct ice_sq_cd *cd);
362 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
363 struct ice_sq_cd *cd);
364 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
365 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
367 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
368 struct ice_sq_cd *cd);
370 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
371 u16 count, struct ice_mir_rule_buf *mr_buf,
372 struct ice_sq_cd *cd, u16 *rule_id);
374 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
375 struct ice_sq_cd *cd);
377 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
380 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
383 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
386 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
388 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
390 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
393 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
396 /* Switch/bridge related commands */
397 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
399 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
402 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
404 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
405 u16 buf_size, struct ice_sq_cd *cd);
407 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
408 struct ice_aqc_get_allocd_res_desc_resp *buf,
409 u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
410 struct ice_sq_cd *cd);
412 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
414 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
415 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
416 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
417 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
419 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
421 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
423 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
425 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
428 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
431 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
432 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
434 /* Promisc/defport setup for VSIs */
436 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
439 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
442 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
445 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
446 bool rm_vlan_promisc);
448 /* Get VSIs Promisc/defport settings */
450 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
453 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
457 ice_aq_add_recipe(struct ice_hw *hw,
458 struct ice_aqc_recipe_data_elem *s_recipe_list,
459 u16 num_recipes, struct ice_sq_cd *cd);
462 ice_aq_get_recipe(struct ice_hw *hw,
463 struct ice_aqc_recipe_data_elem *s_recipe_list,
464 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
466 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
467 struct ice_sq_cd *cd);
470 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
471 struct ice_sq_cd *cd);
473 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
475 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
476 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
477 struct ice_rule_query_data *added_entry);
479 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
481 ice_rem_adv_rule_by_id(struct ice_hw *hw,
482 struct ice_rule_query_data *remove_entry);
484 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
485 u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
487 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
490 ice_init_def_sw_recp(struct ice_hw *hw, struct ice_sw_recipe **recp_list);
491 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
492 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
495 ice_replay_vsi_all_fltr(struct ice_hw *hw, struct ice_port_info *pi,
497 void ice_rm_sw_replay_rule_info(struct ice_hw *hw, struct ice_switch_info *sw);
498 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
499 bool ice_is_prof_rule(enum ice_sw_tunnel_type type);
500 #endif /* _ICE_SWITCH_H_ */