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