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