drivers/net/ethernet/intel/i40evf/i40evf.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright(c) 2013 - 2018 Intel Corporation. */
   3
   4 #ifndef _I40EVF_H_
   5 #define _I40EVF_H_
   6
   7 #include <linux/module.h>
   8 #include <linux/pci.h>
   9 #include <linux/aer.h>
  10 #include <linux/netdevice.h>
  11 #include <linux/vmalloc.h>
  12 #include <linux/interrupt.h>
  13 #include <linux/ethtool.h>
  14 #include <linux/if_vlan.h>
  15 #include <linux/ip.h>
  16 #include <linux/tcp.h>
  17 #include <linux/sctp.h>
  18 #include <linux/ipv6.h>
  19 #include <linux/kernel.h>
  20 #include <linux/bitops.h>
  21 #include <linux/timer.h>
  22 #include <linux/workqueue.h>
  23 #include <linux/wait.h>
  24 #include <linux/delay.h>
  25 #include <linux/gfp.h>
  26 #include <linux/skbuff.h>
  27 #include <linux/dma-mapping.h>
  28 #include <linux/etherdevice.h>
  29 #include <linux/socket.h>
  30 #include <linux/jiffies.h>
  31 #include <net/ip6_checksum.h>
  32 #include <net/pkt_cls.h>
  33 #include <net/udp.h>
  34 #include <net/tc_act/tc_gact.h>
  35 #include <net/tc_act/tc_mirred.h>
  36
  37 #include "i40e_type.h"
  38 #include <linux/avf/virtchnl.h>
  39 #include "i40e_txrx.h"
  40
  41 #define DEFAULT_DEBUG_LEVEL_SHIFT 3
  42 #define PFX "i40evf: "
  43
  44 /* VSI state flags shared with common code */
  45 enum i40evf_vsi_state_t {
  46         __I40E_VSI_DOWN,
  47         /* This must be last as it determines the size of the BITMAP */
  48         __I40E_VSI_STATE_SIZE__,
  49 };
  50
  51 /* dummy struct to make common code less painful */
  52 struct i40e_vsi {
  53         struct i40evf_adapter *back;
  54         struct net_device *netdev;
  55         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
  56         u16 seid;
  57         u16 id;
  58         DECLARE_BITMAP(state, __I40E_VSI_STATE_SIZE__);
  59         int base_vector;
  60         u16 work_limit;
  61         u16 qs_handle;
  62         void *priv;     /* client driver data reference. */
  63 };
  64
  65 /* How many Rx Buffers do we bundle into one write to the hardware ? */
  66 #define I40EVF_RX_BUFFER_WRITE  16      /* Must be power of 2 */
  67 #define I40EVF_DEFAULT_TXD      512
  68 #define I40EVF_DEFAULT_RXD      512
  69 #define I40EVF_MAX_TXD          4096
  70 #define I40EVF_MIN_TXD          64
  71 #define I40EVF_MAX_RXD          4096
  72 #define I40EVF_MIN_RXD          64
  73 #define I40EVF_REQ_DESCRIPTOR_MULTIPLE  32
  74 #define I40EVF_MAX_AQ_BUF_SIZE  4096
  75 #define I40EVF_AQ_LEN           32
  76 #define I40EVF_AQ_MAX_ERR       20 /* times to try before resetting AQ */
  77
  78 #define MAXIMUM_ETHERNET_VLAN_SIZE (VLAN_ETH_FRAME_LEN + ETH_FCS_LEN)
  79
  80 #define I40E_RX_DESC(R, i) (&(((union i40e_32byte_rx_desc *)((R)->desc))[i]))
  81 #define I40E_TX_DESC(R, i) (&(((struct i40e_tx_desc *)((R)->desc))[i]))
  82 #define I40E_TX_CTXTDESC(R, i) \
  83         (&(((struct i40e_tx_context_desc *)((R)->desc))[i]))
  84 #define I40EVF_MAX_REQ_QUEUES 4
  85
  86 #define I40EVF_HKEY_ARRAY_SIZE ((I40E_VFQF_HKEY_MAX_INDEX + 1) * 4)
  87 #define I40EVF_HLUT_ARRAY_SIZE ((I40E_VFQF_HLUT_MAX_INDEX + 1) * 4)
  88 #define I40EVF_MBPS_DIVISOR     125000 /* divisor to convert to Mbps */
  89
  90 /* MAX_MSIX_Q_VECTORS of these are allocated,
  91  * but we only use one per queue-specific vector.
  92  */
  93 struct i40e_q_vector {
  94         struct i40evf_adapter *adapter;
  95         struct i40e_vsi *vsi;
  96         struct napi_struct napi;
  97         struct i40e_ring_container rx;
  98         struct i40e_ring_container tx;
  99         u32 ring_mask;
 100         u8 itr_countdown;       /* when 0 should adjust adaptive ITR */
 101         u8 num_ringpairs;       /* total number of ring pairs in vector */
 102         u16 v_idx;              /* index in the vsi->q_vector array. */
 103         u16 reg_idx;            /* register index of the interrupt */
 104         char name[IFNAMSIZ + 15];
 105         bool arm_wb_state;
 106         cpumask_t affinity_mask;
 107         struct irq_affinity_notify affinity_notify;
 108 };
 109
 110 /* Helper macros to switch between ints/sec and what the register uses.
 111  * And yes, it's the same math going both ways.  The lowest value
 112  * supported by all of the i40e hardware is 8.
 113  */
 114 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \
 115         ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8)
 116 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG
 117
 118 #define I40EVF_DESC_UNUSED(R) \
 119         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 120         (R)->next_to_clean - (R)->next_to_use - 1)
 121
 122 #define I40EVF_RX_DESC_ADV(R, i)        \
 123         (&(((union i40e_adv_rx_desc *)((R).desc))[i]))
 124 #define I40EVF_TX_DESC_ADV(R, i)        \
 125         (&(((union i40e_adv_tx_desc *)((R).desc))[i]))
 126 #define I40EVF_TX_CTXTDESC_ADV(R, i)    \
 127         (&(((struct i40e_adv_tx_context_desc *)((R).desc))[i]))
 128
 129 #define OTHER_VECTOR 1
 130 #define NONQ_VECS (OTHER_VECTOR)
 131
 132 #define MIN_MSIX_Q_VECTORS 1
 133 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NONQ_VECS)
 134
 135 #define I40EVF_QUEUE_END_OF_LIST 0x7FF
 136 #define I40EVF_FREE_VECTOR 0x7FFF
 137 struct i40evf_mac_filter {
 138         struct list_head list;
 139         u8 macaddr[ETH_ALEN];
 140         bool remove;            /* filter needs to be removed */
 141         bool add;               /* filter needs to be added */
 142 };
 143
 144 struct i40evf_vlan_filter {
 145         struct list_head list;
 146         u16 vlan;
 147         bool remove;            /* filter needs to be removed */
 148         bool add;               /* filter needs to be added */
 149 };
 150
 151 #define I40EVF_MAX_TRAFFIC_CLASS        4
 152 /* State of traffic class creation */
 153 enum i40evf_tc_state_t {
 154         __I40EVF_TC_INVALID, /* no traffic class, default state */
 155         __I40EVF_TC_RUNNING, /* traffic classes have been created */
 156 };
 157
 158 /* channel info */
 159 struct i40evf_channel_config {
 160         struct virtchnl_channel_info ch_info[I40EVF_MAX_TRAFFIC_CLASS];
 161         enum i40evf_tc_state_t state;
 162         u8 total_qps;
 163 };
 164
 165 /* State of cloud filter */
 166 enum i40evf_cloud_filter_state_t {
 167         __I40EVF_CF_INVALID,     /* cloud filter not added */
 168         __I40EVF_CF_ADD_PENDING, /* cloud filter pending add by the PF */
 169         __I40EVF_CF_DEL_PENDING, /* cloud filter pending del by the PF */
 170         __I40EVF_CF_ACTIVE,      /* cloud filter is active */
 171 };
 172
 173 /* Driver state. The order of these is important! */
 174 enum i40evf_state_t {
 175         __I40EVF_STARTUP,               /* driver loaded, probe complete */
 176         __I40EVF_REMOVE,                /* driver is being unloaded */
 177         __I40EVF_INIT_VERSION_CHECK,    /* aq msg sent, awaiting reply */
 178         __I40EVF_INIT_GET_RESOURCES,    /* aq msg sent, awaiting reply */
 179         __I40EVF_INIT_SW,               /* got resources, setting up structs */
 180         __I40EVF_RESETTING,             /* in reset */
 181         /* Below here, watchdog is running */
 182         __I40EVF_DOWN,                  /* ready, can be opened */
 183         __I40EVF_DOWN_PENDING,          /* descending, waiting for watchdog */
 184         __I40EVF_TESTING,               /* in ethtool self-test */
 185         __I40EVF_RUNNING,               /* opened, working */
 186 };
 187
 188 enum i40evf_critical_section_t {
 189         __I40EVF_IN_CRITICAL_TASK,      /* cannot be interrupted */
 190         __I40EVF_IN_CLIENT_TASK,
 191         __I40EVF_IN_REMOVE_TASK,        /* device being removed */
 192 };
 193
 194 #define I40EVF_CLOUD_FIELD_OMAC         0x01
 195 #define I40EVF_CLOUD_FIELD_IMAC         0x02
 196 #define I40EVF_CLOUD_FIELD_IVLAN        0x04
 197 #define I40EVF_CLOUD_FIELD_TEN_ID       0x08
 198 #define I40EVF_CLOUD_FIELD_IIP          0x10
 199
 200 #define I40EVF_CF_FLAGS_OMAC    I40EVF_CLOUD_FIELD_OMAC
 201 #define I40EVF_CF_FLAGS_IMAC    I40EVF_CLOUD_FIELD_IMAC
 202 #define I40EVF_CF_FLAGS_IMAC_IVLAN      (I40EVF_CLOUD_FIELD_IMAC |\
 203                                          I40EVF_CLOUD_FIELD_IVLAN)
 204 #define I40EVF_CF_FLAGS_IMAC_TEN_ID     (I40EVF_CLOUD_FIELD_IMAC |\
 205                                          I40EVF_CLOUD_FIELD_TEN_ID)
 206 #define I40EVF_CF_FLAGS_OMAC_TEN_ID_IMAC        (I40EVF_CLOUD_FIELD_OMAC |\
 207                                                  I40EVF_CLOUD_FIELD_IMAC |\
 208                                                  I40EVF_CLOUD_FIELD_TEN_ID)
 209 #define I40EVF_CF_FLAGS_IMAC_IVLAN_TEN_ID       (I40EVF_CLOUD_FIELD_IMAC |\
 210                                                  I40EVF_CLOUD_FIELD_IVLAN |\
 211                                                  I40EVF_CLOUD_FIELD_TEN_ID)
 212 #define I40EVF_CF_FLAGS_IIP     I40E_CLOUD_FIELD_IIP
 213
 214 /* bookkeeping of cloud filters */
 215 struct i40evf_cloud_filter {
 216         enum i40evf_cloud_filter_state_t state;
 217         struct list_head list;
 218         struct virtchnl_filter f;
 219         unsigned long cookie;
 220         bool del;               /* filter needs to be deleted */
 221         bool add;               /* filter needs to be added */
 222 };
 223
 224 /* board specific private data structure */
 225 struct i40evf_adapter {
 226         struct timer_list watchdog_timer;
 227         struct work_struct reset_task;
 228         struct work_struct adminq_task;
 229         struct delayed_work client_task;
 230         struct delayed_work init_task;
 231         wait_queue_head_t down_waitqueue;
 232         struct i40e_q_vector *q_vectors;
 233         struct list_head vlan_filter_list;
 234         struct list_head mac_filter_list;
 235         /* Lock to protect accesses to MAC and VLAN lists */
 236         spinlock_t mac_vlan_list_lock;
 237         char misc_vector_name[IFNAMSIZ + 9];
 238         int num_active_queues;
 239         int num_req_queues;
 240
 241         /* TX */
 242         struct i40e_ring *tx_rings;
 243         u32 tx_timeout_count;
 244         u32 tx_desc_count;
 245
 246         /* RX */
 247         struct i40e_ring *rx_rings;
 248         u64 hw_csum_rx_error;
 249         u32 rx_desc_count;
 250         int num_msix_vectors;
 251         int num_iwarp_msix;
 252         int iwarp_base_vector;
 253         u32 client_pending;
 254         struct i40e_client_instance *cinst;
 255         struct msix_entry *msix_entries;
 256
 257         u32 flags;
 258 #define I40EVF_FLAG_RX_CSUM_ENABLED             BIT(0)
 259 #define I40EVF_FLAG_PF_COMMS_FAILED             BIT(3)
 260 #define I40EVF_FLAG_RESET_PENDING               BIT(4)
 261 #define I40EVF_FLAG_RESET_NEEDED                BIT(5)
 262 #define I40EVF_FLAG_WB_ON_ITR_CAPABLE           BIT(6)
 263 #define I40EVF_FLAG_ADDR_SET_BY_PF              BIT(8)
 264 #define I40EVF_FLAG_SERVICE_CLIENT_REQUESTED    BIT(9)
 265 #define I40EVF_FLAG_CLIENT_NEEDS_OPEN           BIT(10)
 266 #define I40EVF_FLAG_CLIENT_NEEDS_CLOSE          BIT(11)
 267 #define I40EVF_FLAG_CLIENT_NEEDS_L2_PARAMS      BIT(12)
 268 #define I40EVF_FLAG_PROMISC_ON                  BIT(13)
 269 #define I40EVF_FLAG_ALLMULTI_ON                 BIT(14)
 270 #define I40EVF_FLAG_LEGACY_RX                   BIT(15)
 271 #define I40EVF_FLAG_REINIT_ITR_NEEDED           BIT(16)
 272 #define I40EVF_FLAG_QUEUES_DISABLED             BIT(17)
 273 /* duplicates for common code */
 274 #define I40E_FLAG_DCB_ENABLED                   0
 275 #define I40E_FLAG_RX_CSUM_ENABLED               I40EVF_FLAG_RX_CSUM_ENABLED
 276 #define I40E_FLAG_LEGACY_RX                     I40EVF_FLAG_LEGACY_RX
 277         /* flags for admin queue service task */
 278         u32 aq_required;
 279 #define I40EVF_FLAG_AQ_ENABLE_QUEUES            BIT(0)
 280 #define I40EVF_FLAG_AQ_DISABLE_QUEUES           BIT(1)
 281 #define I40EVF_FLAG_AQ_ADD_MAC_FILTER           BIT(2)
 282 #define I40EVF_FLAG_AQ_ADD_VLAN_FILTER          BIT(3)
 283 #define I40EVF_FLAG_AQ_DEL_MAC_FILTER           BIT(4)
 284 #define I40EVF_FLAG_AQ_DEL_VLAN_FILTER          BIT(5)
 285 #define I40EVF_FLAG_AQ_CONFIGURE_QUEUES         BIT(6)
 286 #define I40EVF_FLAG_AQ_MAP_VECTORS              BIT(7)
 287 #define I40EVF_FLAG_AQ_HANDLE_RESET             BIT(8)
 288 #define I40EVF_FLAG_AQ_CONFIGURE_RSS            BIT(9) /* direct AQ config */
 289 #define I40EVF_FLAG_AQ_GET_CONFIG               BIT(10)
 290 /* Newer style, RSS done by the PF so we can ignore hardware vagaries. */
 291 #define I40EVF_FLAG_AQ_GET_HENA                 BIT(11)
 292 #define I40EVF_FLAG_AQ_SET_HENA                 BIT(12)
 293 #define I40EVF_FLAG_AQ_SET_RSS_KEY              BIT(13)
 294 #define I40EVF_FLAG_AQ_SET_RSS_LUT              BIT(14)
 295 #define I40EVF_FLAG_AQ_REQUEST_PROMISC          BIT(15)
 296 #define I40EVF_FLAG_AQ_RELEASE_PROMISC          BIT(16)
 297 #define I40EVF_FLAG_AQ_REQUEST_ALLMULTI         BIT(17)
 298 #define I40EVF_FLAG_AQ_RELEASE_ALLMULTI         BIT(18)
 299 #define I40EVF_FLAG_AQ_ENABLE_VLAN_STRIPPING    BIT(19)
 300 #define I40EVF_FLAG_AQ_DISABLE_VLAN_STRIPPING   BIT(20)
 301 #define I40EVF_FLAG_AQ_ENABLE_CHANNELS          BIT(21)
 302 #define I40EVF_FLAG_AQ_DISABLE_CHANNELS         BIT(22)
 303 #define I40EVF_FLAG_AQ_ADD_CLOUD_FILTER         BIT(23)
 304 #define I40EVF_FLAG_AQ_DEL_CLOUD_FILTER         BIT(24)
 305
 306         /* OS defined structs */
 307         struct net_device *netdev;
 308         struct pci_dev *pdev;
 309
 310         struct i40e_hw hw; /* defined in i40e_type.h */
 311
 312         enum i40evf_state_t state;
 313         unsigned long crit_section;
 314
 315         struct work_struct watchdog_task;
 316         bool netdev_registered;
 317         bool link_up;
 318         enum virtchnl_link_speed link_speed;
 319         enum virtchnl_ops current_op;
 320 #define CLIENT_ALLOWED(_a) ((_a)->vf_res ? \
 321                             (_a)->vf_res->vf_cap_flags & \
 322                                 VIRTCHNL_VF_OFFLOAD_IWARP : \
 323                             0)
 324 #define CLIENT_ENABLED(_a) ((_a)->cinst)
 325 /* RSS by the PF should be preferred over RSS via other methods. */
 326 #define RSS_PF(_a) ((_a)->vf_res->vf_cap_flags & \
 327                     VIRTCHNL_VF_OFFLOAD_RSS_PF)
 328 #define RSS_AQ(_a) ((_a)->vf_res->vf_cap_flags & \
 329                     VIRTCHNL_VF_OFFLOAD_RSS_AQ)
 330 #define RSS_REG(_a) (!((_a)->vf_res->vf_cap_flags & \
 331                        (VIRTCHNL_VF_OFFLOAD_RSS_AQ | \
 332                         VIRTCHNL_VF_OFFLOAD_RSS_PF)))
 333 #define VLAN_ALLOWED(_a) ((_a)->vf_res->vf_cap_flags & \
 334                           VIRTCHNL_VF_OFFLOAD_VLAN)
 335         struct virtchnl_vf_resource *vf_res; /* incl. all VSIs */
 336         struct virtchnl_vsi_resource *vsi_res; /* our LAN VSI */
 337         struct virtchnl_version_info pf_version;
 338 #define PF_IS_V11(_a) (((_a)->pf_version.major == 1) && \
 339                        ((_a)->pf_version.minor == 1))
 340         u16 msg_enable;
 341         struct i40e_eth_stats current_stats;
 342         struct i40e_vsi vsi;
 343         u32 aq_wait_count;
 344         /* RSS stuff */
 345         u64 hena;
 346         u16 rss_key_size;
 347         u16 rss_lut_size;
 348         u8 *rss_key;
 349         u8 *rss_lut;
 350         /* ADQ related members */
 351         struct i40evf_channel_config ch_config;
 352         u8 num_tc;
 353         struct list_head cloud_filter_list;
 354         /* lock to protest access to the cloud filter list */
 355         spinlock_t cloud_filter_list_lock;
 356         u16 num_cloud_filters;
 357 };
 358
 359
 360 /* Ethtool Private Flags */
 361
 362 /* lan device */
 363 struct i40e_device {
 364         struct list_head list;
 365         struct i40evf_adapter *vf;
 366 };
 367
 368 /* needed by i40evf_ethtool.c */
 369 extern char i40evf_driver_name[];
 370 extern const char i40evf_driver_version[];
 371
 372 int i40evf_up(struct i40evf_adapter *adapter);
 373 void i40evf_down(struct i40evf_adapter *adapter);
 374 int i40evf_process_config(struct i40evf_adapter *adapter);
 375 void i40evf_schedule_reset(struct i40evf_adapter *adapter);
 376 void i40evf_reset(struct i40evf_adapter *adapter);
 377 void i40evf_set_ethtool_ops(struct net_device *netdev);
 378 void i40evf_update_stats(struct i40evf_adapter *adapter);
 379 void i40evf_reset_interrupt_capability(struct i40evf_adapter *adapter);
 380 int i40evf_init_interrupt_scheme(struct i40evf_adapter *adapter);
 381 void i40evf_irq_enable_queues(struct i40evf_adapter *adapter, u32 mask);
 382 void i40evf_free_all_tx_resources(struct i40evf_adapter *adapter);
 383 void i40evf_free_all_rx_resources(struct i40evf_adapter *adapter);
 384
 385 void i40e_napi_add_all(struct i40evf_adapter *adapter);
 386 void i40e_napi_del_all(struct i40evf_adapter *adapter);
 387
 388 int i40evf_send_api_ver(struct i40evf_adapter *adapter);
 389 int i40evf_verify_api_ver(struct i40evf_adapter *adapter);
 390 int i40evf_send_vf_config_msg(struct i40evf_adapter *adapter);
 391 int i40evf_get_vf_config(struct i40evf_adapter *adapter);
 392 void i40evf_irq_enable(struct i40evf_adapter *adapter, bool flush);
 393 void i40evf_configure_queues(struct i40evf_adapter *adapter);
 394 void i40evf_deconfigure_queues(struct i40evf_adapter *adapter);
 395 void i40evf_enable_queues(struct i40evf_adapter *adapter);
 396 void i40evf_disable_queues(struct i40evf_adapter *adapter);
 397 void i40evf_map_queues(struct i40evf_adapter *adapter);
 398 int i40evf_request_queues(struct i40evf_adapter *adapter, int num);
 399 void i40evf_add_ether_addrs(struct i40evf_adapter *adapter);
 400 void i40evf_del_ether_addrs(struct i40evf_adapter *adapter);
 401 void i40evf_add_vlans(struct i40evf_adapter *adapter);
 402 void i40evf_del_vlans(struct i40evf_adapter *adapter);
 403 void i40evf_set_promiscuous(struct i40evf_adapter *adapter, int flags);
 404 void i40evf_request_stats(struct i40evf_adapter *adapter);
 405 void i40evf_request_reset(struct i40evf_adapter *adapter);
 406 void i40evf_get_hena(struct i40evf_adapter *adapter);
 407 void i40evf_set_hena(struct i40evf_adapter *adapter);
 408 void i40evf_set_rss_key(struct i40evf_adapter *adapter);
 409 void i40evf_set_rss_lut(struct i40evf_adapter *adapter);
 410 void i40evf_enable_vlan_stripping(struct i40evf_adapter *adapter);
 411 void i40evf_disable_vlan_stripping(struct i40evf_adapter *adapter);
 412 void i40evf_virtchnl_completion(struct i40evf_adapter *adapter,
 413                                 enum virtchnl_ops v_opcode,
 414                                 i40e_status v_retval, u8 *msg, u16 msglen);
 415 int i40evf_config_rss(struct i40evf_adapter *adapter);
 416 int i40evf_lan_add_device(struct i40evf_adapter *adapter);
 417 int i40evf_lan_del_device(struct i40evf_adapter *adapter);
 418 void i40evf_client_subtask(struct i40evf_adapter *adapter);
 419 void i40evf_notify_client_message(struct i40e_vsi *vsi, u8 *msg, u16 len);
 420 void i40evf_notify_client_l2_params(struct i40e_vsi *vsi);
 421 void i40evf_notify_client_open(struct i40e_vsi *vsi);
 422 void i40evf_notify_client_close(struct i40e_vsi *vsi, bool reset);
 423 void i40evf_enable_channels(struct i40evf_adapter *adapter);
 424 void i40evf_disable_channels(struct i40evf_adapter *adapter);
 425 void i40evf_add_cloud_filter(struct i40evf_adapter *adapter);
 426 void i40evf_del_cloud_filter(struct i40evf_adapter *adapter);
 427 #endif /* _I40EVF_H_ */