xref: /openbmc/linux/net/mac80211/debugfs.c (revision a59511d1)
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 "ieee80211_i.h"
14 #include "driver-ops.h"
15 #include "rate.h"
16 #include "debugfs.h"
17 
18 #define DEBUGFS_FORMAT_BUFFER_SIZE 100
19 
20 int mac80211_format_buffer(char __user *userbuf, size_t count,
21 				  loff_t *ppos, char *fmt, ...)
22 {
23 	va_list args;
24 	char buf[DEBUGFS_FORMAT_BUFFER_SIZE];
25 	int res;
26 
27 	va_start(args, fmt);
28 	res = vscnprintf(buf, sizeof(buf), fmt, args);
29 	va_end(args);
30 
31 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
32 }
33 
34 #define DEBUGFS_READONLY_FILE_FN(name, fmt, value...)			\
35 static ssize_t name## _read(struct file *file, char __user *userbuf,	\
36 			    size_t count, loff_t *ppos)			\
37 {									\
38 	struct ieee80211_local *local = file->private_data;		\
39 									\
40 	return mac80211_format_buffer(userbuf, count, ppos, 		\
41 				      fmt "\n", ##value);		\
42 }
43 
44 #define DEBUGFS_READONLY_FILE_OPS(name)			\
45 static const struct file_operations name## _ops = {			\
46 	.read = name## _read,						\
47 	.open = simple_open,						\
48 	.llseek = generic_file_llseek,					\
49 };
50 
51 #define DEBUGFS_READONLY_FILE(name, fmt, value...)		\
52 	DEBUGFS_READONLY_FILE_FN(name, fmt, value)		\
53 	DEBUGFS_READONLY_FILE_OPS(name)
54 
55 #define DEBUGFS_ADD(name)						\
56 	debugfs_create_file(#name, 0400, phyd, local, &name## _ops);
57 
58 #define DEBUGFS_ADD_MODE(name, mode)					\
59 	debugfs_create_file(#name, mode, phyd, local, &name## _ops);
60 
61 
62 DEBUGFS_READONLY_FILE(user_power, "%d",
63 		      local->user_power_level);
64 DEBUGFS_READONLY_FILE(power, "%d",
65 		      local->hw.conf.power_level);
66 DEBUGFS_READONLY_FILE(total_ps_buffered, "%d",
67 		      local->total_ps_buffered);
68 DEBUGFS_READONLY_FILE(wep_iv, "%#08x",
69 		      local->wep_iv & 0xffffff);
70 DEBUGFS_READONLY_FILE(rate_ctrl_alg, "%s",
71 	local->rate_ctrl ? local->rate_ctrl->ops->name : "hw/driver");
72 
73 #ifdef CONFIG_PM
74 static ssize_t reset_write(struct file *file, const char __user *user_buf,
75 			   size_t count, loff_t *ppos)
76 {
77 	struct ieee80211_local *local = file->private_data;
78 
79 	rtnl_lock();
80 	__ieee80211_suspend(&local->hw, NULL);
81 	__ieee80211_resume(&local->hw);
82 	rtnl_unlock();
83 
84 	return count;
85 }
86 
87 static const struct file_operations reset_ops = {
88 	.write = reset_write,
89 	.open = simple_open,
90 	.llseek = noop_llseek,
91 };
92 #endif
93 
94 static const char *hw_flag_names[] = {
95 #define FLAG(F)	[IEEE80211_HW_##F] = #F
96 	FLAG(HAS_RATE_CONTROL),
97 	FLAG(RX_INCLUDES_FCS),
98 	FLAG(HOST_BROADCAST_PS_BUFFERING),
99 	FLAG(SIGNAL_UNSPEC),
100 	FLAG(SIGNAL_DBM),
101 	FLAG(NEED_DTIM_BEFORE_ASSOC),
102 	FLAG(SPECTRUM_MGMT),
103 	FLAG(AMPDU_AGGREGATION),
104 	FLAG(SUPPORTS_PS),
105 	FLAG(PS_NULLFUNC_STACK),
106 	FLAG(SUPPORTS_DYNAMIC_PS),
107 	FLAG(MFP_CAPABLE),
108 	FLAG(WANT_MONITOR_VIF),
109 	FLAG(NO_AUTO_VIF),
110 	FLAG(SW_CRYPTO_CONTROL),
111 	FLAG(SUPPORT_FAST_XMIT),
112 	FLAG(REPORTS_TX_ACK_STATUS),
113 	FLAG(CONNECTION_MONITOR),
114 	FLAG(QUEUE_CONTROL),
115 	FLAG(SUPPORTS_PER_STA_GTK),
116 	FLAG(AP_LINK_PS),
117 	FLAG(TX_AMPDU_SETUP_IN_HW),
118 	FLAG(SUPPORTS_RC_TABLE),
119 	FLAG(P2P_DEV_ADDR_FOR_INTF),
120 	FLAG(TIMING_BEACON_ONLY),
121 	FLAG(SUPPORTS_HT_CCK_RATES),
122 	FLAG(CHANCTX_STA_CSA),
123 	FLAG(SUPPORTS_CLONED_SKBS),
124 	FLAG(SINGLE_SCAN_ON_ALL_BANDS),
125 	FLAG(TDLS_WIDER_BW),
126 	FLAG(SUPPORTS_AMSDU_IN_AMPDU),
127 	FLAG(BEACON_TX_STATUS),
128 	FLAG(NEEDS_UNIQUE_STA_ADDR),
129 	FLAG(SUPPORTS_REORDERING_BUFFER),
130 #undef FLAG
131 };
132 
133 static ssize_t hwflags_read(struct file *file, char __user *user_buf,
134 			    size_t count, loff_t *ppos)
135 {
136 	struct ieee80211_local *local = file->private_data;
137 	size_t bufsz = 30 * NUM_IEEE80211_HW_FLAGS;
138 	char *buf = kzalloc(bufsz, GFP_KERNEL);
139 	char *pos = buf, *end = buf + bufsz - 1;
140 	ssize_t rv;
141 	int i;
142 
143 	if (!buf)
144 		return -ENOMEM;
145 
146 	/* fail compilation if somebody adds or removes
147 	 * a flag without updating the name array above
148 	 */
149 	BUILD_BUG_ON(ARRAY_SIZE(hw_flag_names) != NUM_IEEE80211_HW_FLAGS);
150 
151 	for (i = 0; i < NUM_IEEE80211_HW_FLAGS; i++) {
152 		if (test_bit(i, local->hw.flags))
153 			pos += scnprintf(pos, end - pos, "%s\n",
154 					 hw_flag_names[i]);
155 	}
156 
157 	rv = simple_read_from_buffer(user_buf, count, ppos, buf, strlen(buf));
158 	kfree(buf);
159 	return rv;
160 }
161 
162 static ssize_t queues_read(struct file *file, char __user *user_buf,
163 			   size_t count, loff_t *ppos)
164 {
165 	struct ieee80211_local *local = file->private_data;
166 	unsigned long flags;
167 	char buf[IEEE80211_MAX_QUEUES * 20];
168 	int q, res = 0;
169 
170 	spin_lock_irqsave(&local->queue_stop_reason_lock, flags);
171 	for (q = 0; q < local->hw.queues; q++)
172 		res += sprintf(buf + res, "%02d: %#.8lx/%d\n", q,
173 				local->queue_stop_reasons[q],
174 				skb_queue_len(&local->pending[q]));
175 	spin_unlock_irqrestore(&local->queue_stop_reason_lock, flags);
176 
177 	return simple_read_from_buffer(user_buf, count, ppos, buf, res);
178 }
179 
180 DEBUGFS_READONLY_FILE_OPS(hwflags);
181 DEBUGFS_READONLY_FILE_OPS(queues);
182 
183 /* statistics stuff */
184 
185 static ssize_t format_devstat_counter(struct ieee80211_local *local,
186 	char __user *userbuf,
187 	size_t count, loff_t *ppos,
188 	int (*printvalue)(struct ieee80211_low_level_stats *stats, char *buf,
189 			  int buflen))
190 {
191 	struct ieee80211_low_level_stats stats;
192 	char buf[20];
193 	int res;
194 
195 	rtnl_lock();
196 	res = drv_get_stats(local, &stats);
197 	rtnl_unlock();
198 	if (res)
199 		return res;
200 	res = printvalue(&stats, buf, sizeof(buf));
201 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
202 }
203 
204 #define DEBUGFS_DEVSTATS_FILE(name)					\
205 static int print_devstats_##name(struct ieee80211_low_level_stats *stats,\
206 				 char *buf, int buflen)			\
207 {									\
208 	return scnprintf(buf, buflen, "%u\n", stats->name);		\
209 }									\
210 static ssize_t stats_ ##name## _read(struct file *file,			\
211 				     char __user *userbuf,		\
212 				     size_t count, loff_t *ppos)	\
213 {									\
214 	return format_devstat_counter(file->private_data,		\
215 				      userbuf,				\
216 				      count,				\
217 				      ppos,				\
218 				      print_devstats_##name);		\
219 }									\
220 									\
221 static const struct file_operations stats_ ##name## _ops = {		\
222 	.read = stats_ ##name## _read,					\
223 	.open = simple_open,						\
224 	.llseek = generic_file_llseek,					\
225 };
226 
227 #define DEBUGFS_STATS_ADD(name)					\
228 	debugfs_create_u32(#name, 0400, statsd, &local->name);
229 #define DEBUGFS_DEVSTATS_ADD(name)					\
230 	debugfs_create_file(#name, 0400, statsd, local, &stats_ ##name## _ops);
231 
232 DEBUGFS_DEVSTATS_FILE(dot11ACKFailureCount);
233 DEBUGFS_DEVSTATS_FILE(dot11RTSFailureCount);
234 DEBUGFS_DEVSTATS_FILE(dot11FCSErrorCount);
235 DEBUGFS_DEVSTATS_FILE(dot11RTSSuccessCount);
236 
237 void debugfs_hw_add(struct ieee80211_local *local)
238 {
239 	struct dentry *phyd = local->hw.wiphy->debugfsdir;
240 	struct dentry *statsd;
241 
242 	if (!phyd)
243 		return;
244 
245 	local->debugfs.keys = debugfs_create_dir("keys", phyd);
246 
247 	DEBUGFS_ADD(total_ps_buffered);
248 	DEBUGFS_ADD(wep_iv);
249 	DEBUGFS_ADD(queues);
250 #ifdef CONFIG_PM
251 	DEBUGFS_ADD_MODE(reset, 0200);
252 #endif
253 	DEBUGFS_ADD(hwflags);
254 	DEBUGFS_ADD(user_power);
255 	DEBUGFS_ADD(power);
256 
257 	statsd = debugfs_create_dir("statistics", phyd);
258 
259 	/* if the dir failed, don't put all the other things into the root! */
260 	if (!statsd)
261 		return;
262 
263 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
264 	DEBUGFS_STATS_ADD(dot11TransmittedFragmentCount);
265 	DEBUGFS_STATS_ADD(dot11MulticastTransmittedFrameCount);
266 	DEBUGFS_STATS_ADD(dot11FailedCount);
267 	DEBUGFS_STATS_ADD(dot11RetryCount);
268 	DEBUGFS_STATS_ADD(dot11MultipleRetryCount);
269 	DEBUGFS_STATS_ADD(dot11FrameDuplicateCount);
270 	DEBUGFS_STATS_ADD(dot11ReceivedFragmentCount);
271 	DEBUGFS_STATS_ADD(dot11MulticastReceivedFrameCount);
272 	DEBUGFS_STATS_ADD(dot11TransmittedFrameCount);
273 	DEBUGFS_STATS_ADD(tx_handlers_drop);
274 	DEBUGFS_STATS_ADD(tx_handlers_queued);
275 	DEBUGFS_STATS_ADD(tx_handlers_drop_wep);
276 	DEBUGFS_STATS_ADD(tx_handlers_drop_not_assoc);
277 	DEBUGFS_STATS_ADD(tx_handlers_drop_unauth_port);
278 	DEBUGFS_STATS_ADD(rx_handlers_drop);
279 	DEBUGFS_STATS_ADD(rx_handlers_queued);
280 	DEBUGFS_STATS_ADD(rx_handlers_drop_nullfunc);
281 	DEBUGFS_STATS_ADD(rx_handlers_drop_defrag);
282 	DEBUGFS_STATS_ADD(tx_expand_skb_head);
283 	DEBUGFS_STATS_ADD(tx_expand_skb_head_cloned);
284 	DEBUGFS_STATS_ADD(rx_expand_skb_head_defrag);
285 	DEBUGFS_STATS_ADD(rx_handlers_fragments);
286 	DEBUGFS_STATS_ADD(tx_status_drop);
287 #endif
288 	DEBUGFS_DEVSTATS_ADD(dot11ACKFailureCount);
289 	DEBUGFS_DEVSTATS_ADD(dot11RTSFailureCount);
290 	DEBUGFS_DEVSTATS_ADD(dot11FCSErrorCount);
291 	DEBUGFS_DEVSTATS_ADD(dot11RTSSuccessCount);
292 }
293