1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2019
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)
19 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
20 #define ICE_MAX_RES_TYPES 0x80
21 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
22 (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
24 #define ICE_VSI_INVAL_ID 0xFFFF
25 #define ICE_INVAL_Q_HANDLE 0xFFFF
27 /* VSI context structure for add/get/update/free operations */
33 struct ice_aqc_vsi_props info;
34 struct ice_sched_vsi_info sched;
36 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
37 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
40 /* This is to be used by add/update mirror rule Admin Queue command */
41 struct ice_mir_rule_buf {
42 u16 vsi_idx; /* VSI index */
44 /* For each VSI, user can specify whether corresponding VSI
45 * should be added/removed to/from mirror rule
47 * add mirror rule: this should always be TRUE.
48 * update mirror rule: add(true) or remove(false) VSI to/from
54 /* Switch recipe ID enum values are specific to hardware */
55 enum ice_sw_lkup_type {
56 ICE_SW_LKUP_ETHERTYPE = 0,
58 ICE_SW_LKUP_MAC_VLAN = 2,
59 ICE_SW_LKUP_PROMISC = 3,
62 ICE_SW_LKUP_ETHERTYPE_MAC = 8,
63 ICE_SW_LKUP_PROMISC_VLAN = 9,
67 /* type of filter src ID */
69 ICE_SRC_ID_UNKNOWN = 0,
75 struct ice_fltr_info {
76 /* Look up information: how to look up packet */
77 enum ice_sw_lkup_type lkup_type;
78 /* Forward action: filter action to do after lookup */
79 enum ice_sw_fwd_act_type fltr_act;
80 /* rule ID returned by firmware once filter rule is created */
84 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
86 enum ice_src_id src_id;
90 u8 mac_addr[ETH_ALEN];
93 u8 mac_addr[ETH_ALEN];
99 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
100 * if just using ethertype as filter. Set lkup_type as
101 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
102 * passed in as filter.
106 u8 mac_addr[ETH_ALEN]; /* optional */
108 } l_data; /* Make sure to zero out the memory of l_data before using
109 * it or only set the data associated with lookup match
110 * rest everything should be zero
113 /* Depending on filter action */
115 /* queue ID in case of ICE_FWD_TO_Q and starting
116 * queue ID in case of ICE_FWD_TO_QGRP.
127 /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
128 * determines the range of queues the packet needs to be forwarded to.
129 * Note that qgrp_size must be set to a power of 2.
133 /* Rule creations populate these indicators basing on the switch type */
134 u8 lb_en; /* Indicate if packet can be looped back */
135 u8 lan_en; /* Indicate if packet can be forwarded to the uplink */
138 struct ice_adv_lkup_elem {
139 enum ice_protocol_type type;
140 union ice_prot_hdr h_u; /* Header values */
141 union ice_prot_hdr m_u; /* Mask of header values to match */
144 struct ice_sw_act_ctrl {
145 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
148 enum ice_sw_fwd_act_type fltr_act;
149 /* Depending on filter action */
151 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
152 * queue ID in case of ICE_FWD_TO_QGRP.
159 /* software VSI handle */
164 struct ice_rule_query_data {
165 /* Recipe ID for which the requested rule was added */
167 /* Rule ID that was added or is supposed to be removed */
169 /* vsi_handle for which Rule was added or is supposed to be removed */
173 struct ice_adv_rule_info {
174 enum ice_sw_tunnel_type tun_type;
175 struct ice_sw_act_ctrl sw_act;
177 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
181 /* A collection of one or more four word recipe */
182 struct ice_sw_recipe {
183 /* For a chained recipe the root recipe is what should be used for
189 /* Number of extraction words */
191 /* Protocol ID and Offset pair (extraction word) to describe the
194 struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
195 u16 word_masks[ICE_MAX_CHAIN_WORDS];
197 /* if this recipe is a collection of other recipe */
200 /* if this recipe is part of another bigger recipe then chain index
201 * corresponding to this recipe
205 /* if this recipe is a collection of other recipe then count of other
206 * recipes and recipe IDs of those recipes
210 /* Bit map specifying the IDs associated with this group of recipe */
211 ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
213 enum ice_sw_tunnel_type tun_type;
215 /* List of type ice_fltr_mgmt_list_entry or adv_rule */
217 struct LIST_HEAD_TYPE filt_rules;
218 struct LIST_HEAD_TYPE filt_replay_rules;
220 struct ice_lock filt_rule_lock; /* protect filter rule structure */
222 /* Profiles this recipe should be associated with */
223 struct LIST_HEAD_TYPE fv_list;
225 #define ICE_MAX_NUM_PROFILES 256
226 /* Profiles this recipe is associated with */
227 u8 num_profs, *prof_ids;
229 /* This allows user to specify the recipe priority.
230 * For now, this becomes 'fwd_priority' when recipe
231 * is created, usually recipes can have 'fwd' and 'join'
236 struct LIST_HEAD_TYPE rg_list;
238 /* AQ buffer associated with this recipe */
239 struct ice_aqc_recipe_data_elem *root_buf;
240 /* This struct saves the fv_words for a given lookup */
241 struct ice_prot_lkup_ext lkup_exts;
244 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
245 struct ice_vsi_list_map_info {
246 struct LIST_ENTRY_TYPE list_entry;
247 ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
249 /* counter to track how many rules are reusing this VSI list */
253 struct ice_fltr_list_entry {
254 struct LIST_ENTRY_TYPE list_entry;
255 enum ice_status status;
256 struct ice_fltr_info fltr_info;
259 /* This defines an entry in the list that maintains MAC or VLAN membership
260 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
261 * VLAN. As an optimization the VSI list should be created only when a
262 * second VSI becomes a subscriber to the same MAC address. VSI lists are always
263 * used for VLAN membership.
265 struct ice_fltr_mgmt_list_entry {
266 /* back pointer to VSI list ID to VSI list mapping */
267 struct ice_vsi_list_map_info *vsi_list_info;
269 #define ICE_INVAL_LG_ACT_INDEX 0xffff
271 #define ICE_INVAL_SW_MARKER_ID 0xffff
273 struct LIST_ENTRY_TYPE list_entry;
274 struct ice_fltr_info fltr_info;
275 #define ICE_INVAL_COUNTER_ID 0xff
279 struct ice_adv_fltr_mgmt_list_entry {
280 struct LIST_ENTRY_TYPE list_entry;
282 struct ice_adv_lkup_elem *lkups;
283 struct ice_adv_rule_info rule_info;
285 struct ice_vsi_list_map_info *vsi_list_info;
289 enum ice_promisc_flags {
290 ICE_PROMISC_UCAST_RX = 0x1,
291 ICE_PROMISC_UCAST_TX = 0x2,
292 ICE_PROMISC_MCAST_RX = 0x4,
293 ICE_PROMISC_MCAST_TX = 0x8,
294 ICE_PROMISC_BCAST_RX = 0x10,
295 ICE_PROMISC_BCAST_TX = 0x20,
296 ICE_PROMISC_VLAN_RX = 0x40,
297 ICE_PROMISC_VLAN_TX = 0x80,
300 /* VSI related commands */
302 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
303 struct ice_sq_cd *cd);
305 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
306 bool keep_vsi_alloc, struct ice_sq_cd *cd);
308 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
309 struct ice_sq_cd *cd);
311 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
312 struct ice_sq_cd *cd);
314 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
315 bool keep_vsi_alloc, struct ice_sq_cd *cd);
317 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
318 struct ice_sq_cd *cd);
319 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
320 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
322 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
323 struct ice_sq_cd *cd);
325 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
326 u16 count, struct ice_mir_rule_buf *mr_buf,
327 struct ice_sq_cd *cd, u16 *rule_id);
329 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
330 struct ice_sq_cd *cd);
332 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
335 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
338 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
341 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
343 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
345 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
348 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
351 /* Switch/bridge related commands */
352 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
354 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
357 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
359 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
360 u16 buf_size, struct ice_sq_cd *cd);
362 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
363 struct ice_aqc_get_allocd_res_desc_resp *buf,
364 u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
365 struct ice_sq_cd *cd);
367 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
369 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
370 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
371 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
372 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
374 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
376 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
378 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
380 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
383 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
386 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
387 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
390 /* Promisc/defport setup for VSIs */
392 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
395 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
398 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
401 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
402 bool rm_vlan_promisc);
404 /* Get VSIs Promisc/defport settings */
406 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
409 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
413 ice_aq_add_recipe(struct ice_hw *hw,
414 struct ice_aqc_recipe_data_elem *s_recipe_list,
415 u16 num_recipes, struct ice_sq_cd *cd);
418 ice_aq_get_recipe(struct ice_hw *hw,
419 struct ice_aqc_recipe_data_elem *s_recipe_list,
420 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
422 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
423 struct ice_sq_cd *cd);
426 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
427 struct ice_sq_cd *cd);
429 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
431 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
432 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
433 struct ice_rule_query_data *added_entry);
435 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
437 ice_rem_adv_rule_by_id(struct ice_hw *hw,
438 struct ice_rule_query_data *remove_entry);
440 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
441 u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
443 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
445 enum ice_status ice_init_def_sw_recp(struct ice_hw *hw);
446 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
447 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
449 enum ice_status ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle);
450 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
452 #endif /* _ICE_SWITCH_H_ */