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