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