xref: /openbmc/linux/net/mac80211/debugfs_sta.c (revision e6c81cce)
1 /*
2  * Copyright 2003-2005	Devicescape Software, Inc.
3  * Copyright (c) 2006	Jiri Benc <jbenc@suse.cz>
4  * Copyright 2007	Johannes Berg <johannes@sipsolutions.net>
5  * Copyright 2013-2014  Intel Mobile Communications GmbH
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  */
11 
12 #include <linux/debugfs.h>
13 #include <linux/ieee80211.h>
14 #include "ieee80211_i.h"
15 #include "debugfs.h"
16 #include "debugfs_sta.h"
17 #include "sta_info.h"
18 #include "driver-ops.h"
19 
20 /* sta attributtes */
21 
22 #define STA_READ(name, field, format_string)				\
23 static ssize_t sta_ ##name## _read(struct file *file,			\
24 				   char __user *userbuf,		\
25 				   size_t count, loff_t *ppos)		\
26 {									\
27 	struct sta_info *sta = file->private_data;			\
28 	return mac80211_format_buffer(userbuf, count, ppos, 		\
29 				      format_string, sta->field);	\
30 }
31 #define STA_READ_D(name, field) STA_READ(name, field, "%d\n")
32 #define STA_READ_U(name, field) STA_READ(name, field, "%u\n")
33 #define STA_READ_S(name, field) STA_READ(name, field, "%s\n")
34 
35 #define STA_OPS(name)							\
36 static const struct file_operations sta_ ##name## _ops = {		\
37 	.read = sta_##name##_read,					\
38 	.open = simple_open,						\
39 	.llseek = generic_file_llseek,					\
40 }
41 
42 #define STA_OPS_RW(name)						\
43 static const struct file_operations sta_ ##name## _ops = {		\
44 	.read = sta_##name##_read,					\
45 	.write = sta_##name##_write,					\
46 	.open = simple_open,						\
47 	.llseek = generic_file_llseek,					\
48 }
49 
50 #define STA_FILE(name, field, format)					\
51 		STA_READ_##format(name, field)				\
52 		STA_OPS(name)
53 
54 STA_FILE(aid, sta.aid, D);
55 STA_FILE(dev, sdata->name, S);
56 STA_FILE(last_signal, last_signal, D);
57 STA_FILE(last_ack_signal, last_ack_signal, D);
58 STA_FILE(beacon_loss_count, beacon_loss_count, D);
59 
60 static ssize_t sta_flags_read(struct file *file, char __user *userbuf,
61 			      size_t count, loff_t *ppos)
62 {
63 	char buf[121];
64 	struct sta_info *sta = file->private_data;
65 
66 #define TEST(flg) \
67 	test_sta_flag(sta, WLAN_STA_##flg) ? #flg "\n" : ""
68 
69 	int res = scnprintf(buf, sizeof(buf),
70 			    "%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s",
71 			    TEST(AUTH), TEST(ASSOC), TEST(PS_STA),
72 			    TEST(PS_DRIVER), TEST(AUTHORIZED),
73 			    TEST(SHORT_PREAMBLE),
74 			    sta->sta.wme ? "WME\n" : "",
75 			    TEST(WDS), TEST(CLEAR_PS_FILT),
76 			    TEST(MFP), TEST(BLOCK_BA), TEST(PSPOLL),
77 			    TEST(UAPSD), TEST(SP), TEST(TDLS_PEER),
78 			    TEST(TDLS_PEER_AUTH), TEST(TDLS_INITIATOR),
79 			    TEST(TDLS_CHAN_SWITCH), TEST(TDLS_OFF_CHANNEL),
80 			    TEST(4ADDR_EVENT), TEST(INSERTED),
81 			    TEST(RATE_CONTROL), TEST(TOFFSET_KNOWN),
82 			    TEST(MPSP_OWNER), TEST(MPSP_RECIPIENT));
83 #undef TEST
84 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
85 }
86 STA_OPS(flags);
87 
88 static ssize_t sta_num_ps_buf_frames_read(struct file *file,
89 					  char __user *userbuf,
90 					  size_t count, loff_t *ppos)
91 {
92 	struct sta_info *sta = file->private_data;
93 	char buf[17*IEEE80211_NUM_ACS], *p = buf;
94 	int ac;
95 
96 	for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
97 		p += scnprintf(p, sizeof(buf)+buf-p, "AC%d: %d\n", ac,
98 			       skb_queue_len(&sta->ps_tx_buf[ac]) +
99 			       skb_queue_len(&sta->tx_filtered[ac]));
100 	return simple_read_from_buffer(userbuf, count, ppos, buf, p - buf);
101 }
102 STA_OPS(num_ps_buf_frames);
103 
104 static ssize_t sta_inactive_ms_read(struct file *file, char __user *userbuf,
105 				    size_t count, loff_t *ppos)
106 {
107 	struct sta_info *sta = file->private_data;
108 	return mac80211_format_buffer(userbuf, count, ppos, "%d\n",
109 				      jiffies_to_msecs(jiffies - sta->last_rx));
110 }
111 STA_OPS(inactive_ms);
112 
113 
114 static ssize_t sta_connected_time_read(struct file *file, char __user *userbuf,
115 					size_t count, loff_t *ppos)
116 {
117 	struct sta_info *sta = file->private_data;
118 	struct timespec uptime;
119 	struct tm result;
120 	long connected_time_secs;
121 	char buf[100];
122 	int res;
123 	ktime_get_ts(&uptime);
124 	connected_time_secs = uptime.tv_sec - sta->last_connected;
125 	time_to_tm(connected_time_secs, 0, &result);
126 	result.tm_year -= 70;
127 	result.tm_mday -= 1;
128 	res = scnprintf(buf, sizeof(buf),
129 		"years  - %ld\nmonths - %d\ndays   - %d\nclock  - %d:%d:%d\n\n",
130 			result.tm_year, result.tm_mon, result.tm_mday,
131 			result.tm_hour, result.tm_min, result.tm_sec);
132 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
133 }
134 STA_OPS(connected_time);
135 
136 
137 
138 static ssize_t sta_last_seq_ctrl_read(struct file *file, char __user *userbuf,
139 				      size_t count, loff_t *ppos)
140 {
141 	char buf[15*IEEE80211_NUM_TIDS], *p = buf;
142 	int i;
143 	struct sta_info *sta = file->private_data;
144 	for (i = 0; i < IEEE80211_NUM_TIDS; i++)
145 		p += scnprintf(p, sizeof(buf)+buf-p, "%x ",
146 			       le16_to_cpu(sta->last_seq_ctrl[i]));
147 	p += scnprintf(p, sizeof(buf)+buf-p, "\n");
148 	return simple_read_from_buffer(userbuf, count, ppos, buf, p - buf);
149 }
150 STA_OPS(last_seq_ctrl);
151 
152 static ssize_t sta_agg_status_read(struct file *file, char __user *userbuf,
153 					size_t count, loff_t *ppos)
154 {
155 	char buf[71 + IEEE80211_NUM_TIDS * 40], *p = buf;
156 	int i;
157 	struct sta_info *sta = file->private_data;
158 	struct tid_ampdu_rx *tid_rx;
159 	struct tid_ampdu_tx *tid_tx;
160 
161 	rcu_read_lock();
162 
163 	p += scnprintf(p, sizeof(buf) + buf - p, "next dialog_token: %#02x\n",
164 			sta->ampdu_mlme.dialog_token_allocator + 1);
165 	p += scnprintf(p, sizeof(buf) + buf - p,
166 		       "TID\t\tRX\tDTKN\tSSN\t\tTX\tDTKN\tpending\n");
167 
168 	for (i = 0; i < IEEE80211_NUM_TIDS; i++) {
169 		tid_rx = rcu_dereference(sta->ampdu_mlme.tid_rx[i]);
170 		tid_tx = rcu_dereference(sta->ampdu_mlme.tid_tx[i]);
171 
172 		p += scnprintf(p, sizeof(buf) + buf - p, "%02d", i);
173 		p += scnprintf(p, sizeof(buf) + buf - p, "\t\t%x", !!tid_rx);
174 		p += scnprintf(p, sizeof(buf) + buf - p, "\t%#.2x",
175 				tid_rx ? tid_rx->dialog_token : 0);
176 		p += scnprintf(p, sizeof(buf) + buf - p, "\t%#.3x",
177 				tid_rx ? tid_rx->ssn : 0);
178 
179 		p += scnprintf(p, sizeof(buf) + buf - p, "\t\t%x", !!tid_tx);
180 		p += scnprintf(p, sizeof(buf) + buf - p, "\t%#.2x",
181 				tid_tx ? tid_tx->dialog_token : 0);
182 		p += scnprintf(p, sizeof(buf) + buf - p, "\t%03d",
183 				tid_tx ? skb_queue_len(&tid_tx->pending) : 0);
184 		p += scnprintf(p, sizeof(buf) + buf - p, "\n");
185 	}
186 	rcu_read_unlock();
187 
188 	return simple_read_from_buffer(userbuf, count, ppos, buf, p - buf);
189 }
190 
191 static ssize_t sta_agg_status_write(struct file *file, const char __user *userbuf,
192 				    size_t count, loff_t *ppos)
193 {
194 	char _buf[12] = {}, *buf = _buf;
195 	struct sta_info *sta = file->private_data;
196 	bool start, tx;
197 	unsigned long tid;
198 	int ret;
199 
200 	if (count > sizeof(_buf))
201 		return -EINVAL;
202 
203 	if (copy_from_user(buf, userbuf, count))
204 		return -EFAULT;
205 
206 	buf[sizeof(_buf) - 1] = '\0';
207 
208 	if (strncmp(buf, "tx ", 3) == 0) {
209 		buf += 3;
210 		tx = true;
211 	} else if (strncmp(buf, "rx ", 3) == 0) {
212 		buf += 3;
213 		tx = false;
214 	} else
215 		return -EINVAL;
216 
217 	if (strncmp(buf, "start ", 6) == 0) {
218 		buf += 6;
219 		start = true;
220 		if (!tx)
221 			return -EINVAL;
222 	} else if (strncmp(buf, "stop ", 5) == 0) {
223 		buf += 5;
224 		start = false;
225 	} else
226 		return -EINVAL;
227 
228 	ret = kstrtoul(buf, 0, &tid);
229 	if (ret)
230 		return ret;
231 
232 	if (tid >= IEEE80211_NUM_TIDS)
233 		return -EINVAL;
234 
235 	if (tx) {
236 		if (start)
237 			ret = ieee80211_start_tx_ba_session(&sta->sta, tid, 5000);
238 		else
239 			ret = ieee80211_stop_tx_ba_session(&sta->sta, tid);
240 	} else {
241 		__ieee80211_stop_rx_ba_session(sta, tid, WLAN_BACK_RECIPIENT,
242 					       3, true);
243 		ret = 0;
244 	}
245 
246 	return ret ?: count;
247 }
248 STA_OPS_RW(agg_status);
249 
250 static ssize_t sta_ht_capa_read(struct file *file, char __user *userbuf,
251 				size_t count, loff_t *ppos)
252 {
253 #define PRINT_HT_CAP(_cond, _str) \
254 	do { \
255 	if (_cond) \
256 			p += scnprintf(p, sizeof(buf)+buf-p, "\t" _str "\n"); \
257 	} while (0)
258 	char buf[512], *p = buf;
259 	int i;
260 	struct sta_info *sta = file->private_data;
261 	struct ieee80211_sta_ht_cap *htc = &sta->sta.ht_cap;
262 
263 	p += scnprintf(p, sizeof(buf) + buf - p, "ht %ssupported\n",
264 			htc->ht_supported ? "" : "not ");
265 	if (htc->ht_supported) {
266 		p += scnprintf(p, sizeof(buf)+buf-p, "cap: %#.4x\n", htc->cap);
267 
268 		PRINT_HT_CAP((htc->cap & BIT(0)), "RX LDPC");
269 		PRINT_HT_CAP((htc->cap & BIT(1)), "HT20/HT40");
270 		PRINT_HT_CAP(!(htc->cap & BIT(1)), "HT20");
271 
272 		PRINT_HT_CAP(((htc->cap >> 2) & 0x3) == 0, "Static SM Power Save");
273 		PRINT_HT_CAP(((htc->cap >> 2) & 0x3) == 1, "Dynamic SM Power Save");
274 		PRINT_HT_CAP(((htc->cap >> 2) & 0x3) == 3, "SM Power Save disabled");
275 
276 		PRINT_HT_CAP((htc->cap & BIT(4)), "RX Greenfield");
277 		PRINT_HT_CAP((htc->cap & BIT(5)), "RX HT20 SGI");
278 		PRINT_HT_CAP((htc->cap & BIT(6)), "RX HT40 SGI");
279 		PRINT_HT_CAP((htc->cap & BIT(7)), "TX STBC");
280 
281 		PRINT_HT_CAP(((htc->cap >> 8) & 0x3) == 0, "No RX STBC");
282 		PRINT_HT_CAP(((htc->cap >> 8) & 0x3) == 1, "RX STBC 1-stream");
283 		PRINT_HT_CAP(((htc->cap >> 8) & 0x3) == 2, "RX STBC 2-streams");
284 		PRINT_HT_CAP(((htc->cap >> 8) & 0x3) == 3, "RX STBC 3-streams");
285 
286 		PRINT_HT_CAP((htc->cap & BIT(10)), "HT Delayed Block Ack");
287 
288 		PRINT_HT_CAP(!(htc->cap & BIT(11)), "Max AMSDU length: "
289 			     "3839 bytes");
290 		PRINT_HT_CAP((htc->cap & BIT(11)), "Max AMSDU length: "
291 			     "7935 bytes");
292 
293 		/*
294 		 * For beacons and probe response this would mean the BSS
295 		 * does or does not allow the usage of DSSS/CCK HT40.
296 		 * Otherwise it means the STA does or does not use
297 		 * DSSS/CCK HT40.
298 		 */
299 		PRINT_HT_CAP((htc->cap & BIT(12)), "DSSS/CCK HT40");
300 		PRINT_HT_CAP(!(htc->cap & BIT(12)), "No DSSS/CCK HT40");
301 
302 		/* BIT(13) is reserved */
303 
304 		PRINT_HT_CAP((htc->cap & BIT(14)), "40 MHz Intolerant");
305 
306 		PRINT_HT_CAP((htc->cap & BIT(15)), "L-SIG TXOP protection");
307 
308 		p += scnprintf(p, sizeof(buf)+buf-p, "ampdu factor/density: %d/%d\n",
309 				htc->ampdu_factor, htc->ampdu_density);
310 		p += scnprintf(p, sizeof(buf)+buf-p, "MCS mask:");
311 
312 		for (i = 0; i < IEEE80211_HT_MCS_MASK_LEN; i++)
313 			p += scnprintf(p, sizeof(buf)+buf-p, " %.2x",
314 					htc->mcs.rx_mask[i]);
315 		p += scnprintf(p, sizeof(buf)+buf-p, "\n");
316 
317 		/* If not set this is meaningless */
318 		if (le16_to_cpu(htc->mcs.rx_highest)) {
319 			p += scnprintf(p, sizeof(buf)+buf-p,
320 				       "MCS rx highest: %d Mbps\n",
321 				       le16_to_cpu(htc->mcs.rx_highest));
322 		}
323 
324 		p += scnprintf(p, sizeof(buf)+buf-p, "MCS tx params: %x\n",
325 				htc->mcs.tx_params);
326 	}
327 
328 	return simple_read_from_buffer(userbuf, count, ppos, buf, p - buf);
329 }
330 STA_OPS(ht_capa);
331 
332 static ssize_t sta_vht_capa_read(struct file *file, char __user *userbuf,
333 				 size_t count, loff_t *ppos)
334 {
335 	char buf[128], *p = buf;
336 	struct sta_info *sta = file->private_data;
337 	struct ieee80211_sta_vht_cap *vhtc = &sta->sta.vht_cap;
338 
339 	p += scnprintf(p, sizeof(buf) + buf - p, "VHT %ssupported\n",
340 			vhtc->vht_supported ? "" : "not ");
341 	if (vhtc->vht_supported) {
342 		p += scnprintf(p, sizeof(buf)+buf-p, "cap: %#.8x\n", vhtc->cap);
343 
344 		p += scnprintf(p, sizeof(buf)+buf-p, "RX MCS: %.4x\n",
345 			       le16_to_cpu(vhtc->vht_mcs.rx_mcs_map));
346 		if (vhtc->vht_mcs.rx_highest)
347 			p += scnprintf(p, sizeof(buf)+buf-p,
348 				       "MCS RX highest: %d Mbps\n",
349 				       le16_to_cpu(vhtc->vht_mcs.rx_highest));
350 		p += scnprintf(p, sizeof(buf)+buf-p, "TX MCS: %.4x\n",
351 			       le16_to_cpu(vhtc->vht_mcs.tx_mcs_map));
352 		if (vhtc->vht_mcs.tx_highest)
353 			p += scnprintf(p, sizeof(buf)+buf-p,
354 				       "MCS TX highest: %d Mbps\n",
355 				       le16_to_cpu(vhtc->vht_mcs.tx_highest));
356 	}
357 
358 	return simple_read_from_buffer(userbuf, count, ppos, buf, p - buf);
359 }
360 STA_OPS(vht_capa);
361 
362 static ssize_t sta_current_tx_rate_read(struct file *file, char __user *userbuf,
363 					size_t count, loff_t *ppos)
364 {
365 	struct sta_info *sta = file->private_data;
366 	struct rate_info rinfo;
367 	u16 rate;
368 	sta_set_rate_info_tx(sta, &sta->last_tx_rate, &rinfo);
369 	rate = cfg80211_calculate_bitrate(&rinfo);
370 
371 	return mac80211_format_buffer(userbuf, count, ppos,
372 				      "%d.%d MBit/s\n",
373 				      rate/10, rate%10);
374 }
375 STA_OPS(current_tx_rate);
376 
377 static ssize_t sta_last_rx_rate_read(struct file *file, char __user *userbuf,
378 				     size_t count, loff_t *ppos)
379 {
380 	struct sta_info *sta = file->private_data;
381 	struct rate_info rinfo;
382 	u16 rate;
383 
384 	sta_set_rate_info_rx(sta, &rinfo);
385 
386 	rate = cfg80211_calculate_bitrate(&rinfo);
387 
388 	return mac80211_format_buffer(userbuf, count, ppos,
389 				      "%d.%d MBit/s\n",
390 				      rate/10, rate%10);
391 }
392 STA_OPS(last_rx_rate);
393 
394 #define DEBUGFS_ADD(name) \
395 	debugfs_create_file(#name, 0400, \
396 		sta->debugfs.dir, sta, &sta_ ##name## _ops);
397 
398 #define DEBUGFS_ADD_COUNTER(name, field)				\
399 	if (sizeof(sta->field) == sizeof(u32))				\
400 		debugfs_create_u32(#name, 0400, sta->debugfs.dir,	\
401 			(u32 *) &sta->field);				\
402 	else								\
403 		debugfs_create_u64(#name, 0400, sta->debugfs.dir,	\
404 			(u64 *) &sta->field);
405 
406 void ieee80211_sta_debugfs_add(struct sta_info *sta)
407 {
408 	struct ieee80211_local *local = sta->local;
409 	struct ieee80211_sub_if_data *sdata = sta->sdata;
410 	struct dentry *stations_dir = sta->sdata->debugfs.subdir_stations;
411 	u8 mac[3*ETH_ALEN];
412 
413 	sta->debugfs.add_has_run = true;
414 
415 	if (!stations_dir)
416 		return;
417 
418 	snprintf(mac, sizeof(mac), "%pM", sta->sta.addr);
419 
420 	/*
421 	 * This might fail due to a race condition:
422 	 * When mac80211 unlinks a station, the debugfs entries
423 	 * remain, but it is already possible to link a new
424 	 * station with the same address which triggers adding
425 	 * it to debugfs; therefore, if the old station isn't
426 	 * destroyed quickly enough the old station's debugfs
427 	 * dir might still be around.
428 	 */
429 	sta->debugfs.dir = debugfs_create_dir(mac, stations_dir);
430 	if (!sta->debugfs.dir)
431 		return;
432 
433 	DEBUGFS_ADD(flags);
434 	DEBUGFS_ADD(num_ps_buf_frames);
435 	DEBUGFS_ADD(inactive_ms);
436 	DEBUGFS_ADD(connected_time);
437 	DEBUGFS_ADD(last_seq_ctrl);
438 	DEBUGFS_ADD(agg_status);
439 	DEBUGFS_ADD(dev);
440 	DEBUGFS_ADD(last_signal);
441 	DEBUGFS_ADD(beacon_loss_count);
442 	DEBUGFS_ADD(ht_capa);
443 	DEBUGFS_ADD(vht_capa);
444 	DEBUGFS_ADD(last_ack_signal);
445 	DEBUGFS_ADD(current_tx_rate);
446 	DEBUGFS_ADD(last_rx_rate);
447 
448 	DEBUGFS_ADD_COUNTER(rx_packets, rx_packets);
449 	DEBUGFS_ADD_COUNTER(tx_packets, tx_packets);
450 	DEBUGFS_ADD_COUNTER(rx_bytes, rx_bytes);
451 	DEBUGFS_ADD_COUNTER(tx_bytes, tx_bytes);
452 	DEBUGFS_ADD_COUNTER(rx_duplicates, num_duplicates);
453 	DEBUGFS_ADD_COUNTER(rx_fragments, rx_fragments);
454 	DEBUGFS_ADD_COUNTER(rx_dropped, rx_dropped);
455 	DEBUGFS_ADD_COUNTER(tx_fragments, tx_fragments);
456 	DEBUGFS_ADD_COUNTER(tx_filtered, tx_filtered_count);
457 	DEBUGFS_ADD_COUNTER(tx_retry_failed, tx_retry_failed);
458 	DEBUGFS_ADD_COUNTER(tx_retry_count, tx_retry_count);
459 
460 	if (sizeof(sta->driver_buffered_tids) == sizeof(u32))
461 		debugfs_create_x32("driver_buffered_tids", 0400,
462 				   sta->debugfs.dir,
463 				   (u32 *)&sta->driver_buffered_tids);
464 	else
465 		debugfs_create_x64("driver_buffered_tids", 0400,
466 				   sta->debugfs.dir,
467 				   (u64 *)&sta->driver_buffered_tids);
468 
469 	drv_sta_add_debugfs(local, sdata, &sta->sta, sta->debugfs.dir);
470 }
471 
472 void ieee80211_sta_debugfs_remove(struct sta_info *sta)
473 {
474 	struct ieee80211_local *local = sta->local;
475 	struct ieee80211_sub_if_data *sdata = sta->sdata;
476 
477 	drv_sta_remove_debugfs(local, sdata, &sta->sta, sta->debugfs.dir);
478 	debugfs_remove_recursive(sta->debugfs.dir);
479 	sta->debugfs.dir = NULL;
480 }
481