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