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