xref: /dragonfly/share/man/man4/iwi.4 (revision a4da4a90)
1.\"
2.\" Copyright (c) 2004-2006
3.\"	Damien Bergamini <damien.bergamini@free.fr>. 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 unmodified, this list of conditions, and the following
10.\"    disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD: head/share/man/man4/iwi.4 289399 2015-10-16 00:38:05Z bdrewery $
28.\"
29.Dd July 18, 2010
30.Dt IWI 4
31.Os
32.Sh NAME
33.Nm iwi
34.Nd "Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 driver"
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37include the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device iwi"
41.Cd "device iwifw"
42.Cd "device pci"
43.Cd "device wlan"
44.\".Cd "device firmware"
45.Ed
46.Pp
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51if_iwi_load="YES"
52.Ed
53.Pp
54In both cases, place the following line in
55.Xr loader.conf 5
56to acknowledge the firmware license (see below):
57.Bd -literal -offset indent
58legal.intel_iwi.license_ack=1
59.Ed
60.Sh DESCRIPTION
61The
62.Nm
63driver provides support for
64.Tn Intel
65PRO/Wireless 2200BG/2915ABG MiniPCI and 2225BG PCI network adapters.
66.Nm
67supports
68.Cm station ,
69.Cm adhoc ,
70and
71.Cm monitor
72mode operation.
73Only one virtual interface may be configured at any time.
74For more information on configuring this device, see
75.Xr ifconfig 8 .
76.Pp
77This driver requires the firmware built with the
78.Nm iwifw
79module to work.
80For the loaded firmware to be enabled for use the license at
81.Pa /usr/share/doc/legal/intel_iwi/LICENSE
82must be agreed to by adding the following line to
83.Xr loader.conf 5 :
84.Pp
85.Dl "legal.intel_iwi.license_ack=1"
86.Sh FILES
87.Bl -tag -width ".Pa /usr/share/doc/legal/intel_iwi/LICENSE" -compact
88.It Pa /usr/share/doc/legal/intel_iwi/LICENSE
89.Nm
90firmware license
91.El
92.Sh EXAMPLES
93Join an existing BSS network (i.e., connect to an access point):
94.Bd -literal -offset indent
95ifconfig wlan create wlandev iwi0 inet 192.168.0.20 \e
96    netmask 0xffffff00
97.Ed
98.Pp
99Join a specific BSS network with network name
100.Dq Li my_net :
101.Pp
102.Dl "ifconfig wlan create wlandev iwi0 ssid my_net up"
103.Pp
104Join a specific BSS network with 64-bit WEP encryption:
105.Bd -literal -offset indent
106ifconfig wlan create wlandev iwi0 ssid my_net \e
107	wepmode on wepkey 0x1234567890 weptxkey 1 up
108.Ed
109.Pp
110Join a specific BSS network with 128-bit WEP encryption:
111.Bd -literal -offset indent
112ifconfig wlan create wlandev iwi0 wlanmode adhoc ssid my_net \e
113    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
114.Ed
115.Sh DIAGNOSTICS
116.Bl -diag
117.It "iwi%d: device timeout"
118The driver will reset the hardware.
119This should not happen.
120.It "iwi%d: firmware error"
121The onboard microcontroller crashed for some reason.
122The driver will reset the hardware.
123This should not happen.
124.It "iwi%d: timeout waiting for firmware initialization to complete"
125The onboard microcontroller failed to initialize in time.
126This should not happen.
127.It "iwi%d: could not load firmware image '%s'"
128The driver failed to load the firmware image using the
129.Xr firmware 9
130subsystem.
131Verify the
132.Xr iwifw 4
133firmware module is installed and the license agreement
134.Xr loader 8
135tunable has been set.
136.It "iwi%d: could not load boot firmware"
137An attempt to upload the boot firmware image to the onboard microcontroller
138failed.
139This should not happen.
140.It "iwi%d: could not load microcode"
141An attempt to upload the microcode image to the onboard microcontroller failed.
142This should not happen.
143.It "iwi%d: could not load main firmware"
144An attempt to upload the main firmware image to the onboard microcontroller
145failed.
146This should not happen.
147.El
148.Sh SEE ALSO
149.Xr ifmedia 4 ,
150.Xr iwifw 4 ,
151.Xr pci 4 ,
152.Xr wlan 4 ,
153.Xr wlan_ccmp 4 ,
154.Xr wlan_tkip 4 ,
155.Xr wlan_wep 4 ,
156.Xr ifconfig 8 ,
157.Xr wpa_supplicant 8
158.Sh AUTHORS
159The original
160.Nm
161driver was written by
162.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
163