share/man/man4/man4.i386/ep.4

   1 .\"
   2 .\" Copyright (c) 1994 Herb Peyerl
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"      This product includes software developed by Herb Peyerl
  16 .\" 3. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd July 16, 2005
  33 .Dt EP 4 i386
  34 .Os
  35 .Sh NAME
  36 .Nm ep
  37 .Nd "Ethernet driver for 3Com Etherlink III (3c5x9) interfaces"
  38 .Sh SYNOPSIS
  39 To compile support for the
  40 .Nm
  41 driver into your kernel, place the following line in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device ep"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the
  48 .Nm
  49 driver at boot time, place the following line in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 if_ep_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 device driver supports network adapters based on the 3Com 3C5x9 Etherlink III
  58 Parallel Tasking chipset.
  59 .Pp
  60 Various models of these cards come with a different assortment of
  61 connectors:
  62 .Pp
  63 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  64 .It AUI/DIX
  65 Standard 15 pin connector, also known as 10base5 (thick-net)
  66 .It 10Base2
  67 BNC, also known as thin-net
  68 .It 10BaseT
  69 UTP, also known as twisted pair
  70 .El
  71 .Pp
  72 The default port to use is the port that has been selected with the
  73 setup utility.
  74 To override this, use the following media options with
  75 .Xr ifconfig 8
  76 or in your
  77 .Pa /etc/rc.conf
  78 file.
  79 .Pp
  80 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  81 .It 10base5/AUI
  82 Use the AUI port.
  83 .It 10base2/BNC
  84 Use the BNC port.
  85 .It 10baseT/UTP
  86 Use the UTP port.
  87 .El
  88 .Pp
  89 If there are multiple cards in the computer, they are searched for
  90 in the following order: bus, slot, then Ethernet address.
  91 .Sh HARDWARE
  92 The
  93 .Nm
  94 driver supports Ethernet adapters based on the
  95 3Com 3C5x9 Etherlink III Parallel Tasking chipset, including:
  96 .Pp
  97 .Bl -bullet -compact
  98 .It
  99 3Com 3C1 CF
 100 .It
 101 3Com 3C509-TP, 3C509-BNC, 3C509-Combo, 3C509-TPO, 3C509-TPC ISA
 102 .It
 103 3Com 3C509B-TP, 3C509B-BNC, 3C509B-Combo, 3C509B-TPO, 3C509B-TPC ISA
 104 .It
 105 3Com 3C529, 3C529-TP MCA
 106 .It
 107 3Com 3C562/3C563 PCMCIA
 108 .It
 109 3Com 3C569B-J-TPO, 3C569B-J-COMBO CBUS
 110 .It
 111 3Com 3C574, 3C574TX, 3C574-TX, 3CCFE574BT, 3CXFE574BT, 3C3FE574BT PCMCIA
 112 .It
 113 3Com 3C579-TP, 3C579-BNC EISA
 114 .It
 115 3Com 3C589, 3C589B, 3C589C, 3C589D, 3CXE589DT PCMCIA
 116 .It
 117 3Com 3CCFEM556B, 3CCFEM556BI PCMCIA
 118 .It
 119 3Com 3CXE589EC, 3CCE589EC, 3CXE589ET, 3CCE589ET PCMCIA
 120 .It
 121 3Com Megahertz 3CCEM556, 3CXEM556, 3CCEM556B, 3CXEM556B, 3C3FEM556C PCMCIA
 122 .It
 123 3Com OfficeConnect 3CXSH572BT, 3CCSH572BT PCMCIA
 124 .It
 125 Farallon EtherWave and EtherMac PC Card (P/n 595/895 with BLUE arrow)
 126 .El
 127 .Sh NOTES
 128 The 3c509 card has no jumpers to set the address.
 129 3Com supplies software to set the address of the card in software.
 130 To find the card on the ISA bus, the kernel performs a complex
 131 scan operation at IO address 0x110.
 132 Beware!
 133 Avoid placing other cards at that address!
 134 .Pp
 135 Furthermore,
 136 the 3c509 should only
 137 be configured in EISA mode
 138 when installed in a computer that has actual EISA slots
 139 (and an EISA-aware BIOS).
 140 The normal driver auto-detection support
 141 is sufficient for non-EISA systems.
 142 .Pp
 143 Many different companies sold the 3Com PC Cards under their own private
 144 label.
 145 These cards also work.
 146 .Pp
 147 The Farallon EtherWave and EtherMac card came in two varieties.
 148 The
 149 .Nm
 150 driver supports the 595 and 895 cards.
 151 These cards have the blue arrow on the front along with a 3Com logo.
 152 The Farallon 595a cards, which have a red arrow on the front,
 153 are also called EtherWave and EtherMac.
 154 They are supported by the
 155 .Xr sn 4
 156 driver.
 157 .Sh DIAGNOSTICS
 158 .Bl -diag
 159 .It ep0: reset (status: %x)
 160 The driver has encountered a FIFO underrun or overrun.
 161 The driver will reset the card and the packet will be lost.
 162 This is not fatal.
 163 .It ep0: eeprom failed to come ready
 164 The eeprom failed to come ready.
 165 This probably means the card is wedged.
 166 .It ep0: 3c509 in test mode. Erase pencil mark!
 167 This means that someone has scribbled with pencil
 168 in the test area on the card.
 169 Erase the pencil mark and reboot.
 170 (This is not a joke).
 171 .It ep0: No I/O space?!
 172 The driver was unable to allocate the I/O space that it thinks
 173 should be there.
 174 Look for conflicts with other devices.
 175 .It ep0: No irq?!
 176 The driver couldn't allocate the interrupt it wanted.
 177 Look for conflicts, although sharing interrupts for PC Card is normal.
 178 .It ep0: No connectors!
 179 The driver queried the hardware for what ethernet attachment were
 180 present, but the hardware reported none that the driver recognized.
 181 .It ep0: Unable to get Ethernet address!
 182 The driver was unable to read the ethernet address from the EEPROM.
 183 This is likely the result of the card being wedged.
 184 .It ep0: if_alloc() failed
 185 The driver was unable to allocate a ifnet structure.
 186 This may happen in extremely low memory conditions.
 187 .It ep0: strange connector type in EEPROM: assuming AUI
 188 The driver does not know what to do with the information the EEPROM
 189 has about connectors, so it is assuming the worst.
 190 .It ep0: unknown ID 0xXXXXXXXX
 191 The driver has found an ID that it believes it supports, but doesn't
 192 have a specific identification string to present to the user.
 193 .It ep0: <%s> at port 0x%03x in EISA mode
 194 The 3C509 ISA card is in EISA mode.
 195 This message appears to be purely informational.
 196 .It ep0: <%s> at x0%03x in PnP mode
 197 This card appears to be in Plug and Play mode.
 198 It should be probed as part of the plug and play phase of the ISA
 199 probes.
 200 .It ep0: Invalid EEPROM checksum!
 201 The EEPROM has a bad checksum, so the driver is ignoring the card.
 202 .It ep0: bus_setup_intr() failed!
 203 The driver was unable to setup the interrupt handler.
 204 This should never happen.
 205 .El
 206 .Sh SEE ALSO
 207 .Xr ed 4 ,
 208 .Xr el 4 ,
 209 .Xr ie 4 ,
 210 .Xr intro 4 ,
 211 .Xr ng_ether 4 ,
 212 .Xr vx 4 ,
 213 .Xr ifconfig 8
 214 .Sh STANDARDS
 215 are great.
 216 There is so many to choose from.
 217 .Sh BUGS
 218 Support for the 3Com 3C1 is not working.