drivers/net/ice/base/ice_switch.h

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