drivers/net/ethernet/intel/ice/ice_switch.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright (c) 2018, Intel Corporation. */
   3
   4 #ifndef _ICE_SWITCH_H_
   5 #define _ICE_SWITCH_H_
   6
   7 #include "ice_common.h"
   8
   9 #define ICE_SW_CFG_MAX_BUF_LEN 2048
  10 #define ICE_DFLT_VSI_INVAL 0xff
  11 #define ICE_FLTR_RX BIT(0)
  12 #define ICE_FLTR_TX BIT(1)
  13 #define ICE_VSI_INVAL_ID 0xffff
  14 #define ICE_INVAL_Q_HANDLE 0xFFFF
  15
  16 /* Switch Profile IDs for Profile related switch rules */
  17 #define ICE_PROFID_IPV4_GTPC_TEID                       41
  18 #define ICE_PROFID_IPV4_GTPC_NO_TEID                    42
  19 #define ICE_PROFID_IPV4_GTPU_TEID                       43
  20 #define ICE_PROFID_IPV6_GTPC_TEID                       44
  21 #define ICE_PROFID_IPV6_GTPC_NO_TEID                    45
  22 #define ICE_PROFID_IPV6_GTPU_TEID                       46
  23 #define ICE_PROFID_IPV6_GTPU_IPV6_TCP_INNER             70
  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         u8 vf_num;
  35         u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
  36         struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
  37         u16 num_rdma_q_entries[ICE_MAX_TRAFFIC_CLASS];
  38         struct ice_q_ctx *rdma_q_ctx[ICE_MAX_TRAFFIC_CLASS];
  39 };
  40
  41 /* Switch recipe ID enum values are specific to hardware */
  42 enum ice_sw_lkup_type {
  43         ICE_SW_LKUP_ETHERTYPE = 0,
  44         ICE_SW_LKUP_MAC = 1,
  45         ICE_SW_LKUP_MAC_VLAN = 2,
  46         ICE_SW_LKUP_PROMISC = 3,
  47         ICE_SW_LKUP_VLAN = 4,
  48         ICE_SW_LKUP_DFLT = 5,
  49         ICE_SW_LKUP_ETHERTYPE_MAC = 8,
  50         ICE_SW_LKUP_PROMISC_VLAN = 9,
  51         ICE_SW_LKUP_LAST
  52 };
  53
  54 /* type of filter src ID */
  55 enum ice_src_id {
  56         ICE_SRC_ID_UNKNOWN = 0,
  57         ICE_SRC_ID_VSI,
  58         ICE_SRC_ID_QUEUE,
  59         ICE_SRC_ID_LPORT,
  60 };
  61
  62 struct ice_fltr_info {
  63         /* Look up information: how to look up packet */
  64         enum ice_sw_lkup_type lkup_type;
  65         /* Forward action: filter action to do after lookup */
  66         enum ice_sw_fwd_act_type fltr_act;
  67         /* rule ID returned by firmware once filter rule is created */
  68         u16 fltr_rule_id;
  69         u16 flag;
  70
  71         /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
  72         u16 src;
  73         enum ice_src_id src_id;
  74
  75         union {
  76                 struct {
  77                         u8 mac_addr[ETH_ALEN];
  78                 } mac;
  79                 struct {
  80                         u8 mac_addr[ETH_ALEN];
  81                         u16 vlan_id;
  82                 } mac_vlan;
  83                 struct {
  84                         u16 vlan_id;
  85                         u16 tpid;
  86                         u8 tpid_valid;
  87                 } vlan;
  88                 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
  89                  * if just using ethertype as filter. Set lkup_type as
  90                  * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
  91                  * passed in as filter.
  92                  */
  93                 struct {
  94                         u16 ethertype;
  95                         u8 mac_addr[ETH_ALEN]; /* optional */
  96                 } ethertype_mac;
  97         } l_data; /* Make sure to zero out the memory of l_data before using
  98                    * it or only set the data associated with lookup match
  99                    * rest everything should be zero
 100                    */
 101
 102         /* Depending on filter action */
 103         union {
 104                 /* queue ID in case of ICE_FWD_TO_Q and starting
 105                  * queue ID in case of ICE_FWD_TO_QGRP.
 106                  */
 107                 u16 q_id:11;
 108                 u16 hw_vsi_id:10;
 109                 u16 vsi_list_id:10;
 110         } fwd_id;
 111
 112         /* Sw VSI handle */
 113         u16 vsi_handle;
 114
 115         /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
 116          * determines the range of queues the packet needs to be forwarded to.
 117          * Note that qgrp_size must be set to a power of 2.
 118          */
 119         u8 qgrp_size;
 120
 121         /* Rule creations populate these indicators basing on the switch type */
 122         u8 lb_en;       /* Indicate if packet can be looped back */
 123         u8 lan_en;      /* Indicate if packet can be forwarded to the uplink */
 124 };
 125
 126 struct ice_update_recipe_lkup_idx_params {
 127         u16 rid;
 128         u16 fv_idx;
 129         bool ignore_valid;
 130         u16 mask;
 131         bool mask_valid;
 132         u8 lkup_idx;
 133 };
 134
 135 struct ice_adv_lkup_elem {
 136         enum ice_protocol_type type;
 137         union {
 138                 union ice_prot_hdr h_u; /* Header values */
 139                 /* Used to iterate over the headers */
 140                 u16 h_raw[sizeof(union ice_prot_hdr) / sizeof(u16)];
 141         };
 142         union {
 143                 union ice_prot_hdr m_u; /* Mask of header values to match */
 144                 /* Used to iterate over header mask */
 145                 u16 m_raw[sizeof(union ice_prot_hdr) / sizeof(u16)];
 146         };
 147 };
 148
 149 struct ice_sw_act_ctrl {
 150         /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
 151         u16 src;
 152         u16 flag;
 153         enum ice_sw_fwd_act_type fltr_act;
 154         /* Depending on filter action */
 155         union {
 156                 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
 157                  * queue ID in case of ICE_FWD_TO_QGRP.
 158                  */
 159                 u16 q_id:11;
 160                 u16 vsi_id:10;
 161                 u16 hw_vsi_id:10;
 162                 u16 vsi_list_id:10;
 163         } fwd_id;
 164         /* software VSI handle */
 165         u16 vsi_handle;
 166         u8 qgrp_size;
 167 };
 168
 169 struct ice_rule_query_data {
 170         /* Recipe ID for which the requested rule was added */
 171         u16 rid;
 172         /* Rule ID that was added or is supposed to be removed */
 173         u16 rule_id;
 174         /* vsi_handle for which Rule was added or is supposed to be removed */
 175         u16 vsi_handle;
 176 };
 177
 178 /* This structure allows to pass info about lb_en and lan_en
 179  * flags to ice_add_adv_rule. Values in act would be used
 180  * only if act_valid was set to true, otherwise default
 181  * values would be used.
 182  */
 183 struct ice_adv_rule_flags_info {
 184         u32 act;
 185         u8 act_valid;           /* indicate if flags in act are valid */
 186 };
 187
 188 struct ice_adv_rule_info {
 189         /* Store metadata values in rule info */
 190         enum ice_sw_tunnel_type tun_type;
 191         u16 vlan_type;
 192         u16 fltr_rule_id;
 193         u32 priority;
 194         u16 src_vsi;
 195         struct ice_sw_act_ctrl sw_act;
 196         struct ice_adv_rule_flags_info flags_info;
 197 };
 198
 199 /* A collection of one or more four word recipe */
 200 struct ice_sw_recipe {
 201         /* For a chained recipe the root recipe is what should be used for
 202          * programming rules
 203          */
 204         u8 is_root;
 205         u8 root_rid;
 206         u8 recp_created;
 207
 208         /* Number of extraction words */
 209         u8 n_ext_words;
 210         /* Protocol ID and Offset pair (extraction word) to describe the
 211          * recipe
 212          */
 213         struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
 214         u16 word_masks[ICE_MAX_CHAIN_WORDS];
 215
 216         /* if this recipe is a collection of other recipe */
 217         u8 big_recp;
 218
 219         /* if this recipe is part of another bigger recipe then chain index
 220          * corresponding to this recipe
 221          */
 222         u8 chain_idx;
 223
 224         /* if this recipe is a collection of other recipe then count of other
 225          * recipes and recipe IDs of those recipes
 226          */
 227         u8 n_grp_count;
 228
 229         /* Bit map specifying the IDs associated with this group of recipe */
 230         DECLARE_BITMAP(r_bitmap, ICE_MAX_NUM_RECIPES);
 231
 232         enum ice_sw_tunnel_type tun_type;
 233
 234         /* List of type ice_fltr_mgmt_list_entry or adv_rule */
 235         u8 adv_rule;
 236         struct list_head filt_rules;
 237         struct list_head filt_replay_rules;
 238
 239         struct mutex filt_rule_lock;    /* protect filter rule structure */
 240
 241         /* Profiles this recipe should be associated with */
 242         struct list_head fv_list;
 243
 244         /* Profiles this recipe is associated with */
 245         u8 num_profs, *prof_ids;
 246
 247         /* Bit map for possible result indexes */
 248         DECLARE_BITMAP(res_idxs, ICE_MAX_FV_WORDS);
 249
 250         /* This allows user to specify the recipe priority.
 251          * For now, this becomes 'fwd_priority' when recipe
 252          * is created, usually recipes can have 'fwd' and 'join'
 253          * priority.
 254          */
 255         u8 priority;
 256
 257         struct list_head rg_list;
 258
 259         /* AQ buffer associated with this recipe */
 260         struct ice_aqc_recipe_data_elem *root_buf;
 261         /* This struct saves the fv_words for a given lookup */
 262         struct ice_prot_lkup_ext lkup_exts;
 263 };
 264
 265 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
 266 struct ice_vsi_list_map_info {
 267         struct list_head list_entry;
 268         DECLARE_BITMAP(vsi_map, ICE_MAX_VSI);
 269         u16 vsi_list_id;
 270         /* counter to track how many rules are reusing this VSI list */
 271         u16 ref_cnt;
 272 };
 273
 274 struct ice_fltr_list_entry {
 275         struct list_head list_entry;
 276         int status;
 277         struct ice_fltr_info fltr_info;
 278 };
 279
 280 /* This defines an entry in the list that maintains MAC or VLAN membership
 281  * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
 282  * VLAN. As an optimization the VSI list should be created only when a
 283  * second VSI becomes a subscriber to the same MAC address. VSI lists are always
 284  * used for VLAN membership.
 285  */
 286 struct ice_fltr_mgmt_list_entry {
 287         /* back pointer to VSI list ID to VSI list mapping */
 288         struct ice_vsi_list_map_info *vsi_list_info;
 289         u16 vsi_count;
 290 #define ICE_INVAL_LG_ACT_INDEX 0xffff
 291         u16 lg_act_idx;
 292 #define ICE_INVAL_SW_MARKER_ID 0xffff
 293         u16 sw_marker_id;
 294         struct list_head list_entry;
 295         struct ice_fltr_info fltr_info;
 296 #define ICE_INVAL_COUNTER_ID 0xff
 297         u8 counter_index;
 298 };
 299
 300 struct ice_adv_fltr_mgmt_list_entry {
 301         struct list_head list_entry;
 302
 303         struct ice_adv_lkup_elem *lkups;
 304         struct ice_adv_rule_info rule_info;
 305         u16 lkups_cnt;
 306         struct ice_vsi_list_map_info *vsi_list_info;
 307         u16 vsi_count;
 308 };
 309
 310 enum ice_promisc_flags {
 311         ICE_PROMISC_UCAST_RX = 0x1,
 312         ICE_PROMISC_UCAST_TX = 0x2,
 313         ICE_PROMISC_MCAST_RX = 0x4,
 314         ICE_PROMISC_MCAST_TX = 0x8,
 315         ICE_PROMISC_BCAST_RX = 0x10,
 316         ICE_PROMISC_BCAST_TX = 0x20,
 317         ICE_PROMISC_VLAN_RX = 0x40,
 318         ICE_PROMISC_VLAN_TX = 0x80,
 319 };
 320
 321 /* VSI related commands */
 322 int
 323 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 324             struct ice_sq_cd *cd);
 325 int
 326 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 327              bool keep_vsi_alloc, struct ice_sq_cd *cd);
 328 int
 329 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 330                struct ice_sq_cd *cd);
 331 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
 332 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
 333 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
 334 /* Switch config */
 335 int ice_get_initial_sw_cfg(struct ice_hw *hw);
 336
 337 int
 338 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
 339                    u16 *counter_id);
 340 int
 341 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
 342                   u16 counter_id);
 343
 344 /* Switch/bridge related commands */
 345 void ice_rule_add_tunnel_metadata(struct ice_adv_lkup_elem *lkup);
 346 void ice_rule_add_vlan_metadata(struct ice_adv_lkup_elem *lkup);
 347 void ice_rule_add_src_vsi_metadata(struct ice_adv_lkup_elem *lkup);
 348 int
 349 ice_add_adv_rule(struct ice_hw *hw, struct ice_adv_lkup_elem *lkups,
 350                  u16 lkups_cnt, struct ice_adv_rule_info *rinfo,
 351                  struct ice_rule_query_data *added_entry);
 352 int ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
 353 int ice_add_vlan(struct ice_hw *hw, struct list_head *m_list);
 354 int ice_remove_vlan(struct ice_hw *hw, struct list_head *v_list);
 355 int ice_add_mac(struct ice_hw *hw, struct list_head *m_lst);
 356 int ice_remove_mac(struct ice_hw *hw, struct list_head *m_lst);
 357 bool ice_mac_fltr_exist(struct ice_hw *hw, u8 *mac, u16 vsi_handle);
 358 bool ice_vlan_fltr_exist(struct ice_hw *hw, u16 vlan_id, u16 vsi_handle);
 359 int ice_add_eth_mac(struct ice_hw *hw, struct list_head *em_list);
 360 int ice_remove_eth_mac(struct ice_hw *hw, struct list_head *em_list);
 361 int ice_cfg_rdma_fltr(struct ice_hw *hw, u16 vsi_handle, bool enable);
 362 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
 363
 364 /* Promisc/defport setup for VSIs */
 365 int
 366 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
 367                  u8 direction);
 368 bool
 369 ice_check_if_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle,
 370                       bool *rule_exists);
 371
 372 int
 373 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 374                     u16 vid);
 375 int
 376 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 377                       u16 vid);
 378 int
 379 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 380                          bool rm_vlan_promisc);
 381
 382 int ice_rem_adv_rule_for_vsi(struct ice_hw *hw, u16 vsi_handle);
 383 int
 384 ice_rem_adv_rule_by_id(struct ice_hw *hw,
 385                        struct ice_rule_query_data *remove_entry);
 386
 387 int ice_init_def_sw_recp(struct ice_hw *hw);
 388 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
 389
 390 int ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle);
 391 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
 392
 393 int
 394 ice_aq_sw_rules(struct ice_hw *hw, void *rule_list, u16 rule_list_sz,
 395                 u8 num_rules, enum ice_adminq_opc opc, struct ice_sq_cd *cd);
 396 int
 397 ice_update_recipe_lkup_idx(struct ice_hw *hw,
 398                            struct ice_update_recipe_lkup_idx_params *params);
 399 void ice_change_proto_id_to_dvm(void);
 400 #endif /* _ICE_SWITCH_H_ */