From: Sascha Wildner Date: Sun, 18 Jul 2010 22:06:27 +0000 (+0200) Subject: iwi.4: Update iwi(4)'s manual page (from FreeBSD). X-Git-Tag: v2.9.0~713 X-Git-Url: https://gitweb.dragonflybsd.org/dragonfly.git/commitdiff_plain/534cc2a0a436c2e1125ae266b3962af99d385200 iwi.4: Update iwi(4)'s manual page (from FreeBSD). --- diff --git a/share/man/man4/iwi.4 b/share/man/man4/iwi.4 index 2eb6211210..28b82f3ba8 100644 --- a/share/man/man4/iwi.4 +++ b/share/man/man4/iwi.4 @@ -1,10 +1,6 @@ .\" -.\" Copyright (c) 2004, 2005 -.\" Damien Bergamini . -.\" Copyright (c) 2004, 2005 -.\" Andrew Atrens . -.\" -.\" All rights reserved. +.\" Copyright (c) 2004-2006 +.\" Damien Bergamini . All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -28,77 +24,140 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $DragonFly: src/share/man/man4/iwi.4,v 1.14 2008/07/26 16:25:40 swildner Exp $ +.\" $FreeBSD: src/share/man/man4/iwi.4,v 1.22 2010/04/14 19:08:06 uqs Exp $ .\" -.Dd March 3, 2008 -.Os +.Dd July 18, 2010 .Dt IWI 4 +.Os .Sh NAME .Nm iwi -.Nd Intel(R) PRO/Wireless 2200BG/2915ABG IEEE 802.11 driver +.Nd "Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 driver" .Sh SYNOPSIS +To compile this driver into the kernel, +include the following lines in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device iwi" +.Cd "device iwifw" .Cd "device pci" .Cd "device wlan" +.Cd "device firmware" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +if_iwi_load="YES" +.Ed +.Pp +In both cases, place the following line in +.Xr loader.conf 5 +to acknowledge the firmware license (see below): +.Bd -literal -offset indent +legal.intel_iwi.license_ack=1 +.Ed .Sh DESCRIPTION The .Nm -driver provides support for Intel(R) PRO/Wireless 2200BG and 2915ABG MiniPCI -network adapters. -.Pp -By default, the +driver provides support for +.Tn Intel +PRO/Wireless 2200BG/2915ABG MiniPCI and 2225BG PCI network adapters. .Nm -driver configures the adapter for BSS operation (aka infrastructure mode). -This mode requires the use of an access point. +supports +.Cm station , +.Cm adhoc , +and +.Cm monitor +mode operation. +Only one virtual interface may be configured at any time. +For more information on configuring this device, see +.Xr ifconfig 8 . .Pp -In addition IBSS operation (aka adhoc mode) is also supported. -This mode requires special ibss firmware. +This driver requires the firmware built with the +.Nm iwifw +module to work. +For the loaded firmware to be enabled for use the license at +.Pa /usr/share/doc/legal/intel_iwi/LICENSE +must be agreed by adding the following line to +.Xr loader.conf 5 : .Pp -For more (general) information on configuring this device, see -.Xr ifconfig 8 . +.Dl "legal.intel_iwi.license_ack=1" .Sh FILES -The firmware for the adapter is not shipped with -.Dx -and must be obtained separately. -An archive with firmware files that are known to work can be found at: +.Bl -tag -width ".Pa /usr/share/doc/legal/intel_iwi/LICENSE" -compact +.It Pa /usr/share/doc/legal/intel_iwi/LICENSE +.Nm +firmware license +.El +.Sh EXAMPLES +Join an existing BSS network (i.e., connect to an access point): +.Pp .Bd -literal -offset indent -http://ipw2200.sourceforge.net/firmware.php?fid=7 +ifconfig wlan create wlandev iwi0 inet 192.168.0.20 \e + netmask 0xffffff00 .Ed .Pp -The firmware files have to reside in -.Pa /etc/firmware/iwi/2200/3.0 -and will be loaded when the interface is brought up. -.Sh EXAMPLES -Refer to the -.Sx EXAMPLES -section of -.Xr wlan 4 . -.Sh WORTH NOTING -It's worth noting that in BSS mode if you haven't specified an -ssid, the driver will auto-assign an ssid, joining the best -network available. +Join a specific BSS network with network name +.Dq Li my_net : +.Pp +.Dl "ifconfig wlan create wlandev iwi0 ssid my_net up" +.Pp +Join a specific BSS network with 64-bit WEP encryption: +.Bd -literal -offset indent +ifconfig wlan create wlandev iwi0 ssid my_net \e + wepmode on wepkey 0x1234567890 weptxkey 1 up +.Ed +.Pp +Join a specific BSS network with 128-bit WEP encryption: +.Bd -literal -offset indent +ifconfig wlan create wlandev iwi0 wlanmode adhoc ssid my_net \e + wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 +.Ed .Sh DIAGNOSTICS .Bl -diag -.It "iwi%d: firmware reset" -The driver has reset the firmware. This shouldn't but may occasionally happen. .It "iwi%d: device timeout" -The driver will reset the hardware. This should not happen. +The driver will reset the hardware. +This should not happen. +.It "iwi%d: firmware error" +The onboard microcontroller crashed for some reason. +The driver will reset the hardware. +This should not happen. +.It "iwi%d: timeout waiting for firmware initialization to complete" +The onboard microcontroller failed to initialize in time. +This should not happen. +.It "iwi%d: could not load firmware image '%s'" +The driver failed to load the firmware image using the +.Xr firmware 9 +subsystem. +Verify the +.Xr iwifw 4 +firmware module is installed and the license agreement +.Xr loader 8 +tunable has been set. +.It "iwi%d: could not load boot firmware" +An attempt to upload the boot firmware image to the onboard microcontroller +failed. +This should not happen. +.It "iwi%d: could not load microcode" +An attempt to upload the microcode image to the onboard microcontroller failed. +This should not happen. +.It "iwi%d: could not load main firmware" +An attempt to upload the main firmware image to the onboard microcontroller +failed. +This should not happen. .El .Sh SEE ALSO -.Xr an 4 , +.Xr iwifw 4 , .Xr ifmedia 4 , .Xr pci 4 , -.Xr wi 4 , .Xr wlan 4 , +.Xr wlan_ccmp 4 , +.Xr wlan_tkip 4 , +.Xr wlan_wep 4 , .Xr ifconfig 8 , .Xr wpa_supplicant 8 .Sh AUTHORS -.An -nosplit -The +The original .Nm -driver and this man page were derived from those written by -.An Damien Bergamini Aq damien.bergamini@free.fr . -.Pp -.Dx -enhancements and IBSS support were written by -.An Andrew Atrens Aq atrens@nortel.com . +driver was written by +.An Damien Bergamini Aq damien.bergamini@free.fr