/share/man/man4/iwi.4

  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.Dt IWI 4
 30.Os
 31.Sh NAME
 32.Nm iwi
 33.Nd "Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 driver"
 34.Sh SYNOPSIS
 35To compile this driver into the kernel,
 36include the following lines in your
 37kernel configuration file:
 38.Bd -ragged -offset indent
 39.Cd "device iwi"
 40.Cd "device iwifw"
 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_iwi_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_iwi.license_ack=1
 58.Ed
 59.Sh DESCRIPTION
 60The
 61.Nm
 62driver provides support for
 63.Tn Intel
 64PRO/Wireless 2200BG/2915ABG MiniPCI and 2225BG PCI network adapters.
 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 iwifw
 78module to work.
 79For the loaded firmware to be enabled for use the license at
 80.Pa /usr/share/doc/legal/intel_iwi/LICENSE
 81must be agreed by adding the following line to
 82.Xr loader.conf 5 :
 83.Pp
 84.Dl "legal.intel_iwi.license_ack=1"
 85.Sh FILES
 86.Bl -tag -width ".Pa /usr/share/doc/legal/intel_iwi/LICENSE" -compact
 87.It Pa /usr/share/doc/legal/intel_iwi/LICENSE
 88.Nm
 89firmware license
 90.El
 91.Sh EXAMPLES
 92Join an existing BSS network (i.e., connect to an access point):
 93.Bd -literal -offset indent
 94ifconfig wlan create wlandev iwi0 inet 192.168.0.20 \e
 95    netmask 0xffffff00
 96.Ed
 97.Pp
 98Join a specific BSS network with network name
 99.Dq Li my_net :
100.Pp
101.Dl "ifconfig wlan create wlandev iwi0 ssid my_net up"
102.Pp
103Join a specific BSS network with 64-bit WEP encryption:
104.Bd -literal -offset indent
105ifconfig wlan create wlandev iwi0 ssid my_net \e
106	wepmode on wepkey 0x1234567890 weptxkey 1 up
107.Ed
108.Pp
109Join a specific BSS network with 128-bit WEP encryption:
110.Bd -literal -offset indent
111ifconfig wlan create wlandev iwi0 wlanmode adhoc ssid my_net \e
112    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
113.Ed
114.Sh DIAGNOSTICS
115.Bl -diag
116.It "iwi%d: device timeout"
117The driver will reset the hardware.
118This should not happen.
119.It "iwi%d: firmware error"
120The onboard microcontroller crashed for some reason.
121The driver will reset the hardware.
122This should not happen.
123.It "iwi%d: timeout waiting for firmware initialization to complete"
124The onboard microcontroller failed to initialize in time.
125This should not happen.
126.It "iwi%d: could not load firmware image '%s'"
127The driver failed to load the firmware image using the
128.Xr firmware 9
129subsystem.
130Verify the
131.Xr iwifw 4
132firmware module is installed and the license agreement
133.Xr loader 8
134tunable has been set.
135.It "iwi%d: could not load boot firmware"
136An attempt to upload the boot firmware image to the onboard microcontroller
137failed.
138This should not happen.
139.It "iwi%d: could not load microcode"
140An attempt to upload the microcode image to the onboard microcontroller failed.
141This should not happen.
142.It "iwi%d: could not load main firmware"
143An attempt to upload the main firmware image to the onboard microcontroller
144failed.
145This should not happen.
146.El
147.Sh SEE ALSO
148.Xr iwifw 4 ,
149.Xr pci 4 ,
150.Xr wlan 4 ,
151.Xr wlan_ccmp 4 ,
152.Xr wlan_tkip 4 ,
153.Xr wlan_wep 4 ,
154.Xr ifconfig 8 ,
155.Xr wpa_supplicant 8 .
156.Sh AUTHORS
157The original
158.Nm
159driver was written by
160.An Damien Bergamini Aq damien.bergamini@free.fr