xref: /netbsd-src/share/man/man4/iwn.4 (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1.\" $NetBSD: iwn.4,v 1.9 2010/05/28 13:25:54 wiz 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 May 27, 2010
19.Dt IWN 4
20.Os
21.Sh NAME
22.Nm iwn
23.Nd Intel Wireless 4965AGN IEEE 802.11 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 4965AGN Mini PCI Express network adapters.
32.Pp
33By default, the
34.Nm
35driver configures the adapter for BSS operation (aka infrastructure mode).
36This mode requires the use of an access point.
37.Pp
38For more information on configuring this device, see
39.Xr ifconfig 8 .
40.Sh CONFIGURATION
41The
42.Nm
43driver can be configured at runtime with
44.Xr ifconfig 8
45using the following parameters:
46.Bl -tag -width Ds
47.It Cm bssid Ar bssid
48Set the desired BSSID.
49.It Fl bssid
50Unset the desired BSSID.
51The interface will automatically select a BSSID in this mode, which is
52the default.
53.It Cm chan Ar n
54Set the channel (radio frequency) to be used by the driver based on
55the given channel ID
56.Ar n .
57.It Fl chan
58Unset the desired channel to be used by the driver.
59The driver will automatically select a channel in this mode, which is
60the default.
61.It Cm media Ar media
62The
63.Nm
64driver supports the following
65.Ar media
66types:
67.Pp
68.Bl -tag -width autoselect -compact
69.It Cm autoselect
70Enable autoselection of the media type and options.
71.El
72.It Cm mediaopt Ar opts
73The
74.Nm
75driver supports the following media options:
76.Pp
77.Bl -tag -width monitor -compact
78.It Cm monitor
79Select monitor mode.
80.El
81.It Fl mediaopt Ar opts
82Disable the specified media options on the driver and return it to the
83default mode of operation (BSS).
84.It Cm mode Ar mode
85The
86.Nm
87driver supports the following modes:
88.Pp
89.Bl -tag -width 11b -compact
90.It Cm 11a
91Force 802.11a operation.
92.It Cm 11b
93Force 802.11b operation.
94.It Cm 11g
95Force 802.11g operation.
96.El
97.It Cm nwid Ar id
98Set the network ID.
99The
100.Ar id
101can either be any text string up to 32 characters in length,
102or a series of hexadecimal digits up to 64 digits.
103An empty
104.Ar id
105string allows the interface to connect to any available access points.
106By default the
107.Nm
108driver uses an empty string.
109Note that network ID is synonymous with Extended Service Set ID (ESSID).
110.It Cm nwkey Ar key
111Enable WEP encryption using the specified
112.Ar key .
113The
114.Ar key
115can either be a string, a series of hexadecimal digits (preceded by
116.Sq 0x ) ,
117or a set of keys of the form
118.Dq n:k1,k2,k3,k4 ,
119where
120.Sq n
121specifies which of the keys will be used for transmitted packets,
122and the four keys,
123.Dq k1
124through
125.Dq k4 ,
126are configured as WEP keys.
127If a set of keys is specified, a comma
128.Pq Sq \&,
129within the key must be escaped with a backslash.
130Note that if multiple keys are used, their order must be the same within
131the network.
132.Nm
133is capable of using both 40-bit (5 characters or 10 hexadecimal digits)
134or 104-bit (13 characters or 26 hexadecimal digits) keys.
135.It Fl nwkey
136Disable WEP encryption.
137This is the default mode of operation.
138.El
139.Sh EXAMPLES
140The following
141.\" .Xr hostname.if 5 ,
142example configures iwn0 to join whatever network is available on boot,
143using WEP key
144.Dq 0x1deadbeef1 ,
145channel 11, obtaining an IP address using DHCP:
146.Bd -literal -offset indent
147dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
148.Ed
149.Pp
150Configure iwn0 for WEP, using hex key
151.Dq 0x1deadbeef1 :
152.Bd -literal -offset indent
153# ifconfig iwn0 nwkey 0x1deadbeef1
154.Ed
155.Pp
156Return iwn0 to its default settings:
157.Bd -literal -offset indent
158# ifconfig iwn0 -bssid -chan media autoselect \e
159	nwid "" -nwkey
160.Ed
161.Pp
162Join an existing BSS network,
163.Dq my_net :
164.Bd -literal -offset indent
165# ifconfig iwn0 192.168.1.1 netmask 0xffffff00 nwid my_net
166.Ed
167.Sh DIAGNOSTICS
168.Bl -diag
169.It "iwn%d: device timeout"
170A frame dispatched to the hardware for transmission did not complete in time.
171The driver will reset the hardware.
172This should not happen.
173.It "iwn%d: fatal firmware error"
174For some reason, the firmware crashed.
175The driver will reset the hardware.
176This should not happen.
177.It "iwn%d: radio is disabled by hardware switch"
178The radio transmitter is off and thus no packet can go out.
179The driver will reset the hardware.
180Make sure the laptop radio switch is on.
181.It "iwn%d: error %d, could not read firmware %s"
182For some reason, the driver was unable to read the firmware image from the
183filesystem.
184The file might be missing or corrupted.
185.It "iwn%d: could not get firmware handle %s"
186.It "iwn%d: could not read firmware"
187The driver was unable to find the file with the proper firmware image.
188It should be located in
189.Pa /libdata/firmware/if_iwn .
190.It "iwn%d: firmware file too short: %d bytes"
191The firmware image is corrupted and can't be loaded into the adapter.
192.It "iwn%d: could not load firmware"
193An attempt to load the firmware into the adapter failed.
194The driver will reset the hardware.
195.El
196.Sh SEE ALSO
197.Xr arp 4 ,
198.Xr ifmedia 4 ,
199.Xr intro 4 ,
200.Xr netintro 4 ,
201.Xr pci 4 ,
202.\" .Xr hostname.if 5 ,
203.Xr ifconfig 8
204.Sh AUTHORS
205The
206.Nm
207driver and this man page were written by
208.An Damien Bergamini Aq damien.bergamini@free.fr .
209