drivers/net/vmxnet3/base/vmxnet3_defs.h

   1 /*********************************************************
   2  * Copyright (C) 2007 VMware, Inc. All rights reserved.
   3  *
   4  * SPDX-License-Identifier:    BSD-3-Clause
   5  *
   6  *********************************************************/
   7
   8 /*
   9  * vmxnet3_defs.h --
  10  *
  11  *      Definitions shared by device emulation and guest drivers for
  12  *      VMXNET3 NIC
  13  */
  14
  15 #ifndef _VMXNET3_DEFS_H_
  16 #define _VMXNET3_DEFS_H_
  17
  18 #include "vmxnet3_osdep.h"
  19 #include "upt1_defs.h"
  20
  21 /* all registers are 32 bit wide */
  22 /* BAR 1 */
  23 #define VMXNET3_REG_VRRS  0x0    /* Vmxnet3 Revision Report Selection */
  24 #define VMXNET3_REG_UVRS  0x8    /* UPT Version Report Selection */
  25 #define VMXNET3_REG_DSAL  0x10   /* Driver Shared Address Low */
  26 #define VMXNET3_REG_DSAH  0x18   /* Driver Shared Address High */
  27 #define VMXNET3_REG_CMD   0x20   /* Command */
  28 #define VMXNET3_REG_MACL  0x28   /* MAC Address Low */
  29 #define VMXNET3_REG_MACH  0x30   /* MAC Address High */
  30 #define VMXNET3_REG_ICR   0x38   /* Interrupt Cause Register */
  31 #define VMXNET3_REG_ECR   0x40   /* Event Cause Register */
  32
  33 #define VMXNET3_REG_WSAL  0xF00  /* Wireless Shared Address Lo  */
  34 #define VMXNET3_REG_WSAH  0xF08  /* Wireless Shared Address Hi  */
  35 #define VMXNET3_REG_WCMD  0xF18  /* Wireless Command */
  36
  37 /* BAR 0 */
  38 #define VMXNET3_REG_IMR      0x0   /* Interrupt Mask Register */
  39 #define VMXNET3_REG_TXPROD   0x600 /* Tx Producer Index */
  40 #define VMXNET3_REG_RXPROD   0x800 /* Rx Producer Index for ring 1 */
  41 #define VMXNET3_REG_RXPROD2  0xA00 /* Rx Producer Index for ring 2 */
  42
  43 #define VMXNET3_PT_REG_SIZE     4096    /* BAR 0 */
  44 #define VMXNET3_VD_REG_SIZE     4096    /* BAR 1 */
  45
  46 /*
  47  * The two Vmxnet3 MMIO Register PCI BARs (BAR 0 at offset 10h and BAR 1 at
  48  * offset 14h)  as well as the MSI-X BAR are combined into one PhysMem region:
  49  * <-VMXNET3_PT_REG_SIZE-><-VMXNET3_VD_REG_SIZE-><-VMXNET3_MSIX_BAR_SIZE-->
  50  * -------------------------------------------------------------------------
  51  * |Pass Thru Registers  | Virtual Dev Registers | MSI-X Vector/PBA Table  |
  52  * -------------------------------------------------------------------------
  53  * VMXNET3_MSIX_BAR_SIZE is defined in "vmxnet3Int.h"
  54  */
  55 #define VMXNET3_PHYSMEM_PAGES   4
  56
  57 #define VMXNET3_REG_ALIGN       8  /* All registers are 8-byte aligned. */
  58 #define VMXNET3_REG_ALIGN_MASK  0x7
  59
  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)
  66
  67 #ifndef __le16
  68 #define __le16 uint16
  69 #endif
  70 #ifndef __le32
  71 #define __le32 uint32
  72 #endif
  73 #ifndef __le64
  74 #define __le64 uint64
  75 #endif
  76
  77 typedef enum {
  78    VMXNET3_CMD_FIRST_SET = 0xCAFE0000,
  79    VMXNET3_CMD_ACTIVATE_DEV = VMXNET3_CMD_FIRST_SET,
  80    VMXNET3_CMD_QUIESCE_DEV,
  81    VMXNET3_CMD_RESET_DEV,
  82    VMXNET3_CMD_UPDATE_RX_MODE,
  83    VMXNET3_CMD_UPDATE_MAC_FILTERS,
  84    VMXNET3_CMD_UPDATE_VLAN_FILTERS,
  85    VMXNET3_CMD_UPDATE_RSSIDT,
  86    VMXNET3_CMD_UPDATE_IML,
  87    VMXNET3_CMD_UPDATE_PMCFG,
  88    VMXNET3_CMD_UPDATE_FEATURE,
  89    VMXNET3_CMD_STOP_EMULATION,
  90    VMXNET3_CMD_LOAD_PLUGIN,
  91    VMXNET3_CMD_ACTIVATE_VF,
  92    VMXNET3_CMD_RESERVED3,
  93    VMXNET3_CMD_RESERVED4,
  94    VMXNET3_CMD_REGISTER_MEMREGS,
  95
  96    VMXNET3_CMD_FIRST_GET = 0xF00D0000,
  97    VMXNET3_CMD_GET_QUEUE_STATUS = VMXNET3_CMD_FIRST_GET,
  98    VMXNET3_CMD_GET_STATS,
  99    VMXNET3_CMD_GET_LINK,
 100    VMXNET3_CMD_GET_PERM_MAC_LO,
 101    VMXNET3_CMD_GET_PERM_MAC_HI,
 102    VMXNET3_CMD_GET_DID_LO,
 103    VMXNET3_CMD_GET_DID_HI,
 104    VMXNET3_CMD_GET_DEV_EXTRA_INFO,
 105    VMXNET3_CMD_GET_CONF_INTR,
 106    VMXNET3_CMD_GET_ADAPTIVE_RING_INFO,
 107    VMXNET3_CMD_GET_TXDATA_DESC_SIZE,
 108    VMXNET3_CMD_RESERVED5,
 109 } Vmxnet3_Cmd;
 110
 111 /* Adaptive Ring Info Flags */
 112 #define VMXNET3_DISABLE_ADAPTIVE_RING 1
 113
 114 /*
 115  *      Little Endian layout of bitfields -
 116  *      Byte 0 :        7.....len.....0
 117  *      Byte 1 :        rsvd gen 13.len.8
 118  *      Byte 2 :        5.msscof.0 ext1  dtype
 119  *      Byte 3 :        13...msscof...6
 120  *
 121  *      Big Endian layout of bitfields -
 122  *      Byte 0:         13...msscof...6
 123  *      Byte 1 :        5.msscof.0 ext1  dtype
 124  *      Byte 2 :        rsvd gen 13.len.8
 125  *      Byte 3 :        7.....len.....0
 126  *
 127  *      Thus, le32_to_cpu on the dword will allow the big endian driver to read
 128  *      the bit fields correctly. And cpu_to_le32 will convert bitfields
 129  *      bit fields written by big endian driver to format required by device.
 130  */
 131
 132 typedef
 133 #include "vmware_pack_begin.h"
 134 struct Vmxnet3_TxDesc {
 135    __le64 addr;
 136
 137 #ifdef __BIG_ENDIAN_BITFIELD
 138    uint32 msscof:14;  /* MSS, checksum offset, flags */
 139    uint32 ext1:1;
 140    uint32 dtype:1;    /* descriptor type */
 141    uint32 rsvd:1;
 142    uint32 gen:1;      /* generation bit */
 143    uint32 len:14;
 144 #else
 145    uint32 len:14;
 146    uint32 gen:1;      /* generation bit */
 147    uint32 rsvd:1;
 148    uint32 dtype:1;    /* descriptor type */
 149    uint32 ext1:1;
 150    uint32 msscof:14;  /* MSS, checksum offset, flags */
 151 #endif  /* __BIG_ENDIAN_BITFIELD */
 152
 153 #ifdef __BIG_ENDIAN_BITFIELD
 154    uint32 tci:16;     /* Tag to Insert */
 155    uint32 ti:1;       /* VLAN Tag Insertion */
 156    uint32 ext2:1;
 157    uint32 cq:1;       /* completion request */
 158    uint32 eop:1;      /* End Of Packet */
 159    uint32 om:2;       /* offload mode */
 160    uint32 hlen:10;    /* header len */
 161 #else
 162    uint32 hlen:10;    /* header len */
 163    uint32 om:2;       /* offload mode */
 164    uint32 eop:1;      /* End Of Packet */
 165    uint32 cq:1;       /* completion request */
 166    uint32 ext2:1;
 167    uint32 ti:1;       /* VLAN Tag Insertion */
 168    uint32 tci:16;     /* Tag to Insert */
 169 #endif  /* __BIG_ENDIAN_BITFIELD */
 170 }
 171 #include "vmware_pack_end.h"
 172 Vmxnet3_TxDesc;
 173
 174 /* TxDesc.OM values */
 175 #define VMXNET3_OM_NONE  0
 176 #define VMXNET3_OM_CSUM  2
 177 #define VMXNET3_OM_TSO   3
 178
 179 /* fields in TxDesc we access w/o using bit fields */
 180 #define VMXNET3_TXD_EOP_SHIFT 12
 181 #define VMXNET3_TXD_CQ_SHIFT  13
 182 #define VMXNET3_TXD_GEN_SHIFT 14
 183 #define VMXNET3_TXD_EOP_DWORD_SHIFT 3
 184 #define VMXNET3_TXD_GEN_DWORD_SHIFT 2
 185
 186 #define VMXNET3_TXD_CQ  (1 << VMXNET3_TXD_CQ_SHIFT)
 187 #define VMXNET3_TXD_EOP (1 << VMXNET3_TXD_EOP_SHIFT)
 188 #define VMXNET3_TXD_GEN (1 << VMXNET3_TXD_GEN_SHIFT)
 189
 190 #define VMXNET3_TXD_GEN_SIZE 1
 191 #define VMXNET3_TXD_EOP_SIZE 1
 192
 193 #define VMXNET3_HDR_COPY_SIZE   128
 194
 195 typedef
 196 #include "vmware_pack_begin.h"
 197 struct Vmxnet3_TxDataDesc {
 198    uint8 data[VMXNET3_HDR_COPY_SIZE];
 199 }
 200 #include "vmware_pack_end.h"
 201 Vmxnet3_TxDataDesc;
 202
 203 #define VMXNET3_TCD_GEN_SHIFT   31
 204 #define VMXNET3_TCD_GEN_SIZE    1
 205 #define VMXNET3_TCD_TXIDX_SHIFT 0
 206 #define VMXNET3_TCD_TXIDX_SIZE  12
 207 #define VMXNET3_TCD_GEN_DWORD_SHIFT     3
 208
 209 typedef
 210 #include "vmware_pack_begin.h"
 211 struct Vmxnet3_TxCompDesc {
 212    uint32 txdIdx:12;    /* Index of the EOP TxDesc */
 213    uint32 ext1:20;
 214
 215    __le32 ext2;
 216    __le32 ext3;
 217
 218    uint32 rsvd:24;
 219    uint32 type:7;       /* completion type */
 220    uint32 gen:1;        /* generation bit */
 221 }
 222 #include "vmware_pack_end.h"
 223 Vmxnet3_TxCompDesc;
 224
 225 typedef
 226 #include "vmware_pack_begin.h"
 227 struct Vmxnet3_RxDesc {
 228    __le64 addr;
 229
 230 #ifdef __BIG_ENDIAN_BITFIELD
 231    uint32 gen:1;        /* Generation bit */
 232    uint32 rsvd:15;
 233    uint32 dtype:1;      /* Descriptor type */
 234    uint32 btype:1;      /* Buffer Type */
 235    uint32 len:14;
 236 #else
 237    uint32 len:14;
 238    uint32 btype:1;      /* Buffer Type */
 239    uint32 dtype:1;      /* Descriptor type */
 240    uint32 rsvd:15;
 241    uint32 gen:1;        /* Generation bit */
 242 #endif
 243    __le32 ext1;
 244 }
 245 #include "vmware_pack_end.h"
 246 Vmxnet3_RxDesc;
 247
 248 /* values of RXD.BTYPE */
 249 #define VMXNET3_RXD_BTYPE_HEAD   0    /* head only */
 250 #define VMXNET3_RXD_BTYPE_BODY   1    /* body only */
 251
 252 /* fields in RxDesc we access w/o using bit fields */
 253 #define VMXNET3_RXD_BTYPE_SHIFT  14
 254 #define VMXNET3_RXD_GEN_SHIFT    31
 255
 256 typedef
 257 #include "vmware_pack_begin.h"
 258 struct Vmxnet3_RxCompDesc {
 259 #ifdef __BIG_ENDIAN_BITFIELD
 260    uint32 ext2:1;
 261    uint32 cnc:1;        /* Checksum Not Calculated */
 262    uint32 rssType:4;    /* RSS hash type used */
 263    uint32 rqID:10;      /* rx queue/ring ID */
 264    uint32 sop:1;        /* Start of Packet */
 265    uint32 eop:1;        /* End of Packet */
 266    uint32 ext1:2;
 267    uint32 rxdIdx:12;    /* Index of the RxDesc */
 268 #else
 269    uint32 rxdIdx:12;    /* Index of the RxDesc */
 270    uint32 ext1:2;
 271    uint32 eop:1;        /* End of Packet */
 272    uint32 sop:1;        /* Start of Packet */
 273    uint32 rqID:10;      /* rx queue/ring ID */
 274    uint32 rssType:4;    /* RSS hash type used */
 275    uint32 cnc:1;        /* Checksum Not Calculated */
 276    uint32 ext2:1;
 277 #endif  /* __BIG_ENDIAN_BITFIELD */
 278
 279    __le32 rssHash;      /* RSS hash value */
 280
 281 #ifdef __BIG_ENDIAN_BITFIELD
 282    uint32 tci:16;       /* Tag stripped */
 283    uint32 ts:1;         /* Tag is stripped */
 284    uint32 err:1;        /* Error */
 285    uint32 len:14;       /* data length */
 286 #else
 287    uint32 len:14;       /* data length */
 288    uint32 err:1;        /* Error */
 289    uint32 ts:1;         /* Tag is stripped */
 290    uint32 tci:16;       /* Tag stripped */
 291 #endif  /* __BIG_ENDIAN_BITFIELD */
 292
 293
 294 #ifdef __BIG_ENDIAN_BITFIELD
 295    uint32 gen:1;        /* generation bit */
 296    uint32 type:7;       /* completion type */
 297    uint32 fcs:1;        /* Frame CRC correct */
 298    uint32 frg:1;        /* IP Fragment */
 299    uint32 v4:1;         /* IPv4 */
 300    uint32 v6:1;         /* IPv6 */
 301    uint32 ipc:1;        /* IP Checksum Correct */
 302    uint32 tcp:1;        /* TCP packet */
 303    uint32 udp:1;        /* UDP packet */
 304    uint32 tuc:1;        /* TCP/UDP Checksum Correct */
 305    uint32 csum:16;
 306 #else
 307    uint32 csum:16;
 308    uint32 tuc:1;        /* TCP/UDP Checksum Correct */
 309    uint32 udp:1;        /* UDP packet */
 310    uint32 tcp:1;        /* TCP packet */
 311    uint32 ipc:1;        /* IP Checksum Correct */
 312    uint32 v6:1;         /* IPv6 */
 313    uint32 v4:1;         /* IPv4 */
 314    uint32 frg:1;        /* IP Fragment */
 315    uint32 fcs:1;        /* Frame CRC correct */
 316    uint32 type:7;       /* completion type */
 317    uint32 gen:1;        /* generation bit */
 318 #endif  /* __BIG_ENDIAN_BITFIELD */
 319 }
 320 #include "vmware_pack_end.h"
 321 Vmxnet3_RxCompDesc;
 322
 323 typedef
 324 #include "vmware_pack_begin.h"
 325 struct Vmxnet3_RxCompDescExt {
 326    __le32 dword1;
 327    uint8  segCnt;       /* Number of aggregated packets */
 328    uint8  dupAckCnt;    /* Number of duplicate Acks */
 329    __le16 tsDelta;      /* TCP timestamp difference */
 330    __le32 dword2[2];
 331 }
 332 #include "vmware_pack_end.h"
 333 Vmxnet3_RxCompDescExt;
 334
 335 /* fields in RxCompDesc we access via Vmxnet3_GenericDesc.dword[3] */
 336 #define VMXNET3_RCD_TUC_SHIFT  16
 337 #define VMXNET3_RCD_IPC_SHIFT  19
 338
 339 /* fields in RxCompDesc we access via Vmxnet3_GenericDesc.qword[1] */
 340 #define VMXNET3_RCD_TYPE_SHIFT 56
 341 #define VMXNET3_RCD_GEN_SHIFT  63
 342
 343 /* csum OK for TCP/UDP pkts over IP */
 344 #define VMXNET3_RCD_CSUM_OK (1 << VMXNET3_RCD_TUC_SHIFT | 1 << VMXNET3_RCD_IPC_SHIFT)
 345
 346 /* value of RxCompDesc.rssType */
 347 #define VMXNET3_RCD_RSS_TYPE_NONE     0
 348 #define VMXNET3_RCD_RSS_TYPE_IPV4     1
 349 #define VMXNET3_RCD_RSS_TYPE_TCPIPV4  2
 350 #define VMXNET3_RCD_RSS_TYPE_IPV6     3
 351 #define VMXNET3_RCD_RSS_TYPE_TCPIPV6  4
 352
 353 /* a union for accessing all cmd/completion descriptors */
 354 typedef union Vmxnet3_GenericDesc {
 355    __le64                qword[2];
 356    __le32                dword[4];
 357    __le16                word[8];
 358    Vmxnet3_TxDesc        txd;
 359    Vmxnet3_RxDesc        rxd;
 360    Vmxnet3_TxCompDesc    tcd;
 361    Vmxnet3_RxCompDesc    rcd;
 362    Vmxnet3_RxCompDescExt rcdExt;
 363 } Vmxnet3_GenericDesc;
 364
 365 #define VMXNET3_INIT_GEN       1
 366
 367 /* Max size of a single tx buffer */
 368 #define VMXNET3_MAX_TX_BUF_SIZE  (1 << 14)
 369
 370 /* # of tx desc needed for a tx buffer size */
 371 #define VMXNET3_TXD_NEEDED(size) (((size) + VMXNET3_MAX_TX_BUF_SIZE - 1) / VMXNET3_MAX_TX_BUF_SIZE)
 372
 373 /* max # of tx descs for a non-tso pkt */
 374 #define VMXNET3_MAX_TXD_PER_PKT 16
 375
 376 /* Max size of a single rx buffer */
 377 #define VMXNET3_MAX_RX_BUF_SIZE  ((1 << 14) - 1)
 378 /* Minimum size of a type 0 buffer */
 379 #define VMXNET3_MIN_T0_BUF_SIZE  128
 380 #define VMXNET3_MAX_CSUM_OFFSET  1024
 381
 382 /* Ring base address alignment */
 383 #define VMXNET3_RING_BA_ALIGN   512
 384 #define VMXNET3_RING_BA_MASK    (VMXNET3_RING_BA_ALIGN - 1)
 385
 386 /* Ring size must be a multiple of 32 */
 387 #define VMXNET3_RING_SIZE_ALIGN 32
 388 #define VMXNET3_RING_SIZE_MASK  (VMXNET3_RING_SIZE_ALIGN - 1)
 389
 390 /* Tx Data Ring buffer size must be a multiple of 64 */
 391 #define VMXNET3_TXDATA_DESC_SIZE_ALIGN 64
 392 #define VMXNET3_TXDATA_DESC_SIZE_MASK  (VMXNET3_TXDATA_DESC_SIZE_ALIGN - 1)
 393
 394 /* Rx Data Ring buffer size must be a multiple of 64 */
 395 #define VMXNET3_RXDATA_DESC_SIZE_ALIGN 64
 396 #define VMXNET3_RXDATA_DESC_SIZE_MASK  (VMXNET3_RXDATA_DESC_SIZE_ALIGN - 1)
 397
 398 /* Max ring size */
 399 #define VMXNET3_TX_RING_MAX_SIZE   4096
 400 #define VMXNET3_TC_RING_MAX_SIZE   4096
 401 #define VMXNET3_RX_RING_MAX_SIZE   4096
 402 #define VMXNET3_RC_RING_MAX_SIZE   8192
 403
 404 #define VMXNET3_TXDATA_DESC_MIN_SIZE 128
 405 #define VMXNET3_TXDATA_DESC_MAX_SIZE 2048
 406
 407 #define VMXNET3_RXDATA_DESC_MAX_SIZE 2048
 408
 409 /* a list of reasons for queue stop */
 410
 411 #define VMXNET3_ERR_NOEOP        0x80000000  /* cannot find the EOP desc of a pkt */
 412 #define VMXNET3_ERR_TXD_REUSE    0x80000001  /* reuse a TxDesc before tx completion */
 413 #define VMXNET3_ERR_BIG_PKT      0x80000002  /* too many TxDesc for a pkt */
 414 #define VMXNET3_ERR_DESC_NOT_SPT 0x80000003  /* descriptor type not supported */
 415 #define VMXNET3_ERR_SMALL_BUF    0x80000004  /* type 0 buffer too small */
 416 #define VMXNET3_ERR_STRESS       0x80000005  /* stress option firing in vmkernel */
 417 #define VMXNET3_ERR_SWITCH       0x80000006  /* mode switch failure */
 418 #define VMXNET3_ERR_TXD_INVALID  0x80000007  /* invalid TxDesc */
 419
 420 /* completion descriptor types */
 421 #define VMXNET3_CDTYPE_TXCOMP      0    /* Tx Completion Descriptor */
 422 #define VMXNET3_CDTYPE_RXCOMP      3    /* Rx Completion Descriptor */
 423 #define VMXNET3_CDTYPE_RXCOMP_LRO  4    /* Rx Completion Descriptor for LRO */
 424
 425 #define VMXNET3_GOS_BITS_UNK    0   /* unknown */
 426 #define VMXNET3_GOS_BITS_32     1
 427 #define VMXNET3_GOS_BITS_64     2
 428
 429 #define VMXNET3_GOS_TYPE_UNK        0 /* unknown */
 430 #define VMXNET3_GOS_TYPE_LINUX      1
 431 #define VMXNET3_GOS_TYPE_WIN        2
 432 #define VMXNET3_GOS_TYPE_SOLARIS    3
 433 #define VMXNET3_GOS_TYPE_FREEBSD    4
 434 #define VMXNET3_GOS_TYPE_PXE        5
 435
 436 /* All structures in DriverShared are padded to multiples of 8 bytes */
 437
 438 typedef
 439 #include "vmware_pack_begin.h"
 440 struct Vmxnet3_GOSInfo {
 441 #ifdef __BIG_ENDIAN_BITFIELD
 442    uint32   gosMisc: 10;    /* other info about gos */
 443    uint32   gosVer:  16;    /* gos version */
 444    uint32   gosType: 4;     /* which guest */
 445    uint32   gosBits: 2;     /* 32-bit or 64-bit? */
 446 #else
 447    uint32   gosBits: 2;     /* 32-bit or 64-bit? */
 448    uint32   gosType: 4;     /* which guest */
 449    uint32   gosVer:  16;    /* gos version */
 450    uint32   gosMisc: 10;    /* other info about gos */
 451 #endif  /* __BIG_ENDIAN_BITFIELD */
 452 }
 453 #include "vmware_pack_end.h"
 454 Vmxnet3_GOSInfo;
 455
 456 typedef
 457 #include "vmware_pack_begin.h"
 458 struct Vmxnet3_DriverInfo {
 459    __le32          version;        /* driver version */
 460    Vmxnet3_GOSInfo gos;
 461    __le32          vmxnet3RevSpt;  /* vmxnet3 revision supported */
 462    __le32          uptVerSpt;      /* upt version supported */
 463 }
 464 #include "vmware_pack_end.h"
 465 Vmxnet3_DriverInfo;
 466
 467 #define VMXNET3_REV1_MAGIC  0xbabefee1
 468
 469 /*
 470  * QueueDescPA must be 128 bytes aligned. It points to an array of
 471  * Vmxnet3_TxQueueDesc followed by an array of Vmxnet3_RxQueueDesc.
 472  * The number of Vmxnet3_TxQueueDesc/Vmxnet3_RxQueueDesc are specified by
 473  * Vmxnet3_MiscConf.numTxQueues/numRxQueues, respectively.
 474  */
 475 #define VMXNET3_QUEUE_DESC_ALIGN  128
 476
 477 typedef
 478 #include "vmware_pack_begin.h"
 479 struct Vmxnet3_MiscConf {
 480    Vmxnet3_DriverInfo driverInfo;
 481    __le64             uptFeatures;
 482    __le64             ddPA;         /* driver data PA */
 483    __le64             queueDescPA;  /* queue descriptor table PA */
 484    __le32             ddLen;        /* driver data len */
 485    __le32             queueDescLen; /* queue descriptor table len, in bytes */
 486    __le32             mtu;
 487    __le16             maxNumRxSG;
 488    uint8              numTxQueues;
 489    uint8              numRxQueues;
 490    __le32             reserved[4];
 491 }
 492 #include "vmware_pack_end.h"
 493 Vmxnet3_MiscConf;
 494
 495 typedef
 496 #include "vmware_pack_begin.h"
 497 struct Vmxnet3_TxQueueConf {
 498    __le64    txRingBasePA;
 499    __le64    dataRingBasePA;
 500    __le64    compRingBasePA;
 501    __le64    ddPA;         /* driver data */
 502    __le64    reserved;
 503    __le32    txRingSize;   /* # of tx desc */
 504    __le32    dataRingSize; /* # of data desc */
 505    __le32    compRingSize; /* # of comp desc */
 506    __le32    ddLen;        /* size of driver data */
 507    uint8     intrIdx;
 508    uint8     _pad[1];
 509    __le16    txDataRingDescSize;
 510    uint8     _pad2[4];
 511 }
 512 #include "vmware_pack_end.h"
 513 Vmxnet3_TxQueueConf;
 514
 515 typedef
 516 #include "vmware_pack_begin.h"
 517 struct Vmxnet3_RxQueueConf {
 518    __le64    rxRingBasePA[2];
 519    __le64    compRingBasePA;
 520    __le64    ddPA;            /* driver data */
 521    __le64    rxDataRingBasePA;
 522    __le32    rxRingSize[2];   /* # of rx desc */
 523    __le32    compRingSize;    /* # of rx comp desc */
 524    __le32    ddLen;           /* size of driver data */
 525    uint8     intrIdx;
 526    uint8     _pad1[1];
 527    __le16    rxDataRingDescSize;  /* size of rx data ring buffer */
 528    uint8     _pad2[4];
 529 }
 530 #include "vmware_pack_end.h"
 531 Vmxnet3_RxQueueConf;
 532
 533 enum vmxnet3_intr_mask_mode {
 534    VMXNET3_IMM_AUTO   = 0,
 535    VMXNET3_IMM_ACTIVE = 1,
 536    VMXNET3_IMM_LAZY   = 2
 537 };
 538
 539 enum vmxnet3_intr_type {
 540    VMXNET3_IT_AUTO = 0,
 541    VMXNET3_IT_INTX = 1,
 542    VMXNET3_IT_MSI  = 2,
 543    VMXNET3_IT_MSIX = 3
 544 };
 545
 546 #define VMXNET3_MAX_TX_QUEUES  8
 547 #define VMXNET3_MAX_RX_QUEUES  16
 548 /* addition 1 for events */
 549 #define VMXNET3_MAX_INTRS      25
 550
 551 /* value of intrCtrl */
 552 #define VMXNET3_IC_DISABLE_ALL  0x1   /* bit 0 */
 553
 554 typedef
 555 #include "vmware_pack_begin.h"
 556 struct Vmxnet3_IntrConf {
 557    Bool   autoMask;
 558    uint8  numIntrs;      /* # of interrupts */
 559    uint8  eventIntrIdx;
 560    uint8  modLevels[VMXNET3_MAX_INTRS]; /* moderation level for each intr */
 561    __le32 intrCtrl;
 562    __le32 reserved[2];
 563 }
 564 #include "vmware_pack_end.h"
 565 Vmxnet3_IntrConf;
 566
 567 /* one bit per VLAN ID, the size is in the units of uint32 */
 568 #define VMXNET3_VFT_SIZE  (4096 / (sizeof(uint32) * 8))
 569
 570 typedef
 571 #include "vmware_pack_begin.h"
 572 struct Vmxnet3_QueueStatus {
 573    Bool    stopped;
 574    uint8   _pad[3];
 575    __le32  error;
 576 }
 577 #include "vmware_pack_end.h"
 578 Vmxnet3_QueueStatus;
 579
 580 typedef
 581 #include "vmware_pack_begin.h"
 582 struct Vmxnet3_TxQueueCtrl {
 583    __le32  txNumDeferred;
 584    __le32  txThreshold;
 585    __le64  reserved;
 586 }
 587 #include "vmware_pack_end.h"
 588 Vmxnet3_TxQueueCtrl;
 589
 590 typedef
 591 #include "vmware_pack_begin.h"
 592 struct Vmxnet3_RxQueueCtrl {
 593    Bool    updateRxProd;
 594    uint8   _pad[7];
 595    __le64  reserved;
 596 }
 597 #include "vmware_pack_end.h"
 598 Vmxnet3_RxQueueCtrl;
 599
 600 #define VMXNET3_RXM_UCAST     0x01  /* unicast only */
 601 #define VMXNET3_RXM_MCAST     0x02  /* multicast passing the filters */
 602 #define VMXNET3_RXM_BCAST     0x04  /* broadcast only */
 603 #define VMXNET3_RXM_ALL_MULTI 0x08  /* all multicast */
 604 #define VMXNET3_RXM_PROMISC   0x10  /* promiscuous */
 605
 606 typedef
 607 #include "vmware_pack_begin.h"
 608 struct Vmxnet3_RxFilterConf {
 609    __le32   rxMode;       /* VMXNET3_RXM_xxx */
 610    __le16   mfTableLen;   /* size of the multicast filter table */
 611    __le16   _pad1;
 612    __le64   mfTablePA;    /* PA of the multicast filters table */
 613    __le32   vfTable[VMXNET3_VFT_SIZE]; /* vlan filter */
 614 }
 615 #include "vmware_pack_end.h"
 616 Vmxnet3_RxFilterConf;
 617
 618 #define VMXNET3_PM_MAX_FILTERS        6
 619 #define VMXNET3_PM_MAX_PATTERN_SIZE   128
 620 #define VMXNET3_PM_MAX_MASK_SIZE      (VMXNET3_PM_MAX_PATTERN_SIZE / 8)
 621
 622 #define VMXNET3_PM_WAKEUP_MAGIC       0x01  /* wake up on magic pkts */
 623 #define VMXNET3_PM_WAKEUP_FILTER      0x02  /* wake up on pkts matching filters */
 624
 625 typedef
 626 #include "vmware_pack_begin.h"
 627 struct Vmxnet3_PM_PktFilter {
 628    uint8 maskSize;
 629    uint8 patternSize;
 630    uint8 mask[VMXNET3_PM_MAX_MASK_SIZE];
 631    uint8 pattern[VMXNET3_PM_MAX_PATTERN_SIZE];
 632    uint8 pad[6];
 633 }
 634 #include "vmware_pack_end.h"
 635 Vmxnet3_PM_PktFilter;
 636
 637 typedef
 638 #include "vmware_pack_begin.h"
 639 struct Vmxnet3_PMConf {
 640    __le16               wakeUpEvents;  /* VMXNET3_PM_WAKEUP_xxx */
 641    uint8                numFilters;
 642    uint8                pad[5];
 643    Vmxnet3_PM_PktFilter filters[VMXNET3_PM_MAX_FILTERS];
 644 }
 645 #include "vmware_pack_end.h"
 646 Vmxnet3_PMConf;
 647
 648 typedef
 649 #include "vmware_pack_begin.h"
 650 struct Vmxnet3_VariableLenConfDesc {
 651    __le32              confVer;
 652    __le32              confLen;
 653    __le64              confPA;
 654 }
 655 #include "vmware_pack_end.h"
 656 Vmxnet3_VariableLenConfDesc;
 657
 658 typedef
 659 #include "vmware_pack_begin.h"
 660 struct Vmxnet3_DSDevRead {
 661    /* read-only region for device, read by dev in response to a SET cmd */
 662    Vmxnet3_MiscConf     misc;
 663    Vmxnet3_IntrConf     intrConf;
 664    Vmxnet3_RxFilterConf rxFilterConf;
 665    Vmxnet3_VariableLenConfDesc  rssConfDesc;
 666    Vmxnet3_VariableLenConfDesc  pmConfDesc;
 667    Vmxnet3_VariableLenConfDesc  pluginConfDesc;
 668 }
 669 #include "vmware_pack_end.h"
 670 Vmxnet3_DSDevRead;
 671
 672 typedef
 673 #include "vmware_pack_begin.h"
 674 struct Vmxnet3_TxQueueDesc {
 675    Vmxnet3_TxQueueCtrl ctrl;
 676    Vmxnet3_TxQueueConf conf;
 677    /* Driver read after a GET command */
 678    Vmxnet3_QueueStatus status;
 679    UPT1_TxStats        stats;
 680    uint8               _pad[88]; /* 128 aligned */
 681 }
 682 #include "vmware_pack_end.h"
 683 Vmxnet3_TxQueueDesc;
 684
 685 typedef
 686 #include "vmware_pack_begin.h"
 687 struct Vmxnet3_RxQueueDesc {
 688    Vmxnet3_RxQueueCtrl ctrl;
 689    Vmxnet3_RxQueueConf conf;
 690    /* Driver read after a GET command */
 691    Vmxnet3_QueueStatus status;
 692    UPT1_RxStats        stats;
 693    uint8               _pad[88]; /* 128 aligned */
 694 }
 695 #include "vmware_pack_end.h"
 696 Vmxnet3_RxQueueDesc;
 697
 698 typedef
 699 #include "vmware_pack_begin.h"
 700 struct Vmxnet3_SetPolling {
 701    uint8 enablePolling;
 702 }
 703 #include "vmware_pack_end.h"
 704 Vmxnet3_SetPolling;
 705
 706 typedef
 707 #include "vmware_pack_begin.h"
 708 struct Vmxnet3_MemoryRegion {
 709         __le64            startPA;
 710         __le32            length;
 711         __le16            txQueueBits; /* bit n corresponding to tx queue n */
 712         __le16            rxQueueBits; /* bit n corresponding to rx queue n */
 713 }
 714 #include "vmware_pack_end.h"
 715 Vmxnet3_MemoryRegion;
 716
 717 #define MAX_MEMORY_REGION_PER_QUEUE 16
 718 #define MAX_MEMORY_REGION_PER_DEVICE 256
 719
 720 typedef
 721 #include "vmware_pack_begin.h"
 722 struct Vmxnet3_MemRegs {
 723         __le16           numRegs;
 724         __le16           pad[3];
 725         Vmxnet3_MemoryRegion memRegs[1];
 726 }
 727 #include "vmware_pack_end.h"
 728 Vmxnet3_MemRegs;
 729
 730 /*
 731  * If the command data <= 16 bytes, use the shared memory direcly.
 732  * Otherwise, use the variable length configuration descriptor.
 733  */
 734 typedef
 735 #include "vmware_pack_begin.h"
 736 union Vmxnet3_CmdInfo {
 737    Vmxnet3_VariableLenConfDesc varConf;
 738    Vmxnet3_SetPolling          setPolling;
 739    __le64                      data[2];
 740 }
 741 #include "vmware_pack_end.h"
 742 Vmxnet3_CmdInfo;
 743
 744 typedef
 745 #include "vmware_pack_begin.h"
 746 struct Vmxnet3_DriverShared {
 747    __le32               magic;
 748    __le32               pad; /* make devRead start at 64-bit boundaries */
 749    Vmxnet3_DSDevRead    devRead;
 750    __le32               ecr;
 751    __le32               reserved;
 752
 753    union {
 754       __le32            reserved1[4];
 755       Vmxnet3_CmdInfo   cmdInfo; /* only valid in the context of executing the
 756                                   * relevant command
 757                                   */
 758    } cu;
 759 }
 760 #include "vmware_pack_end.h"
 761 Vmxnet3_DriverShared;
 762
 763 #define VMXNET3_ECR_RQERR       (1 << 0)
 764 #define VMXNET3_ECR_TQERR       (1 << 1)
 765 #define VMXNET3_ECR_LINK        (1 << 2)
 766 #define VMXNET3_ECR_DIC         (1 << 3)
 767 #define VMXNET3_ECR_DEBUG       (1 << 4)
 768
 769 /* flip the gen bit of a ring */
 770 #define VMXNET3_FLIP_RING_GEN(gen) ((gen) = (gen) ^ 0x1)
 771
 772 /* only use this if moving the idx won't affect the gen bit */
 773 #define VMXNET3_INC_RING_IDX_ONLY(idx, ring_size) \
 774 do {\
 775    (idx)++;\
 776    if (UNLIKELY((idx) == (ring_size))) {\
 777       (idx) = 0;\
 778    }\
 779 } while (0)
 780
 781 #define VMXNET3_SET_VFTABLE_ENTRY(vfTable, vid) \
 782    vfTable[vid >> 5] |= (1 << (vid & 31))
 783 #define VMXNET3_CLEAR_VFTABLE_ENTRY(vfTable, vid) \
 784    vfTable[vid >> 5] &= ~(1 << (vid & 31))
 785
 786 #define VMXNET3_VFTABLE_ENTRY_IS_SET(vfTable, vid) \
 787    ((vfTable[vid >> 5] & (1 << (vid & 31))) != 0)
 788
 789 #define VMXNET3_MAX_MTU     9000
 790 #define VMXNET3_MIN_MTU     60
 791
 792 #define VMXNET3_LINK_UP         (10000 << 16 | 1)    // 10 Gbps, up
 793 #define VMXNET3_LINK_DOWN       0
 794
 795 #define VMXWIFI_DRIVER_SHARED_LEN 8192
 796
 797 #define VMXNET3_DID_PASSTHRU    0xFFFF
 798
 799 #endif /* _VMXNET3_DEFS_H_ */