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_DEFS_H_
28
#define _VMXNET3_DEFS_H_
30
#include "upt1_defs.h"
32
/* all registers are 32 bit wide */
35
VMXNET3_REG_VRRS = 0x0, /* Vmxnet3 Revision Report Selection */
36
VMXNET3_REG_UVRS = 0x8, /* UPT Version Report Selection */
37
VMXNET3_REG_DSAL = 0x10, /* Driver Shared Address Low */
38
VMXNET3_REG_DSAH = 0x18, /* Driver Shared Address High */
39
VMXNET3_REG_CMD = 0x20, /* Command */
40
VMXNET3_REG_MACL = 0x28, /* MAC Address Low */
41
VMXNET3_REG_MACH = 0x30, /* MAC Address High */
42
VMXNET3_REG_ICR = 0x38, /* Interrupt Cause Register */
43
VMXNET3_REG_ECR = 0x40 /* Event Cause Register */
48
VMXNET3_REG_IMR = 0x0, /* Interrupt Mask Register */
49
VMXNET3_REG_TXPROD = 0x600, /* Tx Producer Index */
50
VMXNET3_REG_RXPROD = 0x800, /* Rx Producer Index for ring 1 */
51
VMXNET3_REG_RXPROD2 = 0xA00 /* Rx Producer Index for ring 2 */
54
#define VMXNET3_PT_REG_SIZE 4096 /* BAR 0 */
55
#define VMXNET3_VD_REG_SIZE 4096 /* BAR 1 */
57
#define VMXNET3_REG_ALIGN 8 /* All registers are 8-byte aligned. */
58
#define VMXNET3_REG_ALIGN_MASK 0x7
60
/* I/O Mapped access to registers */
61
#define VMXNET3_IO_TYPE_PT 0
62
#define VMXNET3_IO_TYPE_VD 1
63
#define VMXNET3_IO_ADDR(type, reg) (((type) << 24) | ((reg) & 0xFFFFFF))
64
#define VMXNET3_IO_TYPE(addr) ((addr) >> 24)
65
#define VMXNET3_IO_REG(addr) ((addr) & 0xFFFFFF)
68
VMXNET3_CMD_FIRST_SET = 0xCAFE0000,
69
VMXNET3_CMD_ACTIVATE_DEV = VMXNET3_CMD_FIRST_SET,
70
VMXNET3_CMD_QUIESCE_DEV,
71
VMXNET3_CMD_RESET_DEV,
72
VMXNET3_CMD_UPDATE_RX_MODE,
73
VMXNET3_CMD_UPDATE_MAC_FILTERS,
74
VMXNET3_CMD_UPDATE_VLAN_FILTERS,
75
VMXNET3_CMD_UPDATE_RSSIDT,
76
VMXNET3_CMD_UPDATE_IML,
77
VMXNET3_CMD_UPDATE_PMCFG,
78
VMXNET3_CMD_UPDATE_FEATURE,
79
VMXNET3_CMD_LOAD_PLUGIN,
81
VMXNET3_CMD_FIRST_GET = 0xF00D0000,
82
VMXNET3_CMD_GET_QUEUE_STATUS = VMXNET3_CMD_FIRST_GET,
83
VMXNET3_CMD_GET_STATS,
85
VMXNET3_CMD_GET_PERM_MAC_LO,
86
VMXNET3_CMD_GET_PERM_MAC_HI,
87
VMXNET3_CMD_GET_DID_LO,
88
VMXNET3_CMD_GET_DID_HI,
89
VMXNET3_CMD_GET_DEV_EXTRA_INFO,
90
VMXNET3_CMD_GET_CONF_INTR
94
* Little Endian layout of bitfields -
95
* Byte 0 : 7.....len.....0
96
* Byte 1 : rsvd gen 13.len.8
97
* Byte 2 : 5.msscof.0 ext1 dtype
98
* Byte 3 : 13...msscof...6
100
* Big Endian layout of bitfields -
101
* Byte 0: 13...msscof...6
102
* Byte 1 : 5.msscof.0 ext1 dtype
103
* Byte 2 : rsvd gen 13.len.8
104
* Byte 3 : 7.....len.....0
106
* Thus, le32_to_cpu on the dword will allow the big endian driver to read
107
* the bit fields correctly. And cpu_to_le32 will convert bitfields
108
* bit fields written by big endian driver to format required by device.
111
struct Vmxnet3_TxDesc {
114
#ifdef __BIG_ENDIAN_BITFIELD
115
u32 msscof:14; /* MSS, checksum offset, flags */
117
u32 dtype:1; /* descriptor type */
119
u32 gen:1; /* generation bit */
123
u32 gen:1; /* generation bit */
125
u32 dtype:1; /* descriptor type */
127
u32 msscof:14; /* MSS, checksum offset, flags */
128
#endif /* __BIG_ENDIAN_BITFIELD */
130
#ifdef __BIG_ENDIAN_BITFIELD
131
u32 tci:16; /* Tag to Insert */
132
u32 ti:1; /* VLAN Tag Insertion */
134
u32 cq:1; /* completion request */
135
u32 eop:1; /* End Of Packet */
136
u32 om:2; /* offload mode */
137
u32 hlen:10; /* header len */
139
u32 hlen:10; /* header len */
140
u32 om:2; /* offload mode */
141
u32 eop:1; /* End Of Packet */
142
u32 cq:1; /* completion request */
144
u32 ti:1; /* VLAN Tag Insertion */
145
u32 tci:16; /* Tag to Insert */
146
#endif /* __BIG_ENDIAN_BITFIELD */
149
/* TxDesc.OM values */
150
#define VMXNET3_OM_NONE 0
151
#define VMXNET3_OM_CSUM 2
152
#define VMXNET3_OM_TSO 3
154
/* fields in TxDesc we access w/o using bit fields */
155
#define VMXNET3_TXD_EOP_SHIFT 12
156
#define VMXNET3_TXD_CQ_SHIFT 13
157
#define VMXNET3_TXD_GEN_SHIFT 14
158
#define VMXNET3_TXD_EOP_DWORD_SHIFT 3
159
#define VMXNET3_TXD_GEN_DWORD_SHIFT 2
161
#define VMXNET3_TXD_CQ (1 << VMXNET3_TXD_CQ_SHIFT)
162
#define VMXNET3_TXD_EOP (1 << VMXNET3_TXD_EOP_SHIFT)
163
#define VMXNET3_TXD_GEN (1 << VMXNET3_TXD_GEN_SHIFT)
165
#define VMXNET3_HDR_COPY_SIZE 128
168
struct Vmxnet3_TxDataDesc {
169
u8 data[VMXNET3_HDR_COPY_SIZE];
172
#define VMXNET3_TCD_GEN_SHIFT 31
173
#define VMXNET3_TCD_GEN_SIZE 1
174
#define VMXNET3_TCD_TXIDX_SHIFT 0
175
#define VMXNET3_TCD_TXIDX_SIZE 12
176
#define VMXNET3_TCD_GEN_DWORD_SHIFT 3
178
struct Vmxnet3_TxCompDesc {
179
u32 txdIdx:12; /* Index of the EOP TxDesc */
186
u32 type:7; /* completion type */
187
u32 gen:1; /* generation bit */
190
struct Vmxnet3_RxDesc {
193
#ifdef __BIG_ENDIAN_BITFIELD
194
u32 gen:1; /* Generation bit */
196
u32 dtype:1; /* Descriptor type */
197
u32 btype:1; /* Buffer Type */
201
u32 btype:1; /* Buffer Type */
202
u32 dtype:1; /* Descriptor type */
204
u32 gen:1; /* Generation bit */
209
/* values of RXD.BTYPE */
210
#define VMXNET3_RXD_BTYPE_HEAD 0 /* head only */
211
#define VMXNET3_RXD_BTYPE_BODY 1 /* body only */
213
/* fields in RxDesc we access w/o using bit fields */
214
#define VMXNET3_RXD_BTYPE_SHIFT 14
215
#define VMXNET3_RXD_GEN_SHIFT 31
217
struct Vmxnet3_RxCompDesc {
218
#ifdef __BIG_ENDIAN_BITFIELD
220
u32 cnc:1; /* Checksum Not Calculated */
221
u32 rssType:4; /* RSS hash type used */
222
u32 rqID:10; /* rx queue/ring ID */
223
u32 sop:1; /* Start of Packet */
224
u32 eop:1; /* End of Packet */
226
u32 rxdIdx:12; /* Index of the RxDesc */
228
u32 rxdIdx:12; /* Index of the RxDesc */
230
u32 eop:1; /* End of Packet */
231
u32 sop:1; /* Start of Packet */
232
u32 rqID:10; /* rx queue/ring ID */
233
u32 rssType:4; /* RSS hash type used */
234
u32 cnc:1; /* Checksum Not Calculated */
236
#endif /* __BIG_ENDIAN_BITFIELD */
238
__le32 rssHash; /* RSS hash value */
240
#ifdef __BIG_ENDIAN_BITFIELD
241
u32 tci:16; /* Tag stripped */
242
u32 ts:1; /* Tag is stripped */
243
u32 err:1; /* Error */
244
u32 len:14; /* data length */
246
u32 len:14; /* data length */
247
u32 err:1; /* Error */
248
u32 ts:1; /* Tag is stripped */
249
u32 tci:16; /* Tag stripped */
250
#endif /* __BIG_ENDIAN_BITFIELD */
253
#ifdef __BIG_ENDIAN_BITFIELD
254
u32 gen:1; /* generation bit */
255
u32 type:7; /* completion type */
256
u32 fcs:1; /* Frame CRC correct */
257
u32 frg:1; /* IP Fragment */
260
u32 ipc:1; /* IP Checksum Correct */
261
u32 tcp:1; /* TCP packet */
262
u32 udp:1; /* UDP packet */
263
u32 tuc:1; /* TCP/UDP Checksum Correct */
267
u32 tuc:1; /* TCP/UDP Checksum Correct */
268
u32 udp:1; /* UDP packet */
269
u32 tcp:1; /* TCP packet */
270
u32 ipc:1; /* IP Checksum Correct */
273
u32 frg:1; /* IP Fragment */
274
u32 fcs:1; /* Frame CRC correct */
275
u32 type:7; /* completion type */
276
u32 gen:1; /* generation bit */
277
#endif /* __BIG_ENDIAN_BITFIELD */
280
/* fields in RxCompDesc we access via Vmxnet3_GenericDesc.dword[3] */
281
#define VMXNET3_RCD_TUC_SHIFT 16
282
#define VMXNET3_RCD_IPC_SHIFT 19
284
/* fields in RxCompDesc we access via Vmxnet3_GenericDesc.qword[1] */
285
#define VMXNET3_RCD_TYPE_SHIFT 56
286
#define VMXNET3_RCD_GEN_SHIFT 63
288
/* csum OK for TCP/UDP pkts over IP */
289
#define VMXNET3_RCD_CSUM_OK (1 << VMXNET3_RCD_TUC_SHIFT | \
290
1 << VMXNET3_RCD_IPC_SHIFT)
291
#define VMXNET3_TXD_GEN_SIZE 1
292
#define VMXNET3_TXD_EOP_SIZE 1
294
/* value of RxCompDesc.rssType */
296
VMXNET3_RCD_RSS_TYPE_NONE = 0,
297
VMXNET3_RCD_RSS_TYPE_IPV4 = 1,
298
VMXNET3_RCD_RSS_TYPE_TCPIPV4 = 2,
299
VMXNET3_RCD_RSS_TYPE_IPV6 = 3,
300
VMXNET3_RCD_RSS_TYPE_TCPIPV6 = 4,
304
/* a union for accessing all cmd/completion descriptors */
305
union Vmxnet3_GenericDesc {
309
struct Vmxnet3_TxDesc txd;
310
struct Vmxnet3_RxDesc rxd;
311
struct Vmxnet3_TxCompDesc tcd;
312
struct Vmxnet3_RxCompDesc rcd;
315
#define VMXNET3_INIT_GEN 1
317
/* Max size of a single tx buffer */
318
#define VMXNET3_MAX_TX_BUF_SIZE (1 << 14)
320
/* # of tx desc needed for a tx buffer size */
321
#define VMXNET3_TXD_NEEDED(size) (((size) + VMXNET3_MAX_TX_BUF_SIZE - 1) / \
322
VMXNET3_MAX_TX_BUF_SIZE)
324
/* max # of tx descs for a non-tso pkt */
325
#define VMXNET3_MAX_TXD_PER_PKT 16
327
/* Max size of a single rx buffer */
328
#define VMXNET3_MAX_RX_BUF_SIZE ((1 << 14) - 1)
329
/* Minimum size of a type 0 buffer */
330
#define VMXNET3_MIN_T0_BUF_SIZE 128
331
#define VMXNET3_MAX_CSUM_OFFSET 1024
333
/* Ring base address alignment */
334
#define VMXNET3_RING_BA_ALIGN 512
335
#define VMXNET3_RING_BA_MASK (VMXNET3_RING_BA_ALIGN - 1)
337
/* Ring size must be a multiple of 32 */
338
#define VMXNET3_RING_SIZE_ALIGN 32
339
#define VMXNET3_RING_SIZE_MASK (VMXNET3_RING_SIZE_ALIGN - 1)
342
#define VMXNET3_TX_RING_MAX_SIZE 4096
343
#define VMXNET3_TC_RING_MAX_SIZE 4096
344
#define VMXNET3_RX_RING_MAX_SIZE 4096
345
#define VMXNET3_RC_RING_MAX_SIZE 8192
347
/* a list of reasons for queue stop */
350
VMXNET3_ERR_NOEOP = 0x80000000, /* cannot find the EOP desc of a pkt */
351
VMXNET3_ERR_TXD_REUSE = 0x80000001, /* reuse TxDesc before tx completion */
352
VMXNET3_ERR_BIG_PKT = 0x80000002, /* too many TxDesc for a pkt */
353
VMXNET3_ERR_DESC_NOT_SPT = 0x80000003, /* descriptor type not supported */
354
VMXNET3_ERR_SMALL_BUF = 0x80000004, /* type 0 buffer too small */
355
VMXNET3_ERR_STRESS = 0x80000005, /* stress option firing in vmkernel */
356
VMXNET3_ERR_SWITCH = 0x80000006, /* mode switch failure */
357
VMXNET3_ERR_TXD_INVALID = 0x80000007, /* invalid TxDesc */
360
/* completion descriptor types */
361
#define VMXNET3_CDTYPE_TXCOMP 0 /* Tx Completion Descriptor */
362
#define VMXNET3_CDTYPE_RXCOMP 3 /* Rx Completion Descriptor */
365
VMXNET3_GOS_BITS_UNK = 0, /* unknown */
366
VMXNET3_GOS_BITS_32 = 1,
367
VMXNET3_GOS_BITS_64 = 2,
370
#define VMXNET3_GOS_TYPE_LINUX 1
373
struct Vmxnet3_GOSInfo {
374
#ifdef __BIG_ENDIAN_BITFIELD
375
u32 gosMisc:10; /* other info about gos */
376
u32 gosVer:16; /* gos version */
377
u32 gosType:4; /* which guest */
378
u32 gosBits:2; /* 32-bit or 64-bit? */
380
u32 gosBits:2; /* 32-bit or 64-bit? */
381
u32 gosType:4; /* which guest */
382
u32 gosVer:16; /* gos version */
383
u32 gosMisc:10; /* other info about gos */
384
#endif /* __BIG_ENDIAN_BITFIELD */
387
struct Vmxnet3_DriverInfo {
389
struct Vmxnet3_GOSInfo gos;
390
__le32 vmxnet3RevSpt;
395
#define VMXNET3_REV1_MAGIC 0xbabefee1
398
* QueueDescPA must be 128 bytes aligned. It points to an array of
399
* Vmxnet3_TxQueueDesc followed by an array of Vmxnet3_RxQueueDesc.
400
* The number of Vmxnet3_TxQueueDesc/Vmxnet3_RxQueueDesc are specified by
401
* Vmxnet3_MiscConf.numTxQueues/numRxQueues, respectively.
403
#define VMXNET3_QUEUE_DESC_ALIGN 128
406
struct Vmxnet3_MiscConf {
407
struct Vmxnet3_DriverInfo driverInfo;
409
__le64 ddPA; /* driver data PA */
410
__le64 queueDescPA; /* queue descriptor table PA */
411
__le32 ddLen; /* driver data len */
412
__le32 queueDescLen; /* queue desc. table len in bytes */
421
struct Vmxnet3_TxQueueConf {
423
__le64 dataRingBasePA;
424
__le64 compRingBasePA;
425
__le64 ddPA; /* driver data */
427
__le32 txRingSize; /* # of tx desc */
428
__le32 dataRingSize; /* # of data desc */
429
__le32 compRingSize; /* # of comp desc */
430
__le32 ddLen; /* size of driver data */
436
struct Vmxnet3_RxQueueConf {
437
__le64 rxRingBasePA[2];
438
__le64 compRingBasePA;
439
__le64 ddPA; /* driver data */
441
__le32 rxRingSize[2]; /* # of rx desc */
442
__le32 compRingSize; /* # of rx comp desc */
443
__le32 ddLen; /* size of driver data */
449
enum vmxnet3_intr_mask_mode {
450
VMXNET3_IMM_AUTO = 0,
451
VMXNET3_IMM_ACTIVE = 1,
455
enum vmxnet3_intr_type {
462
#define VMXNET3_MAX_TX_QUEUES 8
463
#define VMXNET3_MAX_RX_QUEUES 16
464
/* addition 1 for events */
465
#define VMXNET3_MAX_INTRS 25
467
/* value of intrCtrl */
468
#define VMXNET3_IC_DISABLE_ALL 0x1 /* bit 0 */
471
struct Vmxnet3_IntrConf {
473
u8 numIntrs; /* # of interrupts */
475
u8 modLevels[VMXNET3_MAX_INTRS]; /* moderation level for
481
/* one bit per VLAN ID, the size is in the units of u32 */
482
#define VMXNET3_VFT_SIZE (4096 / (sizeof(u32) * 8))
485
struct Vmxnet3_QueueStatus {
492
struct Vmxnet3_TxQueueCtrl {
493
__le32 txNumDeferred;
499
struct Vmxnet3_RxQueueCtrl {
506
VMXNET3_RXM_UCAST = 0x01, /* unicast only */
507
VMXNET3_RXM_MCAST = 0x02, /* multicast passing the filters */
508
VMXNET3_RXM_BCAST = 0x04, /* broadcast only */
509
VMXNET3_RXM_ALL_MULTI = 0x08, /* all multicast */
510
VMXNET3_RXM_PROMISC = 0x10 /* promiscuous */
513
struct Vmxnet3_RxFilterConf {
514
__le32 rxMode; /* VMXNET3_RXM_xxx */
515
__le16 mfTableLen; /* size of the multicast filter table */
517
__le64 mfTablePA; /* PA of the multicast filters table */
518
__le32 vfTable[VMXNET3_VFT_SIZE]; /* vlan filter */
522
#define VMXNET3_PM_MAX_FILTERS 6
523
#define VMXNET3_PM_MAX_PATTERN_SIZE 128
524
#define VMXNET3_PM_MAX_MASK_SIZE (VMXNET3_PM_MAX_PATTERN_SIZE / 8)
526
#define VMXNET3_PM_WAKEUP_MAGIC cpu_to_le16(0x01) /* wake up on magic pkts */
527
#define VMXNET3_PM_WAKEUP_FILTER cpu_to_le16(0x02) /* wake up on pkts matching
531
struct Vmxnet3_PM_PktFilter {
534
u8 mask[VMXNET3_PM_MAX_MASK_SIZE];
535
u8 pattern[VMXNET3_PM_MAX_PATTERN_SIZE];
540
struct Vmxnet3_PMConf {
541
__le16 wakeUpEvents; /* VMXNET3_PM_WAKEUP_xxx */
544
struct Vmxnet3_PM_PktFilter filters[VMXNET3_PM_MAX_FILTERS];
548
struct Vmxnet3_VariableLenConfDesc {
555
struct Vmxnet3_TxQueueDesc {
556
struct Vmxnet3_TxQueueCtrl ctrl;
557
struct Vmxnet3_TxQueueConf conf;
559
/* Driver read after a GET command */
560
struct Vmxnet3_QueueStatus status;
561
struct UPT1_TxStats stats;
562
u8 _pad[88]; /* 128 aligned */
566
struct Vmxnet3_RxQueueDesc {
567
struct Vmxnet3_RxQueueCtrl ctrl;
568
struct Vmxnet3_RxQueueConf conf;
569
/* Driver read after a GET commad */
570
struct Vmxnet3_QueueStatus status;
571
struct UPT1_RxStats stats;
572
u8 __pad[88]; /* 128 aligned */
576
struct Vmxnet3_DSDevRead {
577
/* read-only region for device, read by dev in response to a SET cmd */
578
struct Vmxnet3_MiscConf misc;
579
struct Vmxnet3_IntrConf intrConf;
580
struct Vmxnet3_RxFilterConf rxFilterConf;
581
struct Vmxnet3_VariableLenConfDesc rssConfDesc;
582
struct Vmxnet3_VariableLenConfDesc pmConfDesc;
583
struct Vmxnet3_VariableLenConfDesc pluginConfDesc;
586
/* All structures in DriverShared are padded to multiples of 8 bytes */
587
struct Vmxnet3_DriverShared {
589
/* make devRead start at 64bit boundaries */
591
struct Vmxnet3_DSDevRead devRead;
597
#define VMXNET3_ECR_RQERR (1 << 0)
598
#define VMXNET3_ECR_TQERR (1 << 1)
599
#define VMXNET3_ECR_LINK (1 << 2)
600
#define VMXNET3_ECR_DIC (1 << 3)
601
#define VMXNET3_ECR_DEBUG (1 << 4)
603
/* flip the gen bit of a ring */
604
#define VMXNET3_FLIP_RING_GEN(gen) ((gen) = (gen) ^ 0x1)
606
/* only use this if moving the idx won't affect the gen bit */
607
#define VMXNET3_INC_RING_IDX_ONLY(idx, ring_size) \
610
if (unlikely((idx) == (ring_size))) {\
615
#define VMXNET3_SET_VFTABLE_ENTRY(vfTable, vid) \
616
(vfTable[vid >> 5] |= (1 << (vid & 31)))
617
#define VMXNET3_CLEAR_VFTABLE_ENTRY(vfTable, vid) \
618
(vfTable[vid >> 5] &= ~(1 << (vid & 31)))
620
#define VMXNET3_VFTABLE_ENTRY_IS_SET(vfTable, vid) \
621
((vfTable[vid >> 5] & (1 << (vid & 31))) != 0)
623
#define VMXNET3_MAX_MTU 9000
624
#define VMXNET3_MIN_MTU 60
626
#define VMXNET3_LINK_UP (10000 << 16 | 1) /* 10 Gbps, up */
627
#define VMXNET3_LINK_DOWN 0
629
#endif /* _VMXNET3_DEFS_H_ */