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 /* VSI context structure for add/get/update/free operations */
  18 struct ice_vsi_ctx {
  19         u16 vsi_num;
  20         u16 vsis_allocd;
  21         u16 vsis_unallocated;
  22         u16 flags;
  23         struct ice_aqc_vsi_props info;
  24         struct ice_sched_vsi_info sched;
  25         u8 alloc_from_pool;
  26         u8 vf_num;
  27         u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
  28         struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
  29         u16 num_rdma_q_entries[ICE_MAX_TRAFFIC_CLASS];
  30         struct ice_q_ctx *rdma_q_ctx[ICE_MAX_TRAFFIC_CLASS];
  31 };
  32
  33 enum ice_sw_fwd_act_type {
  34         ICE_FWD_TO_VSI = 0,
  35         ICE_FWD_TO_VSI_LIST, /* Do not use this when adding filter */
  36         ICE_FWD_TO_Q,
  37         ICE_FWD_TO_QGRP,
  38         ICE_DROP_PACKET,
  39         ICE_INVAL_ACT
  40 };
  41
  42 /* Switch recipe ID enum values are specific to hardware */
  43 enum ice_sw_lkup_type {
  44         ICE_SW_LKUP_ETHERTYPE = 0,
  45         ICE_SW_LKUP_MAC = 1,
  46         ICE_SW_LKUP_MAC_VLAN = 2,
  47         ICE_SW_LKUP_PROMISC = 3,
  48         ICE_SW_LKUP_VLAN = 4,
  49         ICE_SW_LKUP_DFLT = 5,
  50         ICE_SW_LKUP_ETHERTYPE_MAC = 8,
  51         ICE_SW_LKUP_PROMISC_VLAN = 9,
  52         ICE_SW_LKUP_LAST
  53 };
  54
  55 /* type of filter src ID */
  56 enum ice_src_id {
  57         ICE_SRC_ID_UNKNOWN = 0,
  58         ICE_SRC_ID_VSI,
  59         ICE_SRC_ID_QUEUE,
  60         ICE_SRC_ID_LPORT,
  61 };
  62
  63 struct ice_fltr_info {
  64         /* Look up information: how to look up packet */
  65         enum ice_sw_lkup_type lkup_type;
  66         /* Forward action: filter action to do after lookup */
  67         enum ice_sw_fwd_act_type fltr_act;
  68         /* rule ID returned by firmware once filter rule is created */
  69         u16 fltr_rule_id;
  70         u16 flag;
  71
  72         /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
  73         u16 src;
  74         enum ice_src_id src_id;
  75
  76         union {
  77                 struct {
  78                         u8 mac_addr[ETH_ALEN];
  79                 } mac;
  80                 struct {
  81                         u8 mac_addr[ETH_ALEN];
  82                         u16 vlan_id;
  83                 } mac_vlan;
  84                 struct {
  85                         u16 vlan_id;
  86                 } vlan;
  87                 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
  88                  * if just using ethertype as filter. Set lkup_type as
  89                  * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
  90                  * passed in as filter.
  91                  */
  92                 struct {
  93                         u16 ethertype;
  94                         u8 mac_addr[ETH_ALEN]; /* optional */
  95                 } ethertype_mac;
  96         } l_data; /* Make sure to zero out the memory of l_data before using
  97                    * it or only set the data associated with lookup match
  98                    * rest everything should be zero
  99                    */
 100
 101         /* Depending on filter action */
 102         union {
 103                 /* queue ID in case of ICE_FWD_TO_Q and starting
 104                  * queue ID in case of ICE_FWD_TO_QGRP.
 105                  */
 106                 u16 q_id:11;
 107                 u16 hw_vsi_id:10;
 108                 u16 vsi_list_id:10;
 109         } fwd_id;
 110
 111         /* Sw VSI handle */
 112         u16 vsi_handle;
 113
 114         /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
 115          * determines the range of queues the packet needs to be forwarded to.
 116          * Note that qgrp_size must be set to a power of 2.
 117          */
 118         u8 qgrp_size;
 119
 120         /* Rule creations populate these indicators basing on the switch type */
 121         u8 lb_en;       /* Indicate if packet can be looped back */
 122         u8 lan_en;      /* Indicate if packet can be forwarded to the uplink */
 123 };
 124
 125 struct ice_sw_recipe {
 126         struct list_head l_entry;
 127
 128         /* To protect modification of filt_rule list
 129          * defined below
 130          */
 131         struct mutex filt_rule_lock;
 132
 133         /* List of type ice_fltr_mgmt_list_entry */
 134         struct list_head filt_rules;
 135         struct list_head filt_replay_rules;
 136
 137         /* linked list of type recipe_list_entry */
 138         struct list_head rg_list;
 139         /* linked list of type ice_sw_fv_list_entry*/
 140         struct list_head fv_list;
 141         struct ice_aqc_recipe_data_elem *r_buf;
 142         u8 recp_count;
 143         u8 root_rid;
 144         u8 num_profs;
 145         u8 *prof_ids;
 146
 147         /* recipe bitmap: what all recipes makes this recipe */
 148         DECLARE_BITMAP(r_bitmap, ICE_MAX_NUM_RECIPES);
 149 };
 150
 151 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
 152 struct ice_vsi_list_map_info {
 153         struct list_head list_entry;
 154         DECLARE_BITMAP(vsi_map, ICE_MAX_VSI);
 155         u16 vsi_list_id;
 156         /* counter to track how many rules are reusing this VSI list */
 157         u16 ref_cnt;
 158 };
 159
 160 struct ice_fltr_list_entry {
 161         struct list_head list_entry;
 162         enum ice_status status;
 163         struct ice_fltr_info fltr_info;
 164 };
 165
 166 /* This defines an entry in the list that maintains MAC or VLAN membership
 167  * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
 168  * VLAN. As an optimization the VSI list should be created only when a
 169  * second VSI becomes a subscriber to the same MAC address. VSI lists are always
 170  * used for VLAN membership.
 171  */
 172 struct ice_fltr_mgmt_list_entry {
 173         /* back pointer to VSI list ID to VSI list mapping */
 174         struct ice_vsi_list_map_info *vsi_list_info;
 175         u16 vsi_count;
 176 #define ICE_INVAL_LG_ACT_INDEX 0xffff
 177         u16 lg_act_idx;
 178 #define ICE_INVAL_SW_MARKER_ID 0xffff
 179         u16 sw_marker_id;
 180         struct list_head list_entry;
 181         struct ice_fltr_info fltr_info;
 182 #define ICE_INVAL_COUNTER_ID 0xff
 183         u8 counter_index;
 184 };
 185
 186 enum ice_promisc_flags {
 187         ICE_PROMISC_UCAST_RX = 0x1,
 188         ICE_PROMISC_UCAST_TX = 0x2,
 189         ICE_PROMISC_MCAST_RX = 0x4,
 190         ICE_PROMISC_MCAST_TX = 0x8,
 191         ICE_PROMISC_BCAST_RX = 0x10,
 192         ICE_PROMISC_BCAST_TX = 0x20,
 193         ICE_PROMISC_VLAN_RX = 0x40,
 194         ICE_PROMISC_VLAN_TX = 0x80,
 195 };
 196
 197 /* VSI related commands */
 198 enum ice_status
 199 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 200             struct ice_sq_cd *cd);
 201 enum ice_status
 202 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 203              bool keep_vsi_alloc, struct ice_sq_cd *cd);
 204 enum ice_status
 205 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
 206                struct ice_sq_cd *cd);
 207 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
 208 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
 209 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
 210 /* Switch config */
 211 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
 212
 213 enum ice_status
 214 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
 215                    u16 *counter_id);
 216 enum ice_status
 217 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
 218                   u16 counter_id);
 219
 220 /* Switch/bridge related commands */
 221 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
 222 enum ice_status ice_add_mac(struct ice_hw *hw, struct list_head *m_lst);
 223 enum ice_status ice_remove_mac(struct ice_hw *hw, struct list_head *m_lst);
 224 enum ice_status
 225 ice_add_eth_mac(struct ice_hw *hw, struct list_head *em_list);
 226 enum ice_status
 227 ice_remove_eth_mac(struct ice_hw *hw, struct list_head *em_list);
 228 int
 229 ice_cfg_rdma_fltr(struct ice_hw *hw, u16 vsi_handle, bool enable);
 230 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
 231 enum ice_status
 232 ice_add_vlan(struct ice_hw *hw, struct list_head *m_list);
 233 enum ice_status ice_remove_vlan(struct ice_hw *hw, struct list_head *v_list);
 234
 235 /* Promisc/defport setup for VSIs */
 236 enum ice_status
 237 ice_cfg_dflt_vsi(struct ice_hw *hw, u16 vsi_handle, bool set, u8 direction);
 238 enum ice_status
 239 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 240                     u16 vid);
 241 enum ice_status
 242 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 243                       u16 vid);
 244 enum ice_status
 245 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
 246                          bool rm_vlan_promisc);
 247
 248 enum ice_status ice_init_def_sw_recp(struct ice_hw *hw);
 249 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
 250
 251 enum ice_status ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle);
 252 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
 253
 254 #endif /* _ICE_SWITCH_H_ */