xref: /openbmc/linux/net/mac80211/debugfs_netdev.c (revision df2634f43f5106947f3735a0b61a6527a4b278cd)
1 /*
2  * Copyright (c) 2006	Jiri Benc <jbenc@suse.cz>
3  * Copyright 2007	Johannes Berg <johannes@sipsolutions.net>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  */
9 
10 #include <linux/kernel.h>
11 #include <linux/device.h>
12 #include <linux/if.h>
13 #include <linux/interrupt.h>
14 #include <linux/netdevice.h>
15 #include <linux/rtnetlink.h>
16 #include <linux/slab.h>
17 #include <linux/notifier.h>
18 #include <net/mac80211.h>
19 #include <net/cfg80211.h>
20 #include "ieee80211_i.h"
21 #include "rate.h"
22 #include "debugfs.h"
23 #include "debugfs_netdev.h"
24 
25 static ssize_t ieee80211_if_read(
26 	struct ieee80211_sub_if_data *sdata,
27 	char __user *userbuf,
28 	size_t count, loff_t *ppos,
29 	ssize_t (*format)(const struct ieee80211_sub_if_data *, char *, int))
30 {
31 	char buf[70];
32 	ssize_t ret = -EINVAL;
33 
34 	read_lock(&dev_base_lock);
35 	if (sdata->dev->reg_state == NETREG_REGISTERED)
36 		ret = (*format)(sdata, buf, sizeof(buf));
37 	read_unlock(&dev_base_lock);
38 
39 	if (ret != -EINVAL)
40 		ret = simple_read_from_buffer(userbuf, count, ppos, buf, ret);
41 
42 	return ret;
43 }
44 
45 static ssize_t ieee80211_if_write(
46 	struct ieee80211_sub_if_data *sdata,
47 	const char __user *userbuf,
48 	size_t count, loff_t *ppos,
49 	ssize_t (*write)(struct ieee80211_sub_if_data *, const char *, int))
50 {
51 	u8 *buf;
52 	ssize_t ret;
53 
54 	buf = kmalloc(count, GFP_KERNEL);
55 	if (!buf)
56 		return -ENOMEM;
57 
58 	ret = -EFAULT;
59 	if (copy_from_user(buf, userbuf, count))
60 		goto freebuf;
61 
62 	ret = -ENODEV;
63 	rtnl_lock();
64 	if (sdata->dev->reg_state == NETREG_REGISTERED)
65 		ret = (*write)(sdata, buf, count);
66 	rtnl_unlock();
67 
68 freebuf:
69 	kfree(buf);
70 	return ret;
71 }
72 
73 #define IEEE80211_IF_FMT(name, field, format_string)			\
74 static ssize_t ieee80211_if_fmt_##name(					\
75 	const struct ieee80211_sub_if_data *sdata, char *buf,		\
76 	int buflen)							\
77 {									\
78 	return scnprintf(buf, buflen, format_string, sdata->field);	\
79 }
80 #define IEEE80211_IF_FMT_DEC(name, field)				\
81 		IEEE80211_IF_FMT(name, field, "%d\n")
82 #define IEEE80211_IF_FMT_HEX(name, field)				\
83 		IEEE80211_IF_FMT(name, field, "%#x\n")
84 #define IEEE80211_IF_FMT_SIZE(name, field)				\
85 		IEEE80211_IF_FMT(name, field, "%zd\n")
86 
87 #define IEEE80211_IF_FMT_ATOMIC(name, field)				\
88 static ssize_t ieee80211_if_fmt_##name(					\
89 	const struct ieee80211_sub_if_data *sdata,			\
90 	char *buf, int buflen)						\
91 {									\
92 	return scnprintf(buf, buflen, "%d\n", atomic_read(&sdata->field));\
93 }
94 
95 #define IEEE80211_IF_FMT_MAC(name, field)				\
96 static ssize_t ieee80211_if_fmt_##name(					\
97 	const struct ieee80211_sub_if_data *sdata, char *buf,		\
98 	int buflen)							\
99 {									\
100 	return scnprintf(buf, buflen, "%pM\n", sdata->field);		\
101 }
102 
103 #define IEEE80211_IF_FMT_DEC_DIV_16(name, field)			\
104 static ssize_t ieee80211_if_fmt_##name(					\
105 	const struct ieee80211_sub_if_data *sdata,			\
106 	char *buf, int buflen)						\
107 {									\
108 	return scnprintf(buf, buflen, "%d\n", sdata->field / 16);	\
109 }
110 
111 #define __IEEE80211_IF_FILE(name, _write)				\
112 static ssize_t ieee80211_if_read_##name(struct file *file,		\
113 					char __user *userbuf,		\
114 					size_t count, loff_t *ppos)	\
115 {									\
116 	return ieee80211_if_read(file->private_data,			\
117 				 userbuf, count, ppos,			\
118 				 ieee80211_if_fmt_##name);		\
119 }									\
120 static const struct file_operations name##_ops = {			\
121 	.read = ieee80211_if_read_##name,				\
122 	.write = (_write),						\
123 	.open = mac80211_open_file_generic,				\
124 	.llseek = generic_file_llseek,					\
125 }
126 
127 #define __IEEE80211_IF_FILE_W(name)					\
128 static ssize_t ieee80211_if_write_##name(struct file *file,		\
129 					 const char __user *userbuf,	\
130 					 size_t count, loff_t *ppos)	\
131 {									\
132 	return ieee80211_if_write(file->private_data, userbuf, count,	\
133 				  ppos, ieee80211_if_parse_##name);	\
134 }									\
135 __IEEE80211_IF_FILE(name, ieee80211_if_write_##name)
136 
137 
138 #define IEEE80211_IF_FILE(name, field, format)				\
139 		IEEE80211_IF_FMT_##format(name, field)			\
140 		__IEEE80211_IF_FILE(name, NULL)
141 
142 /* common attributes */
143 IEEE80211_IF_FILE(drop_unencrypted, drop_unencrypted, DEC);
144 IEEE80211_IF_FILE(rc_rateidx_mask_2ghz, rc_rateidx_mask[IEEE80211_BAND_2GHZ],
145 		  HEX);
146 IEEE80211_IF_FILE(rc_rateidx_mask_5ghz, rc_rateidx_mask[IEEE80211_BAND_5GHZ],
147 		  HEX);
148 
149 /* STA attributes */
150 IEEE80211_IF_FILE(bssid, u.mgd.bssid, MAC);
151 IEEE80211_IF_FILE(aid, u.mgd.aid, DEC);
152 IEEE80211_IF_FILE(last_beacon, u.mgd.last_beacon_signal, DEC);
153 IEEE80211_IF_FILE(ave_beacon, u.mgd.ave_beacon_signal, DEC_DIV_16);
154 
155 static int ieee80211_set_smps(struct ieee80211_sub_if_data *sdata,
156 			      enum ieee80211_smps_mode smps_mode)
157 {
158 	struct ieee80211_local *local = sdata->local;
159 	int err;
160 
161 	if (!(local->hw.flags & IEEE80211_HW_SUPPORTS_STATIC_SMPS) &&
162 	    smps_mode == IEEE80211_SMPS_STATIC)
163 		return -EINVAL;
164 
165 	/* auto should be dynamic if in PS mode */
166 	if (!(local->hw.flags & IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS) &&
167 	    (smps_mode == IEEE80211_SMPS_DYNAMIC ||
168 	     smps_mode == IEEE80211_SMPS_AUTOMATIC))
169 		return -EINVAL;
170 
171 	/* supported only on managed interfaces for now */
172 	if (sdata->vif.type != NL80211_IFTYPE_STATION)
173 		return -EOPNOTSUPP;
174 
175 	mutex_lock(&local->iflist_mtx);
176 	err = __ieee80211_request_smps(sdata, smps_mode);
177 	mutex_unlock(&local->iflist_mtx);
178 
179 	return err;
180 }
181 
182 static const char *smps_modes[IEEE80211_SMPS_NUM_MODES] = {
183 	[IEEE80211_SMPS_AUTOMATIC] = "auto",
184 	[IEEE80211_SMPS_OFF] = "off",
185 	[IEEE80211_SMPS_STATIC] = "static",
186 	[IEEE80211_SMPS_DYNAMIC] = "dynamic",
187 };
188 
189 static ssize_t ieee80211_if_fmt_smps(const struct ieee80211_sub_if_data *sdata,
190 				     char *buf, int buflen)
191 {
192 	if (sdata->vif.type != NL80211_IFTYPE_STATION)
193 		return -EOPNOTSUPP;
194 
195 	return snprintf(buf, buflen, "request: %s\nused: %s\n",
196 			smps_modes[sdata->u.mgd.req_smps],
197 			smps_modes[sdata->u.mgd.ap_smps]);
198 }
199 
200 static ssize_t ieee80211_if_parse_smps(struct ieee80211_sub_if_data *sdata,
201 				       const char *buf, int buflen)
202 {
203 	enum ieee80211_smps_mode mode;
204 
205 	for (mode = 0; mode < IEEE80211_SMPS_NUM_MODES; mode++) {
206 		if (strncmp(buf, smps_modes[mode], buflen) == 0) {
207 			int err = ieee80211_set_smps(sdata, mode);
208 			if (!err)
209 				return buflen;
210 			return err;
211 		}
212 	}
213 
214 	return -EINVAL;
215 }
216 
217 __IEEE80211_IF_FILE_W(smps);
218 
219 /* AP attributes */
220 IEEE80211_IF_FILE(num_sta_ps, u.ap.num_sta_ps, ATOMIC);
221 IEEE80211_IF_FILE(dtim_count, u.ap.dtim_count, DEC);
222 
223 static ssize_t ieee80211_if_fmt_num_buffered_multicast(
224 	const struct ieee80211_sub_if_data *sdata, char *buf, int buflen)
225 {
226 	return scnprintf(buf, buflen, "%u\n",
227 			 skb_queue_len(&sdata->u.ap.ps_bc_buf));
228 }
229 __IEEE80211_IF_FILE(num_buffered_multicast, NULL);
230 
231 /* WDS attributes */
232 IEEE80211_IF_FILE(peer, u.wds.remote_addr, MAC);
233 
234 #ifdef CONFIG_MAC80211_MESH
235 /* Mesh stats attributes */
236 IEEE80211_IF_FILE(fwded_mcast, u.mesh.mshstats.fwded_mcast, DEC);
237 IEEE80211_IF_FILE(fwded_unicast, u.mesh.mshstats.fwded_unicast, DEC);
238 IEEE80211_IF_FILE(fwded_frames, u.mesh.mshstats.fwded_frames, DEC);
239 IEEE80211_IF_FILE(dropped_frames_ttl, u.mesh.mshstats.dropped_frames_ttl, DEC);
240 IEEE80211_IF_FILE(dropped_frames_no_route,
241 		u.mesh.mshstats.dropped_frames_no_route, DEC);
242 IEEE80211_IF_FILE(estab_plinks, u.mesh.mshstats.estab_plinks, ATOMIC);
243 
244 /* Mesh parameters */
245 IEEE80211_IF_FILE(dot11MeshMaxRetries,
246 		u.mesh.mshcfg.dot11MeshMaxRetries, DEC);
247 IEEE80211_IF_FILE(dot11MeshRetryTimeout,
248 		u.mesh.mshcfg.dot11MeshRetryTimeout, DEC);
249 IEEE80211_IF_FILE(dot11MeshConfirmTimeout,
250 		u.mesh.mshcfg.dot11MeshConfirmTimeout, DEC);
251 IEEE80211_IF_FILE(dot11MeshHoldingTimeout,
252 		u.mesh.mshcfg.dot11MeshHoldingTimeout, DEC);
253 IEEE80211_IF_FILE(dot11MeshTTL, u.mesh.mshcfg.dot11MeshTTL, DEC);
254 IEEE80211_IF_FILE(element_ttl, u.mesh.mshcfg.element_ttl, DEC);
255 IEEE80211_IF_FILE(auto_open_plinks, u.mesh.mshcfg.auto_open_plinks, DEC);
256 IEEE80211_IF_FILE(dot11MeshMaxPeerLinks,
257 		u.mesh.mshcfg.dot11MeshMaxPeerLinks, DEC);
258 IEEE80211_IF_FILE(dot11MeshHWMPactivePathTimeout,
259 		u.mesh.mshcfg.dot11MeshHWMPactivePathTimeout, DEC);
260 IEEE80211_IF_FILE(dot11MeshHWMPpreqMinInterval,
261 		u.mesh.mshcfg.dot11MeshHWMPpreqMinInterval, DEC);
262 IEEE80211_IF_FILE(dot11MeshHWMPnetDiameterTraversalTime,
263 		u.mesh.mshcfg.dot11MeshHWMPnetDiameterTraversalTime, DEC);
264 IEEE80211_IF_FILE(dot11MeshHWMPmaxPREQretries,
265 		u.mesh.mshcfg.dot11MeshHWMPmaxPREQretries, DEC);
266 IEEE80211_IF_FILE(path_refresh_time,
267 		u.mesh.mshcfg.path_refresh_time, DEC);
268 IEEE80211_IF_FILE(min_discovery_timeout,
269 		u.mesh.mshcfg.min_discovery_timeout, DEC);
270 IEEE80211_IF_FILE(dot11MeshHWMPRootMode,
271 		u.mesh.mshcfg.dot11MeshHWMPRootMode, DEC);
272 #endif
273 
274 
275 #define DEBUGFS_ADD(name) \
276 	debugfs_create_file(#name, 0400, sdata->debugfs.dir, \
277 			    sdata, &name##_ops);
278 
279 #define DEBUGFS_ADD_MODE(name, mode) \
280 	debugfs_create_file(#name, mode, sdata->debugfs.dir, \
281 			    sdata, &name##_ops);
282 
283 static void add_sta_files(struct ieee80211_sub_if_data *sdata)
284 {
285 	DEBUGFS_ADD(drop_unencrypted);
286 	DEBUGFS_ADD(rc_rateidx_mask_2ghz);
287 	DEBUGFS_ADD(rc_rateidx_mask_5ghz);
288 
289 	DEBUGFS_ADD(bssid);
290 	DEBUGFS_ADD(aid);
291 	DEBUGFS_ADD(last_beacon);
292 	DEBUGFS_ADD(ave_beacon);
293 	DEBUGFS_ADD_MODE(smps, 0600);
294 }
295 
296 static void add_ap_files(struct ieee80211_sub_if_data *sdata)
297 {
298 	DEBUGFS_ADD(drop_unencrypted);
299 	DEBUGFS_ADD(rc_rateidx_mask_2ghz);
300 	DEBUGFS_ADD(rc_rateidx_mask_5ghz);
301 
302 	DEBUGFS_ADD(num_sta_ps);
303 	DEBUGFS_ADD(dtim_count);
304 	DEBUGFS_ADD(num_buffered_multicast);
305 }
306 
307 static void add_wds_files(struct ieee80211_sub_if_data *sdata)
308 {
309 	DEBUGFS_ADD(drop_unencrypted);
310 	DEBUGFS_ADD(rc_rateidx_mask_2ghz);
311 	DEBUGFS_ADD(rc_rateidx_mask_5ghz);
312 
313 	DEBUGFS_ADD(peer);
314 }
315 
316 static void add_vlan_files(struct ieee80211_sub_if_data *sdata)
317 {
318 	DEBUGFS_ADD(drop_unencrypted);
319 	DEBUGFS_ADD(rc_rateidx_mask_2ghz);
320 	DEBUGFS_ADD(rc_rateidx_mask_5ghz);
321 }
322 
323 static void add_monitor_files(struct ieee80211_sub_if_data *sdata)
324 {
325 }
326 
327 #ifdef CONFIG_MAC80211_MESH
328 
329 static void add_mesh_stats(struct ieee80211_sub_if_data *sdata)
330 {
331 	struct dentry *dir = debugfs_create_dir("mesh_stats",
332 						sdata->debugfs.dir);
333 
334 #define MESHSTATS_ADD(name)\
335 	debugfs_create_file(#name, 0400, dir, sdata, &name##_ops);
336 
337 	MESHSTATS_ADD(fwded_mcast);
338 	MESHSTATS_ADD(fwded_unicast);
339 	MESHSTATS_ADD(fwded_frames);
340 	MESHSTATS_ADD(dropped_frames_ttl);
341 	MESHSTATS_ADD(dropped_frames_no_route);
342 	MESHSTATS_ADD(estab_plinks);
343 #undef MESHSTATS_ADD
344 }
345 
346 static void add_mesh_config(struct ieee80211_sub_if_data *sdata)
347 {
348 	struct dentry *dir = debugfs_create_dir("mesh_config",
349 						sdata->debugfs.dir);
350 
351 #define MESHPARAMS_ADD(name) \
352 	debugfs_create_file(#name, 0600, dir, sdata, &name##_ops);
353 
354 	MESHPARAMS_ADD(dot11MeshMaxRetries);
355 	MESHPARAMS_ADD(dot11MeshRetryTimeout);
356 	MESHPARAMS_ADD(dot11MeshConfirmTimeout);
357 	MESHPARAMS_ADD(dot11MeshHoldingTimeout);
358 	MESHPARAMS_ADD(dot11MeshTTL);
359 	MESHPARAMS_ADD(element_ttl);
360 	MESHPARAMS_ADD(auto_open_plinks);
361 	MESHPARAMS_ADD(dot11MeshMaxPeerLinks);
362 	MESHPARAMS_ADD(dot11MeshHWMPactivePathTimeout);
363 	MESHPARAMS_ADD(dot11MeshHWMPpreqMinInterval);
364 	MESHPARAMS_ADD(dot11MeshHWMPnetDiameterTraversalTime);
365 	MESHPARAMS_ADD(dot11MeshHWMPmaxPREQretries);
366 	MESHPARAMS_ADD(path_refresh_time);
367 	MESHPARAMS_ADD(min_discovery_timeout);
368 
369 #undef MESHPARAMS_ADD
370 }
371 #endif
372 
373 static void add_files(struct ieee80211_sub_if_data *sdata)
374 {
375 	if (!sdata->debugfs.dir)
376 		return;
377 
378 	switch (sdata->vif.type) {
379 	case NL80211_IFTYPE_MESH_POINT:
380 #ifdef CONFIG_MAC80211_MESH
381 		add_mesh_stats(sdata);
382 		add_mesh_config(sdata);
383 #endif
384 		break;
385 	case NL80211_IFTYPE_STATION:
386 		add_sta_files(sdata);
387 		break;
388 	case NL80211_IFTYPE_ADHOC:
389 		/* XXX */
390 		break;
391 	case NL80211_IFTYPE_AP:
392 		add_ap_files(sdata);
393 		break;
394 	case NL80211_IFTYPE_WDS:
395 		add_wds_files(sdata);
396 		break;
397 	case NL80211_IFTYPE_MONITOR:
398 		add_monitor_files(sdata);
399 		break;
400 	case NL80211_IFTYPE_AP_VLAN:
401 		add_vlan_files(sdata);
402 		break;
403 	default:
404 		break;
405 	}
406 }
407 
408 void ieee80211_debugfs_add_netdev(struct ieee80211_sub_if_data *sdata)
409 {
410 	char buf[10+IFNAMSIZ];
411 
412 	sprintf(buf, "netdev:%s", sdata->name);
413 	sdata->debugfs.dir = debugfs_create_dir(buf,
414 		sdata->local->hw.wiphy->debugfsdir);
415 	if (sdata->debugfs.dir)
416 		sdata->debugfs.subdir_stations = debugfs_create_dir("stations",
417 			sdata->debugfs.dir);
418 	add_files(sdata);
419 }
420 
421 void ieee80211_debugfs_remove_netdev(struct ieee80211_sub_if_data *sdata)
422 {
423 	if (!sdata->debugfs.dir)
424 		return;
425 
426 	debugfs_remove_recursive(sdata->debugfs.dir);
427 	sdata->debugfs.dir = NULL;
428 }
429 
430 void ieee80211_debugfs_rename_netdev(struct ieee80211_sub_if_data *sdata)
431 {
432 	struct dentry *dir;
433 	char buf[10 + IFNAMSIZ];
434 
435 	dir = sdata->debugfs.dir;
436 
437 	if (!dir)
438 		return;
439 
440 	sprintf(buf, "netdev:%s", sdata->name);
441 	if (!debugfs_rename(dir->d_parent, dir, dir->d_parent, buf))
442 		printk(KERN_ERR "mac80211: debugfs: failed to rename debugfs "
443 		       "dir to %s\n", buf);
444 }
445