iwn - Add man pages for iwn and iwnfw
[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$
27 .\"
28 .Dd February 8, 2010
29 .Dt IWN 4
30 .Os
31 .Sh NAME
32 .Nm iwn
33 .Nd Intel Wireless WiFi Link 4965/1000/5000/5150/5300/6000/6050 
34 IEEE 802.11n driver
35 .Sh SYNOPSIS
36 To compile this driver into the kernel,
37 include the following lines in your
38 kernel configuration file:
39 .Bd -ragged -offset indent
40 .Cd "device iwn"
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 iwn4965fw"
50 .Cd "device iwn1000fw"
51 .Cd "device iwn5000fw"
52 .Cd "device iwn5150fw"
53 .Cd "device iwn6000fw"
54 .Ed
55 .Pp
56 Or you can use
57 .Bd -ragged -offset indent
58 .Cd "device iwnfw"
59 .Ed
60 .Pp
61 to include them all.
62 .Pp
63 Alternatively, to load the driver as a
64 module at boot time, place the following lines in
65 .Xr loader.conf 5 :
66 .Bd -literal -offset indent
67 if_iwn_load="YES"
68 iwn4965fw_load="YES"
69 iwn1000fw_load="YES"
70 iwn5000fw_load="YES"
71 iwn5150fw_load="YES"
72 iwn6000fw_load="YES"
73 .Ed
74 .Sh DESCRIPTION
75 The
76 .Nm
77 driver provides support for
78 .Tn Intel
79 Wireless WiFi Link 4965, 1000, 5000 and 6000 series of 
80 PCI-Express network adapters.
81 .Nm
82 supports
83 .Cm station ,
84 .Cm adhoc ,
85 and
86 .Cm monitor
87 mode operation.
88 Only one virtual interface may be configured at any time.
89 For more information on configuring this device, see
90 .Xr ifconfig 8 .
91 .Pp
92 This driver requires the firmware built with the
93 .Nm iwnfw
94 module to work.
95 .Sh EXAMPLES
96 Join an existing BSS network (i.e., connect to an access point):
97 .Pp
98 .Bd -literal -offset indent
99 ifconfig wlan create wlandev iwn0 inet 192.168.0.20 \e
100     netmask 0xffffff00
101 .Ed
102 .Pp
103 Join a specific BSS network with network name
104 .Dq Li my_net :
105 .Pp
106 .Dl "ifconfig wlan create wlandev iwn0 ssid my_net up"
107 .Pp
108 Join a specific BSS network with 64-bit WEP encryption:
109 .Bd -literal -offset indent
110 ifconfig wlan create wlandev iwn0 ssid my_net \e
111         wepmode on wepkey 0x1234567890 weptxkey 1 up
112 .Ed
113 .Pp
114 Join a specific BSS network with 128-bit WEP encryption:
115 .Bd -literal -offset indent
116 ifconfig wlan create wlandev iwn0 wlanmode adhoc ssid my_net \e
117     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
118 .Ed
119 .Sh DIAGNOSTICS
120 .Bl -diag
121 .It "iwn%d: device timeout"
122 The driver will reset the hardware.
123 This should not happen.
124 .It "iwn%d: firmware error"
125 The onboard microcontroller crashed for some reason.
126 The driver will reset the hardware.
127 This should not happen.
128 .It "iwn%d: timeout waiting for firmware initialization to complete"
129 The onboard microcontroller failed to initialize in time.
130 This should not happen.
131 .It "iwn%d: could not load firmware image '%s'"
132 The driver failed to load the firmware image using the
133 .Xr firmware 9
134 subsystem.
135 Verify the 
136 .Xr iwnfw 4
137 firmware module is present.
138 .It "iwn%d: could not load boot firmware"
139 An attempt to upload the boot firmware image to the onboard microcontroller
140 failed.
141 This should not happen.
142 .It "iwn%d: could not load microcode"
143 An attempt to upload the microcode image to the onboard microcontroller failed.
144 This should not happen.
145 .It "iwn%d: could not load main firmware"
146 An attempt to upload the main firmware image to the onboard microcontroller
147 failed.
148 This should not happen.
149 .El
150 .Sh SEE ALSO
151 .Xr iwnfw 4 ,
152 .Xr pci 4 ,
153 .Xr wlan 4 ,
154 .Xr wlan_ccmp 4 ,
155 .Xr wlan_tkip 4 ,
156 .Xr wlan_wep 4 ,
157 .Xr ifconfig 8 ,
158 .Xr wpa_supplicant 8
159 .Sh AUTHORS
160 The original
161 .Nm
162 driver was written by
163 .An Damien Bergamini Aq damien.bergamini@free.fr