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