kernel/iwn: Put some finishing touches to the recent upgrade.
[dragonfly.git] / share / man / man4 / iwn.4
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: head/share/man/man4/iwn.4 248507 2013-03-19 13:43:55Z glebius $
27 .\"
28 .Dd November 23, 2013
29 .Dt IWN 4
30 .Os
31 .Sh NAME
32 .Nm iwn
33 .Nd Intel IEEE 802.11n wireless network driver
34 .Sh SYNOPSIS
35 To compile this driver into the kernel,
36 include the following lines in your
37 kernel configuration file:
38 .Bd -ragged -offset indent
39 .Cd "device iwn"
40 .Cd "device iwnfw"
41 .Cd "device pci"
42 .Cd "device wlan"
43 .Ed
44 .Pp
45 .\"You also need to select a firmware for your device.
46 .\"Choose one from:
47 .\".Bd -ragged -offset indent
48 .\".Cd "device iwn4965fw"
49 .\".Cd "device iwn1000fw"
50 .\".Cd "device iwn5000fw"
51 .\".Cd "device iwn5150fw"
52 .\".Cd "device iwn6000fw"
53 .\".Cd "device iwn6000g2afw"
54 .\".Cd "device iwn6000g2bfw"
55 .\".Cd "device iwn6050fw"
56 .\".Ed
57 .\".Pp
58 Or you can use
59 .Bd -ragged -offset indent
60 .Cd "device iwnfw"
61 .Ed
62 .Pp
63 to include them all.
64 .Pp
65 Alternatively, to load the driver as a
66 module at boot time, place the following lines in
67 .Xr loader.conf 5 :
68 .Bd -literal -offset indent
69 if_iwn_load="YES"
70 iwn4965fw_load="YES"
71 iwn1000fw_load="YES"
72 iwn5000fw_load="YES"
73 iwn5150fw_load="YES"
74 iwn6000fw_load="YES"
75 iwn6000g2afw_load="YES"
76 iwn6000g2bfw_load="YES"
77 iwn6050fw_load="YES"
78 .Ed
79 .Sh DESCRIPTION
80 The
81 .Nm
82 driver provides support for:
83 .Pp
84 .Bl -tag -width Ds -offset indent -compact
85 .It Intel Centrino Advanced-N 6200
86 .It Intel Centrino Advanced-N 6205
87 .It Intel Centrino Advanced-N 6230
88 .It Intel Centrino Advanced-N + WiMAX 6250
89 .It Intel Centrino Ultimate-N 6300
90 .It Intel Centrino Wireless-N 130
91 .It Intel Centrino Wireless-N 1000
92 .It Intel Centrino Wireless-N 1030
93 .It Intel Centrino Wireless-N + WiMAX 6150
94 .It Intel Ultimate N WiFi Link 5300
95 .It Intel Wireless WiFi Link 4965
96 .It Intel WiFi Link 5100
97 .It Intel WiMAX/WiFi Link 5150
98 .It Intel WiMAX/WiFi Link 5350
99 .El
100 .Pp
101 .Nm
102 supports
103 .Cm station
104 and
105 .Cm monitor
106 mode operation.
107 Only one virtual interface may be configured at any time.
108 For more information on configuring this device, see
109 .Xr ifconfig 8 .
110 .Pp
111 This driver requires the firmware built with the
112 .Nm iwnfw
113 module to work.
114 .Sh EXAMPLES
115 Join an existing BSS network (i.e., connect to an access point):
116 .Bd -literal -offset indent
117 ifconfig wlan create wlandev iwn0 inet 192.168.0.20 \e
118     netmask 0xffffff00
119 .Ed
120 .Pp
121 Join a specific BSS network with network name
122 .Dq Li my_net :
123 .Pp
124 .Dl "ifconfig wlan create wlandev iwn0 ssid my_net up"
125 .Pp
126 Join a specific BSS network with 64-bit WEP encryption:
127 .Bd -literal -offset indent
128 ifconfig wlan create wlandev iwn0 ssid my_net \e
129         wepmode on wepkey 0x1234567890 weptxkey 1 up
130 .Ed
131 .Pp
132 Join a specific BSS network with 128-bit WEP encryption:
133 .Bd -literal -offset indent
134 ifconfig wlan create wlandev iwn0 wlanmode adhoc ssid my_net \e
135     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
136 .Ed
137 .Sh DIAGNOSTICS
138 .Bl -diag
139 .It "iwn%d: device timeout"
140 The driver will reset the hardware.
141 This should not happen.
142 .It "iwn%d: firmware error"
143 The onboard microcontroller crashed for some reason.
144 The driver will reset the hardware.
145 This should not happen.
146 .It "iwn%d: timeout waiting for firmware initialization to complete"
147 The onboard microcontroller failed to initialize in time.
148 This should not happen.
149 .It "iwn%d: could not load firmware image '%s'"
150 The driver failed to load the firmware image using the
151 .Xr firmware 9
152 subsystem.
153 Verify the
154 .Xr iwnfw 4
155 firmware module is present.
156 .It "iwn%d: could not load boot firmware"
157 An attempt to upload the boot firmware image to the onboard microcontroller
158 failed.
159 This should not happen.
160 .It "iwn%d: could not load microcode"
161 An attempt to upload the microcode image to the onboard microcontroller failed.
162 This should not happen.
163 .It "iwn%d: could not load main firmware"
164 An attempt to upload the main firmware image to the onboard microcontroller
165 failed.
166 This should not happen.
167 .El
168 .Sh SEE ALSO
169 .Xr ifmedia 4 ,
170 .Xr iwnfw 4 ,
171 .Xr pci 4 ,
172 .Xr wlan 4 ,
173 .Xr wlan_ccmp 4 ,
174 .Xr wlan_tkip 4 ,
175 .Xr wlan_wep 4 ,
176 .Xr ifconfig 8 ,
177 .Xr wpa_supplicant 8
178 .Sh AUTHORS
179 The original
180 .Nm
181 driver was written by
182 .An Damien Bergamini Aq Mt damien.bergamini@free.fr .