xref: /netbsd-src/share/man/man4/ep.4 (revision 7cfde6547e53c9fbacb75a53801dd34f7f4c3b96)
1.\"	$NetBSD: ep.4,v 1.39 2021/10/11 07:45:39 wiz Exp $
2.\"
3.\" Copyright (c) 1997 Jonathan Stone
4.\" All rights reserved.
5.\"
6.\" Copyright (c) 1994 Herb Peyerl
7.\" All rights reserved.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgements:
19.\"      This product includes software developed by Herb Peyerl
20.\"      This product includes software developed by Jonathan Stone
21.\" 4. The name of the author may not be used to endorse or promote products
22.\"    derived from this software without specific prior written permission
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34.\"
35.Dd October 11, 2021
36.Dt EP 4
37.Os
38.Sh NAME
39.Nm ep
40.Nd driver for 3Com EtherLink III Ethernet interfaces
41.Sh SYNOPSIS
42.Cd "ep0 at isa? port ? irq ?"
43.Cd "ep* at isapnp?"
44.Cd "ep* at eisa? slot ?"
45.Cd "ep* at mca? slot ?"
46.Cd "ep* at pci? dev ? function ?"
47.Cd "ep* at pcmcia? function ?"
48.Sh DESCRIPTION
49The
50.Nm
51device driver supports the 3Com EtherLink III family of Ethernet cards.
52.Pp
53The 3c515 is an ISA 10/100 card with DMA capability.
54The chipset is similar to that of the 3c905, with some changes to
55make it work with the more limited ISA bus address space.
56This card is supported, although DMA is not used.
57.Pp
58The EISA and PCI 3c59x devices use an older DMA engine which is not
59capable of multi-segment DMA.
60DMA on these devices is not used.
61.Pp
62The 3c529 is a MCA device, and doesn't support DMA.
63.Pp
64The PCI 3c90x devices have multi-segment DMA capability, which is
65not supported by the
66.Nm
67driver.
68To use the DMA capabilities of these cards, the
69.Xr ex 4
70driver must be used.
71.Pp
72The PCI 3c90xB devices are not supported by the
73.Nm
74driver, as they do not include support for programmed I/O.
75These devices are supported by the
76.Xr ex 4
77driver.
78.Pp
79The 3c575 is a CardBus device, and is supported by
80.Xr ex 4
81driver.
82.Sh MEDIA SELECTION
83There are 3 main chipset classes supported by the
84.Nm
85driver.
86Each has their own media selection capabilities.
87.Pp
88The first class is the
89.Dq 3c509
90class.
91This includes the 3c509, 3c509B, 3c529, 3c579, 3c562, and 3c589.
92These devices can support 10BASE-T, 10BASE2, and 10BASE5.
93Available media will be displayed when the device is found by the kernel.
94.Pp
95The second class is the
96.Dq Vortex
97class.
98This includes the 3c592, 3c579, 3c590, and 3c595.
99This class also includes the 3c900-TPO and 3c900-COMBO; they use the
100.Dq Boomerang
101chipset, but use Vortex-style media selection.
102These devices have many different media types varying by model.
103Some models have an external MII connector for connecting an external
104PHY.
105This is supported by means of the
106.Dq manual
107media type.
108Available media will be displayed when the device is found by the kernel.
109.Pp
110The third class is the
111.Dq Boomerang
112class.
113This includes the 3c515, 3c905, and 3c574.
114These devices support media selection via MII.
115The 3c515 and 3c905 have an
116.Xr nsphy 4 ,
117and the 3c574 has a
118.Xr tqphy 4 ,
119for this purpose.
120See
121.Xr ifmedia 4
122and
123.Xr mii 4
124for more information.
125.Sh HARDWARE
126Supported cards include:
127.Bl -tag -width xxxxxx -offset indent
128.It 3c509
129ISA 10Mbps card, in BNC and multiport variants
130.It 3c509B
131ISA Plug-and-Play 10Mbps card, in BNC and multiport variants
132.It 3c515
133ISA Plug-and-Play 10/100 card with UTP
134.It 3c529
135MCA 10Mbps card, in UTP+AUI and BNC+AUI variants
136.It 3c556B
137PCMCIA 56K modem-10/100Mbps Ethernet combo card with dongle
138.It 3c562
139PCMCIA modem-10Mbps Ethernet combo card with dongle
140.It 3c572B
141OfficeConnect.
142Same as 3c574, but with newer revision of
143.Xr tqphy 4
144.It 3c574
145PCMCIA 10/100Mbps card with dongle
146.It 3c579
147EISA 10Mbps card, in UTP, BNC, and multiport variants
148.It 3c589
149PCMCIA 10Mbps card with dongle
150.It 3c590
151PCI 10Mbps multiport card with DMA capability
152.It 3c592
153EISA 10Mbps card with DMA capability
154.It 3c595
155PCI 10/100Mbps with different media options and DMA capability
156.It 3c597
157EISA 10/100Mbps card with DMA capability
158.It 3c900
159PCI 10Mbps card in 10BASE-T and multiport variants with DMA capability
160.It 3c905
161PCI 10/100Mbps card in 10BASE-T, multiport, and fast variants with
162DMA capability
163.El
164.Sh NOTES
165EtherLink III cards have no jumpers to set the address.
1663Com supplies software to set the address of the card in software.
167To find the card on the ISA bus, the kernel performs a complex
168scan operation at IO address 0x100.
169.Em Beware !
170Avoid placing other cards at that address!
171.Pp
172The 3Com configuration utilities can `autosense' the active media and
173save it as default.
174The saved default medium is the medium that
175was active at the time the configuration utility was run.
176The
177.Nm
178driver does not yet re-autosense the active media at boot time.
179If the EEPROM autosense bit is set, the driver simply uses the media
180type sensed and saved when the configuration utility was run.
181.Sh DIAGNOSTICS
182.Bl -diag
183.It "ep0: reset (status: %x)"
184The driver has encountered a FIFO underrun or overrun.
185The driver will reset the card and the packet will be lost.
186This is not fatal.
187.It "ep0: eeprom failed to come ready"
188The EEPROM failed to come ready.
189This probably means the card is wedged.
190.It "ep0: 3c509 in test mode. Erase pencil mark!"
191This means that someone has scribbled with pencil in the test area on the
192card.
193Erase the pencil mark and reboot.
194(This is not a joke.)
195.El
196.Sh SEE ALSO
197.Xr eisa 4 ,
198.Xr ex 4 ,
199.Xr ifmedia 4 ,
200.Xr intro 4 ,
201.Xr isa 4 ,
202.Xr isapnp 4 ,
203.Xr mca 4 ,
204.Xr mii 4 ,
205.Xr nsphy 4 ,
206.Xr pci 4 ,
207.Xr pcmcia 4 ,
208.Xr tqphy 4 ,
209.Xr ifconfig 8
210