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 .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 include the following lines in your
  37 kernel 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
  46 Alternatively, to load the driver as a
  47 module at boot time, place the following line in
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 if_iwi_load="YES"
  51 .Ed
  52 .Pp
  53 In both cases, place the following line in
  54 .Xr loader.conf 5
  55 to acknowledge the firmware license (see below):
  56 .Bd -literal -offset indent
  57 legal.intel_iwi.license_ack=1
  58 .Ed
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 driver provides support for
  63 .Tn Intel
  64 PRO/Wireless 2200BG/2915ABG MiniPCI and 2225BG PCI network adapters.
  65 .Nm
  66 supports
  67 .Cm station ,
  68 .Cm adhoc ,
  69 and
  70 .Cm monitor
  71 mode operation.
  72 Only one virtual interface may be configured at any time.
  73 For more information on configuring this device, see
  74 .Xr ifconfig 8 .
  75 .Pp
  76 This driver requires the firmware built with the
  77 .Nm iwifw
  78 module to work.
  79 For the loaded firmware to be enabled for use the license at
  80 .Pa /usr/share/doc/legal/intel_iwi/LICENSE
  81 must 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
  89 firmware license
  90 .El
  91 .Sh EXAMPLES
  92 Join an existing BSS network (i.e., connect to an access point):
  93 .Pp
  94 .Bd -literal -offset indent
  95 ifconfig wlan create wlandev iwi0 inet 192.168.0.20 \e
  96     netmask 0xffffff00
  97 .Ed
  98 .Pp
  99 Join a specific BSS network with network name
 100 .Dq Li my_net :
 101 .Pp
 102 .Dl "ifconfig wlan create wlandev iwi0 ssid my_net up"
 103 .Pp
 104 Join a specific BSS network with 64-bit WEP encryption:
 105 .Bd -literal -offset indent
 106 ifconfig wlan create wlandev iwi0 ssid my_net \e
 107         wepmode on wepkey 0x1234567890 weptxkey 1 up
 108 .Ed
 109 .Pp
 110 Join a specific BSS network with 128-bit WEP encryption:
 111 .Bd -literal -offset indent
 112 ifconfig wlan create wlandev iwi0 wlanmode adhoc ssid my_net \e
 113     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 114 .Ed
 115 .Sh DIAGNOSTICS
 116 .Bl -diag
 117 .It "iwi%d: device timeout"
 118 The driver will reset the hardware.
 119 This should not happen.
 120 .It "iwi%d: firmware error"
 121 The onboard microcontroller crashed for some reason.
 122 The driver will reset the hardware.
 123 This should not happen.
 124 .It "iwi%d: timeout waiting for firmware initialization to complete"
 125 The onboard microcontroller failed to initialize in time.
 126 This should not happen.
 127 .It "iwi%d: could not load firmware image '%s'"
 128 The driver failed to load the firmware image using the
 129 .Xr firmware 9
 130 subsystem.
 131 Verify the
 132 .Xr iwifw 4
 133 firmware module is installed and the license agreement
 134 .Xr loader 8
 135 tunable has been set.
 136 .It "iwi%d: could not load boot firmware"
 137 An attempt to upload the boot firmware image to the onboard microcontroller
 138 failed.
 139 This should not happen.
 140 .It "iwi%d: could not load microcode"
 141 An attempt to upload the microcode image to the onboard microcontroller failed.
 142 This should not happen.
 143 .It "iwi%d: could not load main firmware"
 144 An attempt to upload the main firmware image to the onboard microcontroller
 145 failed.
 146 This should not happen.
 147 .El
 148 .Sh SEE ALSO
 149 .Xr iwifw 4 ,
 150 .Xr pci 4 ,
 151 .Xr wlan 4 ,
 152 .Xr wlan_ccmp 4 ,
 153 .Xr wlan_tkip 4 ,
 154 .Xr wlan_wep 4 ,
 155 .Xr ifconfig 8 ,
 156 .Xr wpa_supplicant 8 .
 157 .Sh AUTHORS
 158 The original
 159 .Nm
 160 driver was written by
 161 .An Damien Bergamini Aq damien.bergamini@free.fr