Man page for the vx driver.

Submitted by:	Frederick Earl Gray <fgray@owlnet.rice.edu>

share/man/man4/man4.i386/vx.4

@@ -0,0 +1,85 @@
+.\"
+.\" Copyright (c) 1996, Fred Gray
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"     This product includes software developed by David Greenman.
+.\" 4. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd January 15, 1996
+.Dt VX 4 i386
+.Os
+.Sh NAME
+.Nm vx
+.Nd
+PCI Ethernet device driver
+.Sh SYNOPSIS
+.Cd "device vx0 at pci? port? net irq? vector vxintr"
+.Cd "device vx1 at pci? port? net irq? vector vxintr"
+.Cd "device vx2 at pci? port? net irq? vector vxintr"
+.Sh DESCRIPTION
+The
+.Nm vx
+driver provides support for the 3Com 3c590 and 3c595 EtherLink III and Fast
+EtherLink III PCI Ethernet cards in 10 Mbps mode.
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "vx%d: not configured; kernel is built for only %d devices."
+There are not enough devices in the kernel configuration file for the number
+of adapters present in the system.  Add devices to the configuration file,
+rebuild the kernel, and reboot.
+.Pp
+All other diagnostics indicate either a hardware problem or a bug in the
+driver.
+.Sh CAVEATS
+Some early-revision 3c590 cards are defective and suffer from many receive
+overruns, which cause lost packets.  The author has attempted to implement
+a test for it based on the information supplied by 3Com, but the test resulted
+mostly in spurious warnings.
+.Pp
+The performance of this driver is somewhat limited by the fact that it uses
+only polled-mode I/O and does not make use of the bus-mastering capability 
+of the cards.
+.Sh BUGS
+The
+.Nm vx
+driver is known not to reset the adapter correctly following a warm boot
+on some systems.
+.Pp
+The
+.Nm vx
+driver has not been exhaustively tested with all the models of cards that it
+claims to support.
+.Sh HISTORY
+The
+.Nm vx
+device driver first appeared in FreeBSD 2.1.0.  It was derived from the
+.Nm ep
+driver, from which it inheirits most of its limitations.
+.Sh AUTHOR
+The
+.Nm vx
+device driver and this manual page were written by Fred Gray (fgray@rice.edu),
+based on the work of Herb Peyerl and with the assistance of numerous others.