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