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