add initial manual page for vic(4)

2 files changed, 130 insertions, 4 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 5542da593ac..c3f57154984 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.343 2006/02/11 09:30:54 brad Exp $
+#	$OpenBSD: Makefile,v 1.344 2006/02/25 23:53:03 reyk Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 acpi.4 acpitimer.4 \
 	adc.4 addcom.4 admcts.4 admlc.4 admtemp.4 \
@@ -40,9 +40,9 @@ MAN=	aac.4 ac97.4 acphy.4 acpi.4 acpitimer.4 \
 	ukphy.4 ulpt.4 umass.4 umct.4 umidi.4 umodem.4 ums.4 \
 	unix.4 upl.4 uplcom.4 urio.4 url.4 urlphy.4 usb.4 \
 	uscanner.4 usscanner.4 uvisor.4 uvscom.4 uyap.4 vga.4 vgafb.4 vge.4 \
-	viaenv.4 viapm.4 viasio.4 vlan.4 vnd.4 vr.4 watchdog.4 wb.4 wbenv.4 \
-	wd.4 wdc.4 we.4 wi.4tbl wscons.4 wsdisplay.4 wskbd.4 wsmouse.4 \
-	wsmux.4 xe.4 xf86.4 xl.4 xmphy.4 yds.4 ym.4 zero.4
+	viaenv.4 viapm.4 viasio.4 vic.4 vlan.4 vnd.4 vr.4 watchdog.4 wb.4 \
+	wbenv.4 wd.4 wdc.4 we.4 wi.4tbl wscons.4 wsdisplay.4 wskbd.4 \
+	wsmouse.4 wsmux.4 xe.4 xf86.4 xl.4 xmphy.4 yds.4 ym.4 zero.4
 
 
 MLINKS+=ral.4 ural.4
diff --git a/share/man/man4/vic.4 b/share/man/man4/vic.4
new file mode 100644
index 00000000000..75d4e4ca1b3
--- /dev/null
+++ b/share/man/man4/vic.4
@@ -0,0 +1,126 @@
+.\"	$OpenBSD: vic.4,v 1.1 2006/02/25 23:53:03 reyk Exp $
+.\"
+.\" Copyright (c) 2006 Reyk Floeter <reyk@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd Dec 20, 2005
+.Dt VIC 4
+.Os
+.Sh NAME
+.Nm vic
+.Nd VMware Virtual Network Interface Controller driver
+.Sh SYNOPSIS
+.Cd vic* at pci?
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the virtual NIC available in virtual
+machines by VMware.
+It appears as a simple Ethernet device but is a virtual network
+interface to the underlying host operating system indeed.
+.Pp
+This drivers supports the
+.Ic vmxnet
+driver protocol, as an alternative to the the emulated
+.Xr pcn 4
+interface also available in the VMware environment.
+The
+.Nm vic
+driver is optimized for the virtual machine, it can provide advanced
+capabilities depending on the underlying host operating system and
+the physical network interface controller of the host.
+.Pp
+Unlike the capabilities of physical network interface controllers,
+these capabilities may change after reboot.
+The list of available capabilities is printed by the kernel on
+startup, which could be:
+.Pp
+.Bl -tag -width VLANSW -offset indent -compact
+.It SG
+Transmit scatter-gather lists are supported (required).
+.It CSUM4
+IPv4 TCP/UDP checksum offload is supported (ignored).
+.It CSUM
+IPv4/IPv6/TCP/UDP checksum offload is supported (ignored).
+.It HDMA
+Can map high DMA memory.
+.It TOE
+TCP offload engine available (ignored).
+.It TSO
+TCP segmentation offload supported (ignored).
+.It TSOHW
+Software-based TSO supported (ignored).
+.It VPROM
+Virtual PROM available, used for the MAC address.
+.It VLANTx
+VLAN tagging available (ignored).
+.It VLANRx
+VLAN untagging available (ignored).
+.It VLANSW
+Software-based VLAN tagging on the host (ignored).
+.El
+.Pp
+The
+.Nm
+driver supports the following media types:
+.Bl -tag -width autoselect
+.It autoselect
+Enable autoselection of the media type and options.
+The driver always uses the fastest available speed and the media
+options provided by the underlying host of the virtual machine.
+.El
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh HARDWARE
+The
+.Nm
+driver supports VMware Virtual NICs provided by the following
+known products:
+.Pp
+.Bl -bullet -compact -offset indent
+.It
+VMware ESX Server
+.El
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "vic%d: memory mapping is not available"
+A fatal initialization error has occurred.
+.It "vic%d: memory mapping of register space failed"
+A fatal initialization error has occurred.
+.It "vic%d: interrupt mapping failed"
+A fatal initialization error has occurred.
+.It "vic%d: failed to establish the interrupt"
+A fatal initialization error has occurred.
+.It "vic%d: failed to establish the shutdown hook"
+A fatal initialization error has occurred.
+.It "vic%d: watchdog timeout"
+The device has stopped responding to the network, or there is a problem with
+the network connection (cable of the host).
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifmedia 4 ,
+.Xr intro 4 ,
+.Xr netintro 4 ,
+.Xr pci 4 ,
+.Xr pcn 4 ,
+.Xr hostname.if 5 ,
+.Xr ifconfig 8
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Reyk Floeter Aq reyk@openbsd.org .