1.\" $NetBSD: wiconfig.8,v 1.16 2001/11/21 22:29:20 enami Exp $ 2.\" 3.\" Copyright (c) 1997, 1998, 1999 4.\" Bill Paul <wpaul@ctr.columbia.edu> All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following 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.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by Bill Paul. 17.\" 4. Neither the name of the author nor the names of any co-contributors 18.\" may be used to endorse or promote products derived from this software 19.\" without specific prior written permission. 20.\" 21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 31.\" THE POSSIBILITY OF SUCH DAMAGE. 32.\" 33.\" From: wicontrol.8,v 1.6 1999/05/22 16:12:47 wpaul Exp $ 34.\" 35.Dd January 11, 2001 36.Dt WICONFIG 8 37.Os 38.Sh NAME 39.Nm wiconfig 40.Nd configure WaveLAN/IEEE devices 41.Sh SYNOPSIS 42.Nm wiconfig 43.Ar interface 44.Op Fl o 45.Bk -words 46.Op Fl e Ar 0|1 47.Ek 48.Bk -words 49.Oo 50.Fl k Ar key 51.Op Fl v Ar 1|2|3|4 52.Oc 53.Ek 54.Bk -words 55.Op Fl t Ar tx rate 56.Ek 57.Bk -words 58.Op Fl n Ar network name 59.Ek 60.Bk -words 61.Op Fl s Ar station name 62.Ek 63.Bk -words 64.Op Fl c Ar 0|1 65.Ek 66.Bk -words 67.Op Fl q Ar SSID 68.Ek 69.Bk -words 70.Op Fl p Ar port type 71.Ek 72.Bk -words 73.Op Fl a Ar access point density 74.Ek 75.Bk -words 76.Op Fl m Ar MAC address 77.Ek 78.Bk -words 79.Op Fl d Ar max data length 80.Ek 81.Bk -words 82.Op Fl r Ar RTS threshold 83.Ek 84.Bk -words 85.Op Fl f Ar frequency 86.Ek 87.Bk -words 88.Op Fl A Ar 0|1 89.Ek 90.Bk -words 91.Op Fl M Ar 0|1 92.Ek 93.Bk -words 94.Op Fl P Ar 0|1 95.Ek 96.Bk -words 97.Op Fl R Ar 1|3 98.Ek 99.Bk -words 100.Op Fl S Ar max sleep duration 101.Ek 102.Bk -words 103.Op Fl T Ar 1|2|3|4 104.Ek 105.Sh DESCRIPTION 106The 107.Nm 108command controls the operation of WaveLAN/IEEE wireless networking 109devices via the 110.Xr wi 4 111and 112.Xr awi 4 113drivers. Most of the parameters that can be changed relate to the 114IEEE 802.11 protocol which the WaveLAN implements. This includes 115the station name, whether the station is operating in ad-hoc (point 116to point) or BSS (service set) mode, and the network name of a service 117set to join (IBSS) if BSS mode is enabled. The 118.Nm 119command can also be used to view the current settings of these parameters 120and to dump out the values of the card's statistics counters. 121.Pp 122The 123.Ar iface 124argument given to 125.Nm 126should be the logical interface name associated with the WaveLAN/IEEE 127device (wi0, wi1, etc...). 128.Sh OPTIONS 129With no extra options, 130.Nm 131will display the current settings of the specified WaveLAN/IEEE interface. 132.Pp 133The options are as follows: 134.Pp 135.Bl -tag -width Fl 136.It Fl o 137Print out the statistics counters instead of the card settings. 138Note that, however, the statictics will only be updated every 1 minutes or so. 139.It Fl e Ar 0|1 140Enable or disable WEP encryption. Permitted values are 141.Ar 0 142(encryption disabled) or 143.Ar 1 144(encryption enabled). Encryption is off by default. 145.It Fl k Ar key Xo 146.Op Fl v Ar 1|2|3|4 147.Xc 148Set WEP encryption keys. There are four default encryption keys that can be 149programmed. A specific key can be set using the 150.Fl v 151flag. If the 152.Fl v 153flag is not specified, the first key will be set. Encryption keys can either 154be normal text (i.e., "hello") or a series of hexadecimal digits 155(i.e., "0x1234512345"). For WaveLAN Silver cards, the key is 156restricted to 40 bits, hence the key can be either a 5-character text string 157or 10 hexadecimal digits. For WaveLAN Gold cards, the key can be up to 158104 bits, which means the key can be specified as either a 13-character 159text string or 26 hexadecimal digits. The key will be combined with the 16024-bit IV to consist the seed for RC4 in either case. 161.It Fl T Ar 1|2|3|4 162Specify which of the four WEP encryption keys will be used to encrypt 163transmitted packets. 164.It Fl t Ar tx rate 165Set the transmit rate of the specified interface. The legal values 166for the transmit rate vary depending on whether the interface is a 167standard WaveLAN/IEEE or a WaveLAN/IEEE Turbo adapter. The standard 168NICs support a maximum transmit rate of 2Mbps while the turbo NICs 169support a maximum speed of 6Mbps. The following table shows the 170legal transmit rate settings and the corresponding transmit speeds: 171.Bd -filled -offset indent 172.Bl -column "TX rate " "NIC speed " 173.Em "TX rate NIC speed" 1741 Fixed Low (1Mbps) 1752 Fixed Standard (2Mbps) 1763 Auto Rate Select (High) 1774 Fixed Medium (4Mbps) 1785 Fixed High (6Mbps) 1796 Auto Rate Select (Standard) 1807 Auto Rate Select (Medium) 18111 Fixed Turbo (11Mbps) 182.El 183.Ed 184.Pp 185The standard NICs support only settings 1 through 3. Turbo NICs support 186all the above listed speed settings. 187The default driver setting is 3 (auto rate select). 188.It Fl n Ar network name 189Set the name of the service set (IBSS) that this station wishes to 190join. The 191.Ar network name 192can be any text string up to 30 characters in length. The default name 193is the empty string which should allow the station to connect to the first 194available access point. The interface should be set for BSS mode using 195the 196.Fl p 197flag in order for this to work. 198.It Fl s Ar station name 199Sets the 200.Ar station name 201for the specified interface. The 202.Ar station name 203is used for diagnostic purposes. The Lucent WaveMANAGER software can 204poll the names of remote hosts. 205.It Fl c Ar 0|1 206[Lucent only] Allow the station to create a service set (IBSS). Permitted values 207are 0 (don't create IBSS) and 1 (enable creation of IBSS). The default 208is 0. 209.Pp 210Note: this option is provided for experimental purposes only: enabling 211the creation of an IBSS on a host system doesn't appear to actually work. 212.It Fl q Ar SSID 213Specify the name of an IBSS (SSID) to create on a given interface. 214The 215.Ar SSID 216can be any text string up to 30 characters long. 217.Pp 218Note: this option is provided for experimental purposes only: enabling 219the creation of an IBSS on a host system doesn't appear to actually work. 220.It Fl p Ar port type 221Set the 222.Ar port type 223for a specified interface. The legal values for 224.Ar port type 225are 1 (BSS mode) and 3 (ad-hoc) mode. In ad-hoc mode, the station can 226communicate directly with any other stations within direct radio range 227(provided that they are also operating in ad-hoc mode). In BSS mode, 228hosts must associate with a service set controlled by an access point, 229which relays traffic between end stations. The default setting is 1 230(BSS mode). 231.It Fl a Ar access_point_density 232Specify the 233.Ar access point density 234for a given interface. Legal values are 1 (low), 2 (medium) and 3 (high). 235This setting influences some of the radio modem threshold settings. 236.It Fl m Ar MAC address 237Set the station address for the specified interface. The 238.Ar MAC address 239is specified as a series of six hexadecimal values separated by colons, 240e.g.: 00:60:1d:12:34:56. This programs the new address into the card 241and updates the interface as well. 242.It Fl d Ar max_data_length 243Set the maximum receive and transmit frame size for a specified interface. 244The 245.Ar max data length 246can be any number from 350 to 2304. The default is 2304. 247.It Fl r Ar RTS threshold 248Set the RTS/CTS threshold for a given interface. This controls the 249number of bytes used for the RTS/CTS handshake boundary. The 250.Ar RTS threshold 251can be any value between 0 and 2047. The default is 2347. 252.It Fl f Ar frequency 253Set the radio frequency of a given interface. The 254.Ar frequency 255should be specified as a channel ID as shown in the table below. The 256list of available frequencies is dependent on radio regulations specified 257by regional authorities. Recognized regulatory authorities include 258the FCC (United States), ETSI (Europe), France and Japan. Frequencies 259in the table are specified in Mhz. 260.Bd -filled -offset indent 261.Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " 262.Em "Channel ID FCC ETSI France Japan" 2631 2412 2412 - 2412 2642 2417 2417 - 2417 2653 2422 2422 - 2422 2664 2427 2427 - 2427 2675 2432 2432 - 2432 2686 2437 2437 - 2437 2697 2442 2442 - 2442 2708 2447 2447 - 2447 2719 2452 2452 - 2452 27210 2457 2457 2457 2457 27311 2462 2462 2462 2462 27412 - 2467 2467 2467 27513 - 2472 2472 2472 27614 - - - 2484 277.El 278.Ed 279.Pp 280If an illegal channel is specified, the 281NIC will revert to its default channel. For NICs sold in the United States 282and Europe, the default channel is 3. For NICs sold in France, the default 283channel is 11. For NICs sold in Japan, the default channel is 14, and 284it is the only available channel for pre-11Mbps NICs. 285Note that two stations must be set to the same channel in order to 286communicate. 287.It Fl A Ar 0|1 288[Prism2 only] Sets the authentication type for a given interface. 289Permitted values are 290.Ar 1 291(Open System Authentication) or 292.Ar 2 293(Shared Key Authentication). The default is 1. 294.Pp 295Note: It is not valid to enable Shared Key Authentication 296when no valid WEP keys have been defined. 297.It Fl M Ar 0|1 298Enable or disable 299.Dq microwave oven robustness 300on a given interface. 301.It Fl P Ar 0|1 302Enable or disable power management on a given interface. Enabling 303power management uses an alternating sleep/wake protocol to help 304conserve power on mobile stations, at the cost of some increased 305receive latency. Power management is off by default. Note that power 306management requires the cooperation of an access point in order to 307function; it is not functional in ad-hoc mode. Also, power management 308is only implemented in Lucent WavePOINT firmware version 2.03 or 309later, and in WaveLAN PCMCIA adapter firmware 2.00 or later. Older 310revisions will silently ignore the power management setting. Legal 311values for this parameter are 0 (off) and 1 (on). 312.It Fl R Ar 1|3 313Enable or disable roaming function on a given interface. 314The legal values are 315.Ar 1 316(Roaming handled by firmware) and 317.Ar 3 318(Roaming Disabled). The default is 1. 319.It Fl S Ar max sleep interval 320Specify the sleep interval to use when power management is enabled. 321The 322.Ar max sleep interval 323is specified in milliseconds. The default is 100. 324.El 325.Sh SEE ALSO 326.Xr awi 4 , 327.Xr wi 4 , 328.Xr ifconfig 8 329.Sh HISTORY 330The 331.Nm 332command first appeared in 333.Fx 3.0 , 334as 335.Ic wicontrol . 336It was added to 337.Nx 1.5 338under its present name. 339.Sh AUTHOR 340The 341.Nm 342command was written by 343.An Bill Paul Aq wpaul@ctr.columbia.edu . 344