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 6, 2007
  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 .Pp
  54 In both cases, place the following lines in
  55 .Xr loader.conf 5
  56 to load the firmware modules:
  57 .Bd -literal -offset indent
  58 iwi_bss_load="YES"
  59 iwi_ibss_load="YES"
  60 iwi_monitor_load="YES"
  61 .Ed
  62 .Sh DESCRIPTION
  63 The
  64 .Nm
  65 driver provides support for
  66 .Tn Intel
  67 PRO/Wireless 2200BG/2915ABG MiniPCI and 2225BG PCI network adapters.
  68 .Pp
  69 By default, the
  70 .Nm
  71 driver configures the adapter for BSS operation (aka infrastructure mode).
  72 This mode requires the use of an access point.
  73 .Pp
  74 For more information on configuring this device, see
  75 .Xr ifconfig 8 .
  76 .Pp
  77 This driver requires firmware to be loaded before it will work.
  78 For the loaded firmware to work the license at
  79 .Pa /usr/share/doc/legal/intel_iwi/LICENSE
  80 must be agreed to and the following line be added to
  81 .Xr loader.conf 5 :
  82 .Pp
  83 .Dl "legal.intel_iwi.license_ack=1"
  84 .Sh FILES
  85 .Bl -tag -width ".Pa /usr/share/doc/legal/intel_iwi/LICENSE" -compact
  86 .It Pa /usr/share/doc/legal/intel_iwi/LICENSE
  87 .Nm
  88 firmware license
  89 .El
  90 .Sh EXAMPLES
  91 Join an existing BSS network (i.e., connect to an access point):
  92 .Pp
  93 .Dl "ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00"
  94 .Pp
  95 Join a specific BSS network with network name
  96 .Dq Li my_net :
  97 .Pp
  98 .Dl "ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
  99 .Pp
 100 Join a specific BSS network with 64-bit WEP encryption:
 101 .Bd -literal -offset indent
 102 ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 103     wepmode on wepkey 0x1234567890 weptxkey 1
 104 .Ed
 105 .Pp
 106 Join a specific BSS network with 128-bit WEP encryption:
 107 .Bd -literal -offset indent
 108 ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 109     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 110 .Ed
 111 .Sh DIAGNOSTICS
 112 .Bl -diag
 113 .It "iwi%d: device timeout"
 114 The driver will reset the hardware.
 115 This should not happen.
 116 .It "iwi%d: firmware error"
 117 The onboard microcontroller crashes for some reason.
 118 The driver will reset the hardware.
 119 This should not happen.
 120 .It "iwi%d: timeout waiting for firmware initialization to complete"
 121 The onboard microcontroller failed to initialize in time.
 122 This should not happen.
 123 .It "iwi%d: could not load firmware image '%s'"
 124 The driver failed to load the firmware image using the
 125 .Xr firmware 9
 126 subsystem.
 127 Verify that the necessary firmware modules are loaded and the
 128 license agreement
 129 .Xr loader 8
 130 tunable has been set.
 131 .It "iwi%d: could not load boot firmware"
 132 An attempt to upload the boot firmware image to the onboard microcontroller
 133 failed.
 134 This should not happen.
 135 .It "iwi%d: could not load microcode"
 136 An attempt to upload the microcode image to the onboard microcontroller failed.
 137 This should not happen.
 138 .It "iwi%d: could not load main firmware"
 139 An attempt to upload the main firmware image to the onboard microcontroller
 140 failed.
 141 This should not happen.
 142 .El
 143 .Sh SEE ALSO
 144 .Xr altq 4 ,
 145 .Xr ipw 4 ,
 146 .Xr pci 4 ,
 147 .Xr wlan 4 ,
 148 .Xr ifconfig 8
 149 .Sh AUTHORS
 150 The
 151 .Nm
 152 driver was written by
 153 .An Damien Bergamini Aq damien@FreeBSD.org .