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 root_rid;
 187         u8 recp_created;
 188
 189         /* Number of extraction words */
 190         u8 n_ext_words;
 191         /* Protocol ID and Offset pair (extraction word) to describe the
 192          * recipe
 193          */
 194         struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
 195
 196         /* if this recipe is a collection of other recipe */
 197         u8 big_recp;
 198
 199         /* if this recipe is part of another bigger recipe then chain index
 200          * corresponding to this recipe
 201          */
 202         u8 chain_idx;
 203
 204         /* if this recipe is a collection of other recipe then count of other
 205          * recipes and recipe IDs of those recipes
 206          */
 207         u8 n_grp_count;
 208
 209         /* Bit map specifying the IDs associated with this group of recipe */
 210         ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
 211
 212         enum ice_sw_tunnel_type tun_type;
 213
 214         /* List of type ice_fltr_mgmt_list_entry or adv_rule */
 215         u8 adv_rule;
 216         struct LIST_HEAD_TYPE filt_rules;
 217         struct LIST_HEAD_TYPE filt_replay_rules;
 218
 219         struct ice_lock filt_rule_lock; /* protect filter rule structure */
 220
 221         /* Profiles this recipe should be associated with */
 222         struct LIST_HEAD_TYPE fv_list;
 223
 224 #define ICE_MAX_NUM_PROFILES 256
 225         /* Profiles this recipe is associated with */
 226         u8 num_profs, *prof_ids;
 227
 228         /* This allows user to specify the recipe priority.
 229          * For now, this becomes 'fwd_priority' when recipe
 230          * is created, usually recipes can have 'fwd' and 'join'
 231          * priority.
 232          */
 233         u8 priority;
 234
 235         struct LIST_HEAD_TYPE rg_list;
 236
 237         /* AQ buffer associated with this recipe */
 238         struct ice_aqc_recipe_data_elem *root_buf;
 239         /* This struct saves the fv_words for a given lookup */
 240         struct ice_prot_lkup_ext lkup_exts;
 241 };
 242
 243 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
 244 struct ice_vsi_list_map_info {
 245         struct LIST_ENTRY_TYPE list_entry;
 246         ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
 247         u16 vsi_list_id;
 248         /* counter to track how many rules are reusing this VSI list */
 249         u16 ref_cnt;
 250 };
 251
 252 struct ice_fltr_list_entry {
 253         struct LIST_ENTRY_TYPE list_entry;
 254         enum ice_status status;
 255         struct ice_fltr_info fltr_info;
 256 };
 257
 258 /* This defines an entry in the list that maintains MAC or VLAN membership
 259  * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
 260  * VLAN. As an optimization the VSI list should be created only when a
 261  * second VSI becomes a subscriber to the same MAC address. VSI lists are always
 262  * used for VLAN membership.
 263  */
 264 struct ice_fltr_mgmt_list_entry {
 265         /* back pointer to VSI list ID to VSI list mapping */
 266         struct ice_vsi_list_map_info *vsi_list_info;
 267         u16 vsi_count;
 268 #define ICE_INVAL_LG_ACT_INDEX 0xffff
 269         u16 lg_act_idx;
 270 #define ICE_INVAL_SW_MARKER_ID 0xffff
 271         u16 sw_marker_id;
 272         struct LIST_ENTRY_TYPE list_entry;
 273         struct ice_fltr_info fltr_info;
 274 #define ICE_INVAL_COUNTER_ID 0xff
 275         u8 counter_index;
 276 };
 277
 278 struct ice_adv_fltr_mgmt_list_entry {
 279         struct LIST_ENTRY_TYPE list_entry;
 280
 281         struct ice_adv_lkup_elem *lkups;
 282         struct ice_adv_rule_info rule_info;
 283         u16 lkups_cnt;
 284         struct ice_vsi_list_map_info *vsi_list_info;
 285         u16 vsi_count;
 286 };
 287
 288 enum ice_promisc_flags {
 289         ICE_PROMISC_UCAST_RX = 0x1,
 290         ICE_PROMISC_UCAST_TX = 0x2,
 291         ICE_PROMISC_MCAST_RX = 0x4,
 292         ICE_PROMISC_MCAST_TX = 0x8,
 293         ICE_PROMISC_BCAST_RX = 0x10,
 294         ICE_PROMISC_BCAST_TX = 0x20,
 295         ICE_PROMISC_VLAN_RX = 0x40,
 296         ICE_PROMISC_VLAN_TX = 0x80,
 297 };
 298
 299 /* VSI related commands */
 300 enum ice_status
 301 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 302                struct ice_sq_cd *cd);
 303 enum ice_status
 304 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 305                 bool keep_vsi_alloc, struct ice_sq_cd *cd);
 306 enum ice_status
 307 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 308                   struct ice_sq_cd *cd);
 309 enum ice_status
 310 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 311             struct ice_sq_cd *cd);
 312 enum ice_status
 313 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 314              bool keep_vsi_alloc, struct ice_sq_cd *cd);
 315 enum ice_status
 316 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 317                struct ice_sq_cd *cd);
 318 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
 319 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
 320 enum ice_status
 321 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 322                       struct ice_sq_cd *cd);
 323 enum ice_status
 324 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
 325                            u16 count, struct ice_mir_rule_buf *mr_buf,
 326                            struct ice_sq_cd *cd, u16 *rule_id);
 327 enum ice_status
 328 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
 329                        struct ice_sq_cd *cd);
 330 enum ice_status
 331 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
 332                       u32 *ctl_bitmask);
 333 enum ice_status
 334 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
 335                       u32 ctl_bitmask);
 336 /* Switch config */
 337 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
 338
 339 enum ice_status
 340 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
 341 enum ice_status
 342 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
 343 enum ice_status
 344 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
 345                    u16 *counter_id);
 346 enum ice_status
 347 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
 348                   u16 counter_id);
 349
 350 /* Switch/bridge related commands */
 351 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
 352 enum ice_status
 353 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
 354              u16 *counter_id);
 355 enum ice_status
 356 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
 357 enum ice_status
 358 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
 359                      u16 buf_size, struct ice_sq_cd *cd);
 360 enum ice_status
 361 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
 362                      struct ice_aqc_get_allocd_res_desc_resp *buf,
 363                      u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
 364                      struct ice_sq_cd *cd);
 365 enum ice_status
 366 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
 367 enum ice_status
 368 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
 369 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
 370 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
 371 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
 372 enum ice_status
 373 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
 374 enum ice_status
 375 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
 376 enum ice_status
 377 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
 378 enum ice_status
 379 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
 380
 381 enum ice_status
 382 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
 383                            u16 sw_marker);
 384 enum ice_status
 385 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
 386 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
 387
 388
 389 /* Promisc/defport setup for VSIs */
 390 enum ice_status
 391 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
 392                  u8 direction);
 393 enum ice_status
 394 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 395                     u16 vid);
 396 enum ice_status
 397 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 398                       u16 vid);
 399 enum ice_status
 400 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 401                          bool rm_vlan_promisc);
 402
 403 /* Get VSIs Promisc/defport settings */
 404 enum ice_status
 405 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
 406                     u16 *vid);
 407 enum ice_status
 408 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
 409                          u16 *vid);
 410
 411 enum ice_status
 412 ice_aq_add_recipe(struct ice_hw *hw,
 413                   struct ice_aqc_recipe_data_elem *s_recipe_list,
 414                   u16 num_recipes, struct ice_sq_cd *cd);
 415
 416 enum ice_status
 417 ice_aq_get_recipe(struct ice_hw *hw,
 418                   struct ice_aqc_recipe_data_elem *s_recipe_list,
 419                   u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
 420 enum ice_status
 421 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
 422                              struct ice_sq_cd *cd);
 423
 424 enum ice_status
 425 ice_aq_get_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
 426                              struct ice_sq_cd *cd);
 427
 428 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
 429 enum ice_status
 430 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
 431                  u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
 432                  struct ice_rule_query_data *added_entry);
 433 enum ice_status
 434 ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
 435 enum ice_status
 436 ice_rem_adv_rule_by_id(struct ice_hw *hw,
 437                        struct ice_rule_query_data *remove_entry);
 438 enum ice_status
 439 ice_rem_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
 440                  u16 lkups_cnt, struct ice_adv_rule_info *rinfo);
 441
 442 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
 443
 444 enum ice_status ice_init_def_sw_recp(struct ice_hw *hw);
 445 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
 446 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
 447
 448 enum ice_status ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle);
 449 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
 450
 451 #endif /* _ICE_SWITCH_H_ */