drivers/net/ice/base/ice_switch.h

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