[src/netbsd-1-4]: src/usr.sbin/wiconfig Pull up revisions 1.1-1.5 (requested ...

[he <he%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/d4556aaf50be
branches:  netbsd-1-4
changeset: 470566:d4556aaf50be
user:      he <he%NetBSD.org@localhost>
date:      Wed May 10 19:29:33 2000 +0000

description:
Pull up revisions 1.1-1.5 (requested by jhawk):
  Add a driver for ``wi'', Lucent "Orinoco"/Wavelan.

diffstat:

 usr.sbin/wiconfig/wiconfig.8 |  275 +++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 275 insertions(+), 0 deletions(-)

diffs (279 lines):

diff -r 64b77596b153 -r d4556aaf50be usr.sbin/wiconfig/wiconfig.8
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/usr.sbin/wiconfig/wiconfig.8      Wed May 10 19:29:33 2000 +0000
@@ -0,0 +1,275 @@
+.\"    $NetBSD: wiconfig.8,v 1.5.2.2 2000/05/10 19:29:33 he Exp $
+.\"
+.\" Copyright (c) 1997, 1998, 1999
+.\"    Bill Paul <wpaul%ctr.columbia.edu@localhost> 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, 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by Bill Paul.
+.\" 4. Neither the name of the author nor the names of any co-contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"   without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD
+.\" 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.
+.\"
+.\"    From: wicontrol.8,v 1.6 1999/05/22 16:12:47 wpaul Exp $
+.\"
+.Dd April 21, 1999
+.Dt WICONFIG 8
+.Os
+.Sh NAME
+.Nm wiconfig
+.Nd configure WaveLAN/IEEE devices
+.Sh SYNOPSIS
+.Nm wiconfig
+.Ar interface
+.Op Fl o
+.Op Fl e Ar 0|1
+.Op Fl k Ar key "[ -v 1|2|3|4 ]"
+.Op Fl t Ar tx rate
+.Op Fl n Ar network name
+.Op Fl s Ar station name
+.Op Fl c Ar 0|1
+.Op Fl q Ar SSID
+.Op Fl p Ar port type
+.Op Fl a Ar access point density
+.Op Fl m Ar MAC address
+.Op Fl d Ar max data length
+.Op Fl r Ar RTS threshold
+.Op Fl f Ar frequency
+.Op Fl P Ar 0|1
+.Op Fl S Ar max sleep duration
+.Op Fl T Ar 1|2|3|4
+.Sh DESCRIPTION
+The
+.Nm
+command controls the operation of WaveLAN/IEEE wireless networking
+devices via the
+.Xr wi 4
+and
+.Xr awi 4
+drivers. Most of the parameters that can be changed relate to the
+IEEE 802.11 protocol which the WaveLAN implements. This includes
+the station name, whether the station is operating in ad-hoc (point
+to point) or BSS (service set) mode, and the network name of a service
+set to join (IBSS) if BSS mode is enabled. The
+.Nm
+command can also be used to view the current settings of these paremeters
+and to dump out the values of the card's statistics counters.
+.Pp
+The
+.Ar iface
+argument given to
+.Nm
+should be the logical interface name associated with the WaveLAN/IEEE
+device (wi0, wi1, etc...).
+.Sh OPTIONS
+The options are as follows:
+.Pp
+.Bl -tag -width Fl
+.It Fl o
+Display the current settings of the specified WaveLAN/IEEE interface.
+This retrieves the current card settings from the driver and prints them
+out. Using the additional
+.Fl o
+flag will cause
+.Nm
+to print out the statistics counters instead of the card settings.
+.It Fl e Ar 0|1
+Enable or disable WEP encryption. Permitted values are
+.Ar 0
+(encryption disabled) or
+.Ar 1
+(encryption enabled). Encryption is off by default.
+.It Fl k Ar key "[ -v 1|2|3|4 ]"
+Set WEP encryption keys. There are four default encryption keys that can be
+programmed. A specific key can be set using the
+.Fl v
+flag. If the
+.Fl v
+flag is not specified, the first key will be set. Encryption keys can either
+be normal text (i.e., "hello") or a series of hexadecimal digits
+(i.e., "0x1234512345"). For WaveLAN Silver cards, the key is
+restricted to 40 bits, hence the key can be either a 5-character text string
+or 10 hexadecimal digits. For WaveLAN Gold cards, the key can be up to
+112 bits, which means the key can be specified as either a 14-character
+text string or 28 hexadecimal digits.  (The card claims to be 128-bit RC4,
+but you can only send 112 bits to the driver.  Strange, I wonder where the
+other 16 bits come from, and what they are.)
+.It Fl T Ar 1|2|3|4
+Specify which of the four WEP encryption keys will be used to encrypt
+transmitted packets.
+.It Fl t Ar tx rate
+Set the transmit rate of the specified interface. The legal values
+for the transmit rate vary depending on whether the interface is a
+standard WaveLAN/IEEE or a WaveLAN/IEEE Turbo adapter. The standard
+NICs support a maximum transmit rate of 2Mbps while the turbo NICs
+support a maximum speed of 6Mbps. The following table shows the
+legal transmit rate settings and the corresponding transmit speeds:
+.Bd -filled -offset indent
+.Bl -column "TX rate " "NIC speed "
+.Em "TX rate   NIC speed"
+1      Fixed Low (1Mbps)
+2      Fixed Standard (2Mbps)
+3      Auto Rate Select (High)
+4      Fixed Medium (4Mbps)
+5      Fixed High (6Mbps)
+6      Auto Rate Select (Standard)
+7      Auto Rate Select (Medium)
+11     Fixed Turbo (11Mbps)
+.El
+.Ed
+.Pp
+The standard NICs support only settings 1 through 3. Turbo NICs support
+all the above listed speed settings.
+The default driver setting is 3 (auto rate select).
+.It Fl n Ar network name
+Set the name of the service set (IBSS) that this station wishes to
+join. The
+.Ar network name
+can be any text string up to 30 characters in length. The default name
+is the empty string which should allow the station to connect to the first
+available access point. The interface should be set for BSS mode using
+the
+.Fl p
+flag in order for this to work.
+.It Fl s Ar station name
+Sets the
+.Ar station name
+for the specified interface. The
+.Ar station name
+is used for diagnostic purposes. The Lucent WaveMANAGER sofware can
+poll the names of remote hosts.
+.It Fl c Ar 0|1
+Allow the station to create a service set (IBSS). Permitted values
+are 0 (don't create IBSS) and 1 (enable creation of IBSS). The default
+is 0.
+.Pp
+Note: this option is provided for experimental purposes only: enabling
+the creation of an IBSS on a host system doesn't appear to actually work.
+.It Fl q Ar SSID
+Specify the name of an IBSS (SSID) to create on a given interface.
+The
+.Ar SSID
+can be any text string up to 30 characters long.
+.Pp
+Note: this option is provided for experimental purposes only: enabling
+the creation of an IBSS on a host system doesn't appear to actually work.
+.It Fl p Ar port type
+Set the
+.Ar port type
+for a specified interface. The legal values for
+.Ar port type
+are 1 (BSS mode) and 3 (ad-hoc) mode. In ad-hoc mode, the station can
+communicate directly with any other stations within direct radio range
+(provided that they are also operating in ad-hoc mode). In BSS mode,
+hosts must associate with a service set controlled by an access point,
+which relays traffic between end stations. The default setting is 3
+(ad-hoc mode).
+.It Fl a Ar access_point_density
+Specify the
+.Ar access point density
+for a given interface. Legal values are 1 (low), 2 (medium) and 3 (high).
+This setting influences some of the radio modem threshold settings.
+.It Fl m Ar MAC address
+Set the station address for the specified interface. The
+.Ar MAC address
+is specified as a series of six hexadecimal values separated by colons,
+e.g.: 00:60:1d:12:34:56. This programs the new address into the card
+and updates the interface as well.
+.It Fl d Ar max_data_length
+Set the maximum receive and transmit frame size for a specified interface.
+The
+.Ar max data length
+can be any number from 350 to 2304. The default is 2304.
+.It Fl r Ar RTS threshold
+Set the RTS/CTS threshold for a given interface. This controls the
+number of bytes used for the RTS/CTS handshake boundary. The
+.Ar RTS threshold
+can be any value between 0 and 2047. The default is 2347.
+.It Fl f Ar frequency
+Set the radio frequency of a given interface. The
+.Ar frequency
+should be specfied as a channel ID as shown in the table below. The
+list of available frequencies is dependent on radio regulations specified
+by regional authorities. Recognized regulatory authorities include
+the FCC (United States), ETSI (Europe), France and Japan. Frequencies
+in the table are specified in Mhz.
+.Bd -filled -offset indent
+.Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan "
+.Em "Channel ID        FCC     ETSI    France  Japan"
+1      2412    2412    -       -
+2      2417    2417    -       -
+3      2422    2422    -       -
+4      2427    2427    -       -
+5      2432    2432    -       -
+6      2437    2437    -       -
+7      2442    2442    -       -
+8      2447    2447    -       -
+9      2452    2452    -       -
+10     2457    2457    2457    -
+11     2462    2462    2462    -
+12     -       2467    2467    -
+13     -       2472    2472    -
+14     -       -       -       2484
+.El
+.Ed
+.Pp
+If an illegal channel is specified, the
+NIC will revert to its default channel. For NICs sold in the United States
+and Europe, the default channel is 3. For NICs sold in France, the default
+channel is 11. For NICs sold in Japan, the only available channel is 14.
+Note that two stations must be set to the same channel in order to
+communicate.
+.It Fl P Ar 0|1
+Enable or disable power management on a given interface. Enabling
+power management uses an alternating sleep/wake protocol to help
+conserve power on mobile stations, at the cost of some increased
+receive latency. Power management is off by default. Note that power
+management requires the cooperation of an access point in order to
+function; it is not functional in ad-hoc mode. Also, power management
+is only implemented in Lucent WavePOINT firmware version 2.03 or
+later, and in WaveLAN PCMCIA adapter firmware 2.00 or later. Older
+revisions will silently ignore the power management setting. Legal
+values for this parameter are 0 (off) and 1 (on).
+.It Fl S Ar max sleep interval
+Specify the sleep interval to use when power management is enabled.
+The
+.Are max sleep interval
+is specified in milliseconds. The default is 100.
+.El
+.Sh SEE ALSO
+.Xr awi 4 ,
+.Xr wi 4 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+command first appeared in
+.Fx 3.0 ,
+as wicontrol(8).  It was added to
+.Nx 1.5
+under its present name.
+.Sh AUTHOR
+The
+.Nm
+command was written by
+.An Bill Paul Aq wpaul%ctr.columbia.edu@localhost .