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