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_IPV4_GTPU_EH_IPV4_OTHER 47
32 #define ICE_PROFID_IPV6_GTPU_IPV6_OTHER 70
33 #define ICE_PROFID_IPV4_ESP 71
34 #define ICE_PROFID_IPV6_ESP 72
35 #define ICE_PROFID_IPV4_AH 73
36 #define ICE_PROFID_IPV6_AH 74
37 #define ICE_PROFID_IPV4_NAT_T 75
38 #define ICE_PROFID_IPV6_NAT_T 76
39 #define ICE_PROFID_MAC_IPV4_L2TPV3 77
40 #define ICE_PROFID_MAC_IPV6_L2TPV3 78
41 #define ICE_PROFID_IPV4_PFCP_NODE 79
42 #define ICE_PROFID_IPV4_PFCP_SESSION 80
43 #define ICE_PROFID_IPV6_PFCP_NODE 81
44 #define ICE_PROFID_IPV6_PFCP_SESSION 82
46 #define DUMMY_ETH_HDR_LEN 16
47 #define ICE_SW_RULE_RX_TX_ETH_HDR_SIZE \
48 (sizeof(struct ice_aqc_sw_rules_elem) - \
49 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
50 sizeof(struct ice_sw_rule_lkup_rx_tx) + DUMMY_ETH_HDR_LEN - 1)
51 #define ICE_SW_RULE_RX_TX_NO_HDR_SIZE \
52 (sizeof(struct ice_aqc_sw_rules_elem) - \
53 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
54 sizeof(struct ice_sw_rule_lkup_rx_tx) - 1)
55 #define ICE_SW_RULE_LG_ACT_SIZE(n) \
56 (sizeof(struct ice_aqc_sw_rules_elem) - \
57 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
58 sizeof(struct ice_sw_rule_lg_act) - \
59 FIELD_SIZEOF(struct ice_sw_rule_lg_act, act) + \
60 ((n) * FIELD_SIZEOF(struct ice_sw_rule_lg_act, act)))
61 #define ICE_SW_RULE_VSI_LIST_SIZE(n) \
62 (sizeof(struct ice_aqc_sw_rules_elem) - \
63 FIELD_SIZEOF(struct ice_aqc_sw_rules_elem, pdata) + \
64 sizeof(struct ice_sw_rule_vsi_list) - \
65 FIELD_SIZEOF(struct ice_sw_rule_vsi_list, vsi) + \
66 ((n) * FIELD_SIZEOF(struct ice_sw_rule_vsi_list, vsi)))
68 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
69 #define ICE_MAX_RES_TYPES 0x80
70 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
71 (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
73 #define ICE_VSI_INVAL_ID 0xFFFF
74 #define ICE_INVAL_Q_HANDLE 0xFFFF
76 /* VSI context structure for add/get/update/free operations */
82 struct ice_aqc_vsi_props info;
83 struct ice_sched_vsi_info sched;
85 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
86 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
89 /* This is to be used by add/update mirror rule Admin Queue command */
90 struct ice_mir_rule_buf {
91 u16 vsi_idx; /* VSI index */
93 /* For each VSI, user can specify whether corresponding VSI
94 * should be added/removed to/from mirror rule
96 * add mirror rule: this should always be TRUE.
97 * update mirror rule: add(true) or remove(false) VSI to/from
103 /* Switch recipe ID enum values are specific to hardware */
104 enum ice_sw_lkup_type {
105 ICE_SW_LKUP_ETHERTYPE = 0,
107 ICE_SW_LKUP_MAC_VLAN = 2,
108 ICE_SW_LKUP_PROMISC = 3,
109 ICE_SW_LKUP_VLAN = 4,
110 ICE_SW_LKUP_DFLT = 5,
111 ICE_SW_LKUP_ETHERTYPE_MAC = 8,
112 ICE_SW_LKUP_PROMISC_VLAN = 9,
116 /* type of filter src ID */
118 ICE_SRC_ID_UNKNOWN = 0,
124 struct ice_fltr_info {
125 /* Look up information: how to look up packet */
126 enum ice_sw_lkup_type lkup_type;
127 /* Forward action: filter action to do after lookup */
128 enum ice_sw_fwd_act_type fltr_act;
129 /* rule ID returned by firmware once filter rule is created */
133 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
135 enum ice_src_id src_id;
139 u8 mac_addr[ETH_ALEN];
142 u8 mac_addr[ETH_ALEN];
148 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
149 * if just using ethertype as filter. Set lkup_type as
150 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
151 * passed in as filter.
155 u8 mac_addr[ETH_ALEN]; /* optional */
157 } l_data; /* Make sure to zero out the memory of l_data before using
158 * it or only set the data associated with lookup match
159 * rest everything should be zero
162 /* Depending on filter action */
164 /* queue ID in case of ICE_FWD_TO_Q and starting
165 * queue ID in case of ICE_FWD_TO_QGRP.
176 /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
177 * determines the range of queues the packet needs to be forwarded to.
178 * Note that qgrp_size must be set to a power of 2.
182 /* Rule creations populate these indicators basing on the switch type */
183 u8 lb_en; /* Indicate if packet can be looped back */
184 u8 lan_en; /* Indicate if packet can be forwarded to the uplink */
187 struct ice_adv_lkup_elem {
188 enum ice_protocol_type type;
189 union ice_prot_hdr h_u; /* Header values */
190 union ice_prot_hdr m_u; /* Mask of header values to match */
193 struct ice_sw_act_ctrl {
194 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
197 enum ice_sw_fwd_act_type fltr_act;
198 /* Depending on filter action */
200 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
201 * queue ID in case of ICE_FWD_TO_QGRP.
208 /* software VSI handle */
213 struct ice_rule_query_data {
214 /* Recipe ID for which the requested rule was added */
216 /* Rule ID that was added or is supposed to be removed */
218 /* vsi_handle for which Rule was added or is supposed to be removed */
222 struct ice_adv_rule_info {
223 enum ice_sw_tunnel_type tun_type;
224 struct ice_sw_act_ctrl sw_act;
226 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
230 /* A collection of one or more four word recipe */
231 struct ice_sw_recipe {
232 /* For a chained recipe the root recipe is what should be used for
239 /* Number of extraction words */
241 /* Protocol ID and Offset pair (extraction word) to describe the
244 struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
245 u16 word_masks[ICE_MAX_CHAIN_WORDS];
247 /* if this recipe is a collection of other recipe */
250 /* if this recipe is part of another bigger recipe then chain index
251 * corresponding to this recipe
255 /* if this recipe is a collection of other recipe then count of other
256 * recipes and recipe IDs of those recipes
260 /* Bit map specifying the IDs associated with this group of recipe */
261 ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
263 enum ice_sw_tunnel_type tun_type;
265 /* List of type ice_fltr_mgmt_list_entry or adv_rule */
267 struct LIST_HEAD_TYPE filt_rules;
268 struct LIST_HEAD_TYPE filt_replay_rules;
270 struct ice_lock filt_rule_lock; /* protect filter rule structure */
272 /* Profiles this recipe should be associated with */
273 struct LIST_HEAD_TYPE fv_list;
275 /* Profiles this recipe is associated with */
276 u8 num_profs, *prof_ids;
278 /* Bit map for possible result indexes */
279 ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
281 /* This allows user to specify the recipe priority.
282 * For now, this becomes 'fwd_priority' when recipe
283 * is created, usually recipes can have 'fwd' and 'join'
288 struct LIST_HEAD_TYPE rg_list;
290 /* AQ buffer associated with this recipe */
291 struct ice_aqc_recipe_data_elem *root_buf;
292 /* This struct saves the fv_words for a given lookup */
293 struct ice_prot_lkup_ext lkup_exts;
296 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
297 struct ice_vsi_list_map_info {
298 struct LIST_ENTRY_TYPE list_entry;
299 ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
301 /* counter to track how many rules are reusing this VSI list */
305 struct ice_fltr_list_entry {
306 struct LIST_ENTRY_TYPE list_entry;
307 enum ice_status status;
308 struct ice_fltr_info fltr_info;
311 /* This defines an entry in the list that maintains MAC or VLAN membership
312 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
313 * VLAN. As an optimization the VSI list should be created only when a
314 * second VSI becomes a subscriber to the same MAC address. VSI lists are always
315 * used for VLAN membership.
317 struct ice_fltr_mgmt_list_entry {
318 /* back pointer to VSI list ID to VSI list mapping */
319 struct ice_vsi_list_map_info *vsi_list_info;
321 #define ICE_INVAL_LG_ACT_INDEX 0xffff
323 #define ICE_INVAL_SW_MARKER_ID 0xffff
325 struct LIST_ENTRY_TYPE list_entry;
326 struct ice_fltr_info fltr_info;
327 #define ICE_INVAL_COUNTER_ID 0xff
331 struct ice_adv_fltr_mgmt_list_entry {
332 struct LIST_ENTRY_TYPE list_entry;
334 struct ice_adv_lkup_elem *lkups;
335 struct ice_adv_rule_info rule_info;
337 struct ice_vsi_list_map_info *vsi_list_info;
341 enum ice_promisc_flags {
342 ICE_PROMISC_UCAST_RX = 0x1,
343 ICE_PROMISC_UCAST_TX = 0x2,
344 ICE_PROMISC_MCAST_RX = 0x4,
345 ICE_PROMISC_MCAST_TX = 0x8,
346 ICE_PROMISC_BCAST_RX = 0x10,
347 ICE_PROMISC_BCAST_TX = 0x20,
348 ICE_PROMISC_VLAN_RX = 0x40,
349 ICE_PROMISC_VLAN_TX = 0x80,
352 /* VSI related commands */
354 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
355 struct ice_sq_cd *cd);
357 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
358 bool keep_vsi_alloc, struct ice_sq_cd *cd);
360 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
361 struct ice_sq_cd *cd);
363 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
364 struct ice_sq_cd *cd);
366 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
367 bool keep_vsi_alloc, struct ice_sq_cd *cd);
369 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
370 struct ice_sq_cd *cd);
371 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
372 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
374 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
375 struct ice_sq_cd *cd);
377 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
378 u16 count, struct ice_mir_rule_buf *mr_buf,
379 struct ice_sq_cd *cd, u16 *rule_id);
381 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
382 struct ice_sq_cd *cd);
384 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
387 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
390 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
393 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
395 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
397 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
400 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
403 /* Switch/bridge related commands */
404 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
406 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
409 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
411 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
412 u16 buf_size, struct ice_sq_cd *cd);
414 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
415 struct ice_aqc_get_allocd_res_desc_resp *buf,
416 u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
417 struct ice_sq_cd *cd);
419 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
421 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
422 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
423 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
424 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
426 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
428 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
430 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
432 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
435 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
438 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
439 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
441 /* Promisc/defport setup for VSIs */
443 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
446 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
449 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
452 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
453 bool rm_vlan_promisc);
455 /* Get VSIs Promisc/defport settings */
457 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
460 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
464 ice_aq_add_recipe(struct ice_hw *hw,
465 struct ice_aqc_recipe_data_elem *s_recipe_list,
466 u16 num_recipes, struct ice_sq_cd *cd);
469 ice_aq_get_recipe(struct ice_hw *hw,
470 struct ice_aqc_recipe_data_elem *s_recipe_list,
471 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
473 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
474 struct ice_sq_cd *cd);
477 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
478 struct ice_sq_cd *cd);
480 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
482 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
483 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
484 struct ice_rule_query_data *added_entry);
486 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
488 ice_rem_adv_rule_by_id(struct ice_hw *hw,
489 struct ice_rule_query_data *remove_entry);
491 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
492 u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
494 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
497 ice_init_def_sw_recp(struct ice_hw *hw, struct ice_sw_recipe **recp_list);
498 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
499 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
502 ice_replay_vsi_all_fltr(struct ice_hw *hw, struct ice_port_info *pi,
504 void ice_rm_sw_replay_rule_info(struct ice_hw *hw, struct ice_switch_info *sw);
505 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
506 bool ice_is_prof_rule(enum ice_sw_tunnel_type type);
507 #endif /* _ICE_SWITCH_H_ */