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