usr.sbin/wlandebug/wlandebug.8

   1 .\" Copyright (c) 2007 Sam Leffler, Errno Consulting
   2 .\" 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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .Dd August 17, 2015
  26 .Dt WLANDEBUG 8
  27 .Os
  28 .Sh NAME
  29 .Nm wlandebug
  30 .Nd "set/query 802.11 wireless debugging messages"
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl d | Fl i Ar ifnet
  34 .Op Fl flag|+flag Ar ...
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 command is a tool for enabling and disabling
  39 debugging messages in the
  40 .Xr wlan 4
  41 module.
  42 Running
  43 .Nm
  44 without any options will display the current messages
  45 enabled for the specified network interface
  46 (by default, ``wlan0').
  47 The default debugging level for new interfaces can be set
  48 by specifying the
  49 .Fl d
  50 option.
  51 When run as the super-user
  52 .Nm
  53 can be used to enable and/or disable debugging messages.
  54 .Pp
  55 To enable debugging messages of a certain
  56 .Ar type
  57 use
  58 .Ar +type ;
  59 to disable such messages use
  60 .Ar -type .
  61 Multiple messages can be enabled and disabled with a single command.
  62 .Pp
  63 Messages are organized in the following groups:
  64 .Bl -tag -width ".Ar dumppkts"
  65 .It Ar debug
  66 general debugging facilities; equivalent to setting the debug
  67 parameter with
  68 .Xr ifconfig 8 .
  69 .It Ar dumppkts
  70 dump packet contents on transmit and receive.
  71 .It Ar crypto
  72 crypto-related work.
  73 .It Ar input
  74 errors encountered during input handling.
  75 .It Ar xrate
  76 extended rate set handling (for 802.11g).
  77 .It Ar elemid
  78 information element processing in 802.11 management frames.
  79 .It Ar node
  80 management of per-station state.
  81 .It Ar assoc
  82 802.11 station association processing; particularly useful to
  83 see when stations join and leave a BSS.
  84 .It Ar auth
  85 802.11 station authentication processing.
  86 .It Ar scan
  87 scanning operation; especially useful for debugging problems
  88 with not locating an access point.
  89 .It Ar output
  90 errors encountered during output handling.
  91 .It Ar state
  92 .Xr wlan 4
  93 state machine operation.
  94 .It Ar power
  95 802.11 power save operation; in hostap mode this enables
  96 copious information about buffered frames for stations operating
  97 in power save mode.
  98 .It Ar hwmp
  99 trace operation of Hybrid Wireless Mesh Protocol processing.
 100 .It Ar dot1xsm
 101 802.1x state machine operation; not presently meaningful as 802.1x protocol
 102 support is implemented in user mode by the
 103 .Xr hostapd 8
 104 program.
 105 .It Ar radius
 106 radius backend operation as it relates to 802.1x operation;
 107 not presently meaningful as 802.1x protocol
 108 support is implemented in user mode by the
 109 .Xr hostapd 8
 110 program.
 111 .It Ar raddump
 112 dump packets exchanged with the radius backend for 802.1x operation;
 113 not presently meaningful as 802.1x protocol
 114 support is implemented in user mode by the
 115 .Xr hostapd 8
 116 program.
 117 .It Ar mesh
 118 trace operation of 802.11s mesh protocol processing.
 119 .It Ar wpa
 120 trace operation of the WPA protocol;
 121 only partly meaningful as WPA protocol
 122 support is mostly implemented in user mode by the
 123 .Xr hostapd 8
 124 and
 125 .Xr wpa_supplicant 8
 126 programs.
 127 .It Ar acl
 128 trace operation of the Access Control List (ACL) support; see
 129 .Xr wlan_acl 4
 130 for more details.
 131 .It Ar wme
 132 trace operation of WME/WMM protocol processing.
 133 .It Ar superg
 134 trace operation of Atheros SuperG protocol processing.
 135 .It Ar doth
 136 trace operation of IEEE 802.11h protocol processing.
 137 .It Ar inact
 138 trace station inactivity processing; in particular,
 139 show when stations associated to an access point are dropped due to
 140 inactivity.
 141 .It Ar roam
 142 trace station mode roaming between access points.
 143 .It Ar rate
 144 trace transmit rate control operation.
 145 .El
 146 .Sh EXAMPLES
 147 The following might be used to debug basic station mode operation:
 148 .Pp
 149 .Dl "wlandebug -i wlan1 scan+auth+assoc"
 150 .Pp
 151 it enables debug messages while scanning, authenticating to
 152 an access point, and associating to an access point.
 153 .Sh SEE ALSO
 154 .Xr ifconfig 8
 155 .Pp
 156 The
 157 .Pa /usr/src/tools
 158 directory contains some utilities that might be relevant to debug wireless
 159 issues.
 160 .Sh NOTES
 161 Different wireless drivers support different debugging messages.
 162 Drivers such as
 163 .Xr ath 4
 164 and
 165 .Xr ral 4
 166 that depend on the
 167 .Xr wlan 4
 168 module for 802.11 protocol processing typically support
 169 most of the debugging messages while devices that
 170 implement parts of the 802.11 protocol in firmware do not.
 171 .Pp
 172 Some debugging messages are no longer meaningful
 173 because protocol processing has moved from the operating
 174 system to user mode programs such as
 175 .Xr hostapd 8
 176 and
 177 .Xr wpa_supplicant 8 .