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