xref: /freebsd/share/man/man4/ipw.4 (revision 21fdc27a054f668c8b6c2be503fa68622e5226da)
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 April 13, 2008
29.Os
30.Dt IPW 4
31.Sh NAME
32.Nm ipw
33.Nd "Intel PRO/Wireless 2100 IEEE 802.11 driver"
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device ipw"
40.Cd "device ipwfw"
41.Cd "device pci"
42.Cd "device wlan"
43.Cd "device firmware"
44.Ed
45.Pp
46Alternatively, to load the driver as a
47module at boot time, place the following line in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50if_ipw_load="YES"
51.Ed
52.Pp
53In both cases, place the following line in
54.Xr loader.conf 5
55to acknowledge the firmware license (see below):
56.Bd -literal -offset indent
57legal.intel_ipw.license_ack=1
58.Ed
59.Sh DESCRIPTION
60The
61.Nm
62driver provides support for the
63.Tn Intel
64PRO/Wireless 2100 MiniPCI network adapter.
65.Nm
66supports
67.Cm station ,
68.Cm adhoc ,
69and
70.Cm monitor
71mode operation.
72Only one virtual interface may be configured at any time.
73For more information on configuring this device, see
74.Xr ifconfig 8 .
75.Pp
76This driver requires the firmware built with the
77.Nm ipwfw
78module to work.
79For the loaded firmware to be enabled for use the license at
80.Pa /usr/share/doc/legal/intel_ipw/LICENSE
81must be agreed by adding the following line to
82.Xr loader.conf 5 :
83.Pp
84.Dl "legal.intel_ipw.license_ack=1"
85.Sh FILES
86.Bl -tag -width ".Pa /usr/share/doc/legal/intel_ipw/LICENSE" -compact
87.It Pa /usr/share/doc/legal/intel_ipw/LICENSE
88.Nm
89firmware license
90.El
91.Sh EXAMPLES
92Join an existing BSS network (i.e., connect to an access point):
93.Pp
94.Bd -literal -offset indent
95ifconfig wlan create wlandev ipw0 inet 192.168.0.20 \e
96    netmask 0xffffff00
97.Ed
98.Pp
99Join a specific BSS network with network name
100.Dq Li my_net :
101.Pp
102.Dl "ifconfig wlan create wlandev ipw0 ssid my_net up"
103.Pp
104Join a specific BSS network with 64-bit WEP encryption:
105.Bd -literal -offset indent
106ifconfig wlan create wlandev ipw0 ssid my_net \e
107	wepmode on wepkey 0x1234567890 weptxkey 1 up
108.Ed
109.Pp
110Join a specific BSS network with 128-bit WEP encryption:
111.Bd -literal -offset indent
112ifconfig wlan create wlandev ipw0 wlanmode adhoc ssid my_net \e
113    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
114.Ed
115.Sh DIAGNOSTICS
116.Bl -diag
117.It "ipw%d: device timeout"
118The driver will reset the hardware.
119This should not happen.
120.It "ipw%d: firmware error"
121The onboard microcontroller crashes for some reason.
122The driver will reset the hardware.
123This should not happen.
124.It "ipw%d: timeout waiting for firmware initialization to complete"
125The onboard microcontroller failed to initialize in time.
126This should not happen.
127.It "ipw%d: could not load firmware image '%s'"
128The driver failed to load the firmware image using the
129.Xr firmware 9
130subsystem.
131Verify the
132.Xr ipwfw 4
133firmware module is installed and the license agreement
134.Xr loader 8
135tunable has been set.
136.It "ipw%d: could not load microcode"
137An attempt to upload the microcode image to the onboard microcontroller failed.
138This should not happen.
139.It "ipw%d: could not load firmware"
140An attempt to upload the firmware image to the onboard microcontroller failed.
141This should not happen.
142.El
143.Sh SEE ALSO
144.Xr ipwfw 4 ,
145.Xr pci 4 ,
146.Xr wlan 4 ,
147.Xr wlan_ccmp 4 ,
148.Xr wlan_tkip 4 ,
149.Xr wlan_wep 4 ,
150.Xr ifconfig 8 ,
151.Xr wpa_supplicant 8 .
152.Sh AUTHORS
153The original
154.Nm
155driver was written by
156.An Damien Bergamini Aq damien.bergamini@free.fr
157