xref: /netbsd-src/share/man/man4/iwn.4 (revision 0e71d7ed9c1b75a0ae0919564d62f399ea9b5add)
1.\" $NetBSD: iwn.4,v 1.13 2014/10/30 13:05:58 nonaka Exp $
2.\"
3.\" Copyright (c) 2007,2008
4.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd October 30, 2014
19.Dt IWN 4
20.Os
21.Sh NAME
22.Nm iwn
23.Nd Intel WiFi Link and Centrino IEEE 802.11 wireless network driver
24.Sh SYNOPSIS
25.Cd "iwn* at pci? dev ? function ?"
26.Sh DESCRIPTION
27The
28.Nm
29driver provides support for
30.Tn Intel
31Wireless WiFi Link 4965/5000/1000 and Centrino Wireless-N 1000/2000/6000
32Series PCIe Mini Card network adapters.
33.Pp
34The Intel Wireless WiFi Link 4965AGN (codenamed Kedron) is a PCIe
35Mini Card network adapter that operates in the 2GHz and 5GHz spectra.
36It has 2 transmit paths and 3 receiver paths (2T3R).
37It is part of the fourth-generation Centrino platform (codenamed Santa Rosa).
38.Pp
39The Intel WiFi Link 5000 series is a family of wireless network adapters
40that operate in the 2GHz and 5GHz spectra.
41They are part of the fifth-generation Centrino platform (codenamed Montevina).
42These adapters are available in both PCIe Mini Card (model code ending by MMW)
43and PCIe Half Mini Card (model code ending by HMW) form factor.
44The
45.Nm
46driver provides support for the 5100 (codenamed Shirley Peak 1x2),
475150 (codenamed Echo Peak-V), 5300 (codenamed Shirley Peak 3x3) and
485350 (codenamed Echo Peak-P) adapters.
49The 5100 and 5150 adapters have 1 transmit path and 2 receiver paths (1T2R).
50The 5300 and 5350 adapters have 3 transmit paths and 3 receiver paths (3T3R).
51.Pp
52The Intel WiFi Link 1000 (codenamed Condor Peak) is a single-chip wireless
53network adapter that operates in the 2GHz spectrum.
54It is part of the sixth-generation Centrino platform (codenamed Calpella).
55It is available in both PCIe Mini Card (model code ending by MMW)
56and PCIe Half Mini Card (model code ending by HMW) form factor.
57It has 1 transmit path and 2 receiver paths (1T2R).
58.Pp
59The Intel Centrino Ultimate-N 6300 (codenamed Puma Peak 3x3) is a single-chip
60wireless network adapter that operates in the 2GHz and 5GHz spectra.
61It has 3 transmit paths and 3 receiver paths (3T3R).
62The Intel Centrino Advanced-N 6250 (codenamed Kilmer Peak) is a combo
63WiFi/WiMAX network adapter that operates in the 2GHz and 5GHz spectra.
64It has 2 transmit paths and 2 receiver paths (2T2R).
65The Intel Centrino Advanced-N 6200 (codenamed Puma Peak 2x2) is
66a wireless network adapter that operates in the 2GHz and 5GHz spectra.
67It has 2 transmit paths and 2 receiver paths (2T2R).
68These adapters are part of the sixth-generation Centrino platform
69(codenamed Calpella).
70.Pp
71The Intel Centrino Wireless-N 2230 (codename Jackson Peak) and Intel
72Centrino Wireless-N 2200 (codename Marble Peak) are wireless network
73adapters that operate in the 2GHz spectrum.
74These adapters have 2 transmit paths and 2 receiver paths (2T2R).
75The Intel Centrino Wireless-N 135 and Intel Centrino Wireless-N 105
76(codename Canyon Peak) also operate in the 2GHz spectrum.
77These adapters have 1 transmit path and 1 receiver path (1T1R).
78.Pp
79By default, the
80.Nm
81driver configures the adapter for BSS operation (aka infrastructure mode).
82This mode requires the use of an access point.
83.Pp
84For more information on configuring this device, see
85.Xr ifconfig 8 .
86.Sh CONFIGURATION
87The
88.Nm
89driver can be configured at runtime with
90.Xr ifconfig 8
91using the following parameters:
92.Bl -tag -width Ds
93.It Cm bssid Ar bssid
94Set the desired BSSID.
95.It Fl bssid
96Unset the desired BSSID.
97The interface will automatically select a BSSID in this mode, which is
98the default.
99.It Cm chan Ar n
100Set the channel (radio frequency) to be used by the driver based on
101the given channel ID
102.Ar n .
103.It Fl chan
104Unset the desired channel to be used by the driver.
105The driver will automatically select a channel in this mode, which is
106the default.
107.It Cm media Ar media
108The
109.Nm
110driver supports the following
111.Ar media
112types:
113.Pp
114.Bl -tag -width autoselect -compact
115.It Cm autoselect
116Enable autoselection of the media type and options.
117.El
118.It Cm mediaopt Ar opts
119The
120.Nm
121driver supports the following media options:
122.Pp
123.Bl -tag -width monitor -compact
124.It Cm monitor
125Select monitor mode.
126.El
127.It Fl mediaopt Ar opts
128Disable the specified media options on the driver and return it to the
129default mode of operation (BSS).
130.It Cm mode Ar mode
131The
132.Nm
133driver supports the following modes:
134.Pp
135.Bl -tag -width 11b -compact
136.It Cm 11a
137Force 802.11a operation.
138.It Cm 11b
139Force 802.11b operation.
140.It Cm 11g
141Force 802.11g operation.
142.El
143.It Cm nwid Ar id
144Set the network ID.
145The
146.Ar id
147can either be any text string up to 32 characters in length,
148or a series of hexadecimal digits up to 64 digits.
149An empty
150.Ar id
151string allows the interface to connect to any available access points.
152By default the
153.Nm
154driver uses an empty string.
155Note that network ID is synonymous with Extended Service Set ID (ESSID).
156.It Cm nwkey Ar key
157Enable WEP encryption using the specified
158.Ar key .
159The
160.Ar key
161can either be a string, a series of hexadecimal digits (preceded by
162.Sq 0x ) ,
163or a set of keys of the form
164.Dq n:k1,k2,k3,k4 ,
165where
166.Sq n
167specifies which of the keys will be used for transmitted packets,
168and the four keys,
169.Dq k1
170through
171.Dq k4 ,
172are configured as WEP keys.
173If a set of keys is specified, a comma
174.Pq Sq \&,
175within the key must be escaped with a backslash.
176Note that if multiple keys are used, their order must be the same within
177the network.
178.Nm
179is capable of using both 40-bit (5 characters or 10 hexadecimal digits)
180or 104-bit (13 characters or 26 hexadecimal digits) keys.
181.It Fl nwkey
182Disable WEP encryption.
183This is the default mode of operation.
184.El
185.Sh EXAMPLES
186The following
187.Xr ifconfig.if 5 ,
188example configures iwn0 to join whatever network is available on boot,
189using WEP key
190.Dq 0x1deadbeef1 ,
191channel 11, obtaining an IP address using DHCP:
192.Bd -literal -offset indent
193dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
194.Ed
195.Pp
196Configure iwn0 for WEP, using hex key
197.Dq 0x1deadbeef1 :
198.Bd -literal -offset indent
199# ifconfig iwn0 nwkey 0x1deadbeef1
200.Ed
201.Pp
202Return iwn0 to its default settings:
203.Bd -literal -offset indent
204# ifconfig iwn0 -bssid -chan media autoselect \e
205	nwid "" -nwkey
206.Ed
207.Pp
208Join an existing BSS network,
209.Dq my_net :
210.Bd -literal -offset indent
211# ifconfig iwn0 192.168.1.1 netmask 0xffffff00 nwid my_net
212.Ed
213.Sh DIAGNOSTICS
214.Bl -diag
215.It "iwn%d: device timeout"
216A frame dispatched to the hardware for transmission did not complete in time.
217The driver will reset the hardware.
218This should not happen.
219.It "iwn%d: fatal firmware error"
220For some reason, the firmware crashed.
221The driver will reset the hardware.
222This should not happen.
223.It "iwn%d: radio is disabled by hardware switch"
224The radio transmitter is off and thus no packet can go out.
225The driver will reset the hardware.
226Make sure the laptop radio switch is on.
227.It "iwn%d: error %d, could not read firmware %s"
228For some reason, the driver was unable to read the firmware image from the
229filesystem.
230The file might be missing or corrupted.
231.It "iwn%d: could not get firmware handle %s"
232.It "iwn%d: could not read firmware"
233The driver was unable to find the file with the proper firmware image.
234It should be located in
235.Pa /libdata/firmware/if_iwn .
236.It "iwn%d: firmware file too short: %d bytes"
237The firmware image is corrupted and can't be loaded into the adapter.
238.It "iwn%d: could not load firmware"
239An attempt to load the firmware into the adapter failed.
240The driver will reset the hardware.
241.El
242.Sh SEE ALSO
243.Xr arp 4 ,
244.Xr ifmedia 4 ,
245.Xr intro 4 ,
246.Xr netintro 4 ,
247.Xr pci 4 ,
248.Xr ifconfig.if 5 ,
249.Xr ifconfig 8
250.Sh AUTHORS
251The
252.Nm
253driver and this man page were written by
254.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
255