usr.sbin/wicontrol/wicontrol.8

   1 .\" Copyright (c) 1997, 1998, 1999
   2 .\"     Bill Paul <wpaul@ctr.columbia.edu> All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd April 21, 1999
  34 .Dt WICONTROL 8
  35 .Os FreeBSD 3.0
  36 .Sh NAME
  37 .Nm wicontrol
  38 .Nd configure WaveLAN/IEEE devices
  39 .Sh SYNOPSIS
  40 .Nm wicontrol
  41 .Fl i Ar iface Op Fl o
  42 .Nm wicontrol
  43 .Fl i Ar iface Fl t Ar tx rate
  44 .Nm wicontrol
  45 .Fl i Ar iface Fl n Ar network name
  46 .Nm wicontrol
  47 .Fl i Ar iface Fl s Ar station name
  48 .Nm wicontrol
  49 .Fl i Ar iface Fl c Ar 0|1
  50 .Nm wicontrol
  51 .Fl i Ar iface Fl q Ar SSID
  52 .Nm wicontrol
  53 .Fl i Ar iface Fl p Ar port type
  54 .Nm wicontrol
  55 .Fl i Ar iface Fl a Ar access point density
  56 .Nm wicontrol
  57 .Fl i Ar iface Fl m Ar mac address
  58 .Nm wicontrol
  59 .Fl i Ar iface Fl d Ar max data length
  60 .Nm wicontrol
  61 .Fl i Ar iface Fl r Ar RTS threshold
  62 .Nm wicontrol
  63 .Fl i Ar iface Fl f Ar frequency
  64 .Nm wicontrol
  65 .Fl i Ar iface Fl P Ar 0|1
  66 .Nm wicontrol
  67 .Fl i Ar iface Fl S Ar max_sleep_duration
  68 .Nm wicontrol
  69 .Fl i Ar iface Fl Z (zero signal cache)
  70 .Nm wicontrol
  71 .Fl i Ar iface Fl C (display signal cache)
  72 .Sh DESCRIPTION
  73 The
  74 .Nm
  75 command controls the operation of WaveLAN/IEEE wireless networking
  76 devices via the
  77 .Xr wi 4
  78 driver. Most of the parameters that can be changed relate to the
  79 IEEE 802.11 protocol which the WaveLAN implements. This includes
  80 the station name, whether the station is operating in ad-hoc (point
  81 to point) or BSS (service set) mode, and the network name of a service
  82 set to join (IBSS) if BSS mode is enabled. The
  83 .Nm
  84 command can also be used to view the current settings of these parameters
  85 and to dump out the values of the card's statistics counters.
  86 .Pp
  87 The
  88 .Ar iface
  89 argument given to
  90 .Nm
  91 should be the logical interface name associated with the WaveLAN/IEEE
  92 device (wi0, wi1, etc...).
  93 .Sh OPTIONS
  94 The options are as follows:
  95 .Bl -tag -width Fl
  96 .It Fl i Ar iface Op Fl o
  97 Display the current settings of the specified WaveLAN/IEEE interface.
  98 This retrieves the current card settings from the driver and prints them
  99 out. Using the additional
 100 .Fl o
 101 flag will cause
 102 .Nm
 103 to print out the statistics counters instead of the card settings.
 104 .It Fl i Ar iface Fl t Ar tx rate
 105 Set the transmit rate of the specified interface. The legal values
 106 for the transmit rate vary depending on whether the interface is a
 107 standard WaveLAN/IEEE or a WaveLAN/IEEE Turbo adapter. The standard
 108 NICs support a maximum transmit rate of 2Mbps while the turbo NICs
 109 support a maximum speed of 6Mbps. The following table shows the
 110 legal transmit rate settings and the corresponding transmit speeds:
 111 .Bd -filled -offset indent
 112 .Bl -column "TX rate " "NIC speed "
 113 .Em "TX rate    NIC speed"
 114 1       Fixed Low (1Mbps)
 115 2       Fixed Standard (2Mbps)
 116 3       Auto Rate Select (High)
 117 4       Fixed Medium (4Mbps)
 118 5       Fixed High (6Mbps)
 119 6       Auto Rate Select (Standard)
 120 7       Auto Rate Select (Medium)
 121 .El
 122 .Ed
 123 .Pp
 124 The standard NICs support only settings 1 through 3. Turbo NICs support
 125 all the above listed speed settings.
 126 The default driver setting is 3 (auto rate select).
 127 .It Fl i Ar iface Fl n Ar network name
 128 Set the name of the service set (IBSS) that this station wishes to
 129 join. The
 130 .Ar network name
 131 can be any text string up to 30 characters in length. The default name
 132 is the string "ANY" which should allow the station to connect to the first
 133 available access point. The interface should be set for BSS mode using
 134 the
 135 .Fl p
 136 flag in order for this to work.
 137 .Pp
 138 Note: the WaveLAN manual indicates that an empty string will allow the
 139 host to connect to any access point, however I have also seen a reference
 140 in another driver which indicates that the "ANY" string works as well.
 141 .It Fl i Ar iface Fl s Ar station name
 142 Sets the
 143 .Ar station name
 144 for the specified interface. The
 145 .Ar station name
 146 is used for diagnostic purposes. The Lucent WaveMANAGER software can
 147 poll the names of remote hosts.
 148 .It Fl i Ar iface Fl c Ar 0|1
 149 Allow the station to create a service set (IBSS). Permitted values
 150 are 0 (don't create IBSS) and 1 (enable creation of IBSS). The default
 151 is 0.
 152 .Pp
 153 Note: this option is provided for experimental purposes only: enabling
 154 the creation of an IBSS on a host system doesn't appear to actually work.
 155 .It Fl i Ar iface Fl q Ar SSID
 156 Specify the name of an IBSS (SSID) to create on a given interface.
 157 The
 158 .Ar SSID
 159 can be any text string up to 30 characters long.
 160 .Pp
 161 Note: this option is provided for experimental purposes only: enabling
 162 the creation of an IBSS on a host system doesn't appear to actually work.
 163 .It Fl i Ar iface Fl p Ar port type
 164 Set the
 165 .Ar port type
 166 for a specified interface. The legal values for
 167 .Ar port type
 168 are 1 (BSS mode) and 3 (ad-hoc) mode. In ad-hoc mode, the station can
 169 communicate directly with any other stations within direct radio range
 170 (provided that they are also operating in ad-hoc mode). In BSS mode,
 171 hosts must associate with a service set controlled by an access point,
 172 which relays traffic between end stations. The default setting is 3
 173 (ad-hoc mode).
 174 .It Fl i Ar iface Fl a Ar access_point_density
 175 Specify the
 176 .Ar access point density
 177 for a given interface. Legal values are 1 (low), 2 (medium) and 3 (high).
 178 This setting influences some of the radio modem threshold settings.
 179 .It Fl i Ar iface Fl m Ar mac address
 180 Set the station address for the specified interface. The
 181 .Ar mac address
 182 is specified as a series of six hexadecimal values separated by colons,
 183 e.g.: 00:60:1d:12:34:56. This programs the new address into the card
 184 and updates the interface as well.
 185 .It Fl i Ar iface Fl d Ar max_data_length
 186 Set the maximum receive and transmit frame size for a specified interface.
 187 The
 188 .Ar max data length
 189 can be any number from 350 to 2304. The default is 2304.
 190 .It Fl i Ar iface Fl r Ar RTS threshold
 191 Set the RTS/CTS threshold for a given interface. This controls the
 192 number of bytes used for the RTS/CTS handshake boundary. The
 193 .Ar RTS threshold
 194 can be any value between 0 and 2047. The default is 2347.
 195 .It Fl i Ar iface Fl f Ar frequency
 196 Set the radio frequency of a given interface. The
 197 .Ar frequency
 198 should be specified as a channel ID as shown in the table below. The
 199 list of available frequencies is dependent on radio regulations specified
 200 by regional authorities. Recognized regulatory authorities include
 201 the FCC (United States), ETSI (Europe), France and Japan. Frequencies
 202 in the table are specified in Mhz.
 203 .Bd -filled -offset indent
 204 .Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan "
 205 .Em "Channel ID FCC     ETSI    France  Japan"
 206 1       2412    2412    -       -
 207 2       2417    2417    -       -
 208 3       2422    2422    -       -
 209 4       2427    2427    -       -
 210 5       2432    2432    -       -
 211 6       2437    2437    -       -
 212 7       2442    2442    -       -
 213 8       2447    2447    -       -
 214 9       2452    2452    -       -
 215 10      2457    2457    2457    -
 216 11      2462    2462    2462    -
 217 12      -       2467    2467    -
 218 13      -       2472    2472    -
 219 14      -       -       -       2484
 220 .El
 221 .Ed
 222 .Pp
 223 If an illegal channel is specified, the
 224 NIC will revert to its default channel. For NICs sold in the United States
 225 and Europe, the default channel is 3. For NICs sold in France, the default
 226 channel is 11. For NICs sold in Japan, the only available channel is 14.
 227 Note that two stations must be set to the same channel in order to
 228 communicate.
 229 .It Fl i Ar iface Fl P Ar 0|1
 230 Enable or disable power management on a given interface. Enabling
 231 power management uses an alternating sleep/wake protocol to help
 232 conserve power on mobile stations, at the cost of some increased
 233 receive latency. Power management is off by default. Note that power
 234 management requires the cooperation of an access point in order to
 235 function; it is not functional in ad-hoc mode. Also, power management
 236 is only implemented in Lucent WavePOINT firmware version 2.03 or
 237 later, and in WaveLAN PCMCIA adapter firmware 2.00 or later. Older
 238 revisions will silently ignore the power management setting. Legal
 239 values for this parameter are 0 (off) and 1 (on).
 240 .It Fl i Ar iface Fl S Ar max_sleep_interval
 241 Specify the sleep interval to use when power management is enabled.
 242 The
 243 .Are max sleep interval
 244 is specified in milliseconds. The default is 100.
 245 .It Fl i Ar iface Fl Z
 246 Clear the signal strength cache maintained internally by the
 247 .Nm wi
 248 driver.
 249 .It Fl i Ar iface Fl C
 250 Display the cached signal strength information maintained by the
 251 .Nm wi
 252 driver. The driver retains information about signal strength and
 253 noise level for packets received from different hosts. The signal
 254 strength and noise level values are displayed in units of dBms.
 255 The signal quality values is produced by subtracting the noise level
 256 from the signal strength (i.e. less noise and better signal yields
 257 better signal quality).
 258 .El
 259 .Sh SEE ALSO
 260 .Xr wi 4 ,
 261 .Xr ifconfig 8
 262 .Sh HISTORY
 263 The
 264 .Nm
 265 command first appeared in
 266 .Fx 3.0 .
 267 .Sh AUTHORS
 268 The
 269 .Nm
 270 command was written by
 271 .An Bill Paul Aq wpaul@ctr.columbia.edu .