share/man/man4/vmx.4

   1 .\"
   2 .\" Copyright (c) 2006,2013 Reyk Floeter <reyk@openbsd.org>
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $OpenBSD: src/share/man/man4/vmx.4,v 1.1 2013/05/31 20:18:44 reyk Exp $
  17 .\"
  18 .\" $FreeBSD$
  19 .\"
  20 .Dd August 4, 2013
  21 .Dt VMX 4
  22 .Os
  23 .Sh NAME
  24 .Nm vmx
  25 .Nd VMware VMXNET3 Virtual Interface Controller device
  26 .Sh SYNOPSIS
  27 To compile this driver into the kernel,
  28 place the following line in your
  29 kernel configuration file:
  30 .Bd -ragged -offset indent
  31 .Cd "device vmx"
  32 .Ed
  33 .Pp
  34 Alternatively, to load the driver as a
  35 module at boot time, place the following line in
  36 .Xr loader.conf 5 :
  37 .Bd -literal -offset indent
  38 if_vmx_load="YES"
  39 .Ed
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver provides support for the VMXNET3 virtual NIC available in virtual
  44 machines by VMware.
  45 It appears as a simple Ethernet device but is actually a virtual network
  46 interface to the underlying host operating system.
  47 .Pp
  48 This driver supports the
  49 .Ic VMXNET3
  50 driver protocol, as an alternative to the emulated
  51 .Xr pcn 4 ,
  52 .Xr em 4
  53 interfaces also available in the VMware environment.
  54 The
  55 .Nm
  56 driver is optimized for the virtual machine, it can provide advanced
  57 capabilities depending on the underlying host operating system and
  58 the physical network interface controller of the host.
  59 The
  60 .Nm
  61 driver supports features like multiqueue support, IPv6
  62 checksum offloading, MSI/MSI-X support and hardware VLAN tagging in
  63 VMware's VLAN Guest Tagging (VGT) mode.
  64 .Pp
  65 The
  66 .Nm
  67 driver supports VMXNET3 VMware virtual NICs provided by the virtual
  68 machine hardware version 7 or newer, as provided by the following
  69 products:
  70 .Pp
  71 .Bl -bullet -compact -offset indent
  72 .It
  73 VMware ESX/ESXi 4.0 and newer
  74 .It
  75 VMware Server 2.0 and newer
  76 .It
  77 VMware Workstation 6.5 and newer
  78 .It
  79 VMware Fusion 2.0 and newer
  80 .El
  81 .Pp
  82 For more information on configuring this device, see
  83 .Xr ifconfig 8 .
  84 .Sh LOADER TUNABLES
  85 Tunables can be set at the
  86 .Xr loader 8
  87 prompt before booting the kernel or stored in
  88 .Xr loader.conf 5 .
  89 .Bl -tag -width indent
  90 .It Va hw.vmx.txndesc
  91 .It Va hw.vmx. Ns Ar X Ns Va .txndesc
  92 .Pp
  93 Number of transmit descriptors allocated by the driver.
  94 The default value is 512.
  95 The value must be a multiple of 32, and the maximum is 4096.
  96 .It Va hw.vmx.rxndesc
  97 .It Va hw.vmx. Ns Ar X Ns Va .rxndesc
  98 .Pp
  99 Number of receive descriptors per ring allocated by the driver.
 100 The default value is 256.
 101 The value must be a multiple of 32, and the maximum is 2048.
 102 There are two rings so the actual usage is doubled.
 103 .El
 104 .Sh EXAMPLES
 105 The following entry must be added to the VMware configuration file
 106 to provide the
 107 .Nm
 108 device:
 109 .Bd -literal -offset indent
 110 ethernet0.virtualDev = "vmxnet3"
 111 .Ed
 112 .Sh SEE ALSO
 113 .Xr altq 4 ,
 114 .Xr arp 4 ,
 115 .Xr em 4 ,
 116 .Xr netintro 4 ,
 117 .Xr ng_ether 4 ,
 118 .Xr pcn 4 ,
 119 .Xr vlan 4 ,
 120 .Xr ifconfig 8
 121 .Sh AUTHORS
 122 .An -nosplit
 123 The
 124 .Nm
 125 driver was ported from
 126 .Ox
 127 and significantly rewritten by
 128 .An Bryan Venteicher Aq bryanv@freebsd.org .
 129 The
 130 .Ox
 131 driver was written by
 132 .An Tsubai Masanari .