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

   1 /*******************************************************************************
   2  *
   3  * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver
   4  * Copyright(c) 2013 - 2014 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  * The full GNU General Public License is included in this distribution in
  16  * the file called "COPYING".
  17  *
  18  * Contact Information:
  19  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  20  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  21  *
  22  ******************************************************************************/
  23
  24 #ifndef _I40EVF_H_
  25 #define _I40EVF_H_
  26
  27 #include <linux/module.h>
  28 #include <linux/pci.h>
  29 #include <linux/aer.h>
  30 #include <linux/netdevice.h>
  31 #include <linux/vmalloc.h>
  32 #include <linux/interrupt.h>
  33 #include <linux/ethtool.h>
  34 #include <linux/if_vlan.h>
  35 #include <linux/ip.h>
  36 #include <linux/tcp.h>
  37 #include <linux/sctp.h>
  38 #include <linux/ipv6.h>
  39 #include <net/ip6_checksum.h>
  40 #include <net/udp.h>
  41 #include <linux/sctp.h>
  42
  43
  44 #include "i40e_type.h"
  45 #include "i40e_virtchnl.h"
  46 #include "i40e_txrx.h"
  47
  48 #define DEFAULT_DEBUG_LEVEL_SHIFT 3
  49 #define PFX "i40evf: "
  50 #define DPRINTK(nlevel, klevel, fmt, args...) \
  51         ((void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
  52         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
  53                 __func__ , ## args)))
  54
  55 /* dummy struct to make common code less painful */
  56 struct i40e_vsi {
  57         struct i40evf_adapter *back;
  58         struct net_device *netdev;
  59         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
  60         u16 seid;
  61         u16 id;
  62         unsigned long state;
  63         int base_vector;
  64         u16 work_limit;
  65         /* high bit set means dynamic, use accessor routines to read/write.
  66          * hardware only supports 2us resolution for the ITR registers.
  67          * these values always store the USER setting, and must be converted
  68          * before programming to a register.
  69          */
  70         u16 rx_itr_setting;
  71         u16 tx_itr_setting;
  72 };
  73
  74 /* How many Rx Buffers do we bundle into one write to the hardware ? */
  75 #define I40EVF_RX_BUFFER_WRITE  16      /* Must be power of 2 */
  76 #define I40EVF_DEFAULT_TXD   512
  77 #define I40EVF_DEFAULT_RXD   512
  78 #define I40EVF_MAX_TXD       4096
  79 #define I40EVF_MIN_TXD       64
  80 #define I40EVF_MAX_RXD       4096
  81 #define I40EVF_MIN_RXD       64
  82 #define I40EVF_REQ_DESCRIPTOR_MULTIPLE  8
  83
  84 /* Supported Rx Buffer Sizes */
  85 #define I40EVF_RXBUFFER_64    64     /* Used for packet split */
  86 #define I40EVF_RXBUFFER_128   128    /* Used for packet split */
  87 #define I40EVF_RXBUFFER_256   256    /* Used for packet split */
  88 #define I40EVF_RXBUFFER_2048  2048
  89 #define I40EVF_MAX_RXBUFFER   16384  /* largest size for single descriptor */
  90 #define I40EVF_MAX_AQ_BUF_SIZE    4096
  91 #define I40EVF_AQ_LEN             32
  92 #define I40EVF_AQ_MAX_ERR         10 /* times to try before resetting AQ */
  93
  94 #define MAXIMUM_ETHERNET_VLAN_SIZE (VLAN_ETH_FRAME_LEN + ETH_FCS_LEN)
  95
  96 #define I40E_RX_DESC(R, i) (&(((union i40e_32byte_rx_desc *)((R)->desc))[i]))
  97 #define I40E_TX_DESC(R, i) (&(((struct i40e_tx_desc *)((R)->desc))[i]))
  98 #define I40E_TX_CTXTDESC(R, i) \
  99         (&(((struct i40e_tx_context_desc *)((R)->desc))[i]))
 100 #define MAX_RX_QUEUES 8
 101 #define MAX_TX_QUEUES MAX_RX_QUEUES
 102
 103 /* MAX_MSIX_Q_VECTORS of these are allocated,
 104  * but we only use one per queue-specific vector.
 105  */
 106 struct i40e_q_vector {
 107         struct i40evf_adapter *adapter;
 108         struct i40e_vsi *vsi;
 109         struct napi_struct napi;
 110         unsigned long reg_idx;
 111         struct i40e_ring_container rx;
 112         struct i40e_ring_container tx;
 113         u32 ring_mask;
 114         u8 num_ringpairs;       /* total number of ring pairs in vector */
 115         int v_idx;        /* vector index in list */
 116         char name[IFNAMSIZ + 9];
 117         cpumask_var_t affinity_mask;
 118 };
 119
 120 /* Helper macros to switch between ints/sec and what the register uses.
 121  * And yes, it's the same math going both ways.  The lowest value
 122  * supported by all of the i40e hardware is 8.
 123  */
 124 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \
 125         ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8)
 126 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG
 127
 128 #define I40EVF_DESC_UNUSED(R) \
 129         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 130         (R)->next_to_clean - (R)->next_to_use - 1)
 131
 132 #define I40EVF_RX_DESC_ADV(R, i)            \
 133         (&(((union i40e_adv_rx_desc *)((R).desc))[i]))
 134 #define I40EVF_TX_DESC_ADV(R, i)            \
 135         (&(((union i40e_adv_tx_desc *)((R).desc))[i]))
 136 #define I40EVF_TX_CTXTDESC_ADV(R, i)        \
 137         (&(((struct i40e_adv_tx_context_desc *)((R).desc))[i]))
 138
 139 #define OTHER_VECTOR 1
 140 #define NONQ_VECS (OTHER_VECTOR)
 141
 142 #define MAX_MSIX_Q_VECTORS 4
 143 #define MAX_MSIX_COUNT 5
 144
 145 #define MIN_MSIX_Q_VECTORS 1
 146 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NONQ_VECS)
 147
 148 #define I40EVF_QUEUE_END_OF_LIST 0x7FF
 149 #define I40EVF_FREE_VECTOR 0x7FFF
 150 struct i40evf_mac_filter {
 151         struct list_head list;
 152         u8 macaddr[ETH_ALEN];
 153         bool remove;            /* filter needs to be removed */
 154         bool add;               /* filter needs to be added */
 155 };
 156
 157 struct i40evf_vlan_filter {
 158         struct list_head list;
 159         u16 vlan;
 160         bool remove;            /* filter needs to be removed */
 161         bool add;               /* filter needs to be added */
 162 };
 163
 164 /* Driver state. The order of these is important! */
 165 enum i40evf_state_t {
 166         __I40EVF_STARTUP,               /* driver loaded, probe complete */
 167         __I40EVF_FAILED,                /* PF communication failed. Fatal. */
 168         __I40EVF_REMOVE,                /* driver is being unloaded */
 169         __I40EVF_INIT_VERSION_CHECK,    /* aq msg sent, awaiting reply */
 170         __I40EVF_INIT_GET_RESOURCES,    /* aq msg sent, awaiting reply */
 171         __I40EVF_INIT_SW,               /* got resources, setting up structs */
 172         /* Below here, watchdog is running */
 173         __I40EVF_DOWN,                  /* ready, can be opened */
 174         __I40EVF_TESTING,               /* in ethtool self-test */
 175         __I40EVF_RESETTING,             /* in reset */
 176         __I40EVF_RUNNING,               /* opened, working */
 177 };
 178
 179 enum i40evf_critical_section_t {
 180         __I40EVF_IN_CRITICAL_TASK,      /* cannot be interrupted */
 181 };
 182 /* make common code happy */
 183 #define __I40E_DOWN __I40EVF_DOWN
 184
 185 /* board specific private data structure */
 186 struct i40evf_adapter {
 187         struct timer_list watchdog_timer;
 188         struct work_struct reset_task;
 189         struct work_struct adminq_task;
 190         struct delayed_work init_task;
 191         struct i40e_q_vector *q_vector[MAX_MSIX_Q_VECTORS];
 192         struct list_head vlan_filter_list;
 193         char misc_vector_name[IFNAMSIZ + 9];
 194
 195         /* TX */
 196         struct i40e_ring *tx_rings[I40E_MAX_VSI_QP];
 197         u32 tx_timeout_count;
 198         struct list_head mac_filter_list;
 199
 200         /* RX */
 201         struct i40e_ring *rx_rings[I40E_MAX_VSI_QP];
 202         int txd_count;
 203         int rxd_count;
 204         u64 hw_csum_rx_error;
 205         int num_msix_vectors;
 206         struct msix_entry *msix_entries;
 207
 208         u32 flags;
 209 #define I40EVF_FLAG_RX_CSUM_ENABLED              (u32)(1)
 210 #define I40EVF_FLAG_RX_1BUF_CAPABLE              (u32)(1 << 1)
 211 #define I40EVF_FLAG_RX_PS_CAPABLE                (u32)(1 << 2)
 212 #define I40EVF_FLAG_RX_PS_ENABLED                (u32)(1 << 3)
 213 #define I40EVF_FLAG_IN_NETPOLL                   (u32)(1 << 4)
 214 #define I40EVF_FLAG_IMIR_ENABLED                 (u32)(1 << 5)
 215 #define I40EVF_FLAG_MQ_CAPABLE                   (u32)(1 << 6)
 216 #define I40EVF_FLAG_NEED_LINK_UPDATE             (u32)(1 << 7)
 217 /* duplcates for common code */
 218 #define I40E_FLAG_FDIR_ATR_ENABLED               0
 219 #define I40E_FLAG_DCB_ENABLED                    0
 220 #define I40E_FLAG_IN_NETPOLL                     I40EVF_FLAG_IN_NETPOLL
 221 #define I40E_FLAG_RX_CSUM_ENABLED                I40EVF_FLAG_RX_CSUM_ENABLED
 222         /* flags for admin queue service task */
 223         u32 aq_required;
 224         u32 aq_pending;
 225 #define I40EVF_FLAG_AQ_ENABLE_QUEUES            (u32)(1)
 226 #define I40EVF_FLAG_AQ_DISABLE_QUEUES           (u32)(1 << 1)
 227 #define I40EVF_FLAG_AQ_ADD_MAC_FILTER           (u32)(1 << 2)
 228 #define I40EVF_FLAG_AQ_ADD_VLAN_FILTER          (u32)(1 << 3)
 229 #define I40EVF_FLAG_AQ_DEL_MAC_FILTER           (u32)(1 << 4)
 230 #define I40EVF_FLAG_AQ_DEL_VLAN_FILTER          (u32)(1 << 5)
 231 #define I40EVF_FLAG_AQ_CONFIGURE_QUEUES         (u32)(1 << 6)
 232 #define I40EVF_FLAG_AQ_MAP_VECTORS              (u32)(1 << 7)
 233 #define I40EVF_FLAG_AQ_HANDLE_RESET             (u32)(1 << 8)
 234         /* OS defined structs */
 235         struct net_device *netdev;
 236         struct pci_dev *pdev;
 237         struct net_device_stats net_stats;
 238
 239         struct i40e_hw hw; /* defined in i40e_type.h */
 240
 241         enum i40evf_state_t state;
 242         volatile unsigned long crit_section;
 243
 244         struct work_struct watchdog_task;
 245         bool netdev_registered;
 246         bool link_up;
 247         enum i40e_virtchnl_ops current_op;
 248         struct i40e_virtchnl_vf_resource *vf_res; /* incl. all VSIs */
 249         struct i40e_virtchnl_vsi_resource *vsi_res; /* our LAN VSI */
 250         u16 msg_enable;
 251         struct i40e_eth_stats current_stats;
 252         struct i40e_vsi vsi;
 253         u32 aq_wait_count;
 254 };
 255
 256
 257 /* needed by i40evf_ethtool.c */
 258 extern char i40evf_driver_name[];
 259 extern const char i40evf_driver_version[];
 260
 261 int i40evf_up(struct i40evf_adapter *adapter);
 262 void i40evf_down(struct i40evf_adapter *adapter);
 263 void i40evf_reinit_locked(struct i40evf_adapter *adapter);
 264 void i40evf_reset(struct i40evf_adapter *adapter);
 265 void i40evf_set_ethtool_ops(struct net_device *netdev);
 266 void i40evf_update_stats(struct i40evf_adapter *adapter);
 267 void i40evf_reset_interrupt_capability(struct i40evf_adapter *adapter);
 268 int i40evf_init_interrupt_scheme(struct i40evf_adapter *adapter);
 269 void i40evf_irq_enable_queues(struct i40evf_adapter *adapter, u32 mask);
 270
 271 void i40e_napi_add_all(struct i40evf_adapter *adapter);
 272 void i40e_napi_del_all(struct i40evf_adapter *adapter);
 273
 274 int i40evf_send_api_ver(struct i40evf_adapter *adapter);
 275 int i40evf_verify_api_ver(struct i40evf_adapter *adapter);
 276 int i40evf_send_vf_config_msg(struct i40evf_adapter *adapter);
 277 int i40evf_get_vf_config(struct i40evf_adapter *adapter);
 278 void i40evf_irq_enable(struct i40evf_adapter *adapter, bool flush);
 279 void i40evf_configure_queues(struct i40evf_adapter *adapter);
 280 void i40evf_deconfigure_queues(struct i40evf_adapter *adapter);
 281 void i40evf_enable_queues(struct i40evf_adapter *adapter);
 282 void i40evf_disable_queues(struct i40evf_adapter *adapter);
 283 void i40evf_map_queues(struct i40evf_adapter *adapter);
 284 void i40evf_add_ether_addrs(struct i40evf_adapter *adapter);
 285 void i40evf_del_ether_addrs(struct i40evf_adapter *adapter);
 286 void i40evf_add_vlans(struct i40evf_adapter *adapter);
 287 void i40evf_del_vlans(struct i40evf_adapter *adapter);
 288 void i40evf_set_promiscuous(struct i40evf_adapter *adapter, int flags);
 289 void i40evf_request_stats(struct i40evf_adapter *adapter);
 290 void i40evf_virtchnl_completion(struct i40evf_adapter *adapter,
 291                                 enum i40e_virtchnl_ops v_opcode,
 292                                 i40e_status v_retval, u8 *msg, u16 msglen);
 293 #endif /* _I40EVF_H_ */