xref: /netbsd-src/share/man/man4/ep.4 (revision bada23909e740596d0a3785a73bd3583a9807fb8)
1.\"	$NetBSD: ep.4,v 1.20 1999/03/16 01:19:15 garbled 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.\" 3. 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 20, 1997
36.Dt EP 4
37.Os
38.Sh NAME
39.Nm ep
40.Nd device driver for 3Com Etherlink III family
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 pci? dev ? function ?"
46.Cd "ep* at pcmcia? function ?"
47.Sh DESCRIPTION
48The
49.Nm ep
50device driver supports the 3Com Etherlink III family of Ethernet cards.
51Supported Etherlink III cards include:
52.Pp
53.Bl -tag -width xxxxxx -offset indent
54.It 3c509
55ISA 10Mbps card, in BNC and multiport variants
56.It 3c509B
57ISA Plug-and-Play 10Mbps card, in BNC and multiport variants
58.It 3c579
59EISA 10Mbps card, in UTP, BNC, and muiltport variants
60.It 3c592
61EISA 10Mbps card with DMA capability
62.It 3c597
63EISA 10/100Mbps card with DMA capability
64.It 3c590
65PCI 10Mbps multiport card with DMA capability
66.It 3c595
67PCI 10/100Mbps with different media options and DMA capability
68.It 3c900
69PCI 10Mbps card in 10baseT and multiport variants with DMA capability
70.It 3c905
71PCI 10/100Mbps card in 10baseT, multiport, and fast variants with
72DMA capability
73.It 3c562
74PCMCIA modem/10Mbps Ethernet combo card with dongle
75.It 3c574
76PCMCIA 10/100Mbps card with dongle
77.It 3c589
78PCMCIA 10Mbps card with dongle
79.El
80.Pp
81The 3c515 is an ISA 10/100 card with DMA capability.
82The chipset is similar to that of the 3c905, with some changes to
83make it work with the more limited ISA bus address space.  This card
84is not currently supported.
85.Pp
86The EISA and PCI 3c59x devices use an older DMA engine which is not
87capable of multi-segment DMA.  DMA on these devices is not used.
88.Pp
89The PCI 3c90x devices have multi-segment DMA capability, which is
90not supported by the
91.Nm
92driver.  To use the DMA capabilities of these cards, the
93.Xr ex 4
94driver must be used.
95.Pp
96The PCI 3c90xB devices are not supported by the
97.Nm
98driver, as they do not include support for programmed I/O.  These
99devices are supported by the
100.Xr ex 4
101driver.
102.Pp
103The 3c575 is a CardBus device, and is not currently supported.
104.Sh MEDIA SELECTION
105There are 3 main chipset classes supported by the
106.Nm
107driver.  Each has their own media selection capabilities.
108.Pp
109The first class is the
110.Dq 3c509
111class.  This includes the 3c509, 3c509B, 3c579, 3c562, and 3c589.  These
112devices can support 10baseT, 10base2, and 10base5.  Available media will
113be displayed when the device is found by the kernel.
114.Pp
115The second class is the
116.Dq Vortex
117class.  This includes the 3c592, 3c579, 3c590, and 3c595.  This class also
118includes the 3c900-TPO and 3c900-COMBO; they use the
119.Dq Boomerang
120chipset, but use Vortex-style media selection.  These devices many different
121media types varying by model.  Some models have an external MII connector
122for connecting an external PHY.  This is supported by means of the "manual"
123media type.  Available media will be displayed when the device is found by
124the kernel.
125.Pp
126The third class is the
127.Dq Boomerang
128class.  This includes the 3c905 and the 3c574.  These devices support
129media selection via MII.  See
130.Xr ifmedia 4
131and
132.Xr mii 4
133for more information.
134.Sh NOTES
135Etherlink III cards have no jumpers to set the address.
1363Com supplies software to set the address of the card in software.
137To find the card on the ISA bus, the kernel performs a complex
138scan operation at IO address 0x100.
139Beware!
140Avoid placing other cards at that address!
141.Pp
142The 3Com configuration utilities can `autosense' the active media and
143save it as default.  The saved default medium is the medium that
144was  active atthe time the configuration utility was run.  The
145.Nm
146driver does not yet re-autosense the active media at boot time.
147If the EEPROM autosense bit is set, the driver simply uses the media
148type sensed and saved when the configuration utility was run.
149.Sh DIAGNOSTICS
150.Bl -diag
151.It "ep0: reset (status: %x)"
152the driver has encountered a FIFO underrun or overrun. The driver will reset
153the card and the packet will be lost. This is not fatal.
154.It "ep0: eeprom failed to come ready"
155The eeprom failed to come ready.  This probably means the card is wedged.
156.It "ep0: 3c509 in test mode. Erase pencil mark!"
157This means that someone has scribbled with pencil in the test area on the
158card.  Erase the pencil mark and reboot.  (This is not a joke).
159.El
160.Sh SEE ALSO
161.Xr ifconfig 8 ,
162.Xr ifmedia 4 ,
163.Xr intro 4 ,
164.Xr isa 4 ,
165.Xr isapnp 4 ,
166.Xr eisa 4 ,
167.Xr mii 4 ,
168.Xr pci 4 ,
169.Xr pcmcia 4
170