xref: /openbmc/linux/net/mac80211/debugfs.c (revision 2fa49589)
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 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 #ifdef CONFIG_PM
154 static ssize_t reset_write(struct file *file, const char __user *user_buf,
155 			   size_t count, loff_t *ppos)
156 {
157 	struct ieee80211_local *local = file->private_data;
158 
159 	rtnl_lock();
160 	__ieee80211_suspend(&local->hw, NULL);
161 	__ieee80211_resume(&local->hw);
162 	rtnl_unlock();
163 
164 	return count;
165 }
166 
167 static const struct file_operations reset_ops = {
168 	.write = reset_write,
169 	.open = simple_open,
170 	.llseek = noop_llseek,
171 };
172 #endif
173 
174 static const char *hw_flag_names[] = {
175 #define FLAG(F)	[IEEE80211_HW_##F] = #F
176 	FLAG(HAS_RATE_CONTROL),
177 	FLAG(RX_INCLUDES_FCS),
178 	FLAG(HOST_BROADCAST_PS_BUFFERING),
179 	FLAG(SIGNAL_UNSPEC),
180 	FLAG(SIGNAL_DBM),
181 	FLAG(NEED_DTIM_BEFORE_ASSOC),
182 	FLAG(SPECTRUM_MGMT),
183 	FLAG(AMPDU_AGGREGATION),
184 	FLAG(SUPPORTS_PS),
185 	FLAG(PS_NULLFUNC_STACK),
186 	FLAG(SUPPORTS_DYNAMIC_PS),
187 	FLAG(MFP_CAPABLE),
188 	FLAG(WANT_MONITOR_VIF),
189 	FLAG(NO_AUTO_VIF),
190 	FLAG(SW_CRYPTO_CONTROL),
191 	FLAG(SUPPORT_FAST_XMIT),
192 	FLAG(REPORTS_TX_ACK_STATUS),
193 	FLAG(CONNECTION_MONITOR),
194 	FLAG(QUEUE_CONTROL),
195 	FLAG(SUPPORTS_PER_STA_GTK),
196 	FLAG(AP_LINK_PS),
197 	FLAG(TX_AMPDU_SETUP_IN_HW),
198 	FLAG(SUPPORTS_RC_TABLE),
199 	FLAG(P2P_DEV_ADDR_FOR_INTF),
200 	FLAG(TIMING_BEACON_ONLY),
201 	FLAG(SUPPORTS_HT_CCK_RATES),
202 	FLAG(CHANCTX_STA_CSA),
203 	FLAG(SUPPORTS_CLONED_SKBS),
204 	FLAG(SINGLE_SCAN_ON_ALL_BANDS),
205 	FLAG(TDLS_WIDER_BW),
206 	FLAG(SUPPORTS_AMSDU_IN_AMPDU),
207 	FLAG(BEACON_TX_STATUS),
208 	FLAG(NEEDS_UNIQUE_STA_ADDR),
209 	FLAG(SUPPORTS_REORDERING_BUFFER),
210 	FLAG(USES_RSS),
211 	FLAG(TX_AMSDU),
212 	FLAG(TX_FRAG_LIST),
213 	FLAG(REPORTS_LOW_ACK),
214 	FLAG(SUPPORTS_TX_FRAG),
215 	FLAG(SUPPORTS_TDLS_BUFFER_STA),
216 	FLAG(DEAUTH_NEED_MGD_TX_PREP),
217 	FLAG(DOESNT_SUPPORT_QOS_NDP),
218 	FLAG(BUFF_MMPDU_TXQ),
219 	FLAG(SUPPORTS_VHT_EXT_NSS_BW),
220 	FLAG(STA_MMPDU_TXQ),
221 #undef FLAG
222 };
223 
224 static ssize_t hwflags_read(struct file *file, char __user *user_buf,
225 			    size_t count, loff_t *ppos)
226 {
227 	struct ieee80211_local *local = file->private_data;
228 	size_t bufsz = 30 * NUM_IEEE80211_HW_FLAGS;
229 	char *buf = kzalloc(bufsz, GFP_KERNEL);
230 	char *pos = buf, *end = buf + bufsz - 1;
231 	ssize_t rv;
232 	int i;
233 
234 	if (!buf)
235 		return -ENOMEM;
236 
237 	/* fail compilation if somebody adds or removes
238 	 * a flag without updating the name array above
239 	 */
240 	BUILD_BUG_ON(ARRAY_SIZE(hw_flag_names) != NUM_IEEE80211_HW_FLAGS);
241 
242 	for (i = 0; i < NUM_IEEE80211_HW_FLAGS; i++) {
243 		if (test_bit(i, local->hw.flags))
244 			pos += scnprintf(pos, end - pos, "%s\n",
245 					 hw_flag_names[i]);
246 	}
247 
248 	rv = simple_read_from_buffer(user_buf, count, ppos, buf, strlen(buf));
249 	kfree(buf);
250 	return rv;
251 }
252 
253 static ssize_t misc_read(struct file *file, char __user *user_buf,
254 			 size_t count, loff_t *ppos)
255 {
256 	struct ieee80211_local *local = file->private_data;
257 	/* Max len of each line is 16 characters, plus 9 for 'pending:\n' */
258 	size_t bufsz = IEEE80211_MAX_QUEUES * 16 + 9;
259 	char *buf;
260 	char *pos, *end;
261 	ssize_t rv;
262 	int i;
263 	int ln;
264 
265 	buf = kzalloc(bufsz, GFP_KERNEL);
266 	if (!buf)
267 		return -ENOMEM;
268 
269 	pos = buf;
270 	end = buf + bufsz - 1;
271 
272 	pos += scnprintf(pos, end - pos, "pending:\n");
273 
274 	for (i = 0; i < IEEE80211_MAX_QUEUES; i++) {
275 		ln = skb_queue_len(&local->pending[i]);
276 		pos += scnprintf(pos, end - pos, "[%i] %d\n",
277 				 i, ln);
278 	}
279 
280 	rv = simple_read_from_buffer(user_buf, count, ppos, buf, strlen(buf));
281 	kfree(buf);
282 	return rv;
283 }
284 
285 static ssize_t queues_read(struct file *file, char __user *user_buf,
286 			   size_t count, loff_t *ppos)
287 {
288 	struct ieee80211_local *local = file->private_data;
289 	unsigned long flags;
290 	char buf[IEEE80211_MAX_QUEUES * 20];
291 	int q, res = 0;
292 
293 	spin_lock_irqsave(&local->queue_stop_reason_lock, flags);
294 	for (q = 0; q < local->hw.queues; q++)
295 		res += sprintf(buf + res, "%02d: %#.8lx/%d\n", q,
296 				local->queue_stop_reasons[q],
297 				skb_queue_len(&local->pending[q]));
298 	spin_unlock_irqrestore(&local->queue_stop_reason_lock, flags);
299 
300 	return simple_read_from_buffer(user_buf, count, ppos, buf, res);
301 }
302 
303 DEBUGFS_READONLY_FILE_OPS(hwflags);
304 DEBUGFS_READONLY_FILE_OPS(queues);
305 DEBUGFS_READONLY_FILE_OPS(misc);
306 
307 /* statistics stuff */
308 
309 static ssize_t format_devstat_counter(struct ieee80211_local *local,
310 	char __user *userbuf,
311 	size_t count, loff_t *ppos,
312 	int (*printvalue)(struct ieee80211_low_level_stats *stats, char *buf,
313 			  int buflen))
314 {
315 	struct ieee80211_low_level_stats stats;
316 	char buf[20];
317 	int res;
318 
319 	rtnl_lock();
320 	res = drv_get_stats(local, &stats);
321 	rtnl_unlock();
322 	if (res)
323 		return res;
324 	res = printvalue(&stats, buf, sizeof(buf));
325 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
326 }
327 
328 #define DEBUGFS_DEVSTATS_FILE(name)					\
329 static int print_devstats_##name(struct ieee80211_low_level_stats *stats,\
330 				 char *buf, int buflen)			\
331 {									\
332 	return scnprintf(buf, buflen, "%u\n", stats->name);		\
333 }									\
334 static ssize_t stats_ ##name## _read(struct file *file,			\
335 				     char __user *userbuf,		\
336 				     size_t count, loff_t *ppos)	\
337 {									\
338 	return format_devstat_counter(file->private_data,		\
339 				      userbuf,				\
340 				      count,				\
341 				      ppos,				\
342 				      print_devstats_##name);		\
343 }									\
344 									\
345 static const struct file_operations stats_ ##name## _ops = {		\
346 	.read = stats_ ##name## _read,					\
347 	.open = simple_open,						\
348 	.llseek = generic_file_llseek,					\
349 };
350 
351 #define DEBUGFS_STATS_ADD(name)					\
352 	debugfs_create_u32(#name, 0400, statsd, &local->name);
353 #define DEBUGFS_DEVSTATS_ADD(name)					\
354 	debugfs_create_file(#name, 0400, statsd, local, &stats_ ##name## _ops);
355 
356 DEBUGFS_DEVSTATS_FILE(dot11ACKFailureCount);
357 DEBUGFS_DEVSTATS_FILE(dot11RTSFailureCount);
358 DEBUGFS_DEVSTATS_FILE(dot11FCSErrorCount);
359 DEBUGFS_DEVSTATS_FILE(dot11RTSSuccessCount);
360 
361 void debugfs_hw_add(struct ieee80211_local *local)
362 {
363 	struct dentry *phyd = local->hw.wiphy->debugfsdir;
364 	struct dentry *statsd;
365 
366 	if (!phyd)
367 		return;
368 
369 	local->debugfs.keys = debugfs_create_dir("keys", phyd);
370 
371 	DEBUGFS_ADD(total_ps_buffered);
372 	DEBUGFS_ADD(wep_iv);
373 	DEBUGFS_ADD(rate_ctrl_alg);
374 	DEBUGFS_ADD(queues);
375 	DEBUGFS_ADD(misc);
376 #ifdef CONFIG_PM
377 	DEBUGFS_ADD_MODE(reset, 0200);
378 #endif
379 	DEBUGFS_ADD(hwflags);
380 	DEBUGFS_ADD(user_power);
381 	DEBUGFS_ADD(power);
382 
383 	if (local->ops->wake_tx_queue)
384 		DEBUGFS_ADD_MODE(aqm, 0600);
385 
386 	statsd = debugfs_create_dir("statistics", phyd);
387 
388 	/* if the dir failed, don't put all the other things into the root! */
389 	if (!statsd)
390 		return;
391 
392 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
393 	DEBUGFS_STATS_ADD(dot11TransmittedFragmentCount);
394 	DEBUGFS_STATS_ADD(dot11MulticastTransmittedFrameCount);
395 	DEBUGFS_STATS_ADD(dot11FailedCount);
396 	DEBUGFS_STATS_ADD(dot11RetryCount);
397 	DEBUGFS_STATS_ADD(dot11MultipleRetryCount);
398 	DEBUGFS_STATS_ADD(dot11FrameDuplicateCount);
399 	DEBUGFS_STATS_ADD(dot11ReceivedFragmentCount);
400 	DEBUGFS_STATS_ADD(dot11MulticastReceivedFrameCount);
401 	DEBUGFS_STATS_ADD(dot11TransmittedFrameCount);
402 	DEBUGFS_STATS_ADD(tx_handlers_drop);
403 	DEBUGFS_STATS_ADD(tx_handlers_queued);
404 	DEBUGFS_STATS_ADD(tx_handlers_drop_wep);
405 	DEBUGFS_STATS_ADD(tx_handlers_drop_not_assoc);
406 	DEBUGFS_STATS_ADD(tx_handlers_drop_unauth_port);
407 	DEBUGFS_STATS_ADD(rx_handlers_drop);
408 	DEBUGFS_STATS_ADD(rx_handlers_queued);
409 	DEBUGFS_STATS_ADD(rx_handlers_drop_nullfunc);
410 	DEBUGFS_STATS_ADD(rx_handlers_drop_defrag);
411 	DEBUGFS_STATS_ADD(tx_expand_skb_head);
412 	DEBUGFS_STATS_ADD(tx_expand_skb_head_cloned);
413 	DEBUGFS_STATS_ADD(rx_expand_skb_head_defrag);
414 	DEBUGFS_STATS_ADD(rx_handlers_fragments);
415 	DEBUGFS_STATS_ADD(tx_status_drop);
416 #endif
417 	DEBUGFS_DEVSTATS_ADD(dot11ACKFailureCount);
418 	DEBUGFS_DEVSTATS_ADD(dot11RTSFailureCount);
419 	DEBUGFS_DEVSTATS_ADD(dot11FCSErrorCount);
420 	DEBUGFS_DEVSTATS_ADD(dot11RTSSuccessCount);
421 }
422