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