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