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