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_TCP 4
20 #define ICE_PROFID_IPV4_UDP 5
21 #define ICE_PROFID_IPV6_TCP 7
22 #define ICE_PROFID_IPV6_UDP 8
23 #define ICE_PROFID_PPPOE_PAY 34
24 #define ICE_PROFID_PPPOE_IPV4_TCP 35
25 #define ICE_PROFID_PPPOE_IPV4_UDP 36
26 #define ICE_PROFID_PPPOE_IPV4_OTHER 37
27 #define ICE_PROFID_PPPOE_IPV6_TCP 38
28 #define ICE_PROFID_PPPOE_IPV6_UDP 39
29 #define ICE_PROFID_PPPOE_IPV6_OTHER 40
30 #define ICE_PROFID_IPV4_GTPC_TEID 41
31 #define ICE_PROFID_IPV6_GTPU_IPV6_OTHER 70
32 #define ICE_PROFID_IPV4_ESP 71
33 #define ICE_PROFID_IPV6_ESP 72
34 #define ICE_PROFID_IPV4_AH 73
35 #define ICE_PROFID_IPV6_AH 74
36 #define ICE_PROFID_IPV4_NAT_T 75
37 #define ICE_PROFID_IPV6_NAT_T 76
38 #define ICE_PROFID_MAC_IPV4_L2TPV3 77
39 #define ICE_PROFID_MAC_IPV6_L2TPV3 78
40 #define ICE_PROFID_IPV4_PFCP_NODE 79
41 #define ICE_PROFID_IPV4_PFCP_SESSION 80
42 #define ICE_PROFID_IPV6_PFCP_NODE 81
43 #define ICE_PROFID_IPV6_PFCP_SESSION 82
45 #define DUMMY_ETH_HDR_LEN 16
46 #define ICE_SW_RULE_RX_TX_ETH_HDR_SIZE \
47 (sizeof(struct ice_aqc_sw_rules_elem) - \
48 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
49 sizeof(struct ice_sw_rule_lkup_rx_tx) + DUMMY_ETH_HDR_LEN - 1)
50 #define ICE_SW_RULE_RX_TX_NO_HDR_SIZE \
51 (sizeof(struct ice_aqc_sw_rules_elem) - \
52 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
53 sizeof(struct ice_sw_rule_lkup_rx_tx) - 1)
54 #define ICE_SW_RULE_LG_ACT_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_lg_act) - \
58 FIELD_SIZEOF(struct ice_sw_rule_lg_act, act) + \
59 ((n) * FIELD_SIZEOF(struct ice_sw_rule_lg_act, act)))
60 #define ICE_SW_RULE_VSI_LIST_SIZE(n) \
61 (sizeof(struct ice_aqc_sw_rules_elem) - \
62 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
63 sizeof(struct ice_sw_rule_vsi_list) - \
64 FIELD_SIZEOF(struct ice_sw_rule_vsi_list, vsi) + \
65 ((n) * FIELD_SIZEOF(struct ice_sw_rule_vsi_list, vsi)))
67 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
68 #define ICE_MAX_RES_TYPES 0x80
69 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
70 (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
72 #define ICE_VSI_INVAL_ID 0xFFFF
73 #define ICE_INVAL_Q_HANDLE 0xFFFF
75 /* VSI context structure for add/get/update/free operations */
81 struct ice_aqc_vsi_props info;
82 struct ice_sched_vsi_info sched;
84 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
85 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
88 /* This is to be used by add/update mirror rule Admin Queue command */
89 struct ice_mir_rule_buf {
90 u16 vsi_idx; /* VSI index */
92 /* For each VSI, user can specify whether corresponding VSI
93 * should be added/removed to/from mirror rule
95 * add mirror rule: this should always be TRUE.
96 * update mirror rule: add(true) or remove(false) VSI to/from
102 /* Switch recipe ID enum values are specific to hardware */
103 enum ice_sw_lkup_type {
104 ICE_SW_LKUP_ETHERTYPE = 0,
106 ICE_SW_LKUP_MAC_VLAN = 2,
107 ICE_SW_LKUP_PROMISC = 3,
108 ICE_SW_LKUP_VLAN = 4,
109 ICE_SW_LKUP_DFLT = 5,
110 ICE_SW_LKUP_ETHERTYPE_MAC = 8,
111 ICE_SW_LKUP_PROMISC_VLAN = 9,
115 /* type of filter src ID */
117 ICE_SRC_ID_UNKNOWN = 0,
123 struct ice_fltr_info {
124 /* Look up information: how to look up packet */
125 enum ice_sw_lkup_type lkup_type;
126 /* Forward action: filter action to do after lookup */
127 enum ice_sw_fwd_act_type fltr_act;
128 /* rule ID returned by firmware once filter rule is created */
132 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
134 enum ice_src_id src_id;
138 u8 mac_addr[ETH_ALEN];
141 u8 mac_addr[ETH_ALEN];
147 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
148 * if just using ethertype as filter. Set lkup_type as
149 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
150 * passed in as filter.
154 u8 mac_addr[ETH_ALEN]; /* optional */
156 } l_data; /* Make sure to zero out the memory of l_data before using
157 * it or only set the data associated with lookup match
158 * rest everything should be zero
161 /* Depending on filter action */
163 /* queue ID in case of ICE_FWD_TO_Q and starting
164 * queue ID in case of ICE_FWD_TO_QGRP.
175 /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
176 * determines the range of queues the packet needs to be forwarded to.
177 * Note that qgrp_size must be set to a power of 2.
181 /* Rule creations populate these indicators basing on the switch type */
182 u8 lb_en; /* Indicate if packet can be looped back */
183 u8 lan_en; /* Indicate if packet can be forwarded to the uplink */
186 struct ice_adv_lkup_elem {
187 enum ice_protocol_type type;
188 union ice_prot_hdr h_u; /* Header values */
189 union ice_prot_hdr m_u; /* Mask of header values to match */
192 struct ice_sw_act_ctrl {
193 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
196 enum ice_sw_fwd_act_type fltr_act;
197 /* Depending on filter action */
199 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
200 * queue ID in case of ICE_FWD_TO_QGRP.
207 /* software VSI handle */
212 struct ice_rule_query_data {
213 /* Recipe ID for which the requested rule was added */
215 /* Rule ID that was added or is supposed to be removed */
217 /* vsi_handle for which Rule was added or is supposed to be removed */
221 struct ice_adv_rule_info {
222 enum ice_sw_tunnel_type tun_type;
223 struct ice_sw_act_ctrl sw_act;
225 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
229 /* A collection of one or more four word recipe */
230 struct ice_sw_recipe {
231 /* For a chained recipe the root recipe is what should be used for
238 /* Number of extraction words */
240 /* Protocol ID and Offset pair (extraction word) to describe the
243 struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
244 u16 word_masks[ICE_MAX_CHAIN_WORDS];
246 /* if this recipe is a collection of other recipe */
249 /* if this recipe is part of another bigger recipe then chain index
250 * corresponding to this recipe
254 /* if this recipe is a collection of other recipe then count of other
255 * recipes and recipe IDs of those recipes
259 /* Bit map specifying the IDs associated with this group of recipe */
260 ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
262 enum ice_sw_tunnel_type tun_type;
264 /* List of type ice_fltr_mgmt_list_entry or adv_rule */
266 struct LIST_HEAD_TYPE filt_rules;
267 struct LIST_HEAD_TYPE filt_replay_rules;
269 struct ice_lock filt_rule_lock; /* protect filter rule structure */
271 /* Profiles this recipe should be associated with */
272 struct LIST_HEAD_TYPE fv_list;
274 /* Profiles this recipe is associated with */
275 u8 num_profs, *prof_ids;
277 /* Bit map for possible result indexes */
278 ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
280 /* This allows user to specify the recipe priority.
281 * For now, this becomes 'fwd_priority' when recipe
282 * is created, usually recipes can have 'fwd' and 'join'
287 struct LIST_HEAD_TYPE rg_list;
289 /* AQ buffer associated with this recipe */
290 struct ice_aqc_recipe_data_elem *root_buf;
291 /* This struct saves the fv_words for a given lookup */
292 struct ice_prot_lkup_ext lkup_exts;
295 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
296 struct ice_vsi_list_map_info {
297 struct LIST_ENTRY_TYPE list_entry;
298 ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
300 /* counter to track how many rules are reusing this VSI list */
304 struct ice_fltr_list_entry {
305 struct LIST_ENTRY_TYPE list_entry;
306 enum ice_status status;
307 struct ice_fltr_info fltr_info;
310 /* This defines an entry in the list that maintains MAC or VLAN membership
311 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
312 * VLAN. As an optimization the VSI list should be created only when a
313 * second VSI becomes a subscriber to the same MAC address. VSI lists are always
314 * used for VLAN membership.
316 struct ice_fltr_mgmt_list_entry {
317 /* back pointer to VSI list ID to VSI list mapping */
318 struct ice_vsi_list_map_info *vsi_list_info;
320 #define ICE_INVAL_LG_ACT_INDEX 0xffff
322 #define ICE_INVAL_SW_MARKER_ID 0xffff
324 struct LIST_ENTRY_TYPE list_entry;
325 struct ice_fltr_info fltr_info;
326 #define ICE_INVAL_COUNTER_ID 0xff
330 struct ice_adv_fltr_mgmt_list_entry {
331 struct LIST_ENTRY_TYPE list_entry;
333 struct ice_adv_lkup_elem *lkups;
334 struct ice_adv_rule_info rule_info;
336 struct ice_vsi_list_map_info *vsi_list_info;
340 enum ice_promisc_flags {
341 ICE_PROMISC_UCAST_RX = 0x1,
342 ICE_PROMISC_UCAST_TX = 0x2,
343 ICE_PROMISC_MCAST_RX = 0x4,
344 ICE_PROMISC_MCAST_TX = 0x8,
345 ICE_PROMISC_BCAST_RX = 0x10,
346 ICE_PROMISC_BCAST_TX = 0x20,
347 ICE_PROMISC_VLAN_RX = 0x40,
348 ICE_PROMISC_VLAN_TX = 0x80,
351 /* VSI related commands */
353 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
354 struct ice_sq_cd *cd);
356 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
357 bool keep_vsi_alloc, struct ice_sq_cd *cd);
359 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
360 struct ice_sq_cd *cd);
362 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
363 struct ice_sq_cd *cd);
365 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
366 bool keep_vsi_alloc, struct ice_sq_cd *cd);
368 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
369 struct ice_sq_cd *cd);
370 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
371 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
373 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
374 struct ice_sq_cd *cd);
376 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
377 u16 count, struct ice_mir_rule_buf *mr_buf,
378 struct ice_sq_cd *cd, u16 *rule_id);
380 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
381 struct ice_sq_cd *cd);
383 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
386 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
389 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
392 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
394 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
396 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
399 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
402 /* Switch/bridge related commands */
403 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
405 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
408 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
410 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
411 u16 buf_size, struct ice_sq_cd *cd);
413 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
414 struct ice_aqc_get_allocd_res_desc_resp *buf,
415 u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
416 struct ice_sq_cd *cd);
418 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
420 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
421 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
422 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
423 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
425 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
427 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
429 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
431 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
434 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
437 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
438 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
440 /* Promisc/defport setup for VSIs */
442 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
445 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
448 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
451 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
452 bool rm_vlan_promisc);
454 /* Get VSIs Promisc/defport settings */
456 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
459 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
463 ice_aq_add_recipe(struct ice_hw *hw,
464 struct ice_aqc_recipe_data_elem *s_recipe_list,
465 u16 num_recipes, struct ice_sq_cd *cd);
468 ice_aq_get_recipe(struct ice_hw *hw,
469 struct ice_aqc_recipe_data_elem *s_recipe_list,
470 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
472 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
473 struct ice_sq_cd *cd);
476 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
477 struct ice_sq_cd *cd);
479 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
481 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
482 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
483 struct ice_rule_query_data *added_entry);
485 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
487 ice_rem_adv_rule_by_id(struct ice_hw *hw,
488 struct ice_rule_query_data *remove_entry);
490 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
491 u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
493 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
496 ice_init_def_sw_recp(struct ice_hw *hw, struct ice_sw_recipe **recp_list);
497 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
498 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
501 ice_replay_vsi_all_fltr(struct ice_hw *hw, struct ice_port_info *pi,
503 void ice_rm_sw_replay_rule_info(struct ice_hw *hw, struct ice_switch_info *sw);
504 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
505 bool ice_is_prof_rule(enum ice_sw_tunnel_type type);
506 #endif /* _ICE_SWITCH_H_ */