xref: /freebsd/usr.sbin/wlandebug/wlandebug.8 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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.\" $FreeBSD$
26.\"
27.Dd January 8, 2007
28.Dt WLANDEBUG 8
29.Os
30.Sh NAME
31.Nm wlandebug
32.Nd "set/query 802.11 wireless debugging messages"
33.Sh SYNOPSIS
34.Nm
35.Op Fl i Ar ifnet
36.Op Fl flag|+flag Ar ...
37.Sh DESCRIPTION
38The
39.Nm
40command is a tool for enabling and disabling
41debugging messages in the
42.Xr wlan 4
43module.
44Running
45.Nm
46without any options will display the current messages
47enabled for the specified network interface
48(by default, ``ath0').
49When run as the super-user
50.Nm
51can be used to enable and/or disable debugging messages.
52.Pp
53To enable debugging messages of a certain
54.Ar type
55use
56.Ar +type ;
57to disable such messages use
58.Ar -type .
59Multiple messages can be enabled and disabled with a single command.
60.Pp
61Messages are organized in the following groups:
62.Bl -tag -width ".Ar dumppkts"
63.It Ar debug
64general debugging facilities; equivalent to setting the debug
65parameter with
66.Xr ifconfig 8 .
67.It Ar dumppkts
68dump packet contents on transmit and receive.
69.It Ar crypto
70crypto-related work.
71.It Ar input
72errors encountered during input handling.
73.It Ar xrate
74extended rate set handling (for 802.11g).
75.It Ar elemid
76information element processing in 802.11 management frames.
77.It Ar node
78management of per-station state.
79.It Ar assoc
80802.11 station association processing; particularly useful to
81see when stations join and leave a BSS.
82.It Ar auth
83802.11 station authentication processing.
84.It Ar scan
85scanning operation; especially useful for debugging problems
86with not locating an access point.
87.It Ar output
88errors encountered during output handling.
89.It Ar state
90.Xr wlan 4
91state machine operation.
92.It Ar power
93802.11 power save operation; in hostap mode this enables
94copious information about buffered frames for stations operating
95in power save mode.
96.It Ar dot1x
97802.1x operation; not presently meaningful as 802.1x protocol
98support is implemented in user mode by the
99.Xr hostapd 8
100program.
101.It Ar dot1xsm
102802.1x state machine operation; not presently meaningful as 802.1x protocol
103support is implemented in user mode by the
104.Xr hostapd 8
105program.
106.It Ar radius
107radius backend operation as it relates to 802.1x operation;
108not presently meaningful as 802.1x protocol
109support is implemented in user mode by the
110.Xr hostapd 8
111program.
112.It Ar raddump
113dump packets exchanged with the radius backend for 802.1x operation;
114not presently meaningful as 802.1x protocol
115support is implemented in user mode by the
116.Xr hostapd 8
117program.
118.It Ar radkeys
119include key contents when dumping packets exchanged with the
120radius backend for 802.1x operation;
121not presently meaningful as 802.1x protocol
122support is implemented in user mode by the
123.Xr hostapd 8
124program.
125.It Ar wpa
126trace operation of the WPA protocol;
127only partly meaningful as WPA protocol
128support is mostly implemented in user mode by the
129.Xr hostapd 8
130and
131.Xr wpa_supplicant 8
132programs.
133.It Ar acl
134trace operation of the Access Control List (ACL) support; see
135.Xr wlan_acl 4
136for more details.
137.It Ar wme
138trace operation of WME/WMM protocol processing.
139.It Ar superg
140trace operation of Atheros SuperG protocol processing.
141.It Ar doth
142trace operation of IEEE 802.11h protocol processing.
143.It Ar inact
144trace station inactivity processing; in particular,
145show when stations associated to an access point are dropped due to
146inactivity.
147.It Ar roam
148trace station mode roaming between access points.
149.It Ar rate
150trace transmit rate control operation.
151.El
152.Sh EXAMPLES
153The following might be used to debug basic station mode operation:
154.Pp
155.Dl "wlandebug -i ral0 scan+auth+assoc"
156.Pp
157it enables debug messages while scanning, authenticating to
158an access point, and associating to an access point.
159.Sh SEE ALSO
160.Xr ifconfig 8 ,
161.Xr wlanstats 8 ,
162.Xr athdebug 8 ,
163.Xr athstats 8 .
164.Sh NOTES
165Different wireless drivers support different debugging messages.
166Drivers such as
167.Xr ath 4
168and
169.Xr ral 4
170that depend on the
171.Xr wlan 4
172module for 802.11 protocol processing typically support
173most of the debugging messages while devices that
174implement parts of the 802.11 protocol in firmware do not.
175.Pp
176Some debugging messages are no longer meaningful
177because protocol processing has moved from the operating
178system to user mode programs such as
179.Xr hostapd 8
180and
181.Xr wpa_supplicant 8 .
182