tools/tools/ath/athrd/athrd.1

   1 .\"-
   2 .\" Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
   3 .\" All rights reserved.
   4 .\""
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer,
  10 .\"    without modification.
  11 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12 .\"    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  13 .\"    redistribution must be conditioned upon including a substantially
  14 .\"    similar Disclaimer requirement for further binary redistribution.
  15 .\"
  16 .\" NO WARRANTY
  17 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 .\" LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  20 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  21 .\" THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  22 .\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27 .\" THE POSSIBILITY OF SUCH DAMAGES.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"/
  31 .Dd January 27, 2009
  32 .Dt ATHRD 1
  33 .Os
  34 .Sh NAME
  35 .Nm athrd
  36 .Nd list channels and transmit power for a country/regulatory domain
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl aedlpcfr4ABGT
  40 .Op Fl m Ar mode
  41 .Bk
  42 .Op Ar country
  43 .Ek
  44 .Sh DESCRIPTION
  45 .Nm
  46 displays the list of frequencies and the associated maximum transmit
  47 power permitted within a regulatory domain and/or country.
  48 .Pp
  49 If no command line options are given, a default country (\c
  50 .Ql US )
  51 is used.
  52 Country and regulatory names are case insensitive.
  53 .Pp
  54 The following options are available:
  55 .Bl -tag -width indent
  56 .It Fl a
  57 By default
  58 .Nm
  59 will display B channels only if they are not also marked as available for
  60 use as G channels and similary for A and T channels.
  61 With this option
  62 .Nm
  63 will list all channels.
  64 .It Fl e
  65 Calculate channels not assuming extended channel mode.
  66 .It Fl d
  67 Enabling debugging in the HAL code that calculates the available channels
  68 and transmit power values.
  69 .It Fl l
  70 Provide a list of all known country and regulatory domain names.
  71 .It Fl m Ar mode
  72 Calculate channels and transmit power for operation in
  73 .Ql mode ;
  74 one of
  75 .Ql station ,
  76 .Ql ibss ,
  77 .Ql monitor ,
  78 and
  79 .Ql ap
  80 (or the first two letters).
  81 .It Fl p
  82 Mark passive scan channels with lower case letters and active
  83 scan channels with upper case letters.
  84 .It Fl r
  85 Mark channels that require DFS with a
  86 .Ql * .
  87 .It Fl 4
  88 Mark channels that have a 4ms packet limit with a
  89 .Ql 4 .
  90 .It Fl c
  91 Display IEEE channel numbers instead of frequencies.
  92 .It Fl f
  93 Display frequencies (default).
  94 .It Fl A
  95 Display only 11A channels.
  96 .It Fl B
  97 Display only 11B channels.
  98 .It Fl G
  99 Display only 11G channels.
 100 .It Fl T
 101 Display only Turbo channels.
 102 .El
 103 .Sh EXAMPLES
 104 The following demonstrates how to list the permissible frequencies
 105 and maximum transport power per channel for use in Spain:
 106 .Pp
 107 .nf
 108 tubby% athrd es
 109 \&
 110 SPAIN (ES, 0x2d4, 724) NULL1_WORLD (0x3, 3)
 111 2412G 14.0 2417G 14.0 2422G 14.0 2427G 17.0 2432G 14.0 2437G 17.0
 112 2442G 14.0 2447G 17.0 2452G 17.0 2457G 14.0 2462G 17.0
 113 .fi
 114 .Pp
 115 Each frequency has a suffix that is one of:
 116 .Ql G ,
 117 .Ql B ,
 118 .Ql A ,
 119 or
 120 .Ql T
 121 according to whether the channel is usable with 802.11g, 802.11b,
 122 802.11a, or Atheros Turbo mode.
 123 All channels listed as
 124 .Ql G
 125 are also usable in
 126 .Ql B .
 127 Likewise, all channels listed as
 128 .Ql A
 129 are usable in
 130 .Ql T .
 131 Channels listed as
 132 .Ql B
 133 or
 134 .Ql T
 135 are only usable in those modes.
 136 (Note that when the
 137 .Fl p
 138 option is specified passive scan channels are marked with a lower case
 139 .Ql g ,
 140 .Ql b ,
 141 .Ql a ,
 142 or
 143 .Ql t .)
 144 The transmit power is given in units of dbM.
 145 .Sh DIAGNOSTICS
 146 Various diagnostics about unknown regulatory domains and/or country
 147 codes may be encountered.
 148 Use the
 149 .Fl l
 150 option for a list of valid names.
 151 .Sh SEE ALSO
 152 .Xr ath 4 ,
 153 .Xr ath_hal 4
 154 .Sh STANDARDS
 155 Lots belong here.
 156 .Sh NOTES
 157 .Nm
 158 use the HAL to calculate the set of channels.
 159 The transmit power calculations are done by emulating
 160 how the HAL works.
 161 Because
 162 .Nm
 163 does not
 164 read the actual EEPROM contents from a device this emulation may lag
 165 behind current practice.
 166 .Sh BUGS
 167 The HAL reset logic should be used to calculate the transmit power
 168 for each channel instead of using a separate copy of the code.
 169 The data presented by
 170 .Nm
 171 are the expected values; for compliance testing one must measure the actual
 172 operation of the driver and the HAL.