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