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