share/man/man4/xe.4

   1 .\"
   2 .\" Copyright (c) 2003 Tom Rhodes
   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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man4/xe.4,v 1.11 2005/07/21 05:02:38 trhodes Exp $
  27 .\" $DragonFly: src/share/man/man4/xe.4,v 1.1 2005/09/20 11:38:33 asmodai Exp $
  28 .\"
  29 .Dd July 16, 2005
  30 .Dt XE 4
  31 .Os
  32 .Sh NAME
  33 .Nm xe
  34 .Nd "Xircom PCMCIA Ethernet device driver"
  35 .Sh SYNOPSIS
  36 To compile support for the
  37 .Nm
  38 driver into your kernel, place the following line in your
  39 kernel configuration file:
  40 .Bd -ragged -offset indent
  41 .Cd "device xe"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the
  45 .Nm
  46 driver at boot time, place the following line in
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 if_xe_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver supports
  55 .Tn PCMCIA
  56 Ethernet adapters based on Xircom CE2- and CE3-class hardware.
  57 This includes devices made by Xircom along with
  58 various
  59 .Tn OEM
  60 manufacturers.
  61 .Pp
  62 Please note that the
  63 .Nm
  64 driver only supports
  65 .Tn PCMCIA
  66 cards and their Ethernet functions.
  67 .Nm
  68 does not support the on-board modem device located on some
  69 version of the Ethernet/modem combo cards.
  70 In particular, Xircom RealPort2 cards are not supported by this driver.
  71 .Pp
  72 The
  73 .Nm
  74 driver supports the following media types:
  75 .Bl -tag -width ".Cm autoselect"
  76 .It Cm autoselect
  77 Enable autoselection of media type and options.
  78 .It Cm 10Base2/BNC
  79 Select 10Mbps operation on a BNC coaxial connector.
  80 .It Cm 10BaseT/UTP
  81 Select 10Mbps operation on a RJ-45 connector.
  82 .It Cm 100BaseTX
  83 Select 100Mbps operation.
  84 .El
  85 .Pp
  86 Note that 100BaseTX operation is not available on CE2-class cards,
  87 while the 10Base2/BNC mode is only available on CE2-class cards.
  88 Full-duplex
  89 operation is currently not supported.
  90 For more information on configuring network interface devices,
  91 see
  92 .Xr ifconfig 8 .
  93 .Sh HARDWARE
  94 The
  95 .Nm
  96 driver supports the following cards:
  97 .Pp
  98 .Bl -bullet -compact
  99 .It
 100 Xircom CreditCard Ethernet (PS-CE2-10)
 101 .It
 102 Xircom CreditCard Ethernet + Modem 28 (PS-CEM-28)
 103 .It
 104 Xircom CreditCard Ethernet + Modem 33 (CEM33)
 105 .It
 106 Xircom CreditCard 10/100 (CE3, CE3B)
 107 .It
 108 Xircom CreditCard Ethernet 10/100 + Modem 56 (CEM56)
 109 .It
 110 Xircom RealPort Ethernet 10 (RE10)
 111 .It
 112 Xircom RealPort Ethernet 10/100 (RE100)
 113 .It
 114 Xircom RealPort Ethernet 10/100 + Modem 56 (REM56, REM56G)
 115 .It
 116 Accton Fast EtherCard-16 (EN2226)
 117 .It
 118 Compaq Microcom CPQ550 Ethernet/Modem PC Card
 119 .It
 120 Compaq Netelligent 10/100 PC Card (CPQ-10/100)
 121 .It
 122 Intel EtherExpress Pro/100 PC Card Mobile Adapter 16 (Pro/100 M16A)
 123 .It
 124 Intel EtherExpress Pro/100 LAN/Modem PC Card Adapter (Pro/100 M16B)
 125 .El
 126 .Pp
 127 Other similar devices using the same hardware may also be supported.
 128 .Sh DIAGNOSTICS
 129 .Bl -diag
 130 .It "xe%d: Cannot allocate ioport"
 131 .It "xe%d: Cannot allocate irq"
 132 A fatal initialization error occurred while attempting to allocate
 133 system resources for the card.
 134 .It "xe%d: Unable to fix your %s combo card"
 135 A fatal initialization error occurred while attempting to attach an
 136 Ethernet/modem combo card.
 137 .It "xe%d: watchdog timeout: resetting card"
 138 The card failed to generate an interrupt acknowledging a
 139 transmitted packet.
 140 May indicate a
 141 .Tn PCMCIA
 142 configuration problem.
 143 .It "xe%d: no carrier"
 144 The card has lost all contact with the network; this
 145 usually indicates a cable problem.
 146 .El
 147 .Sh SEE ALSO
 148 .Xr pccard 4 ,
 149 .Xr ifconfig 8
 150 .Sh HISTORY
 151 The
 152 .Nm
 153 driver first appeared in
 154 .Fx 3.3 .
 155 .Sh AUTHORS
 156 .An -nosplit
 157 The
 158 .Nm
 159 device driver was written by
 160 .An Scott Mitchell Aq rsm@FreeBSD.org .
 161 This manual page was written by
 162 .An Scott Mitchell Aq rsm@FreeBSD.org ,
 163 and
 164 .An Tom Rhodes Aq trhodes@FreeBSD.org .
 165 .Sh BUGS
 166 Supported devices will fail to attach on some machines using the
 167 .Tn NEWCARD
 168 .Tn PC
 169 Card framework.
 170 .Pp
 171 Automatic media selection is usually unreliable.