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

   1 /*******************************************************************************
   2  *
   3  * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver
   4  * Copyright(c) 2013 - 2016 Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * The full GNU General Public License is included in this distribution in
  19  * the file called "COPYING".
  20  *
  21  * Contact Information:
  22  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  ******************************************************************************/
  26
  27 #ifndef _I40EVF_H_
  28 #define _I40EVF_H_
  29
  30 #include <linux/module.h>
  31 #include <linux/pci.h>
  32 #include <linux/aer.h>
  33 #include <linux/netdevice.h>
  34 #include <linux/vmalloc.h>
  35 #include <linux/interrupt.h>
  36 #include <linux/ethtool.h>
  37 #include <linux/if_vlan.h>
  38 #include <linux/ip.h>
  39 #include <linux/tcp.h>
  40 #include <linux/sctp.h>
  41 #include <linux/ipv6.h>
  42 #include <linux/kernel.h>
  43 #include <linux/bitops.h>
  44 #include <linux/timer.h>
  45 #include <linux/workqueue.h>
  46 #include <linux/wait.h>
  47 #include <linux/delay.h>
  48 #include <linux/gfp.h>
  49 #include <linux/skbuff.h>
  50 #include <linux/dma-mapping.h>
  51 #include <linux/etherdevice.h>
  52 #include <linux/socket.h>
  53 #include <linux/jiffies.h>
  54 #include <net/ip6_checksum.h>
  55 #include <net/udp.h>
  56
  57 #include "i40e_type.h"
  58 #include <linux/avf/virtchnl.h>
  59 #include "i40e_txrx.h"
  60
  61 #define DEFAULT_DEBUG_LEVEL_SHIFT 3
  62 #define PFX "i40evf: "
  63
  64 /* VSI state flags shared with common code */
  65 enum i40evf_vsi_state_t {
  66         __I40E_VSI_DOWN,
  67         /* This must be last as it determines the size of the BITMAP */
  68         __I40E_VSI_STATE_SIZE__,
  69 };
  70
  71 /* dummy struct to make common code less painful */
  72 struct i40e_vsi {
  73         struct i40evf_adapter *back;
  74         struct net_device *netdev;
  75         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
  76         u16 seid;
  77         u16 id;
  78         DECLARE_BITMAP(state, __I40E_VSI_STATE_SIZE__);
  79         int base_vector;
  80         u16 work_limit;
  81         u16 qs_handle;
  82         void *priv;     /* client driver data reference. */
  83 };
  84
  85 /* How many Rx Buffers do we bundle into one write to the hardware ? */
  86 #define I40EVF_RX_BUFFER_WRITE  16      /* Must be power of 2 */
  87 #define I40EVF_DEFAULT_TXD      512
  88 #define I40EVF_DEFAULT_RXD      512
  89 #define I40EVF_MAX_TXD          4096
  90 #define I40EVF_MIN_TXD          64
  91 #define I40EVF_MAX_RXD          4096
  92 #define I40EVF_MIN_RXD          64
  93 #define I40EVF_REQ_DESCRIPTOR_MULTIPLE  32
  94 #define I40EVF_MAX_AQ_BUF_SIZE  4096
  95 #define I40EVF_AQ_LEN           32
  96 #define I40EVF_AQ_MAX_ERR       20 /* times to try before resetting AQ */
  97
  98 #define MAXIMUM_ETHERNET_VLAN_SIZE (VLAN_ETH_FRAME_LEN + ETH_FCS_LEN)
  99
 100 #define I40E_RX_DESC(R, i) (&(((union i40e_32byte_rx_desc *)((R)->desc))[i]))
 101 #define I40E_TX_DESC(R, i) (&(((struct i40e_tx_desc *)((R)->desc))[i]))
 102 #define I40E_TX_CTXTDESC(R, i) \
 103         (&(((struct i40e_tx_context_desc *)((R)->desc))[i]))
 104 #define MAX_QUEUES 16
 105
 106 #define I40EVF_HKEY_ARRAY_SIZE ((I40E_VFQF_HKEY_MAX_INDEX + 1) * 4)
 107 #define I40EVF_HLUT_ARRAY_SIZE ((I40E_VFQF_HLUT_MAX_INDEX + 1) * 4)
 108
 109 /* MAX_MSIX_Q_VECTORS of these are allocated,
 110  * but we only use one per queue-specific vector.
 111  */
 112 struct i40e_q_vector {
 113         struct i40evf_adapter *adapter;
 114         struct i40e_vsi *vsi;
 115         struct napi_struct napi;
 116         unsigned long reg_idx;
 117         struct i40e_ring_container rx;
 118         struct i40e_ring_container tx;
 119         u32 ring_mask;
 120         u8 num_ringpairs;       /* total number of ring pairs in vector */
 121 #define ITR_COUNTDOWN_START 100
 122         u8 itr_countdown;       /* when 0 or 1 update ITR */
 123         int v_idx;      /* vector index in list */
 124         char name[IFNAMSIZ + 15];
 125         bool arm_wb_state;
 126         cpumask_t affinity_mask;
 127         struct irq_affinity_notify affinity_notify;
 128 };
 129
 130 /* Helper macros to switch between ints/sec and what the register uses.
 131  * And yes, it's the same math going both ways.  The lowest value
 132  * supported by all of the i40e hardware is 8.
 133  */
 134 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \
 135         ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8)
 136 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG
 137
 138 #define I40EVF_DESC_UNUSED(R) \
 139         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 140         (R)->next_to_clean - (R)->next_to_use - 1)
 141
 142 #define I40EVF_RX_DESC_ADV(R, i)        \
 143         (&(((union i40e_adv_rx_desc *)((R).desc))[i]))
 144 #define I40EVF_TX_DESC_ADV(R, i)        \
 145         (&(((union i40e_adv_tx_desc *)((R).desc))[i]))
 146 #define I40EVF_TX_CTXTDESC_ADV(R, i)    \
 147         (&(((struct i40e_adv_tx_context_desc *)((R).desc))[i]))
 148
 149 #define OTHER_VECTOR 1
 150 #define NONQ_VECS (OTHER_VECTOR)
 151
 152 #define MIN_MSIX_Q_VECTORS 1
 153 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NONQ_VECS)
 154
 155 #define I40EVF_QUEUE_END_OF_LIST 0x7FF
 156 #define I40EVF_FREE_VECTOR 0x7FFF
 157 struct i40evf_mac_filter {
 158         struct list_head list;
 159         u8 macaddr[ETH_ALEN];
 160         bool remove;            /* filter needs to be removed */
 161         bool add;               /* filter needs to be added */
 162 };
 163
 164 struct i40evf_vlan_filter {
 165         struct list_head list;
 166         u16 vlan;
 167         bool remove;            /* filter needs to be removed */
 168         bool add;               /* filter needs to be added */
 169 };
 170
 171 /* Driver state. The order of these is important! */
 172 enum i40evf_state_t {
 173         __I40EVF_STARTUP,               /* driver loaded, probe complete */
 174         __I40EVF_REMOVE,                /* driver is being unloaded */
 175         __I40EVF_INIT_VERSION_CHECK,    /* aq msg sent, awaiting reply */
 176         __I40EVF_INIT_GET_RESOURCES,    /* aq msg sent, awaiting reply */
 177         __I40EVF_INIT_SW,               /* got resources, setting up structs */
 178         __I40EVF_RESETTING,             /* in reset */
 179         /* Below here, watchdog is running */
 180         __I40EVF_DOWN,                  /* ready, can be opened */
 181         __I40EVF_DOWN_PENDING,          /* descending, waiting for watchdog */
 182         __I40EVF_TESTING,               /* in ethtool self-test */
 183         __I40EVF_RUNNING,               /* opened, working */
 184 };
 185
 186 enum i40evf_critical_section_t {
 187         __I40EVF_IN_CRITICAL_TASK,      /* cannot be interrupted */
 188         __I40EVF_IN_CLIENT_TASK,
 189         __I40EVF_IN_REMOVE_TASK,        /* device being removed */
 190 };
 191
 192 /* board specific private data structure */
 193 struct i40evf_adapter {
 194         struct timer_list watchdog_timer;
 195         struct work_struct reset_task;
 196         struct work_struct adminq_task;
 197         struct delayed_work client_task;
 198         struct delayed_work init_task;
 199         wait_queue_head_t down_waitqueue;
 200         struct i40e_q_vector *q_vectors;
 201         struct list_head vlan_filter_list;
 202         char misc_vector_name[IFNAMSIZ + 9];
 203         int num_active_queues;
 204
 205         /* TX */
 206         struct i40e_ring *tx_rings;
 207         u32 tx_timeout_count;
 208         struct list_head mac_filter_list;
 209         u32 tx_desc_count;
 210
 211         /* RX */
 212         struct i40e_ring *rx_rings;
 213         u64 hw_csum_rx_error;
 214         u32 rx_desc_count;
 215         int num_msix_vectors;
 216         int num_iwarp_msix;
 217         int iwarp_base_vector;
 218         u32 client_pending;
 219         struct i40e_client_instance *cinst;
 220         struct msix_entry *msix_entries;
 221
 222         u32 flags;
 223 #define I40EVF_FLAG_RX_CSUM_ENABLED             BIT(0)
 224 #define I40EVF_FLAG_IMIR_ENABLED                BIT(5)
 225 #define I40EVF_FLAG_MQ_CAPABLE                  BIT(6)
 226 #define I40EVF_FLAG_PF_COMMS_FAILED             BIT(8)
 227 #define I40EVF_FLAG_RESET_PENDING               BIT(9)
 228 #define I40EVF_FLAG_RESET_NEEDED                BIT(10)
 229 #define I40EVF_FLAG_WB_ON_ITR_CAPABLE           BIT(11)
 230 #define I40EVF_FLAG_OUTER_UDP_CSUM_CAPABLE      BIT(12)
 231 #define I40EVF_FLAG_ADDR_SET_BY_PF              BIT(13)
 232 #define I40EVF_FLAG_SERVICE_CLIENT_REQUESTED    BIT(14)
 233 #define I40EVF_FLAG_CLIENT_NEEDS_OPEN           BIT(15)
 234 #define I40EVF_FLAG_CLIENT_NEEDS_CLOSE          BIT(16)
 235 #define I40EVF_FLAG_CLIENT_NEEDS_L2_PARAMS      BIT(17)
 236 #define I40EVF_FLAG_PROMISC_ON                  BIT(18)
 237 #define I40EVF_FLAG_ALLMULTI_ON                 BIT(19)
 238 #define I40EVF_FLAG_LEGACY_RX                   BIT(20)
 239 /* duplicates for common code */
 240 #define I40E_FLAG_DCB_ENABLED                   0
 241 #define I40E_FLAG_RX_CSUM_ENABLED               I40EVF_FLAG_RX_CSUM_ENABLED
 242 #define I40E_FLAG_LEGACY_RX                     I40EVF_FLAG_LEGACY_RX
 243         /* flags for admin queue service task */
 244         u32 aq_required;
 245 #define I40EVF_FLAG_AQ_ENABLE_QUEUES            BIT(0)
 246 #define I40EVF_FLAG_AQ_DISABLE_QUEUES           BIT(1)
 247 #define I40EVF_FLAG_AQ_ADD_MAC_FILTER           BIT(2)
 248 #define I40EVF_FLAG_AQ_ADD_VLAN_FILTER          BIT(3)
 249 #define I40EVF_FLAG_AQ_DEL_MAC_FILTER           BIT(4)
 250 #define I40EVF_FLAG_AQ_DEL_VLAN_FILTER          BIT(5)
 251 #define I40EVF_FLAG_AQ_CONFIGURE_QUEUES         BIT(6)
 252 #define I40EVF_FLAG_AQ_MAP_VECTORS              BIT(7)
 253 #define I40EVF_FLAG_AQ_HANDLE_RESET             BIT(8)
 254 #define I40EVF_FLAG_AQ_CONFIGURE_RSS            BIT(9) /* direct AQ config */
 255 #define I40EVF_FLAG_AQ_GET_CONFIG               BIT(10)
 256 /* Newer style, RSS done by the PF so we can ignore hardware vagaries. */
 257 #define I40EVF_FLAG_AQ_GET_HENA                 BIT(11)
 258 #define I40EVF_FLAG_AQ_SET_HENA                 BIT(12)
 259 #define I40EVF_FLAG_AQ_SET_RSS_KEY              BIT(13)
 260 #define I40EVF_FLAG_AQ_SET_RSS_LUT              BIT(14)
 261 #define I40EVF_FLAG_AQ_REQUEST_PROMISC          BIT(15)
 262 #define I40EVF_FLAG_AQ_RELEASE_PROMISC          BIT(16)
 263 #define I40EVF_FLAG_AQ_REQUEST_ALLMULTI         BIT(17)
 264 #define I40EVF_FLAG_AQ_RELEASE_ALLMULTI         BIT(18)
 265 #define I40EVF_FLAG_AQ_ENABLE_VLAN_STRIPPING    BIT(19)
 266 #define I40EVF_FLAG_AQ_DISABLE_VLAN_STRIPPING   BIT(20)
 267
 268         /* OS defined structs */
 269         struct net_device *netdev;
 270         struct pci_dev *pdev;
 271
 272         struct i40e_hw hw; /* defined in i40e_type.h */
 273
 274         enum i40evf_state_t state;
 275         unsigned long crit_section;
 276
 277         struct work_struct watchdog_task;
 278         bool netdev_registered;
 279         bool link_up;
 280         enum virtchnl_link_speed link_speed;
 281         enum virtchnl_ops current_op;
 282 #define CLIENT_ALLOWED(_a) ((_a)->vf_res ? \
 283                             (_a)->vf_res->vf_cap_flags & \
 284                                 VIRTCHNL_VF_OFFLOAD_IWARP : \
 285                             0)
 286 #define CLIENT_ENABLED(_a) ((_a)->cinst)
 287 /* RSS by the PF should be preferred over RSS via other methods. */
 288 #define RSS_PF(_a) ((_a)->vf_res->vf_cap_flags & \
 289                     VIRTCHNL_VF_OFFLOAD_RSS_PF)
 290 #define RSS_AQ(_a) ((_a)->vf_res->vf_cap_flags & \
 291                     VIRTCHNL_VF_OFFLOAD_RSS_AQ)
 292 #define RSS_REG(_a) (!((_a)->vf_res->vf_cap_flags & \
 293                        (VIRTCHNL_VF_OFFLOAD_RSS_AQ | \
 294                         VIRTCHNL_VF_OFFLOAD_RSS_PF)))
 295 #define VLAN_ALLOWED(_a) ((_a)->vf_res->vf_cap_flags & \
 296                           VIRTCHNL_VF_OFFLOAD_VLAN)
 297         struct virtchnl_vf_resource *vf_res; /* incl. all VSIs */
 298         struct virtchnl_vsi_resource *vsi_res; /* our LAN VSI */
 299         struct virtchnl_version_info pf_version;
 300 #define PF_IS_V11(_a) (((_a)->pf_version.major == 1) && \
 301                        ((_a)->pf_version.minor == 1))
 302         u16 msg_enable;
 303         struct i40e_eth_stats current_stats;
 304         struct i40e_vsi vsi;
 305         u32 aq_wait_count;
 306         /* RSS stuff */
 307         u64 hena;
 308         u16 rss_key_size;
 309         u16 rss_lut_size;
 310         u8 *rss_key;
 311         u8 *rss_lut;
 312 };
 313
 314
 315 /* Ethtool Private Flags */
 316
 317 /* lan device */
 318 struct i40e_device {
 319         struct list_head list;
 320         struct i40evf_adapter *vf;
 321 };
 322
 323 /* needed by i40evf_ethtool.c */
 324 extern char i40evf_driver_name[];
 325 extern const char i40evf_driver_version[];
 326
 327 int i40evf_up(struct i40evf_adapter *adapter);
 328 void i40evf_down(struct i40evf_adapter *adapter);
 329 int i40evf_process_config(struct i40evf_adapter *adapter);
 330 void i40evf_schedule_reset(struct i40evf_adapter *adapter);
 331 void i40evf_reset(struct i40evf_adapter *adapter);
 332 void i40evf_set_ethtool_ops(struct net_device *netdev);
 333 void i40evf_update_stats(struct i40evf_adapter *adapter);
 334 void i40evf_reset_interrupt_capability(struct i40evf_adapter *adapter);
 335 int i40evf_init_interrupt_scheme(struct i40evf_adapter *adapter);
 336 void i40evf_irq_enable_queues(struct i40evf_adapter *adapter, u32 mask);
 337 void i40evf_free_all_tx_resources(struct i40evf_adapter *adapter);
 338 void i40evf_free_all_rx_resources(struct i40evf_adapter *adapter);
 339
 340 void i40e_napi_add_all(struct i40evf_adapter *adapter);
 341 void i40e_napi_del_all(struct i40evf_adapter *adapter);
 342
 343 int i40evf_send_api_ver(struct i40evf_adapter *adapter);
 344 int i40evf_verify_api_ver(struct i40evf_adapter *adapter);
 345 int i40evf_send_vf_config_msg(struct i40evf_adapter *adapter);
 346 int i40evf_get_vf_config(struct i40evf_adapter *adapter);
 347 void i40evf_irq_enable(struct i40evf_adapter *adapter, bool flush);
 348 void i40evf_configure_queues(struct i40evf_adapter *adapter);
 349 void i40evf_deconfigure_queues(struct i40evf_adapter *adapter);
 350 void i40evf_enable_queues(struct i40evf_adapter *adapter);
 351 void i40evf_disable_queues(struct i40evf_adapter *adapter);
 352 void i40evf_map_queues(struct i40evf_adapter *adapter);
 353 void i40evf_add_ether_addrs(struct i40evf_adapter *adapter);
 354 void i40evf_del_ether_addrs(struct i40evf_adapter *adapter);
 355 void i40evf_add_vlans(struct i40evf_adapter *adapter);
 356 void i40evf_del_vlans(struct i40evf_adapter *adapter);
 357 void i40evf_set_promiscuous(struct i40evf_adapter *adapter, int flags);
 358 void i40evf_request_stats(struct i40evf_adapter *adapter);
 359 void i40evf_request_reset(struct i40evf_adapter *adapter);
 360 void i40evf_get_hena(struct i40evf_adapter *adapter);
 361 void i40evf_set_hena(struct i40evf_adapter *adapter);
 362 void i40evf_set_rss_key(struct i40evf_adapter *adapter);
 363 void i40evf_set_rss_lut(struct i40evf_adapter *adapter);
 364 void i40evf_enable_vlan_stripping(struct i40evf_adapter *adapter);
 365 void i40evf_disable_vlan_stripping(struct i40evf_adapter *adapter);
 366 void i40evf_virtchnl_completion(struct i40evf_adapter *adapter,
 367                                 enum virtchnl_ops v_opcode,
 368                                 i40e_status v_retval, u8 *msg, u16 msglen);
 369 int i40evf_config_rss(struct i40evf_adapter *adapter);
 370 int i40evf_lan_add_device(struct i40evf_adapter *adapter);
 371 int i40evf_lan_del_device(struct i40evf_adapter *adapter);
 372 void i40evf_client_subtask(struct i40evf_adapter *adapter);
 373 void i40evf_notify_client_message(struct i40e_vsi *vsi, u8 *msg, u16 len);
 374 void i40evf_notify_client_l2_params(struct i40e_vsi *vsi);
 375 void i40evf_notify_client_open(struct i40e_vsi *vsi);
 376 void i40evf_notify_client_close(struct i40e_vsi *vsi, bool reset);
 377 #endif /* _I40EVF_H_ */