Update iwi(4) manpage according to recent firmware upgrade.
[dragonfly.git] / share / man / man4 / iwi.4
1 .\"
2 .\" Copyright (c) 2004, 2005
3 .\"     Damien Bergamini <damien.bergamini@free.fr>.
4 .\" Copyright (c) 2004, 2005
5 .\"     Andrew Atrens <atrens@nortelnetworks.com>.
6 .\"
7 .\" All rights reserved.
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 unmodified, this list of conditions, and the following
14 .\"    disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\"    notice, this list of conditions and the following disclaimer in the
17 .\"    documentation and/or other materials provided with the distribution.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\" $DragonFly: src/share/man/man4/iwi.4,v 1.14 2008/07/26 16:25:40 swildner Exp $
32 .\"
33 .Dd March 3, 2008
34 .Os
35 .Dt IWI 4
36 .Sh NAME
37 .Nm iwi
38 .Nd Intel(R) PRO/Wireless 2200BG/2915ABG IEEE 802.11 driver
39 .Sh SYNOPSIS
40 .Cd "device iwi"
41 .Cd "device pci"
42 .Cd "device wlan"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for Intel(R) PRO/Wireless 2200BG and 2915ABG MiniPCI
47 network adapters.
48 .Pp
49 By default, the
50 .Nm
51 driver configures the adapter for BSS operation (aka infrastructure mode).
52 This mode requires the use of an access point.
53 .Pp
54 In addition IBSS operation (aka adhoc mode) is also supported.
55 This mode requires special ibss firmware.
56 .Pp
57 For more (general) information on configuring this device, see
58 .Xr ifconfig 8 .
59 .Sh FILES
60 The firmware for the adapter is not shipped with
61 .Dx
62 and must be obtained separately.
63 An archive with firmware files that are known to work can be found at:
64 .Bd -literal -offset indent
65 http://ipw2200.sourceforge.net/firmware.php?fid=7
66 .Ed
67 .Pp
68 The firmware files have to reside in
69 .Pa /etc/firmware/iwi/2200/3.0
70 and will be loaded when the interface is brought up.
71 .Sh EXAMPLES
72 Refer to the
73 .Sx EXAMPLES
74 section of
75 .Xr wlan 4 .
76 .Sh WORTH NOTING
77 It's worth noting that in BSS mode if you haven't specified an
78 ssid, the driver will auto-assign an ssid, joining the best
79 network available.
80 .Sh DIAGNOSTICS
81 .Bl -diag
82 .It "iwi%d: firmware reset"
83 The driver has reset the firmware. This shouldn't but may occasionally happen.
84 .It "iwi%d: device timeout"
85 The driver will reset the hardware. This should not happen.
86 .El
87 .Sh SEE ALSO
88 .Xr an 4 ,
89 .Xr ifmedia 4 ,
90 .Xr pci 4 ,
91 .Xr wi 4 ,
92 .Xr wlan 4 ,
93 .Xr ifconfig 8 ,
94 .Xr wpa_supplicant 8
95 .Sh AUTHORS
96 .An -nosplit
97 The
98 .Nm
99 driver and this man page were derived from those written by
100 .An Damien Bergamini Aq damien.bergamini@free.fr .
101 .Pp
102 .Dx
103 enhancements and IBSS support were written by
104 .An Andrew Atrens Aq atrens@nortel.com .