share/man/man4/ep.4

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