2 * Linux driver for VMware's vmxnet3 ethernet NIC.
4 * Copyright (C) 2008-2009, VMware, Inc. All Rights Reserved.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; version 2 of the License and no later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
13 * NON INFRINGEMENT. See the GNU General Public License for more
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 * The full GNU General Public License is included in this distribution in
21 * the file called "COPYING".
23 * Maintained by: Shreyas Bhatewara <pv-drivers@vmware.com>
27 #ifndef _VMXNET3_INT_H
28 #define _VMXNET3_INT_H
30 #include <linux/bitops.h>
31 #include <linux/ethtool.h>
32 #include <linux/delay.h>
33 #include <linux/netdevice.h>
34 #include <linux/pci.h>
35 #include <linux/compiler.h>
36 #include <linux/slab.h>
37 #include <linux/spinlock.h>
38 #include <linux/ioport.h>
39 #include <linux/highmem.h>
40 #include <linux/timer.h>
41 #include <linux/skbuff.h>
42 #include <linux/interrupt.h>
43 #include <linux/workqueue.h>
44 #include <linux/uaccess.h>
48 #include <linux/tcp.h>
49 #include <linux/udp.h>
51 #include <linux/ipv6.h>
53 #include <linux/etherdevice.h>
54 #include <asm/checksum.h>
55 #include <linux/if_vlan.h>
56 #include <linux/if_arp.h>
57 #include <linux/inetdevice.h>
58 #include <linux/log2.h>
60 #include "vmxnet3_defs.h"
63 # define VMXNET3_DRIVER_VERSION_REPORT VMXNET3_DRIVER_VERSION_STRING"-NAPI(debug)"
65 # define VMXNET3_DRIVER_VERSION_REPORT VMXNET3_DRIVER_VERSION_STRING"-NAPI"
72 #define VMXNET3_DRIVER_VERSION_STRING "1.3.5.0-k"
74 /* a 32-bit int, each byte encode a verion number in VMXNET3_DRIVER_VERSION */
75 #define VMXNET3_DRIVER_VERSION_NUM 0x01030500
77 #if defined(CONFIG_PCI_MSI)
78 /* RSS only makes sense if MSI-X is supported. */
87 VMNET_CAP_SG
= 0x0001, /* Can do scatter-gather transmits. */
88 VMNET_CAP_IP4_CSUM
= 0x0002, /* Can checksum only TCP/UDP over
90 VMNET_CAP_HW_CSUM
= 0x0004, /* Can checksum all packets. */
91 VMNET_CAP_HIGH_DMA
= 0x0008, /* Can DMA to high memory. */
92 VMNET_CAP_TOE
= 0x0010, /* Supports TCP/IP offload. */
93 VMNET_CAP_TSO
= 0x0020, /* Supports TCP Segmentation
95 VMNET_CAP_SW_TSO
= 0x0040, /* Supports SW TCP Segmentation */
96 VMNET_CAP_VMXNET_APROM
= 0x0080, /* Vmxnet APROM support */
97 VMNET_CAP_HW_TX_VLAN
= 0x0100, /* Can we do VLAN tagging in HW */
98 VMNET_CAP_HW_RX_VLAN
= 0x0200, /* Can we do VLAN untagging in HW */
99 VMNET_CAP_SW_VLAN
= 0x0400, /* VLAN tagging/untagging in SW */
100 VMNET_CAP_WAKE_PCKT_RCV
= 0x0800, /* Can wake on network packet recv? */
101 VMNET_CAP_ENABLE_INT_INLINE
= 0x1000, /* Enable Interrupt Inline */
102 VMNET_CAP_ENABLE_HEADER_COPY
= 0x2000, /* copy header for vmkernel */
103 VMNET_CAP_TX_CHAIN
= 0x4000, /* Guest can use multiple tx entries
105 VMNET_CAP_RX_CHAIN
= 0x8000, /* pkt can span multiple rx entries */
106 VMNET_CAP_LPD
= 0x10000, /* large pkt delivery */
107 VMNET_CAP_BPF
= 0x20000, /* BPF Support in VMXNET Virtual HW*/
108 VMNET_CAP_SG_SPAN_PAGES
= 0x40000, /* Scatter-gather can span multiple*/
109 /* pages transmits */
110 VMNET_CAP_IP6_CSUM
= 0x80000, /* Can do IPv6 csum offload. */
111 VMNET_CAP_TSO6
= 0x100000, /* TSO seg. offload for IPv6 pkts. */
112 VMNET_CAP_TSO256k
= 0x200000, /* Can do TSO seg offload for */
113 /* pkts up to 256kB. */
114 VMNET_CAP_UPT
= 0x400000 /* Support UPT */
118 * PCI vendor and device IDs.
120 #define PCI_DEVICE_ID_VMWARE_VMXNET3 0x07B0
121 #define MAX_ETHERNET_CARDS 10
122 #define MAX_PCI_PASSTHRU_DEVICE 6
124 struct vmxnet3_cmd_ring
{
125 union Vmxnet3_GenericDesc
*base
;
134 vmxnet3_cmd_ring_adv_next2fill(struct vmxnet3_cmd_ring
*ring
)
137 if (unlikely(ring
->next2fill
== ring
->size
)) {
139 VMXNET3_FLIP_RING_GEN(ring
->gen
);
144 vmxnet3_cmd_ring_adv_next2comp(struct vmxnet3_cmd_ring
*ring
)
146 VMXNET3_INC_RING_IDX_ONLY(ring
->next2comp
, ring
->size
);
150 vmxnet3_cmd_ring_desc_avail(struct vmxnet3_cmd_ring
*ring
)
152 return (ring
->next2comp
> ring
->next2fill
? 0 : ring
->size
) +
153 ring
->next2comp
- ring
->next2fill
- 1;
156 struct vmxnet3_comp_ring
{
157 union Vmxnet3_GenericDesc
*base
;
166 vmxnet3_comp_ring_adv_next2proc(struct vmxnet3_comp_ring
*ring
)
169 if (unlikely(ring
->next2proc
== ring
->size
)) {
171 VMXNET3_FLIP_RING_GEN(ring
->gen
);
175 struct vmxnet3_tx_data_ring
{
176 struct Vmxnet3_TxDataDesc
*base
;
181 enum vmxnet3_buf_map_type
{
182 VMXNET3_MAP_INVALID
= 0,
188 struct vmxnet3_tx_buf_info
{
196 struct vmxnet3_tq_driver_stats
{
197 u64 drop_total
; /* # of pkts dropped by the driver, the
198 * counters below track droppings due to
201 u64 drop_too_many_frags
;
202 u64 drop_oversized_hdr
;
203 u64 drop_hdr_inspect_err
;
207 u64 linearized
; /* # of pkts linearized */
208 u64 copy_skb_header
; /* # of times we have to copy skb header */
212 struct vmxnet3_tx_ctx
{
216 u32 eth_ip_hdr_size
; /* only valid for pkts requesting tso or csum
219 u32 l4_hdr_size
; /* only valid if mss != 0 */
220 u32 copy_size
; /* # of bytes copied into the data ring */
221 union Vmxnet3_GenericDesc
*sop_txd
;
222 union Vmxnet3_GenericDesc
*eop_txd
;
225 struct vmxnet3_tx_queue
{
226 char name
[IFNAMSIZ
+8]; /* To identify interrupt */
227 struct vmxnet3_adapter
*adapter
;
229 struct vmxnet3_cmd_ring tx_ring
;
230 struct vmxnet3_tx_buf_info
*buf_info
;
231 dma_addr_t buf_info_pa
;
232 struct vmxnet3_tx_data_ring data_ring
;
233 struct vmxnet3_comp_ring comp_ring
;
234 struct Vmxnet3_TxQueueCtrl
*shared
;
235 struct vmxnet3_tq_driver_stats stats
;
237 int num_stop
; /* # of times the queue is
240 } __attribute__((__aligned__(SMP_CACHE_BYTES
)));
242 enum vmxnet3_rx_buf_type
{
243 VMXNET3_RX_BUF_NONE
= 0,
244 VMXNET3_RX_BUF_SKB
= 1,
245 VMXNET3_RX_BUF_PAGE
= 2
248 struct vmxnet3_rx_buf_info
{
249 enum vmxnet3_rx_buf_type buf_type
;
258 struct vmxnet3_rx_ctx
{
263 struct vmxnet3_rq_driver_stats
{
267 u64 rx_buf_alloc_failure
;
270 struct vmxnet3_rx_queue
{
271 char name
[IFNAMSIZ
+ 8]; /* To identify interrupt */
272 struct vmxnet3_adapter
*adapter
;
273 struct napi_struct napi
;
274 struct vmxnet3_cmd_ring rx_ring
[2];
275 struct vmxnet3_comp_ring comp_ring
;
276 struct vmxnet3_rx_ctx rx_ctx
;
277 u32 qid
; /* rqID in RCD for buffer from 1st ring */
278 u32 qid2
; /* rqID in RCD for buffer from 2nd ring */
279 struct vmxnet3_rx_buf_info
*buf_info
[2];
280 dma_addr_t buf_info_pa
;
281 struct Vmxnet3_RxQueueCtrl
*shared
;
282 struct vmxnet3_rq_driver_stats stats
;
283 } __attribute__((__aligned__(SMP_CACHE_BYTES
)));
285 #define VMXNET3_DEVICE_MAX_TX_QUEUES 8
286 #define VMXNET3_DEVICE_MAX_RX_QUEUES 8 /* Keep this value as a power of 2 */
288 /* Should be less than UPT1_RSS_MAX_IND_TABLE_SIZE */
289 #define VMXNET3_RSS_IND_TABLE_SIZE (VMXNET3_DEVICE_MAX_RX_QUEUES * 4)
291 #define VMXNET3_LINUX_MAX_MSIX_VECT (VMXNET3_DEVICE_MAX_TX_QUEUES + \
292 VMXNET3_DEVICE_MAX_RX_QUEUES + 1)
293 #define VMXNET3_LINUX_MIN_MSIX_VECT 2 /* 1 for tx-rx pair and 1 for event */
296 struct vmxnet3_intr
{
297 enum vmxnet3_intr_mask_mode mask_mode
;
298 enum vmxnet3_intr_type type
; /* MSI-X, MSI, or INTx? */
299 u8 num_intrs
; /* # of intr vectors */
300 u8 event_intr_idx
; /* idx of the intr vector for event */
301 u8 mod_levels
[VMXNET3_LINUX_MAX_MSIX_VECT
]; /* moderation level */
302 char event_msi_vector_name
[IFNAMSIZ
+11];
303 #ifdef CONFIG_PCI_MSI
304 struct msix_entry msix_entries
[VMXNET3_LINUX_MAX_MSIX_VECT
];
308 /* Interrupt sharing schemes, share_intr */
309 #define VMXNET3_INTR_BUDDYSHARE 0 /* Corresponding tx,rx queues share irq */
310 #define VMXNET3_INTR_TXSHARE 1 /* All tx queues share one irq */
311 #define VMXNET3_INTR_DONTSHARE 2 /* each queue has its own irq */
314 #define VMXNET3_STATE_BIT_RESETTING 0
315 #define VMXNET3_STATE_BIT_QUIESCED 1
316 struct vmxnet3_adapter
{
317 struct vmxnet3_tx_queue tx_queue
[VMXNET3_DEVICE_MAX_TX_QUEUES
];
318 struct vmxnet3_rx_queue rx_queue
[VMXNET3_DEVICE_MAX_RX_QUEUES
];
319 unsigned long active_vlans
[BITS_TO_LONGS(VLAN_N_VID
)];
320 struct vmxnet3_intr intr
;
322 struct Vmxnet3_DriverShared
*shared
;
323 struct Vmxnet3_PMConf
*pm_conf
;
324 struct Vmxnet3_TxQueueDesc
*tqd_start
; /* all tx queue desc */
325 struct Vmxnet3_RxQueueDesc
*rqd_start
; /* all rx queue desc */
326 struct net_device
*netdev
;
327 struct pci_dev
*pdev
;
329 u8 __iomem
*hw_addr0
; /* for BAR 0 */
330 u8 __iomem
*hw_addr1
; /* for BAR 1 */
333 struct UPT1_RSSConf
*rss_conf
;
339 /* rx buffer related */
340 unsigned skb_buf_size
;
341 int rx_buf_per_pkt
; /* only apply to the 1st ring */
342 dma_addr_t shared_pa
;
343 dma_addr_t queue_desc_pa
;
349 u32 link_speed
; /* in mbps */
351 u64 tx_timeout_count
;
358 struct work_struct work
;
360 unsigned long state
; /* VMXNET3_STATE_BIT_xxx */
364 dma_addr_t adapter_pa
;
365 dma_addr_t pm_conf_pa
;
366 dma_addr_t rss_conf_pa
;
369 #define VMXNET3_WRITE_BAR0_REG(adapter, reg, val) \
370 writel((val), (adapter)->hw_addr0 + (reg))
371 #define VMXNET3_READ_BAR0_REG(adapter, reg) \
372 readl((adapter)->hw_addr0 + (reg))
374 #define VMXNET3_WRITE_BAR1_REG(adapter, reg, val) \
375 writel((val), (adapter)->hw_addr1 + (reg))
376 #define VMXNET3_READ_BAR1_REG(adapter, reg) \
377 readl((adapter)->hw_addr1 + (reg))
379 #define VMXNET3_WAKE_QUEUE_THRESHOLD(tq) (5)
380 #define VMXNET3_RX_ALLOC_THRESHOLD(rq, ring_idx, adapter) \
381 ((rq)->rx_ring[ring_idx].size >> 3)
383 #define VMXNET3_GET_ADDR_LO(dma) ((u32)(dma))
384 #define VMXNET3_GET_ADDR_HI(dma) ((u32)(((u64)(dma)) >> 32))
386 /* must be a multiple of VMXNET3_RING_SIZE_ALIGN */
387 #define VMXNET3_DEF_TX_RING_SIZE 512
388 #define VMXNET3_DEF_RX_RING_SIZE 256
389 #define VMXNET3_DEF_RX_RING2_SIZE 128
391 #define VMXNET3_MAX_ETH_HDR_SIZE 22
392 #define VMXNET3_MAX_SKB_BUF_SIZE (3*1024)
395 vmxnet3_quiesce_dev(struct vmxnet3_adapter
*adapter
);
398 vmxnet3_activate_dev(struct vmxnet3_adapter
*adapter
);
401 vmxnet3_force_close(struct vmxnet3_adapter
*adapter
);
404 vmxnet3_reset_dev(struct vmxnet3_adapter
*adapter
);
407 vmxnet3_tq_destroy_all(struct vmxnet3_adapter
*adapter
);
410 vmxnet3_rq_destroy_all(struct vmxnet3_adapter
*adapter
);
413 vmxnet3_set_features(struct net_device
*netdev
, netdev_features_t features
);
416 vmxnet3_create_queues(struct vmxnet3_adapter
*adapter
,
417 u32 tx_ring_size
, u32 rx_ring_size
, u32 rx_ring2_size
);
419 void vmxnet3_set_ethtool_ops(struct net_device
*netdev
);
421 struct rtnl_link_stats64
*
422 vmxnet3_get_stats64(struct net_device
*dev
, struct rtnl_link_stats64
*stats
);
424 extern char vmxnet3_driver_name
[];