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