xref: /freebsd/share/man/man4/iwi.4 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.Dd October 15, 2015
27.Dt IWI 4
28.Os
29.Sh NAME
30.Nm iwi
31.Nd "Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 driver"
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34include the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device iwi"
38.Cd "device iwifw"
39.Cd "device pci"
40.Cd "device wlan"
41.Cd "device firmware"
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48if_iwi_load="YES"
49.Ed
50.Pp
51In both cases, place the following line in
52.Xr loader.conf 5
53to acknowledge the firmware license (see below):
54.Bd -literal -offset indent
55legal.intel_iwi.license_ack=1
56.Ed
57.Sh DESCRIPTION
58The
59.Nm
60driver provides support for
61.Tn Intel
62PRO/Wireless 2200BG/2915ABG MiniPCI and 2225BG PCI network adapters.
63.Nm
64supports
65.Cm station ,
66.Cm adhoc ,
67and
68.Cm monitor
69mode operation.
70Only one virtual interface may be configured at any time.
71For more information on configuring this device, see
72.Xr ifconfig 8 .
73.Pp
74This driver requires the firmware built with the
75.Nm iwifw
76module to work.
77For the loaded firmware to be enabled for use the license at
78.Pa /usr/share/doc/legal/intel_iwi.LICENSE
79must be agreed by adding the following line to
80.Xr loader.conf 5 :
81.Pp
82.Dl "legal.intel_iwi.license_ack=1"
83.Sh FILES
84.Bl -tag -width ".Pa /usr/share/doc/legal/intel_iwi.LICENSE" -compact
85.It Pa /usr/share/doc/legal/intel_iwi.LICENSE
86.Nm
87firmware license
88.El
89.Sh EXAMPLES
90Join an existing BSS network (i.e., connect to an access point):
91.Bd -literal -offset indent
92ifconfig wlan create wlandev iwi0 inet 192.168.0.20 \e
93    netmask 0xffffff00
94.Ed
95.Pp
96Join a specific BSS network with network name
97.Dq Li my_net :
98.Pp
99.Dl "ifconfig wlan create wlandev iwi0 ssid my_net up"
100.Pp
101Join a specific BSS network with 64-bit WEP encryption:
102.Bd -literal -offset indent
103ifconfig wlan create wlandev iwi0 ssid my_net \e
104	wepmode on wepkey 0x1234567890 weptxkey 1 up
105.Ed
106.Pp
107Join a specific BSS network with 128-bit WEP encryption:
108.Bd -literal -offset indent
109ifconfig wlan create wlandev iwi0 wlanmode adhoc ssid my_net \e
110    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
111.Ed
112.Sh DIAGNOSTICS
113.Bl -diag
114.It "iwi%d: device timeout"
115The driver will reset the hardware.
116This should not happen.
117.It "iwi%d: firmware error"
118The onboard microcontroller crashed for some reason.
119The driver will reset the hardware.
120This should not happen.
121.It "iwi%d: timeout waiting for firmware initialization to complete"
122The onboard microcontroller failed to initialize in time.
123This should not happen.
124.It "iwi%d: could not load firmware image '%s'"
125The driver failed to load the firmware image using the
126.Xr firmware 9
127subsystem.
128Verify the
129.Xr iwifw 4
130firmware module is installed and the license agreement
131.Xr loader 8
132tunable has been set.
133.It "iwi%d: could not load boot firmware"
134An attempt to upload the boot firmware image to the onboard microcontroller
135failed.
136This should not happen.
137.It "iwi%d: could not load microcode"
138An attempt to upload the microcode image to the onboard microcontroller failed.
139This should not happen.
140.It "iwi%d: could not load main firmware"
141An attempt to upload the main firmware image to the onboard microcontroller
142failed.
143This should not happen.
144.El
145.Sh SEE ALSO
146.Xr iwifw 4 ,
147.Xr pci 4 ,
148.Xr wlan 4 ,
149.Xr wlan_ccmp 4 ,
150.Xr wlan_tkip 4 ,
151.Xr wlan_wep 4 ,
152.Xr ifconfig 8 ,
153.Xr wpa_supplicant 8
154.Sh AUTHORS
155The original
156.Nm
157driver was written by
158.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
159