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 #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
  19 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
  20 #define ICE_MAX_RES_TYPES 0x80
  21 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
  22         (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
  23
  24 #define ICE_VSI_INVAL_ID 0xFFFF
  25 #define ICE_INVAL_Q_HANDLE 0xFFFF
  26
  27 /* VSI context structure for add/get/update/free operations */
  28 struct ice_vsi_ctx {
  29         u16 vsi_num;
  30         u16 vsis_allocd;
  31         u16 vsis_unallocated;
  32         u16 flags;
  33         struct ice_aqc_vsi_props info;
  34         struct ice_sched_vsi_info sched;
  35         u8 alloc_from_pool;
  36         u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
  37         struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
  38 };
  39
  40 /* This is to be used by add/update mirror rule Admin Queue command */
  41 struct ice_mir_rule_buf {
  42         u16 vsi_idx; /* VSI index */
  43
  44         /* For each VSI, user can specify whether corresponding VSI
  45          * should be added/removed to/from mirror rule
  46          *
  47          * add mirror rule: this should always be TRUE.
  48          * update mirror rule:  add(true) or remove(false) VSI to/from
  49          * mirror rule
  50          */
  51         u8 add;
  52 };
  53
  54 /* Switch recipe ID enum values are specific to hardware */
  55 enum ice_sw_lkup_type {
  56         ICE_SW_LKUP_ETHERTYPE = 0,
  57         ICE_SW_LKUP_MAC = 1,
  58         ICE_SW_LKUP_MAC_VLAN = 2,
  59         ICE_SW_LKUP_PROMISC = 3,
  60         ICE_SW_LKUP_VLAN = 4,
  61         ICE_SW_LKUP_DFLT = 5,
  62         ICE_SW_LKUP_ETHERTYPE_MAC = 8,
  63         ICE_SW_LKUP_PROMISC_VLAN = 9,
  64         ICE_SW_LKUP_LAST
  65 };
  66
  67 /* type of filter src ID */
  68 enum ice_src_id {
  69         ICE_SRC_ID_UNKNOWN = 0,
  70         ICE_SRC_ID_VSI,
  71         ICE_SRC_ID_QUEUE,
  72         ICE_SRC_ID_LPORT,
  73 };
  74
  75 struct ice_fltr_info {
  76         /* Look up information: how to look up packet */
  77         enum ice_sw_lkup_type lkup_type;
  78         /* Forward action: filter action to do after lookup */
  79         enum ice_sw_fwd_act_type fltr_act;
  80         /* rule ID returned by firmware once filter rule is created */
  81         u16 fltr_rule_id;
  82         u16 flag;
  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         enum ice_sw_fwd_act_type fltr_act;
 149         /* Depending on filter action */
 150         union {
 151                 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
 152                  * queue ID in case of ICE_FWD_TO_QGRP.
 153                  */
 154                 u16 q_id:11;
 155                 u16 vsi_id:10;
 156                 u16 hw_vsi_id:10;
 157                 u16 vsi_list_id:10;
 158         } fwd_id;
 159         /* software VSI handle */
 160         u16 vsi_handle;
 161         u8 qgrp_size;
 162 };
 163
 164 struct ice_rule_query_data {
 165         /* Recipe ID for which the requested rule was added */
 166         u16 rid;
 167         /* Rule ID that was added or is supposed to be removed */
 168         u16 rule_id;
 169         /* vsi_handle for which Rule was added or is supposed to be removed */
 170         u16 vsi_handle;
 171 };
 172
 173 struct ice_adv_rule_info {
 174         enum ice_sw_tunnel_type tun_type;
 175         struct ice_sw_act_ctrl sw_act;
 176         u32 priority;
 177         u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
 178         u16 fltr_rule_id;
 179 };
 180
 181 /* A collection of one or more four word recipe */
 182 struct ice_sw_recipe {
 183         /* For a chained recipe the root recipe is what should be used for
 184          * programming rules
 185          */
 186         u8 is_root;
 187         u8 root_rid;
 188         u8 recp_created;
 189
 190         /* Number of extraction words */
 191         u8 n_ext_words;
 192         /* Protocol ID and Offset pair (extraction word) to describe the
 193          * recipe
 194          */
 195         struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
 196         u16 word_masks[ICE_MAX_CHAIN_WORDS];
 197
 198         /* if this recipe is a collection of other recipe */
 199         u8 big_recp;
 200
 201         /* if this recipe is part of another bigger recipe then chain index
 202          * corresponding to this recipe
 203          */
 204         u8 chain_idx;
 205
 206         /* if this recipe is a collection of other recipe then count of other
 207          * recipes and recipe IDs of those recipes
 208          */
 209         u8 n_grp_count;
 210
 211         /* Bit map specifying the IDs associated with this group of recipe */
 212         ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
 213
 214         enum ice_sw_tunnel_type tun_type;
 215
 216         /* List of type ice_fltr_mgmt_list_entry or adv_rule */
 217         u8 adv_rule;
 218         struct LIST_HEAD_TYPE filt_rules;
 219         struct LIST_HEAD_TYPE filt_replay_rules;
 220
 221         struct ice_lock filt_rule_lock; /* protect filter rule structure */
 222
 223         /* Profiles this recipe should be associated with */
 224         struct LIST_HEAD_TYPE fv_list;
 225
 226 #define ICE_MAX_NUM_PROFILES 256
 227         /* Profiles this recipe is associated with */
 228         u8 num_profs, *prof_ids;
 229
 230         /* Possible result indexes are 44, 45, 46 and 47 */
 231 #define ICE_POSSIBLE_RES_IDX 0x0000F00000000000ULL
 232         ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
 233
 234         /* This allows user to specify the recipe priority.
 235          * For now, this becomes 'fwd_priority' when recipe
 236          * is created, usually recipes can have 'fwd' and 'join'
 237          * priority.
 238          */
 239         u8 priority;
 240
 241         struct LIST_HEAD_TYPE rg_list;
 242
 243         /* AQ buffer associated with this recipe */
 244         struct ice_aqc_recipe_data_elem *root_buf;
 245         /* This struct saves the fv_words for a given lookup */
 246         struct ice_prot_lkup_ext lkup_exts;
 247 };
 248
 249 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
 250 struct ice_vsi_list_map_info {
 251         struct LIST_ENTRY_TYPE list_entry;
 252         ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
 253         u16 vsi_list_id;
 254         /* counter to track how many rules are reusing this VSI list */
 255         u16 ref_cnt;
 256 };
 257
 258 struct ice_fltr_list_entry {
 259         struct LIST_ENTRY_TYPE list_entry;
 260         enum ice_status status;
 261         struct ice_fltr_info fltr_info;
 262 };
 263
 264 /* This defines an entry in the list that maintains MAC or VLAN membership
 265  * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
 266  * VLAN. As an optimization the VSI list should be created only when a
 267  * second VSI becomes a subscriber to the same MAC address. VSI lists are always
 268  * used for VLAN membership.
 269  */
 270 struct ice_fltr_mgmt_list_entry {
 271         /* back pointer to VSI list ID to VSI list mapping */
 272         struct ice_vsi_list_map_info *vsi_list_info;
 273         u16 vsi_count;
 274 #define ICE_INVAL_LG_ACT_INDEX 0xffff
 275         u16 lg_act_idx;
 276 #define ICE_INVAL_SW_MARKER_ID 0xffff
 277         u16 sw_marker_id;
 278         struct LIST_ENTRY_TYPE list_entry;
 279         struct ice_fltr_info fltr_info;
 280 #define ICE_INVAL_COUNTER_ID 0xff
 281         u8 counter_index;
 282 };
 283
 284 struct ice_adv_fltr_mgmt_list_entry {
 285         struct LIST_ENTRY_TYPE list_entry;
 286
 287         struct ice_adv_lkup_elem *lkups;
 288         struct ice_adv_rule_info rule_info;
 289         u16 lkups_cnt;
 290         struct ice_vsi_list_map_info *vsi_list_info;
 291         u16 vsi_count;
 292 };
 293
 294 enum ice_promisc_flags {
 295         ICE_PROMISC_UCAST_RX = 0x1,
 296         ICE_PROMISC_UCAST_TX = 0x2,
 297         ICE_PROMISC_MCAST_RX = 0x4,
 298         ICE_PROMISC_MCAST_TX = 0x8,
 299         ICE_PROMISC_BCAST_RX = 0x10,
 300         ICE_PROMISC_BCAST_TX = 0x20,
 301         ICE_PROMISC_VLAN_RX = 0x40,
 302         ICE_PROMISC_VLAN_TX = 0x80,
 303 };
 304
 305 /* VSI related commands */
 306 enum ice_status
 307 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 308                struct ice_sq_cd *cd);
 309 enum ice_status
 310 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 311                 bool keep_vsi_alloc, struct ice_sq_cd *cd);
 312 enum ice_status
 313 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 314                   struct ice_sq_cd *cd);
 315 enum ice_status
 316 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 317             struct ice_sq_cd *cd);
 318 enum ice_status
 319 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 320              bool keep_vsi_alloc, struct ice_sq_cd *cd);
 321 enum ice_status
 322 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 323                struct ice_sq_cd *cd);
 324 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
 325 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
 326 enum ice_status
 327 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 328                       struct ice_sq_cd *cd);
 329 enum ice_status
 330 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
 331                            u16 count, struct ice_mir_rule_buf *mr_buf,
 332                            struct ice_sq_cd *cd, u16 *rule_id);
 333 enum ice_status
 334 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
 335                        struct ice_sq_cd *cd);
 336 enum ice_status
 337 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
 338                       u32 *ctl_bitmask);
 339 enum ice_status
 340 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
 341                       u32 ctl_bitmask);
 342 /* Switch config */
 343 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
 344
 345 enum ice_status
 346 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
 347 enum ice_status
 348 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
 349 enum ice_status
 350 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
 351                    u16 *counter_id);
 352 enum ice_status
 353 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
 354                   u16 counter_id);
 355
 356 /* Switch/bridge related commands */
 357 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
 358 enum ice_status
 359 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
 360              u16 *counter_id);
 361 enum ice_status
 362 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
 363 enum ice_status
 364 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
 365                      u16 buf_size, struct ice_sq_cd *cd);
 366 enum ice_status
 367 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
 368                      struct ice_aqc_get_allocd_res_desc_resp *buf,
 369                      u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
 370                      struct ice_sq_cd *cd);
 371 enum ice_status
 372 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
 373 enum ice_status
 374 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
 375 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
 376 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
 377 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
 378 enum ice_status
 379 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
 380 enum ice_status
 381 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
 382 enum ice_status
 383 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
 384 enum ice_status
 385 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
 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_ */