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