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: head/share/man/man4/man4.i386/vx.4 148145 2005-07-19 00:26:30Z trhodes $
32.\"
33.Dd July 16, 2005
34.Dt VX 4 i386
35.Os
36.Sh NAME
37.Nm vx
38.Nd "3Com EtherLink III / Fast EtherLink III (3c59x) Ethernet driver"
39.Sh SYNOPSIS
40To compile support for the
41.Nm
42driver into your kernel, place the following liness in your kernel configuration file:
43.Bd -ragged -offset indent
44.Cd "device vx"
45.Ed
46.Pp
47Alternatively, to load the
48.Nm
49driver at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_vx_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for the 3Com
58.Dq Vortex
59chipset.
60.Pp
61The medium selection
62can be influenced by the following link flags to the
63.Xr ifconfig 8
64command:
65.Pp
66.Bl -tag -width LINK0X -compact
67.It Em link0
68Use the AUI port.
69.It Em link1
70Use the BNC port.
71.It Em link2
72Use the UTP port.
73.El
74.Sh HARDWARE
75The
76.Nm
77driver supports the following cards:
78.Pp
79.Bl -bullet -compact
80.It
813Com 3c590 EtherLink III PCI
82.It
833Com 3c592 EtherLink III EISA
84.It
853Com 3c595 Fast EtherLink III PCI in 10 Mbps mode
86.It
873Com 3c597 Fast EtherLink III EISA in 10 Mbps mode
88.El
89.Sh DIAGNOSTICS
90.Bl -diag
91.It "vx%d: not configured; kernel is built for only %d devices."
92There are not enough devices in the kernel configuration file for the number
93of adapters present in the system.
94Add devices to the configuration file,
95rebuild the kernel, and reboot.
96.El
97.Pp
98All other diagnostics indicate either a hardware problem or a bug in the
99driver.
100.Sh CAVEATS
101Some early-revision 3c590 cards are defective and suffer from many receive
102overruns, which cause lost packets.
103The author has attempted to implement
104a test for it based on the information supplied by 3Com, but the test resulted
105mostly in spurious warnings.
106.Pp
107The performance of this driver is somewhat limited by the fact that it uses
108only polled-mode I/O and does not make use of the bus-mastering capability
109of the cards.
110.Sh SEE ALSO
111.Xr arp 4 ,
112.Xr netintro 4 ,
113.Xr ng_ether 4 ,
114.Xr ifconfig 8
115.Sh HISTORY
116The
117.Nm
118device driver first appeared in
119.Fx 2.1 .
120It was derived from the
121.Nm ep
122driver, from which it inherits most of its limitations.
123.Sh AUTHORS
124.An -nosplit
125The
126.Nm
127device driver and this manual page were written by
128.An Fred Gray Aq fgray@rice.edu ,
129based on the work of
130.An Herb Peyerl
131and with the assistance of numerous others.
132.Sh BUGS
133The
134.Nm
135driver is known not to reset the adapter correctly following a warm boot
136on some systems.
137.Pp
138The
139.Nm
140driver has not been exhaustively tested with all the models of cards that it
141claims to support.
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: head/share/man/man4/man4.i386/vx.4 148145 2005-07-19 00:26:30Z trhodes $
32.\"
33.Dd July 16, 2005
34.Dt VX 4 i386
35.Os
36.Sh NAME
37.Nm vx
38.Nd "3Com EtherLink III / Fast EtherLink III (3c59x) Ethernet driver"
39.Sh SYNOPSIS
40To compile support for the
41.Nm
42driver into your kernel, place the following liness in your kernel configuration file:
43.Bd -ragged -offset indent
44.Cd "device vx"
45.Ed
46.Pp
47Alternatively, to load the
48.Nm
49driver at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_vx_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for the 3Com
58.Dq Vortex
59chipset.
60.Pp
61The medium selection
62can be influenced by the following link flags to the
63.Xr ifconfig 8
64command:
65.Pp
66.Bl -tag -width LINK0X -compact
67.It Em link0
68Use the AUI port.
69.It Em link1
70Use the BNC port.
71.It Em link2
72Use the UTP port.
73.El
74.Sh HARDWARE
75The
76.Nm
77driver supports the following cards:
78.Pp
79.Bl -bullet -compact
80.It
813Com 3c590 EtherLink III PCI
82.It
833Com 3c592 EtherLink III EISA
84.It
853Com 3c595 Fast EtherLink III PCI in 10 Mbps mode
86.It
873Com 3c597 Fast EtherLink III EISA in 10 Mbps mode
88.El
89.Sh DIAGNOSTICS
90.Bl -diag
91.It "vx%d: not configured; kernel is built for only %d devices."
92There are not enough devices in the kernel configuration file for the number
93of adapters present in the system.
94Add devices to the configuration file,
95rebuild the kernel, and reboot.
96.El
97.Pp
98All other diagnostics indicate either a hardware problem or a bug in the
99driver.
100.Sh CAVEATS
101Some early-revision 3c590 cards are defective and suffer from many receive
102overruns, which cause lost packets.
103The author has attempted to implement
104a test for it based on the information supplied by 3Com, but the test resulted
105mostly in spurious warnings.
106.Pp
107The performance of this driver is somewhat limited by the fact that it uses
108only polled-mode I/O and does not make use of the bus-mastering capability
109of the cards.
110.Sh SEE ALSO
111.Xr arp 4 ,
112.Xr netintro 4 ,
113.Xr ng_ether 4 ,
114.Xr ifconfig 8
115.Sh HISTORY
116The
117.Nm
118device driver first appeared in
119.Fx 2.1 .
120It was derived from the
121.Nm ep
122driver, from which it inherits most of its limitations.
123.Sh AUTHORS
124.An -nosplit
125The
126.Nm
127device driver and this manual page were written by
128.An Fred Gray Aq fgray@rice.edu ,
129based on the work of
130.An Herb Peyerl
131and with the assistance of numerous others.
132.Sh BUGS
133The
134.Nm
135driver is known not to reset the adapter correctly following a warm boot
136on some systems.
137.Pp
138The
139.Nm
140driver has not been exhaustively tested with all the models of cards that it
141claims to support.