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