Provide a man page for wpi:

    Intel 3945abg wireless driver

Approved by: mlaier (comentor)

1 files changed, 147 insertions, 0 deletions

diff --git a/share/man/man4/wpi.4 b/share/man/man4/wpi.4
new file mode 100644
index 0000000..3fbdf2a
--- /dev/null
+++ b/share/man/man4/wpi.4
@@ -0,0 +1,147 @@
+.\" Copyright (c) 2004-2007
+.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
+.\"	Benjamin Close <Benjamin.Close@clearchain.com>. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice unmodified, this list of conditions, and the following
+.\"    disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd March 6, 2007
+.Os
+.Dt WPI 4
+.Sh NAME
+.Nm wpi
+.Nd "Intel 3945ABG Wireless LAN IEEE 802.11 driver"
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device wpi"
+.Cd "device pci"
+.Cd "device wlan"
+.Cd "device firmware"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following lines in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+if_wpi_load="YES"
+wlan_load="YES"
+firmware_load="YES"
+.Ed
+.Pp
+In both cases, place the following lines in
+.Xr loader.conf 5
+to load the firmware modules:
+.Bd -literal -offset indent
+wpifw_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver is an experimental driver providing support for the
+.Tn Intel
+3945ABG Wireless network adapter
+.Pp
+By default, the
+.Nm
+driver configures the adapter for BSS operation (aka infrastructure mode).
+This mode requires the use of an access point.
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Pp
+This driver requires firmware to be loaded before it will work.
+For the loaded firmware to work the license at
+.Pa /usr/share/doc/legal/intel_wpi/LICENSE
+must be agreed to and the following line be added to
+.Xr loader.conf 5 :
+.Pp
+.Dl "legal.intel_wpi.license_ack=1"
+.Sh FILES
+.Bl -tag -width ".Pa /usr/share/doc/legal/intel_wpi/LICENSE" -compact
+.It Pa /usr/share/doc/legal/intel_wpi/LICENSE
+.Nm
+firmware license
+.El
+.Sh EXAMPLES
+Join an existing BSS network (i.e., connect to an access point):
+.Pp
+.Dl "ifconfig wpi0 inet 192.168.0.20 netmask 0xffffff00"
+.Pp
+Join a specific BSS network with network name
+.Dq Li my_net :
+.Pp
+.Dl "ifconfig wpi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
+.Pp
+Join a specific BSS network with 40-bit WEP encryption:
+.Bd -literal -offset indent
+ifconfig wpi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+    wepmode on wepkey 0x1234567890 weptxkey 1
+.Ed
+.Pp
+Join a specific BSS network with 104-bit WEP encryption:
+.Bd -literal -offset indent
+ifconfig wpi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
+.Ed
+.Sh DIAGNOSTICS
+.Bl -diag
+.Xr firmware 9
+subsystem.
+Verify that the necessary firmware modules are loaded and the
+license agreement
+.Xr loader 8
+tunable has been set.
+.It "wpi%d: could not load firmware"
+An attempt to upload the firmware image to the onboard microcontroller failed.
+This should not happen.
+.It "wpi%d: fatal firmware error"
+An unknown error has occurred in the uploaded firmware, you may have to
+unload/reload the driver to continue.
+.It "wpi%d: Radio Transmitteer is switched off"
+The hardware switch controlling the radio is currently turned off. 
+Data transmision is not possible in this state.
+.Sh BUGS
+Not all the error messages are documented here.
+.Pp
+Automatic recovery of firmware failures is not currently supported, nor is 
+detection of toggling the radio switch on.
+.Pp
+Background scanning is not currently supported
+.El
+.Sh SEE ALSO
+.Xr altq 4 ,
+.Xr iwi 4 ,
+.Xr ipw 4 ,
+.Xr pci 4 ,
+.Xr wlan 4 ,
+.Xr ifconfig 8
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Damien Bergamini Aq damien.bergamini@free.fr
+.An and Benjamin Close Aq benjsc@FreeBSD.org .