1.\" $NetBSD: wiconfig.8,v 1.22 2002/02/06 19:07:27 wiz 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.Op Fl D 46.Bk -words 47.Op Fl e Ar 0|1 48.Ek 49.Bk -words 50.Oo 51.Fl k Ar key 52.Op Fl v Ar 1|2|3|4 53.Oc 54.Ek 55.Bk -words 56.Op Fl t Ar tx rate 57.Ek 58.Bk -words 59.Op Fl n Ar network name 60.Ek 61.Bk -words 62.Op Fl s Ar station name 63.Ek 64.Bk -words 65.Op Fl c Ar 0|1 66.Ek 67.Bk -words 68.Op Fl q Ar SSID 69.Ek 70.Bk -words 71.Op Fl p Ar port type 72.Ek 73.Bk -words 74.Op Fl a Ar access point density 75.Ek 76.Bk -words 77.Op Fl m Ar MAC address 78.Ek 79.Bk -words 80.Op Fl d Ar max data length 81.Ek 82.Bk -words 83.Op Fl r Ar RTS threshold 84.Ek 85.Bk -words 86.Op Fl f Ar frequency 87.Ek 88.Bk -words 89.Op Fl A Ar 0|1 90.Ek 91.Bk -words 92.Op Fl M Ar 0|1 93.Ek 94.Bk -words 95.Op Fl P Ar 0|1 96.Ek 97.Bk -words 98.Op Fl R Ar 1|3 99.Ek 100.Bk -words 101.Op Fl S Ar max sleep duration 102.Ek 103.Bk -words 104.Op Fl T Ar 1|2|3|4 105.Ek 106.Sh DESCRIPTION 107The 108.Nm 109command controls the operation of 110.Tn WaveLAN/IEEE 111wireless networking devices via the 112.Xr wi 4 113and 114.Xr awi 4 115drivers. 116The 117.Nm 118command can also be used to view the current settings of these parameters 119and to dump out the values of the card's statistics counters. 120.Pp 121Most of the parameters that can be changed relate to the 122.Tn IEEE 123802.11 protocol which the 124.Tn WaveLAN 125implements. 126This includes the station name, whether the station is operating 127in ad-hoc (point to point) or BSS (service set) mode, and the 128network name of a service set to join (IBSS) if BSS mode is enabled. 129.Pp 130The 131.Ar iface 132argument given to 133.Nm 134should be the logical interface name associated with the 135.Tn WaveLAN/IEEE 136device (e.g. wi0, wi1, etc.). 137.Sh OPTIONS 138With no extra options, 139.Nm 140will display the current settings of the specified 141.Tn WaveLAN/IEEE 142interface. 143.Pp 144The options are as follows: 145.Pp 146.Bl -tag -width Fl 147.It Fl o 148Print out the statistics counters instead of the card settings. 149Note that, however, the statistics will only be updated every minute or so. 150.It Fl D 151This forces the driver to initiate one round of access point scanning. 152All of the access points found are displayed. 153.It Fl e Ar 0|1 154Enable or disable Wired Equivalent Privacy (WEP) encryption. 155Permitted values are 156.Ar 0 157(encryption disabled) or 158.Ar 1 159(encryption enabled). 160Encryption is off by default. 161.It Fl k Ar key Xo 162.Op Fl v Ar 1|2|3|4 163.Xc 164Set WEP encryption keys. 165There are four default encryption keys that can be programmed. 166A specific key can be set using the 167.Fl v 168flag. 169If the 170.Fl v 171flag is not specified, the first key will be set. 172.Pp 173Encryption keys can either 174be 175.Tn ASCII 176text (e.g. "hello") or a series of hexadecimal digits (e.g. "0x1234512345"). 177.Pp 178For WaveLAN Silver cards, the key is 179restricted to 40 bits, hence the key can be either a 5-character text string 180or 10 hexadecimal digits. 181For WaveLAN Gold cards, the key can be up to 182104 bits, which means the key can be specified as either a 13-character 183text string or 26 hexadecimal digits. 184.Pp 185The key will be combined with the 18624-bit IV to consist the seed for RC4 in either case. 187.It Fl T Ar 1|2|3|4 188Specify which of the four WEP encryption keys will be used to encrypt 189transmitted packets. 190.It Fl t Ar tx rate 191Set the transmit rate of the specified interface. 192The legal values for the transmit rate vary depending on whether 193the interface is a standard 194.Tn WaveLAN/IEEE 195or a 196.Tn WaveLAN/IEEE 197Turbo adapter. 198The standard NICs support a maximum transmit rate of 2Mbps while 199the turbo NICs support a maximum speed of 6Mbps. 200The following table shows the legal transmit rate settings and the 201corresponding transmit speeds: 202.Bd -filled -offset indent 203.Bl -column "TX rate " "NIC speed " 204.Em "TX rate NIC speed" 2051 Fixed Low (1Mbps) 2062 Fixed Standard (2Mbps) 2073 Auto Rate Select (High) 2084 Fixed Medium (4Mbps) 2095 Fixed High (6Mbps) 2106 Auto Rate Select (Standard) 2117 Auto Rate Select (Medium) 21211 Fixed Turbo (11Mbps) 213.El 214.Ed 215.Pp 216The standard NICs support only settings 1 through 3. Turbo NICs support 217all the above listed speed settings. 218The default driver setting is 3 (auto rate select). 219.It Fl n Ar network name 220Set the name of the service set (IBSS) that this station wishes to 221join. The 222.Ar network name 223can be any text string up to 30 characters in length. 224The default name is the empty string which should allow the station 225to connect to the first available access point. 226The interface should be set for BSS mode using the 227.Fl p 228flag in order for this to work. 229.It Fl s Ar station name 230Sets the 231.Ar station name 232for the specified interface. The 233.Ar station name 234is used for diagnostic purposes. 235The 236.Tn Lucent 237.Tn WaveMANAGER 238software can poll the names of remote hosts. 239.It Fl c Ar 0|1 240[Lucent only] Allow the station to create a service set (IBSS). 241Permitted values are 0 (don't create IBSS) and 1 (enable creation of IBSS). 242The default is 0. 243.Pp 244This option requires 245.Tn WaveLAN 246firmware revision 6.04 or later to work. 247.It Fl q Ar SSID 248Specify the name of an IBSS (SSID) to create on a given interface. 249The 250.Ar SSID 251can be any text string up to 30 characters long. 252.Pp 253This option requires 254.Tn WaveLAN 255firmware revision 6.04 or later to work. 256.It Fl p Ar port type 257Set the 258.Ar port type 259for a specified interface. The legal values for 260.Ar port type 261are 1 (BSS mode) and 3 (ad-hoc) mode. 262The default setting is 1 (BSS mode). 263.Pp 264In ad-hoc mode, the station can communicate directly with any other 265stations within direct radio range (provided that they are also 266operating in ad-hoc mode). 267.Pp 268In BSS mode, hosts must associate with a service set controlled by 269an access point, which relays traffic between end stations. 270.It Fl a Ar access_point_density 271Specify the 272.Ar access point density 273for a given interface. Legal values are 1 (low), 2 (medium) and 3 (high). 274This setting influences some of the radio modem threshold settings. 275.It Fl m Ar MAC address 276Set the station address for the specified interface. The 277.Ar MAC address 278is specified as a series of six hexadecimal values separated by colons, 279e.g. 00:60:1d:12:34:56. 280This programs the new address into the card and updates the interface as well. 281.It Fl d Ar max_data_length 282Set the maximum receive and transmit frame size for a specified interface. 283The 284.Ar max data length 285can be any number from 256 to 2346. The default is 2304. 286.It Fl r Ar RTS threshold 287Set the RTS/CTS threshold for a given interface. This controls the 288number of bytes used for the RTS/CTS handshake boundary. The 289.Ar RTS threshold 290can be any value between 0 and 2347. The default is 2347, 291which indicates RTS/CTS mechanism never to be used. 292.It Fl f Ar frequency 293Set the radio frequency of a given interface. The 294.Ar frequency 295should be specified as a channel ID as shown in the table below. The 296list of available frequencies is dependent on radio regulations specified 297by regional authorities. Recognized regulatory authorities include 298the FCC (United States), ETSI (Europe), France and Japan. Frequencies 299in the table are specified in MHz. 300.Bd -filled -offset indent 301.Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " 302.Em "Channel ID FCC ETSI France Japan" 3031 2412 2412 - 2412 3042 2417 2417 - 2417 3053 2422 2422 - 2422 3064 2427 2427 - 2427 3075 2432 2432 - 2432 3086 2437 2437 - 2437 3097 2442 2442 - 2442 3108 2447 2447 - 2447 3119 2452 2452 - 2452 31210 2457 2457 2457 2457 31311 2462 2462 2462 2462 31412 - 2467 2467 2467 31513 - 2472 2472 2472 31614 - - - 2484 317.El 318.Ed 319.Pp 320If an illegal channel is specified, the NIC will revert to its default channel. 321.Pp 322For NICs sold in the United States and Europe, the default channel is 3. 323.Pp 324For NICs sold in France, the default channel is 11. 325.Pp 326For NICs sold in Japan, the default channel is 14, and it is the 327only available channel for pre-11Mbps NICs. 328.Pp 329Note that two stations must be set to the same channel in order to 330communicate. 331.It Fl A Ar 0|1 332[Prism2 only] Sets the authentication type for a given interface. 333Permitted values are 334.Ar 1 335(Open System Authentication) or 336.Ar 2 337(Shared Key Authentication). The default is 1. 338.Pp 339Note: It is not valid to enable Shared Key Authentication 340when no valid WEP keys have been defined. 341.It Fl M Ar 0|1 342Enable or disable 343.Qq microwave oven robustness 344on a given interface. 345.It Fl P Ar 0|1 346Enable or disable power management on a given interface. Enabling 347power management uses an alternating sleep/wake protocol to help 348conserve power on mobile stations, at the cost of some increased 349receive latency. Power management is off by default. 350.Pp 351Power management requires the cooperation of an access point in 352order to function; it is not functional in ad-hoc mode. 353.Pp 354Power management 355is only implemented in Lucent WavePOINT firmware version 2.03 or 356later, and in WaveLAN PCMCIA adapter firmware 2.00 or later. Older 357revisions will silently ignore the power management setting. Legal 358values for this parameter are 0 (off) and 1 (on). 359.It Fl R Ar 1|3 360Enable or disable roaming function on a given interface. 361The legal values are 362.Ar 1 363(Roaming handled by firmware) and 364.Ar 3 365(Roaming Disabled). The default is 1. 366.It Fl S Ar max sleep interval 367Specify the sleep interval to use when power management is enabled. 368The 369.Ar max sleep interval 370is specified in milliseconds. The default is 100. 371.El 372.Sh SEE ALSO 373.Xr awi 4 , 374.Xr wi 4 , 375.Xr ifconfig 8 376.Sh HISTORY 377The 378.Nm 379command first appeared in 380.Fx 3.0 , 381as 382.Ic wicontrol . 383It was added to 384.Nx 1.5 385under its present name. 386.Sh AUTHORS 387The 388.Nm 389command was written by 390.An Bill Paul Aq wpaul@ctr.columbia.edu . 391