From 3c01920f6db8d7c258e4dad47cce635dd075538e Mon Sep 17 00:00:00 2001 From: Joe Talbott Date: Tue, 18 May 2010 20:55:06 -0400 Subject: [PATCH] wpi(4) - Add manual page from FreeBSD. --- share/man/man4/Makefile | 1 + share/man/man4/wpi.4 | 145 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 146 insertions(+) create mode 100644 share/man/man4/wpi.4 diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index cc73e2153b..7b64c3ba68 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -339,6 +339,7 @@ MAN= aac.4 \ wlan_tkip.4 \ wlan_wep.4 \ wlan_xauth.4 \ + wpi.4 \ xe.4 \ xl.4 \ xpt.4 \ diff --git a/share/man/man4/wpi.4 b/share/man/man4/wpi.4 new file mode 100644 index 0000000000..07e8816982 --- /dev/null +++ b/share/man/man4/wpi.4 @@ -0,0 +1,145 @@ +.\" Copyright (c) 2004-2007 +.\" Damien Bergamini . All rights reserved. +.\" Benjamin Close . 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 October 5, 2008 +.Dt WPI 4 +.Os +.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 wpifw" +.Cd "device pci" +.Cd "device wlan" +.Cd "device wlan_amrr" +.Cd "device firmware" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +if_wpi_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for the +.Tn Intel +3945ABG Wireless network adapter +.Nm +supports +.Cm station , +.Cm adhoc , +and +.Cm monitor +mode operation. +Only one virtual interface may be configured at any time. +For more information on configuring this device, see +.Xr ifconfig 8 . +.Pp +This driver requires the firmware built with the +.Nm wpifw +module to work. +.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 +.Bd -literal -offset indent +ifconfig wlan0 create wlandev wpi0 inet 192.168.0.20 \e + netmask 0xffffff00 +.Ed +.Pp +Join a specific BSS network with network name +.Dq Li my_net : +.Pp +.Dl "ifconfig wlan0 create wlandev wpi0 ssid my_net up" +.Pp +Join a specific BSS network with 64-bit WEP encryption: +.Bd -literal -offset indent +ifconfig wlan0 create wlandev wpi0 ssid my_net \e + wepmode on wepkey 0x1234567890 weptxkey 1 up +.Ed +.Pp +Join a specific BSS network with 128-bit WEP encryption: +.Bd -literal -offset indent +ifconfig wlan0 create wlandev wpi0 wlanmode adhoc ssid my_net \e + wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 +.Ed +.Sh DIAGNOSTICS +.Bl -diag +.It "wpi%d: could not load firmware image '%s'" +The driver failed to load the firmware image using the +.Xr firmware 9 +subsystem. +Verify the +.Xr wpifw +firmware module is installed. +.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 transmitter is switched off" +The hardware switch controlling the radio is currently turned off. +Data transmission is not possible in this state. +.El +.Sh BUGS +Not all the error messages are documented here. +.Pp +Background scanning is not currently supported. +.Sh SEE ALSO +.Xr wpifw 4 , +.Xr pci 4 , +.Xr wlan 4 , +.Xr wlan_ccmp 4 , +.Xr wlan_tkip 4 , +.Xr wlan_wep 4 , +.Xr ifconfig 8 , +.Xr wpa_supplicant 8 . +.Sh AUTHORS +.An -nosplit +The original +.Nm +driver was written for +.Ox +by +.An Damien Bergamini Aq damien.bergamini@free.fr . +.An Benjamin Close Aq benjsc@FreeBSD.org +ported +.Nm +to +.Fx . -- 2.41.0