xref: /linux/net/mac80211/debugfs.c (revision b7019ac550eb3916f34d79db583e9b7ea2524afa)
1 /*
2  * mac80211 debugfs for wireless PHYs
3  *
4  * Copyright 2007	Johannes Berg <johannes@sipsolutions.net>
5  * Copyright 2013-2014  Intel Mobile Communications GmbH
6  * Copyright (C) 2018 - 2019 Intel Corporation
7  *
8  * GPLv2
9  *
10  */
11 
12 #include <linux/debugfs.h>
13 #include <linux/rtnetlink.h>
14 #include <linux/vmalloc.h>
15 #include "ieee80211_i.h"
16 #include "driver-ops.h"
17 #include "rate.h"
18 #include "debugfs.h"
19 
20 #define DEBUGFS_FORMAT_BUFFER_SIZE 100
21 
22 int mac80211_format_buffer(char __user *userbuf, size_t count,
23 				  loff_t *ppos, char *fmt, ...)
24 {
25 	va_list args;
26 	char buf[DEBUGFS_FORMAT_BUFFER_SIZE];
27 	int res;
28 
29 	va_start(args, fmt);
30 	res = vscnprintf(buf, sizeof(buf), fmt, args);
31 	va_end(args);
32 
33 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
34 }
35 
36 #define DEBUGFS_READONLY_FILE_FN(name, fmt, value...)			\
37 static ssize_t name## _read(struct file *file, char __user *userbuf,	\
38 			    size_t count, loff_t *ppos)			\
39 {									\
40 	struct ieee80211_local *local = file->private_data;		\
41 									\
42 	return mac80211_format_buffer(userbuf, count, ppos, 		\
43 				      fmt "\n", ##value);		\
44 }
45 
46 #define DEBUGFS_READONLY_FILE_OPS(name)			\
47 static const struct file_operations name## _ops = {			\
48 	.read = name## _read,						\
49 	.open = simple_open,						\
50 	.llseek = generic_file_llseek,					\
51 };
52 
53 #define DEBUGFS_READONLY_FILE(name, fmt, value...)		\
54 	DEBUGFS_READONLY_FILE_FN(name, fmt, value)		\
55 	DEBUGFS_READONLY_FILE_OPS(name)
56 
57 #define DEBUGFS_ADD(name)						\
58 	debugfs_create_file(#name, 0400, phyd, local, &name## _ops);
59 
60 #define DEBUGFS_ADD_MODE(name, mode)					\
61 	debugfs_create_file(#name, mode, phyd, local, &name## _ops);
62 
63 
64 DEBUGFS_READONLY_FILE(user_power, "%d",
65 		      local->user_power_level);
66 DEBUGFS_READONLY_FILE(power, "%d",
67 		      local->hw.conf.power_level);
68 DEBUGFS_READONLY_FILE(total_ps_buffered, "%d",
69 		      local->total_ps_buffered);
70 DEBUGFS_READONLY_FILE(wep_iv, "%#08x",
71 		      local->wep_iv & 0xffffff);
72 DEBUGFS_READONLY_FILE(rate_ctrl_alg, "%s",
73 	local->rate_ctrl ? local->rate_ctrl->ops->name : "hw/driver");
74 
75 static ssize_t aqm_read(struct file *file,
76 			char __user *user_buf,
77 			size_t count,
78 			loff_t *ppos)
79 {
80 	struct ieee80211_local *local = file->private_data;
81 	struct fq *fq = &local->fq;
82 	char buf[200];
83 	int len = 0;
84 
85 	spin_lock_bh(&local->fq.lock);
86 	rcu_read_lock();
87 
88 	len = scnprintf(buf, sizeof(buf),
89 			"access name value\n"
90 			"R fq_flows_cnt %u\n"
91 			"R fq_backlog %u\n"
92 			"R fq_overlimit %u\n"
93 			"R fq_overmemory %u\n"
94 			"R fq_collisions %u\n"
95 			"R fq_memory_usage %u\n"
96 			"RW fq_memory_limit %u\n"
97 			"RW fq_limit %u\n"
98 			"RW fq_quantum %u\n",
99 			fq->flows_cnt,
100 			fq->backlog,
101 			fq->overmemory,
102 			fq->overlimit,
103 			fq->collisions,
104 			fq->memory_usage,
105 			fq->memory_limit,
106 			fq->limit,
107 			fq->quantum);
108 
109 	rcu_read_unlock();
110 	spin_unlock_bh(&local->fq.lock);
111 
112 	return simple_read_from_buffer(user_buf, count, ppos,
113 				       buf, len);
114 }
115 
116 static ssize_t aqm_write(struct file *file,
117 			 const char __user *user_buf,
118 			 size_t count,
119 			 loff_t *ppos)
120 {
121 	struct ieee80211_local *local = file->private_data;
122 	char buf[100];
123 	size_t len;
124 
125 	if (count > sizeof(buf))
126 		return -EINVAL;
127 
128 	if (copy_from_user(buf, user_buf, count))
129 		return -EFAULT;
130 
131 	buf[sizeof(buf) - 1] = '\0';
132 	len = strlen(buf);
133 	if (len > 0 && buf[len-1] == '\n')
134 		buf[len-1] = 0;
135 
136 	if (sscanf(buf, "fq_limit %u", &local->fq.limit) == 1)
137 		return count;
138 	else if (sscanf(buf, "fq_memory_limit %u", &local->fq.memory_limit) == 1)
139 		return count;
140 	else if (sscanf(buf, "fq_quantum %u", &local->fq.quantum) == 1)
141 		return count;
142 
143 	return -EINVAL;
144 }
145 
146 static const struct file_operations aqm_ops = {
147 	.write = aqm_write,
148 	.read = aqm_read,
149 	.open = simple_open,
150 	.llseek = default_llseek,
151 };
152 
153 static ssize_t force_tx_status_read(struct file *file,
154 				    char __user *user_buf,
155 				    size_t count,
156 				    loff_t *ppos)
157 {
158 	struct ieee80211_local *local = file->private_data;
159 	char buf[3];
160 	int len = 0;
161 
162 	len = scnprintf(buf, sizeof(buf), "%d\n", (int)local->force_tx_status);
163 
164 	return simple_read_from_buffer(user_buf, count, ppos,
165 				       buf, len);
166 }
167 
168 static ssize_t force_tx_status_write(struct file *file,
169 				     const char __user *user_buf,
170 				     size_t count,
171 				     loff_t *ppos)
172 {
173 	struct ieee80211_local *local = file->private_data;
174 	char buf[3];
175 	size_t len;
176 
177 	if (count > sizeof(buf))
178 		return -EINVAL;
179 
180 	if (copy_from_user(buf, user_buf, count))
181 		return -EFAULT;
182 
183 	buf[sizeof(buf) - 1] = '\0';
184 	len = strlen(buf);
185 	if (len > 0 && buf[len - 1] == '\n')
186 		buf[len - 1] = 0;
187 
188 	if (buf[0] == '0' && buf[1] == '\0')
189 		local->force_tx_status = 0;
190 	else if (buf[0] == '1' && buf[1] == '\0')
191 		local->force_tx_status = 1;
192 	else
193 		return -EINVAL;
194 
195 	return count;
196 }
197 
198 static const struct file_operations force_tx_status_ops = {
199 	.write = force_tx_status_write,
200 	.read = force_tx_status_read,
201 	.open = simple_open,
202 	.llseek = default_llseek,
203 };
204 
205 #ifdef CONFIG_PM
206 static ssize_t reset_write(struct file *file, const char __user *user_buf,
207 			   size_t count, loff_t *ppos)
208 {
209 	struct ieee80211_local *local = file->private_data;
210 
211 	rtnl_lock();
212 	__ieee80211_suspend(&local->hw, NULL);
213 	__ieee80211_resume(&local->hw);
214 	rtnl_unlock();
215 
216 	return count;
217 }
218 
219 static const struct file_operations reset_ops = {
220 	.write = reset_write,
221 	.open = simple_open,
222 	.llseek = noop_llseek,
223 };
224 #endif
225 
226 static const char *hw_flag_names[] = {
227 #define FLAG(F)	[IEEE80211_HW_##F] = #F
228 	FLAG(HAS_RATE_CONTROL),
229 	FLAG(RX_INCLUDES_FCS),
230 	FLAG(HOST_BROADCAST_PS_BUFFERING),
231 	FLAG(SIGNAL_UNSPEC),
232 	FLAG(SIGNAL_DBM),
233 	FLAG(NEED_DTIM_BEFORE_ASSOC),
234 	FLAG(SPECTRUM_MGMT),
235 	FLAG(AMPDU_AGGREGATION),
236 	FLAG(SUPPORTS_PS),
237 	FLAG(PS_NULLFUNC_STACK),
238 	FLAG(SUPPORTS_DYNAMIC_PS),
239 	FLAG(MFP_CAPABLE),
240 	FLAG(WANT_MONITOR_VIF),
241 	FLAG(NO_AUTO_VIF),
242 	FLAG(SW_CRYPTO_CONTROL),
243 	FLAG(SUPPORT_FAST_XMIT),
244 	FLAG(REPORTS_TX_ACK_STATUS),
245 	FLAG(CONNECTION_MONITOR),
246 	FLAG(QUEUE_CONTROL),
247 	FLAG(SUPPORTS_PER_STA_GTK),
248 	FLAG(AP_LINK_PS),
249 	FLAG(TX_AMPDU_SETUP_IN_HW),
250 	FLAG(SUPPORTS_RC_TABLE),
251 	FLAG(P2P_DEV_ADDR_FOR_INTF),
252 	FLAG(TIMING_BEACON_ONLY),
253 	FLAG(SUPPORTS_HT_CCK_RATES),
254 	FLAG(CHANCTX_STA_CSA),
255 	FLAG(SUPPORTS_CLONED_SKBS),
256 	FLAG(SINGLE_SCAN_ON_ALL_BANDS),
257 	FLAG(TDLS_WIDER_BW),
258 	FLAG(SUPPORTS_AMSDU_IN_AMPDU),
259 	FLAG(BEACON_TX_STATUS),
260 	FLAG(NEEDS_UNIQUE_STA_ADDR),
261 	FLAG(SUPPORTS_REORDERING_BUFFER),
262 	FLAG(USES_RSS),
263 	FLAG(TX_AMSDU),
264 	FLAG(TX_FRAG_LIST),
265 	FLAG(REPORTS_LOW_ACK),
266 	FLAG(SUPPORTS_TX_FRAG),
267 	FLAG(SUPPORTS_TDLS_BUFFER_STA),
268 	FLAG(DEAUTH_NEED_MGD_TX_PREP),
269 	FLAG(DOESNT_SUPPORT_QOS_NDP),
270 	FLAG(BUFF_MMPDU_TXQ),
271 	FLAG(SUPPORTS_VHT_EXT_NSS_BW),
272 	FLAG(STA_MMPDU_TXQ),
273 	FLAG(TX_STATUS_NO_AMPDU_LEN),
274 	FLAG(SUPPORTS_MULTI_BSSID),
275 	FLAG(SUPPORTS_ONLY_HE_MULTI_BSSID),
276 	FLAG(EXT_KEY_ID_NATIVE),
277 #undef FLAG
278 };
279 
280 static ssize_t hwflags_read(struct file *file, char __user *user_buf,
281 			    size_t count, loff_t *ppos)
282 {
283 	struct ieee80211_local *local = file->private_data;
284 	size_t bufsz = 30 * NUM_IEEE80211_HW_FLAGS;
285 	char *buf = kzalloc(bufsz, GFP_KERNEL);
286 	char *pos = buf, *end = buf + bufsz - 1;
287 	ssize_t rv;
288 	int i;
289 
290 	if (!buf)
291 		return -ENOMEM;
292 
293 	/* fail compilation if somebody adds or removes
294 	 * a flag without updating the name array above
295 	 */
296 	BUILD_BUG_ON(ARRAY_SIZE(hw_flag_names) != NUM_IEEE80211_HW_FLAGS);
297 
298 	for (i = 0; i < NUM_IEEE80211_HW_FLAGS; i++) {
299 		if (test_bit(i, local->hw.flags))
300 			pos += scnprintf(pos, end - pos, "%s\n",
301 					 hw_flag_names[i]);
302 	}
303 
304 	rv = simple_read_from_buffer(user_buf, count, ppos, buf, strlen(buf));
305 	kfree(buf);
306 	return rv;
307 }
308 
309 static ssize_t misc_read(struct file *file, char __user *user_buf,
310 			 size_t count, loff_t *ppos)
311 {
312 	struct ieee80211_local *local = file->private_data;
313 	/* Max len of each line is 16 characters, plus 9 for 'pending:\n' */
314 	size_t bufsz = IEEE80211_MAX_QUEUES * 16 + 9;
315 	char *buf;
316 	char *pos, *end;
317 	ssize_t rv;
318 	int i;
319 	int ln;
320 
321 	buf = kzalloc(bufsz, GFP_KERNEL);
322 	if (!buf)
323 		return -ENOMEM;
324 
325 	pos = buf;
326 	end = buf + bufsz - 1;
327 
328 	pos += scnprintf(pos, end - pos, "pending:\n");
329 
330 	for (i = 0; i < IEEE80211_MAX_QUEUES; i++) {
331 		ln = skb_queue_len(&local->pending[i]);
332 		pos += scnprintf(pos, end - pos, "[%i] %d\n",
333 				 i, ln);
334 	}
335 
336 	rv = simple_read_from_buffer(user_buf, count, ppos, buf, strlen(buf));
337 	kfree(buf);
338 	return rv;
339 }
340 
341 static ssize_t queues_read(struct file *file, char __user *user_buf,
342 			   size_t count, loff_t *ppos)
343 {
344 	struct ieee80211_local *local = file->private_data;
345 	unsigned long flags;
346 	char buf[IEEE80211_MAX_QUEUES * 20];
347 	int q, res = 0;
348 
349 	spin_lock_irqsave(&local->queue_stop_reason_lock, flags);
350 	for (q = 0; q < local->hw.queues; q++)
351 		res += sprintf(buf + res, "%02d: %#.8lx/%d\n", q,
352 				local->queue_stop_reasons[q],
353 				skb_queue_len(&local->pending[q]));
354 	spin_unlock_irqrestore(&local->queue_stop_reason_lock, flags);
355 
356 	return simple_read_from_buffer(user_buf, count, ppos, buf, res);
357 }
358 
359 DEBUGFS_READONLY_FILE_OPS(hwflags);
360 DEBUGFS_READONLY_FILE_OPS(queues);
361 DEBUGFS_READONLY_FILE_OPS(misc);
362 
363 /* statistics stuff */
364 
365 static ssize_t format_devstat_counter(struct ieee80211_local *local,
366 	char __user *userbuf,
367 	size_t count, loff_t *ppos,
368 	int (*printvalue)(struct ieee80211_low_level_stats *stats, char *buf,
369 			  int buflen))
370 {
371 	struct ieee80211_low_level_stats stats;
372 	char buf[20];
373 	int res;
374 
375 	rtnl_lock();
376 	res = drv_get_stats(local, &stats);
377 	rtnl_unlock();
378 	if (res)
379 		return res;
380 	res = printvalue(&stats, buf, sizeof(buf));
381 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
382 }
383 
384 #define DEBUGFS_DEVSTATS_FILE(name)					\
385 static int print_devstats_##name(struct ieee80211_low_level_stats *stats,\
386 				 char *buf, int buflen)			\
387 {									\
388 	return scnprintf(buf, buflen, "%u\n", stats->name);		\
389 }									\
390 static ssize_t stats_ ##name## _read(struct file *file,			\
391 				     char __user *userbuf,		\
392 				     size_t count, loff_t *ppos)	\
393 {									\
394 	return format_devstat_counter(file->private_data,		\
395 				      userbuf,				\
396 				      count,				\
397 				      ppos,				\
398 				      print_devstats_##name);		\
399 }									\
400 									\
401 static const struct file_operations stats_ ##name## _ops = {		\
402 	.read = stats_ ##name## _read,					\
403 	.open = simple_open,						\
404 	.llseek = generic_file_llseek,					\
405 };
406 
407 #define DEBUGFS_STATS_ADD(name)					\
408 	debugfs_create_u32(#name, 0400, statsd, &local->name);
409 #define DEBUGFS_DEVSTATS_ADD(name)					\
410 	debugfs_create_file(#name, 0400, statsd, local, &stats_ ##name## _ops);
411 
412 DEBUGFS_DEVSTATS_FILE(dot11ACKFailureCount);
413 DEBUGFS_DEVSTATS_FILE(dot11RTSFailureCount);
414 DEBUGFS_DEVSTATS_FILE(dot11FCSErrorCount);
415 DEBUGFS_DEVSTATS_FILE(dot11RTSSuccessCount);
416 
417 void debugfs_hw_add(struct ieee80211_local *local)
418 {
419 	struct dentry *phyd = local->hw.wiphy->debugfsdir;
420 	struct dentry *statsd;
421 
422 	if (!phyd)
423 		return;
424 
425 	local->debugfs.keys = debugfs_create_dir("keys", phyd);
426 
427 	DEBUGFS_ADD(total_ps_buffered);
428 	DEBUGFS_ADD(wep_iv);
429 	DEBUGFS_ADD(rate_ctrl_alg);
430 	DEBUGFS_ADD(queues);
431 	DEBUGFS_ADD(misc);
432 #ifdef CONFIG_PM
433 	DEBUGFS_ADD_MODE(reset, 0200);
434 #endif
435 	DEBUGFS_ADD(hwflags);
436 	DEBUGFS_ADD(user_power);
437 	DEBUGFS_ADD(power);
438 	DEBUGFS_ADD_MODE(force_tx_status, 0600);
439 
440 	if (local->ops->wake_tx_queue)
441 		DEBUGFS_ADD_MODE(aqm, 0600);
442 
443 	debugfs_create_u16("airtime_flags", 0600,
444 			   phyd, &local->airtime_flags);
445 
446 	statsd = debugfs_create_dir("statistics", phyd);
447 
448 	/* if the dir failed, don't put all the other things into the root! */
449 	if (!statsd)
450 		return;
451 
452 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
453 	DEBUGFS_STATS_ADD(dot11TransmittedFragmentCount);
454 	DEBUGFS_STATS_ADD(dot11MulticastTransmittedFrameCount);
455 	DEBUGFS_STATS_ADD(dot11FailedCount);
456 	DEBUGFS_STATS_ADD(dot11RetryCount);
457 	DEBUGFS_STATS_ADD(dot11MultipleRetryCount);
458 	DEBUGFS_STATS_ADD(dot11FrameDuplicateCount);
459 	DEBUGFS_STATS_ADD(dot11ReceivedFragmentCount);
460 	DEBUGFS_STATS_ADD(dot11MulticastReceivedFrameCount);
461 	DEBUGFS_STATS_ADD(dot11TransmittedFrameCount);
462 	DEBUGFS_STATS_ADD(tx_handlers_drop);
463 	DEBUGFS_STATS_ADD(tx_handlers_queued);
464 	DEBUGFS_STATS_ADD(tx_handlers_drop_wep);
465 	DEBUGFS_STATS_ADD(tx_handlers_drop_not_assoc);
466 	DEBUGFS_STATS_ADD(tx_handlers_drop_unauth_port);
467 	DEBUGFS_STATS_ADD(rx_handlers_drop);
468 	DEBUGFS_STATS_ADD(rx_handlers_queued);
469 	DEBUGFS_STATS_ADD(rx_handlers_drop_nullfunc);
470 	DEBUGFS_STATS_ADD(rx_handlers_drop_defrag);
471 	DEBUGFS_STATS_ADD(tx_expand_skb_head);
472 	DEBUGFS_STATS_ADD(tx_expand_skb_head_cloned);
473 	DEBUGFS_STATS_ADD(rx_expand_skb_head_defrag);
474 	DEBUGFS_STATS_ADD(rx_handlers_fragments);
475 	DEBUGFS_STATS_ADD(tx_status_drop);
476 #endif
477 	DEBUGFS_DEVSTATS_ADD(dot11ACKFailureCount);
478 	DEBUGFS_DEVSTATS_ADD(dot11RTSFailureCount);
479 	DEBUGFS_DEVSTATS_ADD(dot11FCSErrorCount);
480 	DEBUGFS_DEVSTATS_ADD(dot11RTSSuccessCount);
481 }
482