xref: /netbsd/share/man/man4/ep.4 (revision bf9ec67e)
1.\"	$NetBSD: ep.4,v 1.31 2001/09/19 00:49:57 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 March 17, 2001
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 ep
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.  This card
56is 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.  DMA on these devices is not used.
60.Pp
61The 3c529 is a MCA device, and doesn't support DMA.
62.Pp
63The PCI 3c90x devices have multi-segment DMA capability, which is
64not supported by the
65.Nm
66driver.  To use the DMA capabilities of these cards, the
67.Xr ex 4
68driver must be used.
69.Pp
70The PCI 3c90xB devices are not supported by the
71.Nm
72driver, as they do not include support for programmed I/O.  These
73devices are supported by the
74.Xr ex 4
75driver.
76.Pp
77The 3c575 is a CardBus device, and is supported by
78.Xr ex 4
79driver.
80.Sh MEDIA SELECTION
81There are 3 main chipset classes supported by the
82.Nm
83driver.  Each has their own media selection capabilities.
84.Pp
85The first class is the
86.Dq 3c509
87class.  This includes the 3c509, 3c509B, 3c529, 3c579, 3c562, and 3c589.  These
88devices can support 10BASE-T, 10BASE2, and 10BASE5.  Available media will
89be displayed when the device is found by the kernel.
90.Pp
91The second class is the
92.Dq Vortex
93class.  This includes the 3c592, 3c579, 3c590, and 3c595.  This class also
94includes the 3c900-TPO and 3c900-COMBO; they use the
95.Dq Boomerang
96chipset, but use Vortex-style media selection.  These devices have many
97different media types varying by model.  Some models have an external MII
98connector for connecting an external PHY.  This is supported by means of the
99"manual" media type.  Available media will be displayed when the device is
100found by the kernel.
101.Pp
102The third class is the
103.Dq Boomerang
104class.  This includes the 3c515, 3c905, and 3c574.  These devices support
105media selection via MII.  The 3c515 and 3c905 have an
106.Xr nsphy 4 ,
107and the 3c574 has a
108.Xr tqphy 4 ,
109for this purpose. See
110.Xr ifmedia 4
111and
112.Xr mii 4
113for more information.
114.Sh HARDWARE
115Supported cards include:
116.Pp
117.Bl -tag -width xxxxxx -offset indent
118.It 3c509
119ISA 10Mbps card, in BNC and multiport variants
120.It 3c509B
121ISA Plug-and-Play 10Mbps card, in BNC and multiport variants
122.It 3c515
123ISA Plug-and-Play 10/100 card with UTP
124.It 3c529
125MCA 10Mbps card, in UTP+AUI and BNC+AUI variants
126.It 3c579
127EISA 10Mbps card, in UTP, BNC, and multiport variants
128.It 3c592
129EISA 10Mbps card with DMA capability
130.It 3c597
131EISA 10/100Mbps card with DMA capability
132.It 3c590
133PCI 10Mbps multiport card with DMA capability
134.It 3c595
135PCI 10/100Mbps with different media options and DMA capability
136.It 3c900
137PCI 10Mbps card in 10BASE-T and multiport variants with DMA capability
138.It 3c905
139PCI 10/100Mbps card in 10BASE-T, multiport, and fast variants with
140DMA capability
141.It 3c562
142PCMCIA modem/10Mbps Ethernet combo card with dongle
143.It 3c574
144PCMCIA 10/100Mbps card with dongle
145.It 3c589
146PCMCIA 10Mbps card with dongle
147.El
148.Sh NOTES
149Etherlink III cards have no jumpers to set the address.
1503Com supplies software to set the address of the card in software.
151To find the card on the ISA bus, the kernel performs a complex
152scan operation at IO address 0x100.
153.Em Beware!
154Avoid placing other cards at that address!
155.Pp
156The 3Com configuration utilities can `autosense' the active media and
157save it as default.  The saved default medium is the medium that
158was  active at the time the configuration utility was run.  The
159.Nm
160driver does not yet re-autosense the active media at boot time.
161If the EEPROM autosense bit is set, the driver simply uses the media
162type sensed and saved when the configuration utility was run.
163.Sh DIAGNOSTICS
164.Bl -diag
165.It "ep0: reset (status: %x)"
166the driver has encountered a FIFO underrun or overrun. The driver will reset
167the card and the packet will be lost. This is not fatal.
168.It "ep0: eeprom failed to come ready"
169The eeprom failed to come ready.  This probably means the card is wedged.
170.It "ep0: 3c509 in test mode. Erase pencil mark!"
171This means that someone has scribbled with pencil in the test area on the
172card.  Erase the pencil mark and reboot.  (This is not a joke).
173.El
174.Sh SEE ALSO
175.Xr eisa 4 ,
176.Xr ex 4 ,
177.Xr ifmedia 4 ,
178.Xr intro 4 ,
179.Xr isa 4 ,
180.Xr isapnp 4 ,
181.Xr mca 4 ,
182.Xr mii 4 ,
183.Xr nsphy 4 ,
184.Xr pci 4 ,
185.Xr pcmcia 4 ,
186.Xr tqphy 4 ,
187.Xr ifconfig 8
188