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.3 2007/02/25 12:03:07 swildner 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 this driver into your kernel, place the following line in
  37 your kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device xe"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a module at boot time, place the
  43 following line in
  44 .Pa /boot/loader.conf :
  45 .Bd -literal -offset indent
  46 if_xe_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver supports
  52 .Tn PCMCIA
  53 Ethernet adapters based on Xircom CE2- and CE3-class hardware.
  54 This includes devices made by Xircom along with
  55 various
  56 .Tn OEM
  57 manufacturers.
  58 .Pp
  59 Please note that the
  60 .Nm
  61 driver only supports
  62 .Tn PCMCIA
  63 cards and their Ethernet functions.
  64 .Nm
  65 does not support the on-board modem device located on some
  66 version of the Ethernet/modem combo cards.
  67 In particular, Xircom RealPort2 cards are not supported by this driver.
  68 .Pp
  69 The
  70 .Nm
  71 driver supports the following media types:
  72 .Bl -tag -width ".Cm autoselect"
  73 .It Cm autoselect
  74 Enable autoselection of media type and options.
  75 .It Cm 10Base2/BNC
  76 Select 10Mbps operation on a BNC coaxial connector.
  77 .It Cm 10BaseT/UTP
  78 Select 10Mbps operation on a RJ-45 connector.
  79 .It Cm 100BaseTX
  80 Select 100Mbps operation.
  81 .El
  82 .Pp
  83 Note that 100BaseTX operation is not available on CE2-class cards,
  84 while the 10Base2/BNC mode is only available on CE2-class cards.
  85 Full-duplex
  86 operation is currently not supported.
  87 For more information on configuring network interface devices,
  88 see
  89 .Xr ifconfig 8 .
  90 .Sh HARDWARE
  91 The
  92 .Nm
  93 driver supports the following cards:
  94 .Pp
  95 .Bl -bullet -compact
  96 .It
  97 Xircom CreditCard Ethernet (PS-CE2-10)
  98 .It
  99 Xircom CreditCard Ethernet + Modem 28 (PS-CEM-28)
 100 .It
 101 Xircom CreditCard Ethernet + Modem 33 (CEM33)
 102 .It
 103 Xircom CreditCard 10/100 (CE3, CE3B)
 104 .It
 105 Xircom CreditCard Ethernet 10/100 + Modem 56 (CEM56)
 106 .It
 107 Xircom RealPort Ethernet 10 (RE10)
 108 .It
 109 Xircom RealPort Ethernet 10/100 (RE100)
 110 .It
 111 Xircom RealPort Ethernet 10/100 + Modem 56 (REM56, REM56G)
 112 .It
 113 Accton Fast EtherCard-16 (EN2226)
 114 .It
 115 Compaq Microcom CPQ550 Ethernet/Modem PC Card
 116 .It
 117 Compaq Netelligent 10/100 PC Card (CPQ-10/100)
 118 .It
 119 Intel EtherExpress Pro/100 PC Card Mobile Adapter 16 (Pro/100 M16A)
 120 .It
 121 Intel EtherExpress Pro/100 LAN/Modem PC Card Adapter (Pro/100 M16B)
 122 .El
 123 .Pp
 124 Other similar devices using the same hardware may also be supported.
 125 .Sh DIAGNOSTICS
 126 .Bl -diag
 127 .It "xe%d: Cannot allocate ioport"
 128 .It "xe%d: Cannot allocate irq"
 129 A fatal initialization error occurred while attempting to allocate
 130 system resources for the card.
 131 .It "xe%d: Unable to fix your %s combo card"
 132 A fatal initialization error occurred while attempting to attach an
 133 Ethernet/modem combo card.
 134 .It "xe%d: watchdog timeout: resetting card"
 135 The card failed to generate an interrupt acknowledging a
 136 transmitted packet.
 137 May indicate a
 138 .Tn PCMCIA
 139 configuration problem.
 140 .It "xe%d: no carrier"
 141 The card has lost all contact with the network; this
 142 usually indicates a cable problem.
 143 .El
 144 .Sh SEE ALSO
 145 .Xr ifmedia 4 ,
 146 .Xr pccard 4 ,
 147 .Xr ifconfig 8
 148 .Sh HISTORY
 149 The
 150 .Nm
 151 driver first appeared in
 152 .Fx 3.3 .
 153 .Sh AUTHORS
 154 .An -nosplit
 155 The
 156 .Nm
 157 device driver was written by
 158 .An Scott Mitchell Aq rsm@FreeBSD.org .
 159 This manual page was written by
 160 .An Scott Mitchell Aq rsm@FreeBSD.org ,
 161 and
 162 .An Tom Rhodes Aq trhodes@FreeBSD.org .
 163 .Sh BUGS
 164 Supported devices will fail to attach on some machines using the
 165 .Tn NEWCARD
 166 .Tn PC
 167 Card framework.
 168 .Pp
 169 Automatic media selection is usually unreliable.