xref: /openbmc/linux/net/mac80211/debugfs.c (revision 64c70b1c)
1 /*
2  * mac80211 debugfs for wireless PHYs
3  *
4  * Copyright 2007	Johannes Berg <johannes@sipsolutions.net>
5  *
6  * GPLv2
7  *
8  */
9 
10 #include <linux/debugfs.h>
11 #include <linux/rtnetlink.h>
12 #include "ieee80211_i.h"
13 #include "ieee80211_rate.h"
14 #include "debugfs.h"
15 
16 int mac80211_open_file_generic(struct inode *inode, struct file *file)
17 {
18 	file->private_data = inode->i_private;
19 	return 0;
20 }
21 
22 static const char *ieee80211_mode_str(int mode)
23 {
24 	switch (mode) {
25 	case MODE_IEEE80211A:
26 		return "IEEE 802.11a";
27 	case MODE_IEEE80211B:
28 		return "IEEE 802.11b";
29 	case MODE_IEEE80211G:
30 		return "IEEE 802.11g";
31 	case MODE_ATHEROS_TURBO:
32 		return "Atheros Turbo (5 GHz)";
33 	default:
34 		return "UNKNOWN";
35 	}
36 }
37 
38 static ssize_t modes_read(struct file *file, char __user *userbuf,
39 			  size_t count, loff_t *ppos)
40 {
41 	struct ieee80211_local *local = file->private_data;
42 	struct ieee80211_hw_mode *mode;
43 	char buf[150], *p = buf;
44 
45 	/* FIXME: locking! */
46 	list_for_each_entry(mode, &local->modes_list, list) {
47 		p += scnprintf(p, sizeof(buf)+buf-p,
48 			       "%s\n", ieee80211_mode_str(mode->mode));
49 	}
50 
51 	return simple_read_from_buffer(userbuf, count, ppos, buf, p-buf);
52 }
53 
54 static const struct file_operations modes_ops = {
55 	.read = modes_read,
56 	.open = mac80211_open_file_generic,
57 };
58 
59 #define DEBUGFS_READONLY_FILE(name, buflen, fmt, value...)		\
60 static ssize_t name## _read(struct file *file, char __user *userbuf,	\
61 			    size_t count, loff_t *ppos)			\
62 {									\
63 	struct ieee80211_local *local = file->private_data;		\
64 	char buf[buflen];						\
65 	int res;							\
66 									\
67 	res = scnprintf(buf, buflen, fmt "\n", ##value);		\
68 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);	\
69 }									\
70 									\
71 static const struct file_operations name## _ops = {			\
72 	.read = name## _read,						\
73 	.open = mac80211_open_file_generic,				\
74 };
75 
76 #define DEBUGFS_ADD(name)						\
77 	local->debugfs.name = debugfs_create_file(#name, 0444, phyd,	\
78 						  local, &name## _ops);
79 
80 #define DEBUGFS_DEL(name)						\
81 	debugfs_remove(local->debugfs.name);				\
82 	local->debugfs.name = NULL;
83 
84 
85 DEBUGFS_READONLY_FILE(channel, 20, "%d",
86 		      local->hw.conf.channel);
87 DEBUGFS_READONLY_FILE(frequency, 20, "%d",
88 		      local->hw.conf.freq);
89 DEBUGFS_READONLY_FILE(radar_detect, 20, "%d",
90 		      local->hw.conf.radar_detect);
91 DEBUGFS_READONLY_FILE(antenna_sel_tx, 20, "%d",
92 		      local->hw.conf.antenna_sel_tx);
93 DEBUGFS_READONLY_FILE(antenna_sel_rx, 20, "%d",
94 		      local->hw.conf.antenna_sel_rx);
95 DEBUGFS_READONLY_FILE(bridge_packets, 20, "%d",
96 		      local->bridge_packets);
97 DEBUGFS_READONLY_FILE(key_tx_rx_threshold, 20, "%d",
98 		      local->key_tx_rx_threshold);
99 DEBUGFS_READONLY_FILE(rts_threshold, 20, "%d",
100 		      local->rts_threshold);
101 DEBUGFS_READONLY_FILE(fragmentation_threshold, 20, "%d",
102 		      local->fragmentation_threshold);
103 DEBUGFS_READONLY_FILE(short_retry_limit, 20, "%d",
104 		      local->short_retry_limit);
105 DEBUGFS_READONLY_FILE(long_retry_limit, 20, "%d",
106 		      local->long_retry_limit);
107 DEBUGFS_READONLY_FILE(total_ps_buffered, 20, "%d",
108 		      local->total_ps_buffered);
109 DEBUGFS_READONLY_FILE(mode, 20, "%s",
110 		      ieee80211_mode_str(local->hw.conf.phymode));
111 DEBUGFS_READONLY_FILE(wep_iv, 20, "%#06x",
112 		      local->wep_iv & 0xffffff);
113 DEBUGFS_READONLY_FILE(tx_power_reduction, 20, "%d.%d dBm",
114 		      local->hw.conf.tx_power_reduction / 10,
115 		      local->hw.conf.tx_power_reduction % 10);
116 DEBUGFS_READONLY_FILE(rate_ctrl_alg, 100, "%s",
117 		      local->rate_ctrl ? local->rate_ctrl->ops->name : "<unset>");
118 
119 /* statistics stuff */
120 
121 static inline int rtnl_lock_local(struct ieee80211_local *local)
122 {
123 	rtnl_lock();
124 	if (unlikely(local->reg_state != IEEE80211_DEV_REGISTERED)) {
125 		rtnl_unlock();
126 		return -ENODEV;
127 	}
128 	return 0;
129 }
130 
131 #define DEBUGFS_STATS_FILE(name, buflen, fmt, value...)			\
132 	DEBUGFS_READONLY_FILE(stats_ ##name, buflen, fmt, ##value)
133 
134 static ssize_t format_devstat_counter(struct ieee80211_local *local,
135 	char __user *userbuf,
136 	size_t count, loff_t *ppos,
137 	int (*printvalue)(struct ieee80211_low_level_stats *stats, char *buf,
138 			  int buflen))
139 {
140 	struct ieee80211_low_level_stats stats;
141 	char buf[20];
142 	int res;
143 
144 	if (!local->ops->get_stats)
145 		return -EOPNOTSUPP;
146 
147 	res = rtnl_lock_local(local);
148 	if (res)
149 		return res;
150 
151 	res = local->ops->get_stats(local_to_hw(local), &stats);
152 	rtnl_unlock();
153 	if (!res)
154 		res = printvalue(&stats, buf, sizeof(buf));
155 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
156 }
157 
158 #define DEBUGFS_DEVSTATS_FILE(name)					\
159 static int print_devstats_##name(struct ieee80211_low_level_stats *stats,\
160 				 char *buf, int buflen)			\
161 {									\
162 	return scnprintf(buf, buflen, "%u\n", stats->name);		\
163 }									\
164 static ssize_t stats_ ##name## _read(struct file *file,			\
165 				     char __user *userbuf,		\
166 				     size_t count, loff_t *ppos)	\
167 {									\
168 	return format_devstat_counter(file->private_data,		\
169 				      userbuf,				\
170 				      count,				\
171 				      ppos,				\
172 				      print_devstats_##name);		\
173 }									\
174 									\
175 static const struct file_operations stats_ ##name## _ops = {		\
176 	.read = stats_ ##name## _read,					\
177 	.open = mac80211_open_file_generic,				\
178 };
179 
180 #define DEBUGFS_STATS_ADD(name)						\
181 	local->debugfs.stats.name = debugfs_create_file(#name, 0444, statsd,\
182 		local, &stats_ ##name## _ops);
183 
184 #define DEBUGFS_STATS_DEL(name)						\
185 	debugfs_remove(local->debugfs.stats.name);			\
186 	local->debugfs.stats.name = NULL;
187 
188 DEBUGFS_STATS_FILE(transmitted_fragment_count, 20, "%u",
189 		   local->dot11TransmittedFragmentCount);
190 DEBUGFS_STATS_FILE(multicast_transmitted_frame_count, 20, "%u",
191 		   local->dot11MulticastTransmittedFrameCount);
192 DEBUGFS_STATS_FILE(failed_count, 20, "%u",
193 		   local->dot11FailedCount);
194 DEBUGFS_STATS_FILE(retry_count, 20, "%u",
195 		   local->dot11RetryCount);
196 DEBUGFS_STATS_FILE(multiple_retry_count, 20, "%u",
197 		   local->dot11MultipleRetryCount);
198 DEBUGFS_STATS_FILE(frame_duplicate_count, 20, "%u",
199 		   local->dot11FrameDuplicateCount);
200 DEBUGFS_STATS_FILE(received_fragment_count, 20, "%u",
201 		   local->dot11ReceivedFragmentCount);
202 DEBUGFS_STATS_FILE(multicast_received_frame_count, 20, "%u",
203 		   local->dot11MulticastReceivedFrameCount);
204 DEBUGFS_STATS_FILE(transmitted_frame_count, 20, "%u",
205 		   local->dot11TransmittedFrameCount);
206 DEBUGFS_STATS_FILE(wep_undecryptable_count, 20, "%u",
207 		   local->dot11WEPUndecryptableCount);
208 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
209 DEBUGFS_STATS_FILE(tx_handlers_drop, 20, "%u",
210 		   local->tx_handlers_drop);
211 DEBUGFS_STATS_FILE(tx_handlers_queued, 20, "%u",
212 		   local->tx_handlers_queued);
213 DEBUGFS_STATS_FILE(tx_handlers_drop_unencrypted, 20, "%u",
214 		   local->tx_handlers_drop_unencrypted);
215 DEBUGFS_STATS_FILE(tx_handlers_drop_fragment, 20, "%u",
216 		   local->tx_handlers_drop_fragment);
217 DEBUGFS_STATS_FILE(tx_handlers_drop_wep, 20, "%u",
218 		   local->tx_handlers_drop_wep);
219 DEBUGFS_STATS_FILE(tx_handlers_drop_not_assoc, 20, "%u",
220 		   local->tx_handlers_drop_not_assoc);
221 DEBUGFS_STATS_FILE(tx_handlers_drop_unauth_port, 20, "%u",
222 		   local->tx_handlers_drop_unauth_port);
223 DEBUGFS_STATS_FILE(rx_handlers_drop, 20, "%u",
224 		   local->rx_handlers_drop);
225 DEBUGFS_STATS_FILE(rx_handlers_queued, 20, "%u",
226 		   local->rx_handlers_queued);
227 DEBUGFS_STATS_FILE(rx_handlers_drop_nullfunc, 20, "%u",
228 		   local->rx_handlers_drop_nullfunc);
229 DEBUGFS_STATS_FILE(rx_handlers_drop_defrag, 20, "%u",
230 		   local->rx_handlers_drop_defrag);
231 DEBUGFS_STATS_FILE(rx_handlers_drop_short, 20, "%u",
232 		   local->rx_handlers_drop_short);
233 DEBUGFS_STATS_FILE(rx_handlers_drop_passive_scan, 20, "%u",
234 		   local->rx_handlers_drop_passive_scan);
235 DEBUGFS_STATS_FILE(tx_expand_skb_head, 20, "%u",
236 		   local->tx_expand_skb_head);
237 DEBUGFS_STATS_FILE(tx_expand_skb_head_cloned, 20, "%u",
238 		   local->tx_expand_skb_head_cloned);
239 DEBUGFS_STATS_FILE(rx_expand_skb_head, 20, "%u",
240 		   local->rx_expand_skb_head);
241 DEBUGFS_STATS_FILE(rx_expand_skb_head2, 20, "%u",
242 		   local->rx_expand_skb_head2);
243 DEBUGFS_STATS_FILE(rx_handlers_fragments, 20, "%u",
244 		   local->rx_handlers_fragments);
245 DEBUGFS_STATS_FILE(tx_status_drop, 20, "%u",
246 		   local->tx_status_drop);
247 
248 static ssize_t stats_wme_rx_queue_read(struct file *file,
249 				       char __user *userbuf,
250 				       size_t count, loff_t *ppos)
251 {
252 	struct ieee80211_local *local = file->private_data;
253 	char buf[NUM_RX_DATA_QUEUES*15], *p = buf;
254 	int i;
255 
256 	for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
257 		p += scnprintf(p, sizeof(buf)+buf-p,
258 			       "%u\n", local->wme_rx_queue[i]);
259 
260 	return simple_read_from_buffer(userbuf, count, ppos, buf, p-buf);
261 }
262 
263 static const struct file_operations stats_wme_rx_queue_ops = {
264 	.read = stats_wme_rx_queue_read,
265 	.open = mac80211_open_file_generic,
266 };
267 
268 static ssize_t stats_wme_tx_queue_read(struct file *file,
269 				       char __user *userbuf,
270 				       size_t count, loff_t *ppos)
271 {
272 	struct ieee80211_local *local = file->private_data;
273 	char buf[NUM_TX_DATA_QUEUES*15], *p = buf;
274 	int i;
275 
276 	for (i = 0; i < NUM_TX_DATA_QUEUES; i++)
277 		p += scnprintf(p, sizeof(buf)+buf-p,
278 			       "%u\n", local->wme_tx_queue[i]);
279 
280 	return simple_read_from_buffer(userbuf, count, ppos, buf, p-buf);
281 }
282 
283 static const struct file_operations stats_wme_tx_queue_ops = {
284 	.read = stats_wme_tx_queue_read,
285 	.open = mac80211_open_file_generic,
286 };
287 #endif
288 
289 DEBUGFS_DEVSTATS_FILE(dot11ACKFailureCount);
290 DEBUGFS_DEVSTATS_FILE(dot11RTSFailureCount);
291 DEBUGFS_DEVSTATS_FILE(dot11FCSErrorCount);
292 DEBUGFS_DEVSTATS_FILE(dot11RTSSuccessCount);
293 
294 
295 void debugfs_hw_add(struct ieee80211_local *local)
296 {
297 	struct dentry *phyd = local->hw.wiphy->debugfsdir;
298 	struct dentry *statsd;
299 
300 	if (!phyd)
301 		return;
302 
303 	local->debugfs.stations = debugfs_create_dir("stations", phyd);
304 	local->debugfs.keys = debugfs_create_dir("keys", phyd);
305 
306 	DEBUGFS_ADD(channel);
307 	DEBUGFS_ADD(frequency);
308 	DEBUGFS_ADD(radar_detect);
309 	DEBUGFS_ADD(antenna_sel_tx);
310 	DEBUGFS_ADD(antenna_sel_rx);
311 	DEBUGFS_ADD(bridge_packets);
312 	DEBUGFS_ADD(key_tx_rx_threshold);
313 	DEBUGFS_ADD(rts_threshold);
314 	DEBUGFS_ADD(fragmentation_threshold);
315 	DEBUGFS_ADD(short_retry_limit);
316 	DEBUGFS_ADD(long_retry_limit);
317 	DEBUGFS_ADD(total_ps_buffered);
318 	DEBUGFS_ADD(mode);
319 	DEBUGFS_ADD(wep_iv);
320 	DEBUGFS_ADD(tx_power_reduction);
321 	DEBUGFS_ADD(modes);
322 
323 	statsd = debugfs_create_dir("statistics", phyd);
324 	local->debugfs.statistics = statsd;
325 
326 	/* if the dir failed, don't put all the other things into the root! */
327 	if (!statsd)
328 		return;
329 
330 	DEBUGFS_STATS_ADD(transmitted_fragment_count);
331 	DEBUGFS_STATS_ADD(multicast_transmitted_frame_count);
332 	DEBUGFS_STATS_ADD(failed_count);
333 	DEBUGFS_STATS_ADD(retry_count);
334 	DEBUGFS_STATS_ADD(multiple_retry_count);
335 	DEBUGFS_STATS_ADD(frame_duplicate_count);
336 	DEBUGFS_STATS_ADD(received_fragment_count);
337 	DEBUGFS_STATS_ADD(multicast_received_frame_count);
338 	DEBUGFS_STATS_ADD(transmitted_frame_count);
339 	DEBUGFS_STATS_ADD(wep_undecryptable_count);
340 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
341 	DEBUGFS_STATS_ADD(tx_handlers_drop);
342 	DEBUGFS_STATS_ADD(tx_handlers_queued);
343 	DEBUGFS_STATS_ADD(tx_handlers_drop_unencrypted);
344 	DEBUGFS_STATS_ADD(tx_handlers_drop_fragment);
345 	DEBUGFS_STATS_ADD(tx_handlers_drop_wep);
346 	DEBUGFS_STATS_ADD(tx_handlers_drop_not_assoc);
347 	DEBUGFS_STATS_ADD(tx_handlers_drop_unauth_port);
348 	DEBUGFS_STATS_ADD(rx_handlers_drop);
349 	DEBUGFS_STATS_ADD(rx_handlers_queued);
350 	DEBUGFS_STATS_ADD(rx_handlers_drop_nullfunc);
351 	DEBUGFS_STATS_ADD(rx_handlers_drop_defrag);
352 	DEBUGFS_STATS_ADD(rx_handlers_drop_short);
353 	DEBUGFS_STATS_ADD(rx_handlers_drop_passive_scan);
354 	DEBUGFS_STATS_ADD(tx_expand_skb_head);
355 	DEBUGFS_STATS_ADD(tx_expand_skb_head_cloned);
356 	DEBUGFS_STATS_ADD(rx_expand_skb_head);
357 	DEBUGFS_STATS_ADD(rx_expand_skb_head2);
358 	DEBUGFS_STATS_ADD(rx_handlers_fragments);
359 	DEBUGFS_STATS_ADD(tx_status_drop);
360 	DEBUGFS_STATS_ADD(wme_tx_queue);
361 	DEBUGFS_STATS_ADD(wme_rx_queue);
362 #endif
363 	DEBUGFS_STATS_ADD(dot11ACKFailureCount);
364 	DEBUGFS_STATS_ADD(dot11RTSFailureCount);
365 	DEBUGFS_STATS_ADD(dot11FCSErrorCount);
366 	DEBUGFS_STATS_ADD(dot11RTSSuccessCount);
367 }
368 
369 void debugfs_hw_del(struct ieee80211_local *local)
370 {
371 	DEBUGFS_DEL(channel);
372 	DEBUGFS_DEL(frequency);
373 	DEBUGFS_DEL(radar_detect);
374 	DEBUGFS_DEL(antenna_sel_tx);
375 	DEBUGFS_DEL(antenna_sel_rx);
376 	DEBUGFS_DEL(bridge_packets);
377 	DEBUGFS_DEL(key_tx_rx_threshold);
378 	DEBUGFS_DEL(rts_threshold);
379 	DEBUGFS_DEL(fragmentation_threshold);
380 	DEBUGFS_DEL(short_retry_limit);
381 	DEBUGFS_DEL(long_retry_limit);
382 	DEBUGFS_DEL(total_ps_buffered);
383 	DEBUGFS_DEL(mode);
384 	DEBUGFS_DEL(wep_iv);
385 	DEBUGFS_DEL(tx_power_reduction);
386 	DEBUGFS_DEL(modes);
387 
388 	DEBUGFS_STATS_DEL(transmitted_fragment_count);
389 	DEBUGFS_STATS_DEL(multicast_transmitted_frame_count);
390 	DEBUGFS_STATS_DEL(failed_count);
391 	DEBUGFS_STATS_DEL(retry_count);
392 	DEBUGFS_STATS_DEL(multiple_retry_count);
393 	DEBUGFS_STATS_DEL(frame_duplicate_count);
394 	DEBUGFS_STATS_DEL(received_fragment_count);
395 	DEBUGFS_STATS_DEL(multicast_received_frame_count);
396 	DEBUGFS_STATS_DEL(transmitted_frame_count);
397 	DEBUGFS_STATS_DEL(wep_undecryptable_count);
398 	DEBUGFS_STATS_DEL(num_scans);
399 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
400 	DEBUGFS_STATS_DEL(tx_handlers_drop);
401 	DEBUGFS_STATS_DEL(tx_handlers_queued);
402 	DEBUGFS_STATS_DEL(tx_handlers_drop_unencrypted);
403 	DEBUGFS_STATS_DEL(tx_handlers_drop_fragment);
404 	DEBUGFS_STATS_DEL(tx_handlers_drop_wep);
405 	DEBUGFS_STATS_DEL(tx_handlers_drop_not_assoc);
406 	DEBUGFS_STATS_DEL(tx_handlers_drop_unauth_port);
407 	DEBUGFS_STATS_DEL(rx_handlers_drop);
408 	DEBUGFS_STATS_DEL(rx_handlers_queued);
409 	DEBUGFS_STATS_DEL(rx_handlers_drop_nullfunc);
410 	DEBUGFS_STATS_DEL(rx_handlers_drop_defrag);
411 	DEBUGFS_STATS_DEL(rx_handlers_drop_short);
412 	DEBUGFS_STATS_DEL(rx_handlers_drop_passive_scan);
413 	DEBUGFS_STATS_DEL(tx_expand_skb_head);
414 	DEBUGFS_STATS_DEL(tx_expand_skb_head_cloned);
415 	DEBUGFS_STATS_DEL(rx_expand_skb_head);
416 	DEBUGFS_STATS_DEL(rx_expand_skb_head2);
417 	DEBUGFS_STATS_DEL(rx_handlers_fragments);
418 	DEBUGFS_STATS_DEL(tx_status_drop);
419 	DEBUGFS_STATS_DEL(wme_tx_queue);
420 	DEBUGFS_STATS_DEL(wme_rx_queue);
421 #endif
422 	DEBUGFS_STATS_DEL(dot11ACKFailureCount);
423 	DEBUGFS_STATS_DEL(dot11RTSFailureCount);
424 	DEBUGFS_STATS_DEL(dot11FCSErrorCount);
425 	DEBUGFS_STATS_DEL(dot11RTSSuccessCount);
426 
427 	debugfs_remove(local->debugfs.statistics);
428 	local->debugfs.statistics = NULL;
429 	debugfs_remove(local->debugfs.stations);
430 	local->debugfs.stations = NULL;
431 	debugfs_remove(local->debugfs.keys);
432 	local->debugfs.keys = NULL;
433 }
434