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 January 1, 2008
  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 this driver into the kernel,
  40 place the following line in your
  41 kernel configuration file:
  42 .Bd -ragged -offset indent
  43 .Cd "device ep"
  44 .Ed
  45 .Pp
  46 Alternatively, to load the driver as a
  47 module at boot time, place the following line in
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 if_ep_load="YES"
  51 .Ed
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 device driver supports network adapters based on the 3Com 3C5x9 Etherlink III
  56 Parallel Tasking chipset.
  57 .Pp
  58 Various models of these cards come with a different assortment of
  59 connectors:
  60 .Pp
  61 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  62 .It AUI/DIX
  63 Standard 15 pin connector, also known as 10base5 (thick-net)
  64 .It 10Base2
  65 BNC, also known as thin-net
  66 .It 10BaseT
  67 UTP, also known as twisted pair
  68 .El
  69 .Pp
  70 The default port to use is the port that has been selected with the
  71 setup utility.
  72 To override this, use the following media options with
  73 .Xr ifconfig 8
  74 or in your
  75 .Pa /etc/rc.conf
  76 file.
  77 .Pp
  78 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  79 .It 10base5/AUI
  80 Use the AUI port.
  81 .It 10base2/BNC
  82 Use the BNC port.
  83 .It 10baseT/UTP
  84 Use the UTP port.
  85 .El
  86 .Pp
  87 If there are multiple cards in the computer, they are searched for
  88 in the following order: bus, slot, then Ethernet address.
  89 .Sh HARDWARE
  90 The
  91 .Nm
  92 driver supports Ethernet adapters based on the
  93 3Com 3C5x9 Etherlink III Parallel Tasking chipset, including:
  94 .Pp
  95 .Bl -bullet -compact
  96 .It
  97 3Com 3C1 CF
  98 .It
  99 3Com 3C509-TP, 3C509-BNC, 3C509-Combo, 3C509-TPO, 3C509-TPC ISA
 100 .It
 101 3Com 3C509B-TP, 3C509B-BNC, 3C509B-Combo, 3C509B-TPO, 3C509B-TPC ISA
 102 .It
 103 3Com 3C529, 3C529-TP MCA
 104 .It
 105 3Com 3C562/3C563 PCMCIA
 106 .It
 107 3Com 3C569B-J-TPO, 3C569B-J-COMBO CBUS
 108 .It
 109 3Com 3C574, 3C574TX, 3C574-TX, 3CCFE574BT, 3CXFE574BT, 3C3FE574BT PCMCIA
 110 .It
 111 3Com 3C579-TP, 3C579-BNC EISA
 112 .It
 113 3Com 3C589, 3C589B, 3C589C, 3C589D, 3CXE589DT PCMCIA
 114 .It
 115 3Com 3CCFEM556B, 3CCFEM556BI PCMCIA
 116 .It
 117 3Com 3CXE589EC, 3CCE589EC, 3CXE589ET, 3CCE589ET PCMCIA
 118 .It
 119 3Com Megahertz 3CCEM556, 3CXEM556, 3CCEM556B, 3CXEM556B, 3C3FEM556C PCMCIA
 120 .It
 121 3Com OfficeConnect 3CXSH572BT, 3CCSH572BT PCMCIA
 122 .It
 123 Farallon EtherWave and EtherMac PC Card (P/n 595/895 with BLUE arrow)
 124 .El
 125 .Sh NOTES
 126 The 3c509 card has no jumpers to set the address.
 127 3Com supplies software to set the address of the card in software.
 128 To find the card on the ISA bus, the kernel performs a complex
 129 scan operation at IO address 0x110.
 130 Beware!
 131 Avoid placing other cards at that address!
 132 .Pp
 133 Furthermore,
 134 the 3c509 should only
 135 be configured in EISA mode
 136 when installed in a computer that has actual EISA slots
 137 (and an EISA-aware BIOS).
 138 The normal driver auto-detection support
 139 is sufficient for non-EISA systems.
 140 .Pp
 141 Many different companies sold the 3Com PC Cards under their own private
 142 label.
 143 These cards also work.
 144 .Pp
 145 The Farallon EtherWave and EtherMac card came in two varieties.
 146 The
 147 .Nm
 148 driver supports the 595 and 895 cards.
 149 These cards have the blue arrow on the front along with a 3Com logo.
 150 The Farallon 595a cards, which have a red arrow on the front,
 151 are also called EtherWave and EtherMac.
 152 They are supported by the
 153 .Xr sn 4
 154 driver.
 155 .Sh DIAGNOSTICS
 156 .Bl -diag
 157 .It "ep0: reset (status: %x)"
 158 The driver has encountered a FIFO underrun or overrun.
 159 The driver will reset the card and the packet will be lost.
 160 This is not fatal.
 161 .It "ep0: eeprom failed to come ready"
 162 The eeprom failed to come ready.
 163 This probably means the card is wedged.
 164 .It "ep0: 3c509 in test mode. Erase pencil mark!"
 165 This means that someone has scribbled with pencil
 166 in the test area on the card.
 167 Erase the pencil mark and reboot.
 168 (This is not a joke).
 169 .It "ep0: No I/O space?!"
 170 The driver was unable to allocate the I/O space that it thinks
 171 should be there.
 172 Look for conflicts with other devices.
 173 .It "ep0: No irq?!"
 174 The driver could not allocate the interrupt it wanted.
 175 Look for conflicts, although sharing interrupts for PC Card is normal.
 176 .It "ep0: No connectors!"
 177 The driver queried the hardware for what ethernet attachment were
 178 present, but the hardware reported none that the driver recognized.
 179 .It "ep0: Unable to get Ethernet address!"
 180 The driver was unable to read the ethernet address from the EEPROM.
 181 This is likely the result of the card being wedged.
 182 .It "ep0: if_alloc() failed"
 183 The driver was unable to allocate a ifnet structure.
 184 This may happen in extremely low memory conditions.
 185 .It "ep0: strange connector type in EEPROM: assuming AUI"
 186 The driver does not know what to do with the information the EEPROM
 187 has about connectors, so it is assuming the worst.
 188 .It "ep0: unknown ID 0xXXXXXXXX"
 189 The driver has found an ID that it believes it supports, but does not
 190 have a specific identification string to present to the user.
 191 .It "ep0: <%s> at port 0x%03x in EISA mode"
 192 The 3C509 ISA card is in EISA mode.
 193 This message appears to be purely informational.
 194 .It "ep0: <%s> at x0%03x in PnP mode"
 195 This card appears to be in Plug and Play mode.
 196 It should be probed as part of the plug and play phase of the ISA
 197 probes.
 198 .It "ep0: Invalid EEPROM checksum!"
 199 The EEPROM has a bad checksum, so the driver is ignoring the card.
 200 .It "ep0: bus_setup_intr() failed!"
 201 The driver was unable to setup the interrupt handler.
 202 This should never happen.
 203 .El
 204 .Sh SEE ALSO
 205 .Xr altq 4 ,
 206 .Xr ed 4 ,
 207 .Xr el 4 ,
 208 .Xr ie 4 ,
 209 .Xr intro 4 ,
 210 .Xr ng_ether 4 ,
 211 .Xr sn 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 CompactFlash is not working.