Merge branch 'vendor/MDOCML'
[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 100
91 .It Intel Centrino Wireless-N 130
92 .It Intel Centrino Wireless-N 1000
93 .It Intel Centrino Wireless-N 1030
94 .It Intel Centrino Wireless-N 2200
95 .It Intel Centrino Wireless-N 2230
96 .It Intel Centrino Wireless-N 4965
97 .It Intel Centrino Wireless-N 5100
98 .It Intel Centrino Wireless-N 6150
99 .It Intel Centrino Wireless-N 6200
100 .It Intel Centrino Wireless-N 6250
101 .It Intel Centrino Wireless-N 6250
102 .It Intel Centrino Wireless-N + WiMAX 6150
103 .It Intel Ultimate N WiFi Link 5300
104 .It Intel Wireless WiFi Link 4965
105 .It Intel WiFi Link 5100
106 .It Intel WiMAX/WiFi Link 5150
107 .It Intel WiMAX/WiFi Link 5350
108 .El
109 .Pp
110 .Nm
111 supports
112 .Cm station
113 and
114 .Cm monitor
115 mode operation.
116 Only one virtual interface may be configured at any time.
117 For more information on configuring this device, see
118 .Xr ifconfig 8 .
119 .Pp
120 This driver requires the firmware built with the
121 .Nm iwnfw
122 module to work.
123 .Sh EXAMPLES
124 Join an existing BSS network (i.e., connect to an access point):
125 .Bd -literal -offset indent
126 ifconfig wlan create wlandev iwn0 inet 192.168.0.20 \e
127     netmask 0xffffff00
128 .Ed
129 .Pp
130 Join a specific BSS network with network name
131 .Dq Li my_net :
132 .Pp
133 .Dl "ifconfig wlan create wlandev iwn0 ssid my_net up"
134 .Pp
135 Join a specific BSS network with 64-bit WEP encryption:
136 .Bd -literal -offset indent
137 ifconfig wlan create wlandev iwn0 ssid my_net \e
138         wepmode on wepkey 0x1234567890 weptxkey 1 up
139 .Ed
140 .Pp
141 Join a specific BSS network with 128-bit WEP encryption:
142 .Bd -literal -offset indent
143 ifconfig wlan create wlandev iwn0 wlanmode adhoc ssid my_net \e
144     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
145 .Ed
146 .Sh DIAGNOSTICS
147 .Bl -diag
148 .It "iwn%d: device timeout"
149 The driver will reset the hardware.
150 This should not happen.
151 .It "iwn%d: firmware error"
152 The onboard microcontroller crashed for some reason.
153 The driver will reset the hardware.
154 This should not happen.
155 .It "iwn%d: timeout waiting for firmware initialization to complete"
156 The onboard microcontroller failed to initialize in time.
157 This should not happen.
158 .It "iwn%d: could not load firmware image '%s'"
159 The driver failed to load the firmware image using the
160 .Xr firmware 9
161 subsystem.
162 Verify the
163 .Xr iwnfw 4
164 firmware module is present.
165 .It "iwn%d: could not load boot firmware"
166 An attempt to upload the boot firmware image to the onboard microcontroller
167 failed.
168 This should not happen.
169 .It "iwn%d: could not load microcode"
170 An attempt to upload the microcode image to the onboard microcontroller failed.
171 This should not happen.
172 .It "iwn%d: could not load main firmware"
173 An attempt to upload the main firmware image to the onboard microcontroller
174 failed.
175 This should not happen.
176 .El
177 .Sh SEE ALSO
178 .Xr ifmedia 4 ,
179 .Xr iwnfw 4 ,
180 .Xr pci 4 ,
181 .Xr wlan 4 ,
182 .Xr wlan_ccmp 4 ,
183 .Xr wlan_tkip 4 ,
184 .Xr wlan_wep 4 ,
185 .Xr ifconfig 8 ,
186 .Xr wpa_supplicant 8
187 .Sh AUTHORS
188 The original
189 .Nm
190 driver was written by
191 .An Damien Bergamini Aq Mt damien.bergamini@free.fr .