share/man/man4/wpi.4

   1 .\" Copyright (c) 2004-2007
   2 .\"     Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
   3 .\"     Benjamin Close <Benjamin.Close@clearchain.com>. All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice unmodified, this list of conditions, and the following
  10 .\"    disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd March 6, 2007
  30 .Os
  31 .Dt WPI 4
  32 .Sh NAME
  33 .Nm wpi
  34 .Nd "Intel 3945ABG Wireless LAN IEEE 802.11 driver"
  35 .Sh SYNOPSIS
  36 To compile this driver into the kernel,
  37 place the following lines in your
  38 kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device wpi"
  41 .Cd "device pci"
  42 .Cd "device wlan"
  43 .Cd "device wlan_amrr"
  44 .Cd "device firmware"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following lines in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 if_wpi_load="YES"
  52 wlan_load="YES"
  53 wlan_amrr_load="YES"
  54 firmware_load="YES"
  55 .Ed
  56 .Pp
  57 In both cases, place the following line in
  58 .Xr loader.conf 5
  59 to load the firmware modules:
  60 .Bd -literal -offset indent
  61 wpifw_load="YES"
  62 .Ed
  63 .Sh DESCRIPTION
  64 The
  65 .Nm
  66 driver is an experimental driver providing support for the
  67 .Tn Intel
  68 3945ABG Wireless network adapter
  69 .Pp
  70 By default, the
  71 .Nm
  72 driver configures the adapter for BSS operation (aka infrastructure mode).
  73 This mode requires the use of an access point.
  74 .Pp
  75 For more information on configuring this device, see
  76 .Xr ifconfig 8 .
  77 .Pp
  78 This driver requires firmware to be loaded before it will work.
  79 For the loaded firmware to work the license at
  80 .Pa /usr/share/doc/legal/intel_wpi/LICENSE
  81 must be agreed to and the following line be added to
  82 .Xr loader.conf 5 :
  83 .Pp
  84 .Dl "legal.intel_wpi.license_ack=1"
  85 .Sh FILES
  86 .Bl -tag -width ".Pa /usr/share/doc/legal/intel_wpi/LICENSE" -compact
  87 .It Pa /usr/share/doc/legal/intel_wpi/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 .Dl "ifconfig wpi0 inet 192.168.0.20 netmask 0xffffff00"
  95 .Pp
  96 Join a specific BSS network with network name
  97 .Dq Li my_net :
  98 .Pp
  99 .Dl "ifconfig wpi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 100 .Pp
 101 Join a specific BSS network with 40-bit WEP encryption:
 102 .Bd -literal -offset indent
 103 ifconfig wpi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 104     wepmode on wepkey 0x1234567890 weptxkey 1
 105 .Ed
 106 .Pp
 107 Join a specific BSS network with 104-bit WEP encryption:
 108 .Bd -literal -offset indent
 109 ifconfig wpi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 110     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 111 .Ed
 112 .Sh DIAGNOSTICS
 113 .Bl -diag
 114 .Xr firmware 9
 115 subsystem.
 116 Verify that the necessary firmware modules are loaded and the
 117 license agreement
 118 .Xr loader 8
 119 tunable has been set.
 120 .It "wpi%d: could not load firmware"
 121 An attempt to upload the firmware image to the onboard microcontroller failed.
 122 This should not happen.
 123 .It "wpi%d: fatal firmware error"
 124 An unknown error has occurred in the uploaded firmware, you may have to
 125 unload/reload the driver to continue.
 126 .It "wpi%d: Radio transmitter is switched off"
 127 The hardware switch controlling the radio is currently turned off.
 128 Data transmission is not possible in this state.
 129 .Sh BUGS
 130 Not all the error messages are documented here.
 131 .Pp
 132 Automatic recovery of firmware failures is not currently supported, nor is
 133 detection of toggling the radio switch on.
 134 .Pp
 135 Background scanning is not currently supported.
 136 .El
 137 .Sh SEE ALSO
 138 .Xr altq 4 ,
 139 .Xr ipw 4 ,
 140 .Xr iwi 4 ,
 141 .Xr pci 4 ,
 142 .Xr wlan 4 ,
 143 .Xr ifconfig 8
 144 .Sh AUTHORS
 145 .An -nosplit
 146 The
 147 .Nm
 148 driver was written by
 149 .An Damien Bergamini Aq damien.bergamini@free.fr
 150 and
 151 .An Benjamin Close Aq benjsc@FreeBSD.org .