1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2021 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_IPV4_GTPU_TEID 43
32 #define ICE_PROFID_IPV6_GTPU_TEID 46
33 #define ICE_PROFID_IPV4_GTPU_EH_IPV4_OTHER 47
34 #define ICE_PROFID_IPV4_GTPU_IPV4_OTHER 48
35 #define ICE_PROFID_IPV4_GTPU_EH_IPV4_UDP 49
36 #define ICE_PROFID_IPV4_GTPU_IPV4_UDP 50
37 #define ICE_PROFID_IPV4_GTPU_EH_IPV4_TCP 51
38 #define ICE_PROFID_IPV4_GTPU_IPV4_TCP 52
39 #define ICE_PROFID_IPV6_GTPU_EH_IPV4_OTHER 53
40 #define ICE_PROFID_IPV6_GTPU_IPV4_OTHER 54
41 #define ICE_PROFID_IPV6_GTPU_EH_IPV4_UDP 55
42 #define ICE_PROFID_IPV6_GTPU_IPV4_UDP 56
43 #define ICE_PROFID_IPV6_GTPU_EH_IPV4_TCP 57
44 #define ICE_PROFID_IPV6_GTPU_IPV4_TCP 58
45 #define ICE_PROFID_IPV4_GTPU_EH_IPV6_OTHER 59
46 #define ICE_PROFID_IPV4_GTPU_IPV6_OTHER 60
47 #define ICE_PROFID_IPV4_GTPU_EH_IPV6_UDP 61
48 #define ICE_PROFID_IPV4_GTPU_IPV6_UDP 62
49 #define ICE_PROFID_IPV4_GTPU_EH_IPV6_TCP 63
50 #define ICE_PROFID_IPV4_GTPU_IPV6_TCP 64
51 #define ICE_PROFID_IPV6_GTPU_EH_IPV6_OTHER 65
52 #define ICE_PROFID_IPV6_GTPU_IPV6_OTHER 66
53 #define ICE_PROFID_IPV6_GTPU_EH_IPV6_UDP 67
54 #define ICE_PROFID_IPV6_GTPU_IPV6_UDP 68
55 #define ICE_PROFID_IPV6_GTPU_EH_IPV6_TCP 69
56 #define ICE_PROFID_IPV6_GTPU_IPV6_TCP 70
57 #define ICE_PROFID_IPV4_ESP 71
58 #define ICE_PROFID_IPV6_ESP 72
59 #define ICE_PROFID_IPV4_AH 73
60 #define ICE_PROFID_IPV6_AH 74
61 #define ICE_PROFID_IPV4_NAT_T 75
62 #define ICE_PROFID_IPV6_NAT_T 76
63 #define ICE_PROFID_MAC_IPV4_L2TPV3 77
64 #define ICE_PROFID_MAC_IPV6_L2TPV3 78
65 #define ICE_PROFID_IPV4_PFCP_NODE 79
66 #define ICE_PROFID_IPV4_PFCP_SESSION 80
67 #define ICE_PROFID_IPV6_PFCP_NODE 81
68 #define ICE_PROFID_IPV6_PFCP_SESSION 82
70 #define DUMMY_ETH_HDR_LEN 16
71 #define ICE_SW_RULE_RX_TX_ETH_HDR_SIZE \
72 (offsetof(struct ice_aqc_sw_rules_elem, pdata.lkup_tx_rx.hdr) + \
73 (DUMMY_ETH_HDR_LEN * \
74 sizeof(((struct ice_sw_rule_lkup_rx_tx *)0)->hdr[0])))
75 #define ICE_SW_RULE_RX_TX_NO_HDR_SIZE \
76 (offsetof(struct ice_aqc_sw_rules_elem, pdata.lkup_tx_rx.hdr))
77 #define ICE_SW_RULE_LG_ACT_SIZE(n) \
78 (offsetof(struct ice_aqc_sw_rules_elem, pdata.lg_act.act) + \
79 ((n) * sizeof(((struct ice_sw_rule_lg_act *)0)->act[0])))
80 #define ICE_SW_RULE_VSI_LIST_SIZE(n) \
81 (offsetof(struct ice_aqc_sw_rules_elem, pdata.vsi_list.vsi) + \
82 ((n) * sizeof(((struct ice_sw_rule_vsi_list *)0)->vsi[0])))
84 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
85 #define ICE_MAX_RES_TYPES 0x80
86 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
87 (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
89 #define ICE_VSI_INVAL_ID 0xFFFF
90 #define ICE_INVAL_Q_HANDLE 0xFFFF
92 /* VSI context structure for add/get/update/free operations */
98 struct ice_aqc_vsi_props info;
99 struct ice_sched_vsi_info sched;
101 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
102 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
105 /* This is to be used by add/update mirror rule Admin Queue command */
106 struct ice_mir_rule_buf {
107 u16 vsi_idx; /* VSI index */
109 /* For each VSI, user can specify whether corresponding VSI
110 * should be added/removed to/from mirror rule
112 * add mirror rule: this should always be TRUE.
113 * update mirror rule: add(true) or remove(false) VSI to/from
119 /* Switch recipe ID enum values are specific to hardware */
120 enum ice_sw_lkup_type {
121 ICE_SW_LKUP_ETHERTYPE = 0,
123 ICE_SW_LKUP_MAC_VLAN = 2,
124 ICE_SW_LKUP_PROMISC = 3,
125 ICE_SW_LKUP_VLAN = 4,
126 ICE_SW_LKUP_DFLT = 5,
127 ICE_SW_LKUP_ETHERTYPE_MAC = 8,
128 ICE_SW_LKUP_PROMISC_VLAN = 9,
132 /* type of filter src ID */
134 ICE_SRC_ID_UNKNOWN = 0,
140 struct ice_fltr_info {
141 /* Look up information: how to look up packet */
142 enum ice_sw_lkup_type lkup_type;
143 /* Forward action: filter action to do after lookup */
144 enum ice_sw_fwd_act_type fltr_act;
145 /* rule ID returned by firmware once filter rule is created */
149 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
151 enum ice_src_id src_id;
155 u8 mac_addr[ETH_ALEN];
158 u8 mac_addr[ETH_ALEN];
166 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
167 * if just using ethertype as filter. Set lkup_type as
168 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
169 * passed in as filter.
173 u8 mac_addr[ETH_ALEN]; /* optional */
175 } l_data; /* Make sure to zero out the memory of l_data before using
176 * it or only set the data associated with lookup match
177 * rest everything should be zero
180 /* Depending on filter action */
182 /* queue ID in case of ICE_FWD_TO_Q and starting
183 * queue ID in case of ICE_FWD_TO_QGRP.
193 /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
194 * determines the range of queues the packet needs to be forwarded to.
195 * Note that qgrp_size must be set to a power of 2.
199 /* Rule creations populate these indicators basing on the switch type */
200 u8 lb_en; /* Indicate if packet can be looped back */
201 u8 lan_en; /* Indicate if packet can be forwarded to the uplink */
204 struct ice_update_recipe_lkup_idx_params {
213 struct ice_adv_lkup_elem {
214 enum ice_protocol_type type;
215 union ice_prot_hdr h_u; /* Header values */
216 union ice_prot_hdr m_u; /* Mask of header values to match */
219 struct ice_prof_type_entry {
221 enum ice_sw_tunnel_type type;
224 struct ice_sw_act_ctrl {
225 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
228 enum ice_sw_fwd_act_type fltr_act;
229 /* Depending on filter action */
231 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
232 * queue ID in case of ICE_FWD_TO_QGRP.
239 /* software VSI handle */
244 struct ice_rule_query_data {
245 /* Recipe ID for which the requested rule was added */
247 /* Rule ID that was added or is supposed to be removed */
249 /* vsi_handle for which Rule was added or is supposed to be removed */
253 /* This structure allows to pass info about lb_en and lan_en
254 * flags to ice_add_adv_rule. Values in act would be used
255 * only if act_valid was set to true, otherwise dflt
256 * values would be used.
258 struct ice_adv_rule_flags_info {
260 u8 act_valid; /* indicate if flags in act are valid */
263 struct ice_adv_rule_info {
264 enum ice_sw_tunnel_type tun_type;
265 struct ice_sw_act_ctrl sw_act;
267 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
269 struct ice_adv_rule_flags_info flags_info;
272 /* A collection of one or more four word recipe */
273 struct ice_sw_recipe {
274 /* For a chained recipe the root recipe is what should be used for
281 /* Number of extraction words */
283 /* Protocol ID and Offset pair (extraction word) to describe the
286 struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
287 u16 word_masks[ICE_MAX_CHAIN_WORDS];
289 /* if this recipe is a collection of other recipe */
292 /* if this recipe is part of another bigger recipe then chain index
293 * corresponding to this recipe
297 /* if this recipe is a collection of other recipe then count of other
298 * recipes and recipe IDs of those recipes
302 /* Bit map specifying the IDs associated with this group of recipe */
303 ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
305 enum ice_sw_tunnel_type tun_type;
307 /* List of type ice_fltr_mgmt_list_entry or adv_rule */
309 struct LIST_HEAD_TYPE filt_rules;
310 struct LIST_HEAD_TYPE filt_replay_rules;
312 struct ice_lock filt_rule_lock; /* protect filter rule structure */
314 /* Profiles this recipe should be associated with */
315 struct LIST_HEAD_TYPE fv_list;
317 /* Profiles this recipe is associated with */
318 u8 num_profs, *prof_ids;
320 /* Bit map for possible result indexes */
321 ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
323 /* This allows user to specify the recipe priority.
324 * For now, this becomes 'fwd_priority' when recipe
325 * is created, usually recipes can have 'fwd' and 'join'
330 struct LIST_HEAD_TYPE rg_list;
332 /* AQ buffer associated with this recipe */
333 struct ice_aqc_recipe_data_elem *root_buf;
334 /* This struct saves the fv_words for a given lookup */
335 struct ice_prot_lkup_ext lkup_exts;
338 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
339 struct ice_vsi_list_map_info {
340 struct LIST_ENTRY_TYPE list_entry;
341 ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
343 /* counter to track how many rules are reusing this VSI list */
347 struct ice_fltr_list_entry {
348 struct LIST_ENTRY_TYPE list_entry;
349 enum ice_status status;
350 struct ice_fltr_info fltr_info;
353 /* This defines an entry in the list that maintains MAC or VLAN membership
354 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
355 * VLAN. As an optimization the VSI list should be created only when a
356 * second VSI becomes a subscriber to the same MAC address. VSI lists are always
357 * used for VLAN membership.
359 struct ice_fltr_mgmt_list_entry {
360 /* back pointer to VSI list ID to VSI list mapping */
361 struct ice_vsi_list_map_info *vsi_list_info;
363 #define ICE_INVAL_LG_ACT_INDEX 0xffff
365 #define ICE_INVAL_SW_MARKER_ID 0xffff
367 struct LIST_ENTRY_TYPE list_entry;
368 struct ice_fltr_info fltr_info;
369 #define ICE_INVAL_COUNTER_ID 0xff
373 struct ice_adv_fltr_mgmt_list_entry {
374 struct LIST_ENTRY_TYPE list_entry;
376 struct ice_adv_lkup_elem *lkups;
377 struct ice_adv_rule_info rule_info;
379 struct ice_vsi_list_map_info *vsi_list_info;
383 enum ice_promisc_flags {
384 ICE_PROMISC_UCAST_RX = 0x1,
385 ICE_PROMISC_UCAST_TX = 0x2,
386 ICE_PROMISC_MCAST_RX = 0x4,
387 ICE_PROMISC_MCAST_TX = 0x8,
388 ICE_PROMISC_BCAST_RX = 0x10,
389 ICE_PROMISC_BCAST_TX = 0x20,
390 ICE_PROMISC_VLAN_RX = 0x40,
391 ICE_PROMISC_VLAN_TX = 0x80,
394 /* VSI related commands */
396 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
397 struct ice_sq_cd *cd);
399 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
400 bool keep_vsi_alloc, struct ice_sq_cd *cd);
402 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
403 struct ice_sq_cd *cd);
405 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
406 struct ice_sq_cd *cd);
408 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
409 bool keep_vsi_alloc, struct ice_sq_cd *cd);
411 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
412 struct ice_sq_cd *cd);
413 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
414 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
416 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
417 struct ice_sq_cd *cd);
419 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
420 u16 count, struct ice_mir_rule_buf *mr_buf,
421 struct ice_sq_cd *cd, u16 *rule_id);
423 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
424 struct ice_sq_cd *cd);
426 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
429 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
432 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
435 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
437 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
439 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
442 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
445 /* Switch/bridge related commands */
446 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
447 enum ice_status ice_alloc_rss_global_lut(struct ice_hw *hw, bool shared_res, u16 *global_lut_id);
448 enum ice_status ice_free_rss_global_lut(struct ice_hw *hw, u16 global_lut_id);
450 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
453 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
455 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries,
456 struct ice_aqc_get_res_resp_elem *buf, u16 buf_size,
457 struct ice_sq_cd *cd);
459 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
460 struct ice_aqc_res_elem *buf, u16 buf_size, u16 res_type,
461 bool res_shared, u16 *desc_id, struct ice_sq_cd *cd);
463 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
465 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
466 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
467 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
468 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
470 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
472 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
474 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
476 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
479 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
482 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
483 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
485 /* Promisc/defport setup for VSIs */
487 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
490 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
493 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
496 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
497 bool rm_vlan_promisc);
499 /* Get VSIs Promisc/defport settings */
501 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
504 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
508 ice_aq_add_recipe(struct ice_hw *hw,
509 struct ice_aqc_recipe_data_elem *s_recipe_list,
510 u16 num_recipes, struct ice_sq_cd *cd);
513 ice_aq_get_recipe(struct ice_hw *hw,
514 struct ice_aqc_recipe_data_elem *s_recipe_list,
515 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
517 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
518 struct ice_sq_cd *cd);
521 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
522 struct ice_sq_cd *cd);
524 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
526 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
527 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
528 struct ice_rule_query_data *added_entry);
530 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
532 ice_rem_adv_rule_by_id(struct ice_hw *hw,
533 struct ice_rule_query_data *remove_entry);
535 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
536 u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
538 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
541 ice_init_def_sw_recp(struct ice_hw *hw, struct ice_sw_recipe **recp_list);
542 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
543 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
546 ice_replay_vsi_all_fltr(struct ice_hw *hw, struct ice_port_info *pi,
548 void ice_rm_sw_replay_rule_info(struct ice_hw *hw, struct ice_switch_info *sw);
549 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
550 bool ice_is_prof_rule(enum ice_sw_tunnel_type type);
552 ice_update_recipe_lkup_idx(struct ice_hw *hw,
553 struct ice_update_recipe_lkup_idx_params *params);
554 void ice_change_proto_id_to_dvm(void);
555 #endif /* _ICE_SWITCH_H_ */