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