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