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)
18 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
19 #define ICE_MAX_RES_TYPES 0x80
20 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
21 (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
23 #define ICE_VSI_INVAL_ID 0xFFFF
24 #define ICE_INVAL_Q_HANDLE 0xFFFF
26 /* VSI context structure for add/get/update/free operations */
32 struct ice_aqc_vsi_props info;
33 struct ice_sched_vsi_info sched;
35 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
36 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
39 /* This is to be used by add/update mirror rule Admin Queue command */
40 struct ice_mir_rule_buf {
41 u16 vsi_idx; /* VSI index */
43 /* For each VSI, user can specify whether corresponding VSI
44 * should be added/removed to/from mirror rule
46 * add mirror rule: this should always be TRUE.
47 * update mirror rule: add(true) or remove(false) VSI to/from
53 /* Switch recipe ID enum values are specific to hardware */
54 enum ice_sw_lkup_type {
55 ICE_SW_LKUP_ETHERTYPE = 0,
57 ICE_SW_LKUP_MAC_VLAN = 2,
58 ICE_SW_LKUP_PROMISC = 3,
61 ICE_SW_LKUP_ETHERTYPE_MAC = 8,
62 ICE_SW_LKUP_PROMISC_VLAN = 9,
66 /* type of filter src ID */
68 ICE_SRC_ID_UNKNOWN = 0,
74 struct ice_fltr_info {
75 /* Look up information: how to look up packet */
76 enum ice_sw_lkup_type lkup_type;
77 /* Forward action: filter action to do after lookup */
78 enum ice_sw_fwd_act_type fltr_act;
79 /* rule ID returned by firmware once filter rule is created */
83 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
85 enum ice_src_id src_id;
89 u8 mac_addr[ETH_ALEN];
92 u8 mac_addr[ETH_ALEN];
98 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
99 * if just using ethertype as filter. Set lkup_type as
100 * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
101 * passed in as filter.
105 u8 mac_addr[ETH_ALEN]; /* optional */
107 } l_data; /* Make sure to zero out the memory of l_data before using
108 * it or only set the data associated with lookup match
109 * rest everything should be zero
112 /* Depending on filter action */
114 /* queue ID in case of ICE_FWD_TO_Q and starting
115 * queue ID in case of ICE_FWD_TO_QGRP.
126 /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
127 * determines the range of queues the packet needs to be forwarded to.
128 * Note that qgrp_size must be set to a power of 2.
132 /* Rule creations populate these indicators basing on the switch type */
133 u8 lb_en; /* Indicate if packet can be looped back */
134 u8 lan_en; /* Indicate if packet can be forwarded to the uplink */
137 struct ice_adv_lkup_elem {
138 enum ice_protocol_type type;
139 union ice_prot_hdr h_u; /* Header values */
140 union ice_prot_hdr m_u; /* Mask of header values to match */
143 struct ice_sw_act_ctrl {
144 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
147 enum ice_sw_fwd_act_type fltr_act;
148 /* Depending on filter action */
150 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
151 * queue ID in case of ICE_FWD_TO_QGRP.
158 /* software VSI handle */
163 struct ice_rule_query_data {
164 /* Recipe ID for which the requested rule was added */
166 /* Rule ID that was added or is supposed to be removed */
168 /* vsi_handle for which Rule was added or is supposed to be removed */
172 struct ice_adv_rule_info {
173 enum ice_sw_tunnel_type tun_type;
174 struct ice_sw_act_ctrl sw_act;
176 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
180 /* A collection of one or more four word recipe */
181 struct ice_sw_recipe {
182 /* 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 /* Possible result indexes are 44, 45, 46 and 47 */
230 #define ICE_POSSIBLE_RES_IDX 0x0000F00000000000ULL
231 ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
233 /* This allows user to specify the recipe priority.
234 * For now, this becomes 'fwd_priority' when recipe
235 * is created, usually recipes can have 'fwd' and 'join'
240 struct LIST_HEAD_TYPE rg_list;
242 /* AQ buffer associated with this recipe */
243 struct ice_aqc_recipe_data_elem *root_buf;
244 /* This struct saves the fv_words for a given lookup */
245 struct ice_prot_lkup_ext lkup_exts;
248 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
249 struct ice_vsi_list_map_info {
250 struct LIST_ENTRY_TYPE list_entry;
251 ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
253 /* counter to track how many rules are reusing this VSI list */
257 struct ice_fltr_list_entry {
258 struct LIST_ENTRY_TYPE list_entry;
259 enum ice_status status;
260 struct ice_fltr_info fltr_info;
263 /* This defines an entry in the list that maintains MAC or VLAN membership
264 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
265 * VLAN. As an optimization the VSI list should be created only when a
266 * second VSI becomes a subscriber to the same MAC address. VSI lists are always
267 * used for VLAN membership.
269 struct ice_fltr_mgmt_list_entry {
270 /* back pointer to VSI list ID to VSI list mapping */
271 struct ice_vsi_list_map_info *vsi_list_info;
273 #define ICE_INVAL_LG_ACT_INDEX 0xffff
275 #define ICE_INVAL_SW_MARKER_ID 0xffff
277 struct LIST_ENTRY_TYPE list_entry;
278 struct ice_fltr_info fltr_info;
279 #define ICE_INVAL_COUNTER_ID 0xff
283 struct ice_adv_fltr_mgmt_list_entry {
284 struct LIST_ENTRY_TYPE list_entry;
286 struct ice_adv_lkup_elem *lkups;
287 struct ice_adv_rule_info rule_info;
289 struct ice_vsi_list_map_info *vsi_list_info;
293 enum ice_promisc_flags {
294 ICE_PROMISC_UCAST_RX = 0x1,
295 ICE_PROMISC_UCAST_TX = 0x2,
296 ICE_PROMISC_MCAST_RX = 0x4,
297 ICE_PROMISC_MCAST_TX = 0x8,
298 ICE_PROMISC_BCAST_RX = 0x10,
299 ICE_PROMISC_BCAST_TX = 0x20,
300 ICE_PROMISC_VLAN_RX = 0x40,
301 ICE_PROMISC_VLAN_TX = 0x80,
304 /* VSI related commands */
306 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
307 struct ice_sq_cd *cd);
309 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
310 bool keep_vsi_alloc, struct ice_sq_cd *cd);
312 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
313 struct ice_sq_cd *cd);
315 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
316 struct ice_sq_cd *cd);
318 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
319 bool keep_vsi_alloc, struct ice_sq_cd *cd);
321 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
322 struct ice_sq_cd *cd);
323 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
324 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
326 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
327 struct ice_sq_cd *cd);
329 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
330 u16 count, struct ice_mir_rule_buf *mr_buf,
331 struct ice_sq_cd *cd, u16 *rule_id);
333 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
334 struct ice_sq_cd *cd);
336 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
339 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
342 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
345 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
347 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
349 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
352 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
355 /* Switch/bridge related commands */
356 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
358 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
361 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
363 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
364 u16 buf_size, struct ice_sq_cd *cd);
366 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
367 struct ice_aqc_get_allocd_res_desc_resp *buf,
368 u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
369 struct ice_sq_cd *cd);
371 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
373 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
374 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
375 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
376 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
378 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
380 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
382 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
384 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
387 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
390 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
391 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
393 /* Promisc/defport setup for VSIs */
395 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
398 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
401 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
404 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
405 bool rm_vlan_promisc);
407 /* Get VSIs Promisc/defport settings */
409 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
412 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
416 ice_aq_add_recipe(struct ice_hw *hw,
417 struct ice_aqc_recipe_data_elem *s_recipe_list,
418 u16 num_recipes, struct ice_sq_cd *cd);
421 ice_aq_get_recipe(struct ice_hw *hw,
422 struct ice_aqc_recipe_data_elem *s_recipe_list,
423 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
425 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
426 struct ice_sq_cd *cd);
429 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
430 struct ice_sq_cd *cd);
432 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
434 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
435 u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
436 struct ice_rule_query_data *added_entry);
438 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
440 ice_rem_adv_rule_by_id(struct ice_hw *hw,
441 struct ice_rule_query_data *remove_entry);
443 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
444 u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
446 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
448 enum ice_status ice_init_def_sw_recp(struct ice_hw *hw);
449 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
450 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
452 enum ice_status ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle);
453 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
455 #endif /* _ICE_SWITCH_H_ */