Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / xi.4
blob9c381345c8c6b61e34ef448c1568b37f4372cec5
1 .\" $NetBSD: xi.4,v 1.12 2008/04/30 13:10:55 martin Exp $
2 .\"
3 .\" Copyright (c) 2000 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Gregory McGarry.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd June 1, 2007
31 .Dt XI 4
32 .Os
33 .Sh NAME
34 .Nm xi
35 .Nd Xircom CreditCard Ethernet device driver
36 .Sh SYNOPSIS
37 .Cd "xi* at xirc?"
38 .Pp
39 Configuration of PHYs may also be necessary.
40 See
41 .Xr mii 4 .
42 .Sh DESCRIPTION
43 The
44 .Nm
45 driver provides support for the Xircom CreditCard family of PCMCIA
46 Ethernet adapters.
47 Supported cards include:
48 .Pp
49 .Bl -item -compact -offset indent
50 .It
51 Xircom CreditCard Ethernet II
52 .It
53 Xircom CreditCard 10/100 Ethernet
54 .\" .It Xircom CreditCard Ethernet + Modem
55 .\" .It Xircom CreditCard 10/100 Ethernet + Modem
56 .It
57 Xircom RealPort 10/100 Ethernet + Modem (Ethernet function only)
58 .It
59 Intel EtherExpress Pro/100
60 .It
61 Compaq Netelligent 10/100
62 .El
63 .Pp
64 Cards which should work, but have not been confirmed include:
65 .Pp
66 .Bl -item -compact -offset indent
67 .It
68 Xircom RealPort Ethernet
69 .It
70 Xircom RealPort 10/100 Ethernet
71 .El
72 .Pp
73 Some Xircom Ethernet products are supported by the
74 .Xr tlp 4
75 driver.
76 .Sh MEDIA SELECTION
77 Media selection is done using
78 .Xr ifconfig 8
79 using the standard
80 .Xr ifmedia 4
81 mechanism.
82 Refer to those manual pages for more information.
83 .Sh SEE ALSO
84 .Xr ifmedia 4 ,
85 .Xr mii 4 ,
86 .Xr netintro 4 ,
87 .Xr pcmcia 4 ,
88 .Xr tlp 4 ,
89 .Xr xirc 4 ,
90 .Xr ifconfig 8
91 .Sh HISTORY
92 The
93 .Nm
94 device driver appeared in
95 .Nx 1.5 .
96 .Sh BUGS
97 The driver suffers from poor performance.
98 Even with the 10/100 cards, do not expect more than ~450KB/s.
99 Some 10/100 cards may not autonegotiate
100 reliably and require manual media selection.
102 The Xircom multifunction cards which contain both Ethernet and modem
103 interfaces are known to have problems.
104 This is due to the card not
105 reporting itself correctly as a multifunction card.