sys/dev/ice/ice_switch.h

   1 /* SPDX-License-Identifier: BSD-3-Clause */
   2 /*  Copyright (c) 2021, Intel Corporation
   3  *  All rights reserved.
   4  *
   5  *  Redistribution and use in source and binary forms, with or without
   6  *  modification, are permitted provided that the following conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above copyright notice,
   9  *      this list of conditions and the following disclaimer.
  10  *
  11  *   2. Redistributions in binary form must reproduce the above copyright
  12  *      notice, this list of conditions and the following disclaimer in the
  13  *      documentation and/or other materials provided with the distribution.
  14  *
  15  *   3. Neither the name of the Intel Corporation nor the names of its
  16  *      contributors may be used to endorse or promote products derived from
  17  *      this software without specific prior written permission.
  18  *
  19  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  *  POSSIBILITY OF SUCH DAMAGE.
  30  */
  31 /*$FreeBSD$*/
  32
  33 #ifndef _ICE_SWITCH_H_
  34 #define _ICE_SWITCH_H_
  35
  36 #include "ice_common.h"
  37 #include "ice_protocol_type.h"
  38
  39 #define ICE_SW_CFG_MAX_BUF_LEN 2048
  40 #define ICE_MAX_SW 256
  41 #define ICE_DFLT_VSI_INVAL 0xff
  42 #define ICE_FLTR_RX BIT(0)
  43 #define ICE_FLTR_TX BIT(1)
  44 #define ICE_FLTR_TX_RX (ICE_FLTR_RX | ICE_FLTR_TX)
  45
  46 #define DUMMY_ETH_HDR_LEN               16
  47 #define ICE_SW_RULE_RX_TX_ETH_HDR_SIZE \
  48         (offsetof(struct ice_aqc_sw_rules_elem, pdata.lkup_tx_rx.hdr) + \
  49          (DUMMY_ETH_HDR_LEN * \
  50           sizeof(((struct ice_sw_rule_lkup_rx_tx *)0)->hdr[0])))
  51 #define ICE_SW_RULE_RX_TX_NO_HDR_SIZE \
  52         (offsetof(struct ice_aqc_sw_rules_elem, pdata.lkup_tx_rx.hdr))
  53 #define ICE_SW_RULE_LG_ACT_SIZE(n) \
  54         (offsetof(struct ice_aqc_sw_rules_elem, pdata.lg_act.act) + \
  55          ((n) * sizeof(((struct ice_sw_rule_lg_act *)0)->act[0])))
  56 #define ICE_SW_RULE_VSI_LIST_SIZE(n) \
  57         (offsetof(struct ice_aqc_sw_rules_elem, pdata.vsi_list.vsi) + \
  58          ((n) * sizeof(((struct ice_sw_rule_vsi_list *)0)->vsi[0])))
  59
  60 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
  61 #define ICE_MAX_RES_TYPES 0x80
  62 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
  63         (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
  64
  65 #define ICE_VSI_INVAL_ID 0xFFFF
  66 #define ICE_INVAL_Q_HANDLE 0xFFFF
  67
  68 /* VSI context structure for add/get/update/free operations */
  69 struct ice_vsi_ctx {
  70         u16 vsi_num;
  71         u16 vsis_allocd;
  72         u16 vsis_unallocated;
  73         u16 flags;
  74         struct ice_aqc_vsi_props info;
  75         struct ice_sched_vsi_info sched;
  76         u8 alloc_from_pool;
  77         u8 vf_num;
  78         u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
  79         struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
  80 };
  81
  82 /* This is to be used by add/update mirror rule Admin Queue command */
  83 struct ice_mir_rule_buf {
  84         u16 vsi_idx; /* VSI index */
  85
  86         /* For each VSI, user can specify whether corresponding VSI
  87          * should be added/removed to/from mirror rule
  88          *
  89          * add mirror rule: this should always be TRUE.
  90          * update mirror rule:  add(true) or remove(false) VSI to/from
  91          * mirror rule
  92          */
  93         u8 add;
  94 };
  95
  96 /* Switch recipe ID enum values are specific to hardware */
  97 enum ice_sw_lkup_type {
  98         ICE_SW_LKUP_ETHERTYPE = 0,
  99         ICE_SW_LKUP_MAC = 1,
 100         ICE_SW_LKUP_MAC_VLAN = 2,
 101         ICE_SW_LKUP_PROMISC = 3,
 102         ICE_SW_LKUP_VLAN = 4,
 103         ICE_SW_LKUP_DFLT = 5,
 104         ICE_SW_LKUP_ETHERTYPE_MAC = 8,
 105         ICE_SW_LKUP_PROMISC_VLAN = 9,
 106         ICE_SW_LKUP_LAST
 107 };
 108
 109 /* type of filter src ID */
 110 enum ice_src_id {
 111         ICE_SRC_ID_UNKNOWN = 0,
 112         ICE_SRC_ID_VSI,
 113         ICE_SRC_ID_QUEUE,
 114         ICE_SRC_ID_LPORT,
 115 };
 116
 117 struct ice_fltr_info {
 118         /* Look up information: how to look up packet */
 119         enum ice_sw_lkup_type lkup_type;
 120         /* Forward action: filter action to do after lookup */
 121         enum ice_sw_fwd_act_type fltr_act;
 122         /* rule ID returned by firmware once filter rule is created */
 123         u16 fltr_rule_id;
 124         u16 flag;
 125
 126         /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
 127         u16 src;
 128         enum ice_src_id src_id;
 129
 130         union {
 131                 struct {
 132                         u8 mac_addr[ETH_ALEN];
 133                 } mac;
 134                 struct {
 135                         u8 mac_addr[ETH_ALEN];
 136                         u16 vlan_id;
 137                 } mac_vlan;
 138                 struct {
 139                         u16 vlan_id;
 140                         u16 tpid;
 141                         u8 tpid_valid;
 142                 } vlan;
 143                 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
 144                  * if just using ethertype as filter. Set lkup_type as
 145                  * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
 146                  * passed in as filter.
 147                  */
 148                 struct {
 149                         u16 ethertype;
 150                         u8 mac_addr[ETH_ALEN]; /* optional */
 151                 } ethertype_mac;
 152         } l_data; /* Make sure to zero out the memory of l_data before using
 153                    * it or only set the data associated with lookup match
 154                    * rest everything should be zero
 155                    */
 156
 157         /* Depending on filter action */
 158         union {
 159                 /* queue ID in case of ICE_FWD_TO_Q and starting
 160                  * queue ID in case of ICE_FWD_TO_QGRP.
 161                  */
 162                 u16 q_id:11;
 163                 u16 hw_vsi_id:10;
 164                 u16 vsi_list_id:10;
 165         } fwd_id;
 166
 167         /* Sw VSI handle */
 168         u16 vsi_handle;
 169
 170         /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
 171          * determines the range of queues the packet needs to be forwarded to.
 172          * Note that qgrp_size must be set to a power of 2.
 173          */
 174         u8 qgrp_size;
 175
 176         /* Rule creations populate these indicators basing on the switch type */
 177         u8 lb_en;       /* Indicate if packet can be looped back */
 178         u8 lan_en;      /* Indicate if packet can be forwarded to the uplink */
 179 };
 180
 181 struct ice_adv_lkup_elem {
 182         enum ice_protocol_type type;
 183         union ice_prot_hdr h_u; /* Header values */
 184         union ice_prot_hdr m_u; /* Mask of header values to match */
 185 };
 186
 187 struct ice_sw_act_ctrl {
 188         /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
 189         u16 src;
 190         u16 flag;
 191         enum ice_sw_fwd_act_type fltr_act;
 192         /* Depending on filter action */
 193         union {
 194                 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
 195                  * queue ID in case of ICE_FWD_TO_QGRP.
 196                  */
 197                 u16 q_id:11;
 198                 u16 vsi_id:10;
 199                 u16 hw_vsi_id:10;
 200                 u16 vsi_list_id:10;
 201         } fwd_id;
 202         /* software VSI handle */
 203         u16 vsi_handle;
 204         u8 qgrp_size;
 205 };
 206
 207 struct ice_rule_query_data {
 208         /* Recipe ID for which the requested rule was added */
 209         u16 rid;
 210         /* Rule ID that was added or is supposed to be removed */
 211         u16 rule_id;
 212         /* vsi_handle for which Rule was added or is supposed to be removed */
 213         u16 vsi_handle;
 214 };
 215
 216 /*
 217  * This structure allows to pass info about lb_en and lan_en
 218  * flags to ice_add_adv_rule. Values in act would be used
 219  * only if act_valid was set to true, otherwise dflt
 220  * values would be used.
 221  */
 222 struct ice_adv_rule_flags_info {
 223         u32 act;
 224         u8 act_valid;           /* indicate if flags in act are valid */
 225 };
 226
 227 struct ice_adv_rule_info {
 228         enum ice_sw_tunnel_type tun_type;
 229         struct ice_sw_act_ctrl sw_act;
 230         u32 priority;
 231         u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
 232         u16 fltr_rule_id;
 233         struct ice_adv_rule_flags_info flags_info;
 234 };
 235
 236 /* A collection of one or more four word recipe */
 237 struct ice_sw_recipe {
 238         /* For a chained recipe the root recipe is what should be used for
 239          * programming rules
 240          */
 241         u8 is_root;
 242         u8 root_rid;
 243         u8 recp_created;
 244
 245         /* Number of extraction words */
 246         u8 n_ext_words;
 247         /* Protocol ID and Offset pair (extraction word) to describe the
 248          * recipe
 249          */
 250         struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
 251         u16 word_masks[ICE_MAX_CHAIN_WORDS];
 252
 253         /* if this recipe is a collection of other recipe */
 254         u8 big_recp;
 255
 256         /* if this recipe is part of another bigger recipe then chain index
 257          * corresponding to this recipe
 258          */
 259         u8 chain_idx;
 260
 261         /* if this recipe is a collection of other recipe then count of other
 262          * recipes and recipe IDs of those recipes
 263          */
 264         u8 n_grp_count;
 265
 266         /* Bit map specifying the IDs associated with this group of recipe */
 267         ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
 268
 269         enum ice_sw_tunnel_type tun_type;
 270
 271         /* List of type ice_fltr_mgmt_list_entry or adv_rule */
 272         u8 adv_rule;
 273         struct LIST_HEAD_TYPE filt_rules;
 274         struct LIST_HEAD_TYPE filt_replay_rules;
 275
 276         struct ice_lock filt_rule_lock; /* protect filter rule structure */
 277
 278         /* Profiles this recipe should be associated with */
 279         struct LIST_HEAD_TYPE fv_list;
 280
 281         /* Profiles this recipe is associated with */
 282         u8 num_profs, *prof_ids;
 283
 284         /* Bit map for possible result indexes */
 285         ice_declare_bitmap(res_idxs, ICE_MAX_FV_WORDS);
 286
 287         /* This allows user to specify the recipe priority.
 288          * For now, this becomes 'fwd_priority' when recipe
 289          * is created, usually recipes can have 'fwd' and 'join'
 290          * priority.
 291          */
 292         u8 priority;
 293
 294         struct LIST_HEAD_TYPE rg_list;
 295
 296         /* AQ buffer associated with this recipe */
 297         struct ice_aqc_recipe_data_elem *root_buf;
 298         /* This struct saves the fv_words for a given lookup */
 299         struct ice_prot_lkup_ext lkup_exts;
 300 };
 301
 302 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
 303 struct ice_vsi_list_map_info {
 304         struct LIST_ENTRY_TYPE list_entry;
 305         ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
 306         u16 vsi_list_id;
 307         /* counter to track how many rules are reusing this VSI list */
 308         u16 ref_cnt;
 309 };
 310
 311 struct ice_fltr_list_entry {
 312         struct LIST_ENTRY_TYPE list_entry;
 313         enum ice_status status;
 314         struct ice_fltr_info fltr_info;
 315 };
 316
 317 /**
 318  * enum ice_fltr_marker - Marker for syncing OS and driver filter lists
 319  * @ICE_FLTR_NOT_FOUND: initial state, indicates filter has not been found
 320  * @ICE_FLTR_FOUND: set when a filter has been found in both lists
 321  *
 322  * This enumeration is used to help sync an operating system provided filter
 323  * list with the filters previously added.
 324  *
 325  * This is required for FreeBSD because the operating system does not provide
 326  * individual indications of whether a filter has been added or deleted, but
 327  * instead just notifies the driver with the entire new list.
 328  *
 329  * To use this marker state, the driver shall initially reset all filters to
 330  * the ICE_FLTR_NOT_FOUND state. Then, for each filter in the OS list, it
 331  * shall search the driver list for the filter. If found, the filter state
 332  * will be set to ICE_FLTR_FOUND. If not found, that filter will be added.
 333  * Finally, the driver shall search the internal filter list for all filters
 334  * still marked as ICE_FLTR_NOT_FOUND and remove them.
 335  */
 336 enum ice_fltr_marker {
 337         ICE_FLTR_NOT_FOUND,
 338         ICE_FLTR_FOUND,
 339 };
 340
 341 /* This defines an entry in the list that maintains MAC or VLAN membership
 342  * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
 343  * VLAN. As an optimization the VSI list should be created only when a
 344  * second VSI becomes a subscriber to the same MAC address. VSI lists are always
 345  * used for VLAN membership.
 346  */
 347 struct ice_fltr_mgmt_list_entry {
 348         /* back pointer to VSI list ID to VSI list mapping */
 349         struct ice_vsi_list_map_info *vsi_list_info;
 350         u16 vsi_count;
 351 #define ICE_INVAL_LG_ACT_INDEX 0xffff
 352         u16 lg_act_idx;
 353 #define ICE_INVAL_SW_MARKER_ID 0xffff
 354         u16 sw_marker_id;
 355         struct LIST_ENTRY_TYPE list_entry;
 356         struct ice_fltr_info fltr_info;
 357 #define ICE_INVAL_COUNTER_ID 0xff
 358         u8 counter_index;
 359         enum ice_fltr_marker marker;
 360 };
 361
 362 struct ice_adv_fltr_mgmt_list_entry {
 363         struct LIST_ENTRY_TYPE list_entry;
 364
 365         struct ice_adv_lkup_elem *lkups;
 366         struct ice_adv_rule_info rule_info;
 367         u16 lkups_cnt;
 368         struct ice_vsi_list_map_info *vsi_list_info;
 369         u16 vsi_count;
 370 };
 371
 372 enum ice_promisc_flags {
 373         ICE_PROMISC_UCAST_RX = 0x1,
 374         ICE_PROMISC_UCAST_TX = 0x2,
 375         ICE_PROMISC_MCAST_RX = 0x4,
 376         ICE_PROMISC_MCAST_TX = 0x8,
 377         ICE_PROMISC_BCAST_RX = 0x10,
 378         ICE_PROMISC_BCAST_TX = 0x20,
 379         ICE_PROMISC_VLAN_RX = 0x40,
 380         ICE_PROMISC_VLAN_TX = 0x80,
 381 };
 382
 383 /* VSI related commands */
 384 enum ice_status
 385 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 386                struct ice_sq_cd *cd);
 387 enum ice_status
 388 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 389                 bool keep_vsi_alloc, struct ice_sq_cd *cd);
 390 enum ice_status
 391 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 392                   struct ice_sq_cd *cd);
 393 enum ice_status
 394 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 395             struct ice_sq_cd *cd);
 396 enum ice_status
 397 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 398              bool keep_vsi_alloc, struct ice_sq_cd *cd);
 399 enum ice_status
 400 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 401                struct ice_sq_cd *cd);
 402 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
 403 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
 404 enum ice_status
 405 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
 406                       struct ice_sq_cd *cd);
 407 enum ice_status
 408 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
 409                            u16 count, struct ice_mir_rule_buf *mr_buf,
 410                            struct ice_sq_cd *cd, u16 *rule_id);
 411 enum ice_status
 412 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
 413                        struct ice_sq_cd *cd);
 414 enum ice_status
 415 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
 416                       u32 *ctl_bitmask);
 417 enum ice_status
 418 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
 419                       u32 ctl_bitmask);
 420 /* Switch config */
 421 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
 422
 423 enum ice_status
 424 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
 425 enum ice_status
 426 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
 427
 428 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
 429 enum ice_status ice_alloc_rss_global_lut(struct ice_hw *hw, bool shared_res, u16 *global_lut_id);
 430 enum ice_status ice_free_rss_global_lut(struct ice_hw *hw, u16 global_lut_id);
 431 enum ice_status
 432 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
 433              u16 *counter_id);
 434 enum ice_status
 435 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
 436 enum ice_status
 437 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries,
 438                      struct ice_aqc_get_res_resp_elem *buf, u16 buf_size,
 439                      struct ice_sq_cd *cd);
 440 enum ice_status
 441 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
 442                      struct ice_aqc_res_elem *buf, u16 buf_size, u16 res_type,
 443                      bool res_shared, u16 *desc_id, struct ice_sq_cd *cd);
 444 enum ice_status
 445 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
 446 enum ice_status
 447 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
 448 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
 449 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
 450 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
 451 enum ice_status
 452 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
 453 enum ice_status
 454 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
 455
 456 enum ice_status
 457 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
 458                            u16 sw_marker);
 459 enum ice_status
 460 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
 461 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
 462
 463 /* Promisc/defport setup for VSIs */
 464 enum ice_status
 465 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
 466                  u8 direction);
 467 enum ice_status
 468 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 469                     u16 vid);
 470 enum ice_status
 471 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 472                       u16 vid);
 473 enum ice_status
 474 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 475                          bool rm_vlan_promisc);
 476
 477 /* Get VSIs Promisc/defport settings */
 478 enum ice_status
 479 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
 480                     u16 *vid);
 481 enum ice_status
 482 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
 483                          u16 *vid);
 484
 485 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
 486
 487 enum ice_status
 488 ice_init_def_sw_recp(struct ice_hw *hw, struct ice_sw_recipe **recp_list);
 489 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
 490 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
 491
 492 enum ice_status
 493 ice_replay_vsi_all_fltr(struct ice_hw *hw, struct ice_port_info *pi,
 494                         u16 vsi_handle);
 495 void ice_rm_sw_replay_rule_info(struct ice_hw *hw, struct ice_switch_info *sw);
 496 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
 497 #endif /* _ICE_SWITCH_H_ */