regdomain.1

Atheros wifi driver source code

.Dd January 10, 2004
.Dt REGDOMAIN 1
.Os
.Sh NAME
.Nm regdomain
.Nd list channels and transmit power for a country/regulatory domain
.Sh SYNOPSIS
.Nm
.Op Fl aioedlpcfABGT
.Op Fl m Ar mode
.Bk
.Op Ar country
.Ek
.Sh DESCRIPTION
.Nm
displays the list of frequencies and the associated maximum transmit
power permitted within a regulatory domain and/or country.
.Pp
If no command line options are given, a default country (\c
.Ql US )
is used.
Country and regulatory names are case insensitive.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl a
By default
.Nm
will display B channels only if they are not also marked as available for
use as G channels and similary for A and T channels.
With this option
.Nm
will list all channels.
.It Fl i
Calculate channels based on indoor use.
.It Fl o
Calculate channels based on outdoor use (default).
.It Fl e
Calculate channels not assuming extended channel mode.
.It Fl d
Enabling debugging in the HAL code that calculates the available channels
and transmit power values.
.It Fl l
Provide a list of all known country and regulatory domain names.
.It Fl m Ar mode
Calculate channels and transmit power for operation in
.Ql mode ;
one of
.Ql station ,
.Ql ibss ,
.Ql monitor ,
and
.Ql ap
(or the first two letters).
.It Fl p
Mark passive scan channels with lower case letters and active
scan channels with upper case letters.
.It Fl c
Display IEEE channel numbers instead of frequencies.
.It Fl f
Display frequencies (default).
.It Fl A
Display only 11A channels.
.It Fl B
Display only 11B channels.
.It Fl G
Display only 11G channels.
.It Fl T
Display only Turbo channels.
.El
.Sh EXAMPLES
The following demonstrates how to list the permissible frequencies
and maximum transport power per channel for use in Spain:
.Pp
.nf
tubby% regdomain es
\&
SPAIN (ES, 0x2d4, 724) NULL1_WORLD (0x3, 3)
2412G 14.0 2417G 14.0 2422G 14.0 2427G 17.0 2432G 14.0 2437G 17.0
2442G 14.0 2447G 17.0 2452G 17.0 2457G 14.0 2462G 17.0
.fi
.Pp
Each frequency has a suffix that is one of:
.Ql G ,
.Ql B ,
.Ql A ,
or
.Ql T 
according to whether the channel is usable with 802.11g, 802.11b,
802.11a, or Atheros Turbo mode.
All channels listed as 
.Ql G
are also usable in
.Ql B .
Likewise, all channels listed as
.Ql A
are usable in
.Ql T .
Channels listed as
.Ql B
or
.Ql T
are only usable in those modes.
(Note that when the
.Fl p
option is specified passive scan channels are marked with a lower case
.Ql g ,
.Ql b ,
.Ql a ,
or
.Ql t .)
The transmit power is given in units of dbM.
.Sh DIAGNOSTICS
Various diagnostics about unknown regulatory domains and/or country
codes may be encountered.
Use the
.Fl l
option for a list of valid names.
.Sh SEE ALSO
.Xr ath 4 ,
.Xr ath_hal 4
.Sh STANDARDS
Lots belong here.
.Sh NOTES
.Nm
use the HAL to calculate the set of channels.
The transmit power calculations are done by emulating
how the HAL works.
Because 
.Nm
does not
read the actual EEPROM contents from a device this emulation may lag
behind current practice.
.Sh BUGS
The HAL reset logic should be used to calculate the transmit power
for each channel instead of using a separate copy of the code.
The data presented by
.Nm
are the expected values; for compliance testing one must measure the actual
operation of the driver and the HAL.