xref: /freebsd/share/man/man4/iwi.4 (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
1.\" Copyright (c) 2004-2006
2.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice unmodified, this list of conditions, and the following
9.\"    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$
27.\"
28.Dd March 6, 2007
29.Os
30.Dt IWI 4
31.Sh NAME
32.Nm iwi
33.Nd "Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 driver"
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device iwi"
40.Cd "device pci"
41.Cd "device wlan"
42.Cd "device firmware"
43.Ed
44.Pp
45Alternatively, to load the driver as a
46module at boot time, place the following lines in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49if_iwi_load="YES"
50wlan_load="YES"
51firmware_load="YES"
52.Ed
53.Pp
54In both cases, place the following lines in
55.Xr loader.conf 5
56to load the firmware modules:
57.Bd -literal -offset indent
58iwi_bss_load="YES"
59iwi_ibss_load="YES"
60iwi_monitor_load="YES"
61.Ed
62.Sh DESCRIPTION
63The
64.Nm
65driver provides support for
66.Tn Intel
67PRO/Wireless 2200BG/2915ABG MiniPCI and 2225BG PCI network adapters.
68.Pp
69By default, the
70.Nm
71driver configures the adapter for BSS operation (aka infrastructure mode).
72This mode requires the use of an access point.
73.Pp
74For more information on configuring this device, see
75.Xr ifconfig 8 .
76.Pp
77This driver requires firmware to be loaded before it will work.
78For the loaded firmware to work the license at
79.Pa /usr/share/doc/legal/intel_iwi/LICENSE
80must be agreed to and the following line be added to
81.Xr loader.conf 5 :
82.Pp
83.Dl "legal.intel_iwi.license_ack=1"
84.Sh FILES
85.Bl -tag -width ".Pa /usr/share/doc/legal/intel_iwi/LICENSE" -compact
86.It Pa /usr/share/doc/legal/intel_iwi/LICENSE
87.Nm
88firmware license
89.El
90.Sh EXAMPLES
91Join an existing BSS network (i.e., connect to an access point):
92.Pp
93.Dl "ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00"
94.Pp
95Join a specific BSS network with network name
96.Dq Li my_net :
97.Pp
98.Dl "ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
99.Pp
100Join a specific BSS network with 64-bit WEP encryption:
101.Bd -literal -offset indent
102ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
103    wepmode on wepkey 0x1234567890 weptxkey 1
104.Ed
105.Pp
106Join a specific BSS network with 128-bit WEP encryption:
107.Bd -literal -offset indent
108ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
109    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
110.Ed
111.Sh DIAGNOSTICS
112.Bl -diag
113.It "iwi%d: device timeout"
114The driver will reset the hardware.
115This should not happen.
116.It "iwi%d: firmware error"
117The onboard microcontroller crashes for some reason.
118The driver will reset the hardware.
119This should not happen.
120.It "iwi%d: timeout waiting for firmware initialization to complete"
121The onboard microcontroller failed to initialize in time.
122This should not happen.
123.It "iwi%d: could not load firmware image '%s'"
124The driver failed to load the firmware image using the
125.Xr firmware 9
126subsystem.
127Verify that the necessary firmware modules are loaded and the
128license agreement
129.Xr loader 8
130tunable has been set.
131.It "iwi%d: could not load boot firmware"
132An attempt to upload the boot firmware image to the onboard microcontroller
133failed.
134This should not happen.
135.It "iwi%d: could not load microcode"
136An attempt to upload the microcode image to the onboard microcontroller failed.
137This should not happen.
138.It "iwi%d: could not load main firmware"
139An attempt to upload the main firmware image to the onboard microcontroller
140failed.
141This should not happen.
142.El
143.Sh SEE ALSO
144.Xr altq 4 ,
145.Xr ipw 4 ,
146.Xr pci 4 ,
147.Xr wlan 4 ,
148.Xr wpi 4 ,
149.Xr ifconfig 8
150.Sh AUTHORS
151The
152.Nm
153driver was written by
154.An Damien Bergamini Aq damien@FreeBSD.org .
155