drivers/net/ice/base/ice_switch.h

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