1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2001-2019 3 */ 4 5 #ifndef _ICE_SWITCH_H_ 6 #define _ICE_SWITCH_H_ 7 8 #include "ice_common.h" 9 #include "ice_protocol_type.h" 10 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) 17 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)) 22 23 #define ICE_VSI_INVAL_ID 0xFFFF 24 #define ICE_INVAL_Q_HANDLE 0xFFFF 25 26 /* VSI context structure for add/get/update/free operations */ 27 struct ice_vsi_ctx { 28 u16 vsi_num; 29 u16 vsis_allocd; 30 u16 vsis_unallocated; 31 u16 flags; 32 struct ice_aqc_vsi_props info; 33 struct ice_sched_vsi_info sched; 34 u8 alloc_from_pool; 35 u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS]; 36 struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS]; 37 }; 38 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 */ 42 43 /* For each VSI, user can specify whether corresponding VSI 44 * should be added/removed to/from mirror rule 45 * 46 * add mirror rule: this should always be TRUE. 47 * update mirror rule: add(true) or remove(false) VSI to/from 48 * mirror rule 49 */ 50 u8 add; 51 }; 52 53 /* Switch recipe ID enum values are specific to hardware */ 54 enum ice_sw_lkup_type { 55 ICE_SW_LKUP_ETHERTYPE = 0, 56 ICE_SW_LKUP_MAC = 1, 57 ICE_SW_LKUP_MAC_VLAN = 2, 58 ICE_SW_LKUP_PROMISC = 3, 59 ICE_SW_LKUP_VLAN = 4, 60 ICE_SW_LKUP_DFLT = 5, 61 ICE_SW_LKUP_ETHERTYPE_MAC = 8, 62 ICE_SW_LKUP_PROMISC_VLAN = 9, 63 ICE_SW_LKUP_LAST 64 }; 65 66 /* type of filter src ID */ 67 enum ice_src_id { 68 ICE_SRC_ID_UNKNOWN = 0, 69 ICE_SRC_ID_VSI, 70 ICE_SRC_ID_QUEUE, 71 ICE_SRC_ID_LPORT, 72 }; 73 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 */ 80 u16 fltr_rule_id; 81 u16 flag; 82 83 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */ 84 u16 src; 85 enum ice_src_id src_id; 86 87 union { 88 struct { 89 u8 mac_addr[ETH_ALEN]; 90 } mac; 91 struct { 92 u8 mac_addr[ETH_ALEN]; 93 u16 vlan_id; 94 } mac_vlan; 95 struct { 96 u16 vlan_id; 97 } vlan; 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. 102 */ 103 struct { 104 u16 ethertype; 105 u8 mac_addr[ETH_ALEN]; /* optional */ 106 } ethertype_mac; 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 110 */ 111 112 /* Depending on filter action */ 113 union { 114 /* queue ID in case of ICE_FWD_TO_Q and starting 115 * queue ID in case of ICE_FWD_TO_QGRP. 116 */ 117 u16 q_id:11; 118 u16 hw_vsi_id:10; 119 u16 vsi_id:10; 120 u16 vsi_list_id:10; 121 } fwd_id; 122 123 /* Sw VSI handle */ 124 u16 vsi_handle; 125 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. 129 */ 130 u8 qgrp_size; 131 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 */ 135 }; 136 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 */ 141 }; 142 143 struct ice_sw_act_ctrl { 144 /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */ 145 u16 src; 146 u16 flag; 147 enum ice_sw_fwd_act_type fltr_act; 148 /* Depending on filter action */ 149 union { 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. 152 */ 153 u16 q_id:11; 154 u16 vsi_id:10; 155 u16 hw_vsi_id:10; 156 u16 vsi_list_id:10; 157 } fwd_id; 158 /* software VSI handle */ 159 u16 vsi_handle; 160 u8 qgrp_size; 161 }; 162 163 struct ice_rule_query_data { 164 /* Recipe ID for which the requested rule was added */ 165 u16 rid; 166 /* Rule ID that was added or is supposed to be removed */ 167 u16 rule_id; 168 /* vsi_handle for which Rule was added or is supposed to be removed */ 169 u16 vsi_handle; 170 }; 171 172 struct ice_adv_rule_info { 173 enum ice_sw_tunnel_type tun_type; 174 struct ice_sw_act_ctrl sw_act; 175 u32 priority; 176 u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */ 177 u16 fltr_rule_id; 178 }; 179 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 183 * programming rules 184 */ 185 u8 is_root; 186 u8 root_rid; 187 u8 recp_created; 188 189 /* Number of extraction words */ 190 u8 n_ext_words; 191 /* Protocol ID and Offset pair (extraction word) to describe the 192 * recipe 193 */ 194 struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS]; 195 u16 word_masks[ICE_MAX_CHAIN_WORDS]; 196 197 /* if this recipe is a collection of other recipe */ 198 u8 big_recp; 199 200 /* if this recipe is part of another bigger recipe then chain index 201 * corresponding to this recipe 202 */ 203 u8 chain_idx; 204 205 /* if this recipe is a collection of other recipe then count of other 206 * recipes and recipe IDs of those recipes 207 */ 208 u8 n_grp_count; 209 210 /* Bit map specifying the IDs associated with this group of recipe */ 211 ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES); 212 213 enum ice_sw_tunnel_type tun_type; 214 215 /* List of type ice_fltr_mgmt_list_entry or adv_rule */ 216 u8 adv_rule; 217 struct LIST_HEAD_TYPE filt_rules; 218 struct LIST_HEAD_TYPE filt_replay_rules; 219 220 struct ice_lock filt_rule_lock; /* protect filter rule structure */ 221 222 /* Profiles this recipe should be associated with */ 223 struct LIST_HEAD_TYPE fv_list; 224 225 /* Profiles this recipe is associated with */ 226 u8 num_profs, *prof_ids; 227 228 /* Possible result indexes are 44, 45, 46 and 47 */ 229 #define ICE_POSSIBLE_RES_IDX 0x0000F00000000000ULL 230 ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS); 231 232 /* This allows user to specify the recipe priority. 233 * For now, this becomes 'fwd_priority' when recipe 234 * is created, usually recipes can have 'fwd' and 'join' 235 * priority. 236 */ 237 u8 priority; 238 239 struct LIST_HEAD_TYPE rg_list; 240 241 /* AQ buffer associated with this recipe */ 242 struct ice_aqc_recipe_data_elem *root_buf; 243 /* This struct saves the fv_words for a given lookup */ 244 struct ice_prot_lkup_ext lkup_exts; 245 }; 246 247 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */ 248 struct ice_vsi_list_map_info { 249 struct LIST_ENTRY_TYPE list_entry; 250 ice_declare_bitmap(vsi_map, ICE_MAX_VSI); 251 u16 vsi_list_id; 252 /* counter to track how many rules are reusing this VSI list */ 253 u16 ref_cnt; 254 }; 255 256 struct ice_fltr_list_entry { 257 struct LIST_ENTRY_TYPE list_entry; 258 enum ice_status status; 259 struct ice_fltr_info fltr_info; 260 }; 261 262 /* This defines an entry in the list that maintains MAC or VLAN membership 263 * to HW list mapping, since multiple VSIs can subscribe to the same MAC or 264 * VLAN. As an optimization the VSI list should be created only when a 265 * second VSI becomes a subscriber to the same MAC address. VSI lists are always 266 * used for VLAN membership. 267 */ 268 struct ice_fltr_mgmt_list_entry { 269 /* back pointer to VSI list ID to VSI list mapping */ 270 struct ice_vsi_list_map_info *vsi_list_info; 271 u16 vsi_count; 272 #define ICE_INVAL_LG_ACT_INDEX 0xffff 273 u16 lg_act_idx; 274 #define ICE_INVAL_SW_MARKER_ID 0xffff 275 u16 sw_marker_id; 276 struct LIST_ENTRY_TYPE list_entry; 277 struct ice_fltr_info fltr_info; 278 #define ICE_INVAL_COUNTER_ID 0xff 279 u8 counter_index; 280 }; 281 282 struct ice_adv_fltr_mgmt_list_entry { 283 struct LIST_ENTRY_TYPE list_entry; 284 285 struct ice_adv_lkup_elem *lkups; 286 struct ice_adv_rule_info rule_info; 287 u16 lkups_cnt; 288 struct ice_vsi_list_map_info *vsi_list_info; 289 u16 vsi_count; 290 }; 291 292 enum ice_promisc_flags { 293 ICE_PROMISC_UCAST_RX = 0x1, 294 ICE_PROMISC_UCAST_TX = 0x2, 295 ICE_PROMISC_MCAST_RX = 0x4, 296 ICE_PROMISC_MCAST_TX = 0x8, 297 ICE_PROMISC_BCAST_RX = 0x10, 298 ICE_PROMISC_BCAST_TX = 0x20, 299 ICE_PROMISC_VLAN_RX = 0x40, 300 ICE_PROMISC_VLAN_TX = 0x80, 301 }; 302 303 /* VSI related commands */ 304 enum ice_status 305 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx, 306 struct ice_sq_cd *cd); 307 enum ice_status 308 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx, 309 bool keep_vsi_alloc, struct ice_sq_cd *cd); 310 enum ice_status 311 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx, 312 struct ice_sq_cd *cd); 313 enum ice_status 314 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx, 315 struct ice_sq_cd *cd); 316 enum ice_status 317 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx, 318 bool keep_vsi_alloc, struct ice_sq_cd *cd); 319 enum ice_status 320 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx, 321 struct ice_sq_cd *cd); 322 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle); 323 void ice_clear_all_vsi_ctx(struct ice_hw *hw); 324 enum ice_status 325 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx, 326 struct ice_sq_cd *cd); 327 enum ice_status 328 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi, 329 u16 count, struct ice_mir_rule_buf *mr_buf, 330 struct ice_sq_cd *cd, u16 *rule_id); 331 enum ice_status 332 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd, 333 struct ice_sq_cd *cd); 334 enum ice_status 335 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh, 336 u32 *ctl_bitmask); 337 enum ice_status 338 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh, 339 u32 ctl_bitmask); 340 /* Switch config */ 341 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw); 342 343 enum ice_status 344 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id); 345 enum ice_status 346 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id); 347 enum ice_status 348 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items, 349 u16 *counter_id); 350 enum ice_status 351 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items, 352 u16 counter_id); 353 354 /* Switch/bridge related commands */ 355 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw); 356 enum ice_status 357 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id, 358 u16 *counter_id); 359 enum ice_status 360 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id); 361 enum ice_status 362 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf, 363 u16 buf_size, struct ice_sq_cd *cd); 364 enum ice_status 365 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries, 366 struct ice_aqc_get_allocd_res_desc_resp *buf, 367 u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id, 368 struct ice_sq_cd *cd); 369 enum ice_status 370 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list); 371 enum ice_status 372 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list); 373 void ice_rem_all_sw_rules_info(struct ice_hw *hw); 374 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst); 375 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst); 376 enum ice_status 377 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list); 378 enum ice_status 379 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list); 380 enum ice_status 381 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list); 382 enum ice_status 383 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list); 384 385 enum ice_status 386 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info, 387 u16 sw_marker); 388 enum ice_status 389 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info); 390 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle); 391 392 /* Promisc/defport setup for VSIs */ 393 enum ice_status 394 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set, 395 u8 direction); 396 enum ice_status 397 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask, 398 u16 vid); 399 enum ice_status 400 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask, 401 u16 vid); 402 enum ice_status 403 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask, 404 bool rm_vlan_promisc); 405 406 /* Get VSIs Promisc/defport settings */ 407 enum ice_status 408 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask, 409 u16 *vid); 410 enum ice_status 411 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask, 412 u16 *vid); 413 414 enum ice_status 415 ice_aq_add_recipe(struct ice_hw *hw, 416 struct ice_aqc_recipe_data_elem *s_recipe_list, 417 u16 num_recipes, struct ice_sq_cd *cd); 418 419 enum ice_status 420 ice_aq_get_recipe(struct ice_hw *hw, 421 struct ice_aqc_recipe_data_elem *s_recipe_list, 422 u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd); 423 enum ice_status 424 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap, 425 struct ice_sq_cd *cd); 426 427 enum ice_status 428 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap, 429 struct ice_sq_cd *cd); 430 431 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id); 432 enum ice_status 433 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups, 434 u16 lkups_cnt, struct ice_adv_rule_info *rinfo, 435 struct ice_rule_query_data *added_entry); 436 enum ice_status 437 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle); 438 enum ice_status 439 ice_rem_adv_rule_by_id(struct ice_hw *hw, 440 struct ice_rule_query_data *remove_entry); 441 enum ice_status 442 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups, 443 u16 lkups_cnt, struct ice_adv_rule_info *rinfo); 444 445 enum ice_status ice_replay_all_fltr(struct ice_hw *hw); 446 447 enum ice_status ice_init_def_sw_recp(struct ice_hw *hw); 448 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle); 449 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle); 450 451 enum ice_status ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle); 452 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw); 453 454 #endif /* _ICE_SWITCH_H_ */ 455