Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / share / man / man4 / man4.i386 / vx.4
1 .\"
2 .\" Copyright (c) 1996, Fred Gray
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
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 .\" 3. All advertising materials mentioning features or use of this software
14 .\"    must display the following acknowledgement:
15 .\"     This product includes software developed by David Greenman.
16 .\" 4. The name of the author may not be used to endorse or promote products
17 .\"    derived from this software without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\" $FreeBSD: src/share/man/man4/man4.i386/vx.4,v 1.10.2.5 2001/08/17 13:08:46 ru Exp $
32 .\" $DragonFly: src/share/man/man4/man4.i386/vx.4,v 1.2 2003/06/17 04:37:00 dillon Exp $
33 .\"
34 .Dd January 15, 1996
35 .Dt VX 4 i386
36 .Os
37 .Sh NAME
38 .Nm vx
39 .Nd PCI Ethernet device driver
40 .Sh SYNOPSIS
41 .Cd "device vx"
42 .Sh DESCRIPTION
43 The
44 .Nm
45 driver provides support for the 3Com 3c590 and 3c595 EtherLink III and Fast
46 EtherLink III PCI Ethernet cards in 10 Mbps mode.  The medium selection
47 can be influenced by the following link flags to the
48 .Xr ifconfig 8
49 command:
50 .Pp
51 .Bl -tag -width LINK0X -compact
52 .It Em link0
53 Use the AUI port.
54 .It Em link1
55 Use the BNC port.
56 .It Em link2
57 Use the UTP port.
58 .El
59 .Sh DIAGNOSTICS
60 .Bl -diag
61 .It "vx%d: not configured; kernel is built for only %d devices."
62 There are not enough devices in the kernel configuration file for the number
63 of adapters present in the system.  Add devices to the configuration file,
64 rebuild the kernel, and reboot.
65 .El
66 .Pp
67 All other diagnostics indicate either a hardware problem or a bug in the
68 driver.
69 .Sh CAVEATS
70 Some early-revision 3c590 cards are defective and suffer from many receive
71 overruns, which cause lost packets.  The author has attempted to implement
72 a test for it based on the information supplied by 3Com, but the test resulted
73 mostly in spurious warnings.
74 .Pp
75 The performance of this driver is somewhat limited by the fact that it uses
76 only polled-mode I/O and does not make use of the bus-mastering capability
77 of the cards.
78 .Sh BUGS
79 The
80 .Nm
81 driver is known not to reset the adapter correctly following a warm boot
82 on some systems.
83 .Pp
84 The
85 .Nm
86 driver has not been exhaustively tested with all the models of cards that it
87 claims to support.
88 .Sh SEE ALSO
89 .Xr arp 4 ,
90 .Xr netintro 4 ,
91 .Xr ng_ether 4 ,
92 .Xr ifconfig 8
93 .Sh HISTORY
94 The
95 .Nm
96 device driver first appeared in
97 .Fx 2.1 .
98 It was derived from the
99 .Nm ep
100 driver, from which it inherits most of its limitations.
101 .Sh AUTHORS
102 .An -nosplit
103 The
104 .Nm
105 device driver and this manual page were written by
106 .An Fred Gray Aq fgray@rice.edu ,
107 based on the work of
108 .An Herb Peyerl
109 and with the assistance of numerous others.