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