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 Apri 13, 2008
  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 wpifw"
  42 .Cd "device pci"
  43 .Cd "device wlan"
  44 .Cd "device wlan_amrr"
  45 .Cd "device firmware"
  46 .Ed
  47 .Pp
  48 Alternatively, to load the driver as a
  49 module at boot time, place the following line in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 if_wpi_load="YES"
  53 .Ed
  54 .Pp
  55 In both cases, place the following line in
  56 .Xr loader.conf 5
  57 to acknowledge the firmware license (see below):
  58 .Bd -literal -offset indent
  59 legal.intel_wpi.license_ack=1
  60 .Ed
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 driver provides support for the
  65 .Tn Intel
  66 3945ABG Wireless network adapter
  67 .Nm
  68 supports
  69 .Cm station ,
  70 .Cm adhoc ,
  71 and
  72 .Cm monitor
  73 mode operation.
  74 Only one virtual interface may be configured at any time.
  75 For more information on configuring this device, see
  76 .Xr ifconfig 8 .
  77 .Pp
  78 This driver requires the firmware built with the
  79 .Nm wpifw
  80 module to work.
  81 For the loaded firmware to be enabled for use the license at
  82 .Pa /usr/share/doc/legal/intel_iwi/LICENSE
  83 must be agreed by adding the following line to
  84 .Xr loader.conf 5 :
  85 .Pp
  86 .Dl "legal.intel_wpi.license_ack=1"
  87 .Sh FILES
  88 .Bl -tag -width ".Pa /usr/share/doc/legal/intel_wpi/LICENSE" -compact
  89 .It Pa /usr/share/doc/legal/intel_wpi/LICENSE
  90 .Nm
  91 firmware license
  92 .El
  93 .Sh EXAMPLES
  94 Join an existing BSS network (i.e., connect to an access point):
  95 .Pp
  96 .Bd -literal -offset indent
  97 ifconfig wlan create wlandev wpi0 inet 192.168.0.20 \e
  98     netmask 0xffffff00
  99 .Ed
 100 .Pp
 101 Join a specific BSS network with network name
 102 .Dq Li my_net :
 103 .Pp
 104 .Dl "ifconfig wlan create wlandev wpi0 ssid my_net up"
 105 .Pp
 106 Join a specific BSS network with 64-bit WEP encryption:
 107 .Bd -literal -offset indent
 108 ifconfig wlan create wlandev wpi0 ssid my_net \e
 109         wepmode on wepkey 0x1234567890 weptxkey 1 up
 110 .Ed
 111 .Pp
 112 Join a specific BSS network with 128-bit WEP encryption:
 113 .Bd -literal -offset indent
 114 ifconfig wlan create wlandev wpi0 wlanmode adhoc ssid my_net \e
 115     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 116 .Ed
 117 .Sh DIAGNOSTICS
 118 .Bl -diag
 119 .It "wpi%d: could not load firmware image '%s'"
 120 The driver failed to load the firmware image using the
 121 .Xr firmware 9
 122 subsystem.
 123 Verify the
 124 .Xr wpifw
 125 firmware module is installed and the license agreement
 126 .Xr loader 8
 127 tunable has been set.
 128 .It "wpi%d: fatal firmware error"
 129 An unknown error has occurred in the uploaded firmware, you may have to
 130 unload/reload the driver to continue.
 131 .It "wpi%d: Radio transmitter is switched off"
 132 The hardware switch controlling the radio is currently turned off.
 133 Data transmission is not possible in this state.
 134 .Sh BUGS
 135 Not all the error messages are documented here.
 136 .Pp
 137 Background scanning is not currently supported.
 138 .El
 139 .Sh SEE ALSO
 140 .Xr wpifw 4 ,
 141 .Xr pci 4 ,
 142 .Xr wlan 4 ,
 143 .Xr wlan_ccmp 4 ,
 144 .Xr wlan_tkip 4 ,
 145 .Xr wlan_wep 4 ,
 146 .Xr ifconfig 8 ,
 147 .Xr wpa_supplicant 8 .
 148 .Sh AUTHORS
 149 .An -nosplit
 150 The original
 151 .Nm
 152 driver was written for
 153 .Ox
 154 by
 155 .An Damien Bergamini Aq damien.bergamini@free.fr .
 156 .An Benjamin Close Aq benjsc@FreeBSD.org
 157 ported
 158 .Nm
 159 to
 160 .Fx .