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