xref: /freebsd/share/man/man4/ipw.4 (revision f856af0466c076beef4ea9b15d088e1119a945b8)
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 July 28, 2006
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 pci"
41.Cd "device wlan"
42.Cd "device firmware"
43.Ed
44.Pp
45Alternatively, to load the driver as a
46module at boot time, place the following lines in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49if_ipw_load="YES"
50wlan_load="YES"
51firmware_load="YES"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver provides support for the
57.Tn Intel
58PRO/Wireless 2100 MiniPCI network adapter.
59.Pp
60By default, the
61.Nm
62driver configures the adapter for BSS operation (aka infrastructure mode).
63This mode requires the use of an access point.
64.Pp
65For more information on configuring this device, see
66.Xr ifconfig 8 .
67.Pp
68This driver requires firmware to be loaded before it will work.
69You need to install the
70.Pa ports/net/ipw-firmware-kmod
71port before
72.Xr ifconfig 8
73will work.
74.Sh EXAMPLES
75Join an existing BSS network (i.e., connect to an access point):
76.Pp
77.Dl "ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00"
78.Pp
79Join a specific BSS network with network name
80.Dq Li my_net :
81.Pp
82.Dl "ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
83.Pp
84Join a specific BSS network with 40-bit WEP encryption:
85.Bd -literal -offset indent
86ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
87    wepmode on wepkey 0x1234567890 weptxkey 1
88.Ed
89.Pp
90Join a specific BSS network with 104-bit WEP encryption:
91.Bd -literal -offset indent
92ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
93    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
94.Ed
95.Sh DIAGNOSTICS
96.Bl -diag
97.It "ipw%d: device timeout"
98The driver will reset the hardware.
99This should not happen.
100.It "ipw%d: firmware error"
101The onboard microcontroller crashes for some reason.
102The driver will reset the hardware.
103This should not happen.
104.It "ipw%d: timeout waiting for firmware initialization to complete"
105The onboard microcontroller failed to initialize in time.
106This should not happen.
107.It "ipw%d: could not load firmware image '%s'"
108The driver failed to load the firmware image using the
109.Xr firmware 9
110subsystem.
111Verify that the
112.Pa ports/net/ipw-firmware-kmod
113port is installed correctly.
114.It "ipw%d: could not load microcode"
115An attempt to upload the microcode image to the onboard microcontroller failed.
116This should not happen.
117.It "ipw%d: could not load firmware"
118An attempt to upload the firmware image to the onboard microcontroller failed.
119This should not happen.
120.El
121.Sh SEE ALSO
122.Xr an 4 ,
123.Xr ath 4 ,
124.Xr iwi 4 ,
125.Xr pci 4 ,
126.Xr wi 4 ,
127.Xr wlan 4 ,
128.Xr ifconfig 8
129.Rs
130.%T The IPW Web Page
131.%O http://damien.bergamini.free.fr/ipw/
132.Re
133.Sh AUTHORS
134The
135.Nm
136driver was written by
137.An Damien Bergamini Aq damien@FreeBSD.org .
138