drivers/net/vmxnet3/base/vmxnet3_defs.h

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