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