xref: /openbmc/linux/net/mac80211/debugfs_sta.c (revision baa7eb025ab14f3cba2e35c0a8648f9c9f01d24f)
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  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  */
10 
11 #include <linux/debugfs.h>
12 #include <linux/ieee80211.h>
13 #include "ieee80211_i.h"
14 #include "debugfs.h"
15 #include "debugfs_sta.h"
16 #include "sta_info.h"
17 
18 /* sta attributtes */
19 
20 #define STA_READ(name, field, format_string)				\
21 static ssize_t sta_ ##name## _read(struct file *file,			\
22 				   char __user *userbuf,		\
23 				   size_t count, loff_t *ppos)		\
24 {									\
25 	struct sta_info *sta = file->private_data;			\
26 	return mac80211_format_buffer(userbuf, count, ppos, 		\
27 				      format_string, sta->field);	\
28 }
29 #define STA_READ_D(name, field) STA_READ(name, field, "%d\n")
30 #define STA_READ_U(name, field) STA_READ(name, field, "%u\n")
31 #define STA_READ_S(name, field) STA_READ(name, field, "%s\n")
32 
33 #define STA_OPS(name)							\
34 static const struct file_operations sta_ ##name## _ops = {		\
35 	.read = sta_##name##_read,					\
36 	.open = mac80211_open_file_generic,				\
37 	.llseek = generic_file_llseek,					\
38 }
39 
40 #define STA_OPS_RW(name)						\
41 static const struct file_operations sta_ ##name## _ops = {		\
42 	.read = sta_##name##_read,					\
43 	.write = sta_##name##_write,					\
44 	.open = mac80211_open_file_generic,				\
45 	.llseek = generic_file_llseek,					\
46 }
47 
48 #define STA_FILE(name, field, format)					\
49 		STA_READ_##format(name, field)				\
50 		STA_OPS(name)
51 
52 STA_FILE(aid, sta.aid, D);
53 STA_FILE(dev, sdata->name, S);
54 STA_FILE(last_signal, last_signal, D);
55 
56 static ssize_t sta_flags_read(struct file *file, char __user *userbuf,
57 			      size_t count, loff_t *ppos)
58 {
59 	char buf[100];
60 	struct sta_info *sta = file->private_data;
61 	u32 staflags = get_sta_flags(sta);
62 	int res = scnprintf(buf, sizeof(buf), "%s%s%s%s%s%s%s%s%s",
63 		staflags & WLAN_STA_AUTH ? "AUTH\n" : "",
64 		staflags & WLAN_STA_ASSOC ? "ASSOC\n" : "",
65 		staflags & WLAN_STA_PS_STA ? "PS (sta)\n" : "",
66 		staflags & WLAN_STA_PS_DRIVER ? "PS (driver)\n" : "",
67 		staflags & WLAN_STA_AUTHORIZED ? "AUTHORIZED\n" : "",
68 		staflags & WLAN_STA_SHORT_PREAMBLE ? "SHORT PREAMBLE\n" : "",
69 		staflags & WLAN_STA_WME ? "WME\n" : "",
70 		staflags & WLAN_STA_WDS ? "WDS\n" : "",
71 		staflags & WLAN_STA_MFP ? "MFP\n" : "");
72 	return simple_read_from_buffer(userbuf, count, ppos, buf, res);
73 }
74 STA_OPS(flags);
75 
76 static ssize_t sta_num_ps_buf_frames_read(struct file *file,
77 					  char __user *userbuf,
78 					  size_t count, loff_t *ppos)
79 {
80 	struct sta_info *sta = file->private_data;
81 	return mac80211_format_buffer(userbuf, count, ppos, "%u\n",
82 				      skb_queue_len(&sta->ps_tx_buf));
83 }
84 STA_OPS(num_ps_buf_frames);
85 
86 static ssize_t sta_inactive_ms_read(struct file *file, char __user *userbuf,
87 				    size_t count, loff_t *ppos)
88 {
89 	struct sta_info *sta = file->private_data;
90 	return mac80211_format_buffer(userbuf, count, ppos, "%d\n",
91 				      jiffies_to_msecs(jiffies - sta->last_rx));
92 }
93 STA_OPS(inactive_ms);
94 
95 static ssize_t sta_last_seq_ctrl_read(struct file *file, char __user *userbuf,
96 				      size_t count, loff_t *ppos)
97 {
98 	char buf[15*NUM_RX_DATA_QUEUES], *p = buf;
99 	int i;
100 	struct sta_info *sta = file->private_data;
101 	for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
102 		p += scnprintf(p, sizeof(buf)+buf-p, "%x ",
103 			       le16_to_cpu(sta->last_seq_ctrl[i]));
104 	p += scnprintf(p, sizeof(buf)+buf-p, "\n");
105 	return simple_read_from_buffer(userbuf, count, ppos, buf, p - buf);
106 }
107 STA_OPS(last_seq_ctrl);
108 
109 static ssize_t sta_agg_status_read(struct file *file, char __user *userbuf,
110 					size_t count, loff_t *ppos)
111 {
112 	char buf[71 + STA_TID_NUM * 40], *p = buf;
113 	int i;
114 	struct sta_info *sta = file->private_data;
115 	struct tid_ampdu_rx *tid_rx;
116 	struct tid_ampdu_tx *tid_tx;
117 
118 	rcu_read_lock();
119 
120 	p += scnprintf(p, sizeof(buf) + buf - p, "next dialog_token: %#02x\n",
121 			sta->ampdu_mlme.dialog_token_allocator + 1);
122 	p += scnprintf(p, sizeof(buf) + buf - p,
123 		       "TID\t\tRX active\tDTKN\tSSN\t\tTX\tDTKN\tpending\n");
124 
125 	for (i = 0; i < STA_TID_NUM; i++) {
126 		tid_rx = rcu_dereference(sta->ampdu_mlme.tid_rx[i]);
127 		tid_tx = rcu_dereference(sta->ampdu_mlme.tid_tx[i]);
128 
129 		p += scnprintf(p, sizeof(buf) + buf - p, "%02d", i);
130 		p += scnprintf(p, sizeof(buf) + buf - p, "\t\t%x", !!tid_rx);
131 		p += scnprintf(p, sizeof(buf) + buf - p, "\t%#.2x",
132 				tid_rx ? tid_rx->dialog_token : 0);
133 		p += scnprintf(p, sizeof(buf) + buf - p, "\t%#.3x",
134 				tid_rx ? tid_rx->ssn : 0);
135 
136 		p += scnprintf(p, sizeof(buf) + buf - p, "\t\t%x", !!tid_tx);
137 		p += scnprintf(p, sizeof(buf) + buf - p, "\t%#.2x",
138 				tid_tx ? tid_tx->dialog_token : 0);
139 		p += scnprintf(p, sizeof(buf) + buf - p, "\t%03d",
140 				tid_tx ? skb_queue_len(&tid_tx->pending) : 0);
141 		p += scnprintf(p, sizeof(buf) + buf - p, "\n");
142 	}
143 	rcu_read_unlock();
144 
145 	return simple_read_from_buffer(userbuf, count, ppos, buf, p - buf);
146 }
147 
148 static ssize_t sta_agg_status_write(struct file *file, const char __user *userbuf,
149 				    size_t count, loff_t *ppos)
150 {
151 	char _buf[12], *buf = _buf;
152 	struct sta_info *sta = file->private_data;
153 	bool start, tx;
154 	unsigned long tid;
155 	int ret;
156 
157 	if (count > sizeof(_buf))
158 		return -EINVAL;
159 
160 	if (copy_from_user(buf, userbuf, count))
161 		return -EFAULT;
162 
163 	buf[sizeof(_buf) - 1] = '\0';
164 
165 	if (strncmp(buf, "tx ", 3) == 0) {
166 		buf += 3;
167 		tx = true;
168 	} else if (strncmp(buf, "rx ", 3) == 0) {
169 		buf += 3;
170 		tx = false;
171 	} else
172 		return -EINVAL;
173 
174 	if (strncmp(buf, "start ", 6) == 0) {
175 		buf += 6;
176 		start = true;
177 		if (!tx)
178 			return -EINVAL;
179 	} else if (strncmp(buf, "stop ", 5) == 0) {
180 		buf += 5;
181 		start = false;
182 	} else
183 		return -EINVAL;
184 
185 	tid = simple_strtoul(buf, NULL, 0);
186 
187 	if (tid >= STA_TID_NUM)
188 		return -EINVAL;
189 
190 	if (tx) {
191 		if (start)
192 			ret = ieee80211_start_tx_ba_session(&sta->sta, tid, 5000);
193 		else
194 			ret = ieee80211_stop_tx_ba_session(&sta->sta, tid);
195 	} else {
196 		__ieee80211_stop_rx_ba_session(sta, tid, WLAN_BACK_RECIPIENT,
197 					       3, true);
198 		ret = 0;
199 	}
200 
201 	return ret ?: count;
202 }
203 STA_OPS_RW(agg_status);
204 
205 static ssize_t sta_ht_capa_read(struct file *file, char __user *userbuf,
206 				size_t count, loff_t *ppos)
207 {
208 #define PRINT_HT_CAP(_cond, _str) \
209 	do { \
210 	if (_cond) \
211 			p += scnprintf(p, sizeof(buf)+buf-p, "\t" _str "\n"); \
212 	} while (0)
213 	char buf[512], *p = buf;
214 	int i;
215 	struct sta_info *sta = file->private_data;
216 	struct ieee80211_sta_ht_cap *htc = &sta->sta.ht_cap;
217 
218 	p += scnprintf(p, sizeof(buf) + buf - p, "ht %ssupported\n",
219 			htc->ht_supported ? "" : "not ");
220 	if (htc->ht_supported) {
221 		p += scnprintf(p, sizeof(buf)+buf-p, "cap: %#.4x\n", htc->cap);
222 
223 		PRINT_HT_CAP((htc->cap & BIT(0)), "RX LDPC");
224 		PRINT_HT_CAP((htc->cap & BIT(1)), "HT20/HT40");
225 		PRINT_HT_CAP(!(htc->cap & BIT(1)), "HT20");
226 
227 		PRINT_HT_CAP(((htc->cap >> 2) & 0x3) == 0, "Static SM Power Save");
228 		PRINT_HT_CAP(((htc->cap >> 2) & 0x3) == 1, "Dynamic SM Power Save");
229 		PRINT_HT_CAP(((htc->cap >> 2) & 0x3) == 3, "SM Power Save disabled");
230 
231 		PRINT_HT_CAP((htc->cap & BIT(4)), "RX Greenfield");
232 		PRINT_HT_CAP((htc->cap & BIT(5)), "RX HT20 SGI");
233 		PRINT_HT_CAP((htc->cap & BIT(6)), "RX HT40 SGI");
234 		PRINT_HT_CAP((htc->cap & BIT(7)), "TX STBC");
235 
236 		PRINT_HT_CAP(((htc->cap >> 8) & 0x3) == 0, "No RX STBC");
237 		PRINT_HT_CAP(((htc->cap >> 8) & 0x3) == 1, "RX STBC 1-stream");
238 		PRINT_HT_CAP(((htc->cap >> 8) & 0x3) == 2, "RX STBC 2-streams");
239 		PRINT_HT_CAP(((htc->cap >> 8) & 0x3) == 3, "RX STBC 3-streams");
240 
241 		PRINT_HT_CAP((htc->cap & BIT(10)), "HT Delayed Block Ack");
242 
243 		PRINT_HT_CAP((htc->cap & BIT(11)), "Max AMSDU length: "
244 			     "3839 bytes");
245 		PRINT_HT_CAP(!(htc->cap & BIT(11)), "Max AMSDU length: "
246 			     "7935 bytes");
247 
248 		/*
249 		 * For beacons and probe response this would mean the BSS
250 		 * does or does not allow the usage of DSSS/CCK HT40.
251 		 * Otherwise it means the STA does or does not use
252 		 * DSSS/CCK HT40.
253 		 */
254 		PRINT_HT_CAP((htc->cap & BIT(12)), "DSSS/CCK HT40");
255 		PRINT_HT_CAP(!(htc->cap & BIT(12)), "No DSSS/CCK HT40");
256 
257 		/* BIT(13) is reserved */
258 
259 		PRINT_HT_CAP((htc->cap & BIT(14)), "40 MHz Intolerant");
260 
261 		PRINT_HT_CAP((htc->cap & BIT(15)), "L-SIG TXOP protection");
262 
263 		p += scnprintf(p, sizeof(buf)+buf-p, "ampdu factor/density: %d/%d\n",
264 				htc->ampdu_factor, htc->ampdu_density);
265 		p += scnprintf(p, sizeof(buf)+buf-p, "MCS mask:");
266 
267 		for (i = 0; i < IEEE80211_HT_MCS_MASK_LEN; i++)
268 			p += scnprintf(p, sizeof(buf)+buf-p, " %.2x",
269 					htc->mcs.rx_mask[i]);
270 		p += scnprintf(p, sizeof(buf)+buf-p, "\n");
271 
272 		/* If not set this is meaningless */
273 		if (le16_to_cpu(htc->mcs.rx_highest)) {
274 			p += scnprintf(p, sizeof(buf)+buf-p,
275 				       "MCS rx highest: %d Mbps\n",
276 				       le16_to_cpu(htc->mcs.rx_highest));
277 		}
278 
279 		p += scnprintf(p, sizeof(buf)+buf-p, "MCS tx params: %x\n",
280 				htc->mcs.tx_params);
281 	}
282 
283 	return simple_read_from_buffer(userbuf, count, ppos, buf, p - buf);
284 }
285 STA_OPS(ht_capa);
286 
287 #define DEBUGFS_ADD(name) \
288 	debugfs_create_file(#name, 0400, \
289 		sta->debugfs.dir, sta, &sta_ ##name## _ops);
290 
291 #define DEBUGFS_ADD_COUNTER(name, field)				\
292 	if (sizeof(sta->field) == sizeof(u32))				\
293 		debugfs_create_u32(#name, 0400, sta->debugfs.dir,	\
294 			(u32 *) &sta->field);				\
295 	else								\
296 		debugfs_create_u64(#name, 0400, sta->debugfs.dir,	\
297 			(u64 *) &sta->field);
298 
299 void ieee80211_sta_debugfs_add(struct sta_info *sta)
300 {
301 	struct dentry *stations_dir = sta->sdata->debugfs.subdir_stations;
302 	u8 mac[3*ETH_ALEN];
303 
304 	sta->debugfs.add_has_run = true;
305 
306 	if (!stations_dir)
307 		return;
308 
309 	snprintf(mac, sizeof(mac), "%pM", sta->sta.addr);
310 
311 	/*
312 	 * This might fail due to a race condition:
313 	 * When mac80211 unlinks a station, the debugfs entries
314 	 * remain, but it is already possible to link a new
315 	 * station with the same address which triggers adding
316 	 * it to debugfs; therefore, if the old station isn't
317 	 * destroyed quickly enough the old station's debugfs
318 	 * dir might still be around.
319 	 */
320 	sta->debugfs.dir = debugfs_create_dir(mac, stations_dir);
321 	if (!sta->debugfs.dir)
322 		return;
323 
324 	DEBUGFS_ADD(flags);
325 	DEBUGFS_ADD(num_ps_buf_frames);
326 	DEBUGFS_ADD(inactive_ms);
327 	DEBUGFS_ADD(last_seq_ctrl);
328 	DEBUGFS_ADD(agg_status);
329 	DEBUGFS_ADD(dev);
330 	DEBUGFS_ADD(last_signal);
331 	DEBUGFS_ADD(ht_capa);
332 
333 	DEBUGFS_ADD_COUNTER(rx_packets, rx_packets);
334 	DEBUGFS_ADD_COUNTER(tx_packets, tx_packets);
335 	DEBUGFS_ADD_COUNTER(rx_bytes, rx_bytes);
336 	DEBUGFS_ADD_COUNTER(tx_bytes, tx_bytes);
337 	DEBUGFS_ADD_COUNTER(rx_duplicates, num_duplicates);
338 	DEBUGFS_ADD_COUNTER(rx_fragments, rx_fragments);
339 	DEBUGFS_ADD_COUNTER(rx_dropped, rx_dropped);
340 	DEBUGFS_ADD_COUNTER(tx_fragments, tx_fragments);
341 	DEBUGFS_ADD_COUNTER(tx_filtered, tx_filtered_count);
342 	DEBUGFS_ADD_COUNTER(tx_retry_failed, tx_retry_failed);
343 	DEBUGFS_ADD_COUNTER(tx_retry_count, tx_retry_count);
344 	DEBUGFS_ADD_COUNTER(wep_weak_iv_count, wep_weak_iv_count);
345 }
346 
347 void ieee80211_sta_debugfs_remove(struct sta_info *sta)
348 {
349 	debugfs_remove_recursive(sta->debugfs.dir);
350 	sta->debugfs.dir = NULL;
351 }
352