xref: /linux/net/mac80211/debugfs_netdev.c (revision a33f32244d8550da8b4a26e277ce07d5c6d158b5)
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_FILE(name, _write)				\
104 static ssize_t ieee80211_if_read_##name(struct file *file,		\
105 					char __user *userbuf,		\
106 					size_t count, loff_t *ppos)	\
107 {									\
108 	return ieee80211_if_read(file->private_data,			\
109 				 userbuf, count, ppos,			\
110 				 ieee80211_if_fmt_##name);		\
111 }									\
112 static const struct file_operations name##_ops = {			\
113 	.read = ieee80211_if_read_##name,				\
114 	.write = (_write),						\
115 	.open = mac80211_open_file_generic,				\
116 }
117 
118 #define __IEEE80211_IF_FILE_W(name)					\
119 static ssize_t ieee80211_if_write_##name(struct file *file,		\
120 					 const char __user *userbuf,	\
121 					 size_t count, loff_t *ppos)	\
122 {									\
123 	return ieee80211_if_write(file->private_data, userbuf, count,	\
124 				  ppos, ieee80211_if_parse_##name);	\
125 }									\
126 __IEEE80211_IF_FILE(name, ieee80211_if_write_##name)
127 
128 
129 #define IEEE80211_IF_FILE(name, field, format)				\
130 		IEEE80211_IF_FMT_##format(name, field)			\
131 		__IEEE80211_IF_FILE(name, NULL)
132 
133 /* common attributes */
134 IEEE80211_IF_FILE(drop_unencrypted, drop_unencrypted, DEC);
135 IEEE80211_IF_FILE(rc_rateidx_mask_2ghz, rc_rateidx_mask[IEEE80211_BAND_2GHZ],
136 		  HEX);
137 IEEE80211_IF_FILE(rc_rateidx_mask_5ghz, rc_rateidx_mask[IEEE80211_BAND_5GHZ],
138 		  HEX);
139 
140 /* STA attributes */
141 IEEE80211_IF_FILE(bssid, u.mgd.bssid, MAC);
142 IEEE80211_IF_FILE(aid, u.mgd.aid, DEC);
143 
144 static int ieee80211_set_smps(struct ieee80211_sub_if_data *sdata,
145 			      enum ieee80211_smps_mode smps_mode)
146 {
147 	struct ieee80211_local *local = sdata->local;
148 	int err;
149 
150 	if (!(local->hw.flags & IEEE80211_HW_SUPPORTS_STATIC_SMPS) &&
151 	    smps_mode == IEEE80211_SMPS_STATIC)
152 		return -EINVAL;
153 
154 	/* auto should be dynamic if in PS mode */
155 	if (!(local->hw.flags & IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS) &&
156 	    (smps_mode == IEEE80211_SMPS_DYNAMIC ||
157 	     smps_mode == IEEE80211_SMPS_AUTOMATIC))
158 		return -EINVAL;
159 
160 	/* supported only on managed interfaces for now */
161 	if (sdata->vif.type != NL80211_IFTYPE_STATION)
162 		return -EOPNOTSUPP;
163 
164 	mutex_lock(&local->iflist_mtx);
165 	err = __ieee80211_request_smps(sdata, smps_mode);
166 	mutex_unlock(&local->iflist_mtx);
167 
168 	return err;
169 }
170 
171 static const char *smps_modes[IEEE80211_SMPS_NUM_MODES] = {
172 	[IEEE80211_SMPS_AUTOMATIC] = "auto",
173 	[IEEE80211_SMPS_OFF] = "off",
174 	[IEEE80211_SMPS_STATIC] = "static",
175 	[IEEE80211_SMPS_DYNAMIC] = "dynamic",
176 };
177 
178 static ssize_t ieee80211_if_fmt_smps(const struct ieee80211_sub_if_data *sdata,
179 				     char *buf, int buflen)
180 {
181 	if (sdata->vif.type != NL80211_IFTYPE_STATION)
182 		return -EOPNOTSUPP;
183 
184 	return snprintf(buf, buflen, "request: %s\nused: %s\n",
185 			smps_modes[sdata->u.mgd.req_smps],
186 			smps_modes[sdata->u.mgd.ap_smps]);
187 }
188 
189 static ssize_t ieee80211_if_parse_smps(struct ieee80211_sub_if_data *sdata,
190 				       const char *buf, int buflen)
191 {
192 	enum ieee80211_smps_mode mode;
193 
194 	for (mode = 0; mode < IEEE80211_SMPS_NUM_MODES; mode++) {
195 		if (strncmp(buf, smps_modes[mode], buflen) == 0) {
196 			int err = ieee80211_set_smps(sdata, mode);
197 			if (!err)
198 				return buflen;
199 			return err;
200 		}
201 	}
202 
203 	return -EINVAL;
204 }
205 
206 __IEEE80211_IF_FILE_W(smps);
207 
208 /* AP attributes */
209 IEEE80211_IF_FILE(num_sta_ps, u.ap.num_sta_ps, ATOMIC);
210 IEEE80211_IF_FILE(dtim_count, u.ap.dtim_count, DEC);
211 
212 static ssize_t ieee80211_if_fmt_num_buffered_multicast(
213 	const struct ieee80211_sub_if_data *sdata, char *buf, int buflen)
214 {
215 	return scnprintf(buf, buflen, "%u\n",
216 			 skb_queue_len(&sdata->u.ap.ps_bc_buf));
217 }
218 __IEEE80211_IF_FILE(num_buffered_multicast, NULL);
219 
220 /* WDS attributes */
221 IEEE80211_IF_FILE(peer, u.wds.remote_addr, MAC);
222 
223 #ifdef CONFIG_MAC80211_MESH
224 /* Mesh stats attributes */
225 IEEE80211_IF_FILE(fwded_mcast, u.mesh.mshstats.fwded_mcast, DEC);
226 IEEE80211_IF_FILE(fwded_unicast, u.mesh.mshstats.fwded_unicast, DEC);
227 IEEE80211_IF_FILE(fwded_frames, u.mesh.mshstats.fwded_frames, DEC);
228 IEEE80211_IF_FILE(dropped_frames_ttl, u.mesh.mshstats.dropped_frames_ttl, DEC);
229 IEEE80211_IF_FILE(dropped_frames_no_route,
230 		u.mesh.mshstats.dropped_frames_no_route, DEC);
231 IEEE80211_IF_FILE(estab_plinks, u.mesh.mshstats.estab_plinks, ATOMIC);
232 
233 /* Mesh parameters */
234 IEEE80211_IF_FILE(dot11MeshMaxRetries,
235 		u.mesh.mshcfg.dot11MeshMaxRetries, DEC);
236 IEEE80211_IF_FILE(dot11MeshRetryTimeout,
237 		u.mesh.mshcfg.dot11MeshRetryTimeout, DEC);
238 IEEE80211_IF_FILE(dot11MeshConfirmTimeout,
239 		u.mesh.mshcfg.dot11MeshConfirmTimeout, DEC);
240 IEEE80211_IF_FILE(dot11MeshHoldingTimeout,
241 		u.mesh.mshcfg.dot11MeshHoldingTimeout, DEC);
242 IEEE80211_IF_FILE(dot11MeshTTL, u.mesh.mshcfg.dot11MeshTTL, DEC);
243 IEEE80211_IF_FILE(auto_open_plinks, u.mesh.mshcfg.auto_open_plinks, DEC);
244 IEEE80211_IF_FILE(dot11MeshMaxPeerLinks,
245 		u.mesh.mshcfg.dot11MeshMaxPeerLinks, DEC);
246 IEEE80211_IF_FILE(dot11MeshHWMPactivePathTimeout,
247 		u.mesh.mshcfg.dot11MeshHWMPactivePathTimeout, DEC);
248 IEEE80211_IF_FILE(dot11MeshHWMPpreqMinInterval,
249 		u.mesh.mshcfg.dot11MeshHWMPpreqMinInterval, DEC);
250 IEEE80211_IF_FILE(dot11MeshHWMPnetDiameterTraversalTime,
251 		u.mesh.mshcfg.dot11MeshHWMPnetDiameterTraversalTime, DEC);
252 IEEE80211_IF_FILE(dot11MeshHWMPmaxPREQretries,
253 		u.mesh.mshcfg.dot11MeshHWMPmaxPREQretries, DEC);
254 IEEE80211_IF_FILE(path_refresh_time,
255 		u.mesh.mshcfg.path_refresh_time, DEC);
256 IEEE80211_IF_FILE(min_discovery_timeout,
257 		u.mesh.mshcfg.min_discovery_timeout, DEC);
258 IEEE80211_IF_FILE(dot11MeshHWMPRootMode,
259 		u.mesh.mshcfg.dot11MeshHWMPRootMode, DEC);
260 #endif
261 
262 
263 #define DEBUGFS_ADD(name) \
264 	debugfs_create_file(#name, 0400, sdata->debugfs.dir, \
265 			    sdata, &name##_ops);
266 
267 #define DEBUGFS_ADD_MODE(name, mode) \
268 	debugfs_create_file(#name, mode, sdata->debugfs.dir, \
269 			    sdata, &name##_ops);
270 
271 static void add_sta_files(struct ieee80211_sub_if_data *sdata)
272 {
273 	DEBUGFS_ADD(drop_unencrypted);
274 	DEBUGFS_ADD(rc_rateidx_mask_2ghz);
275 	DEBUGFS_ADD(rc_rateidx_mask_5ghz);
276 
277 	DEBUGFS_ADD(bssid);
278 	DEBUGFS_ADD(aid);
279 	DEBUGFS_ADD_MODE(smps, 0600);
280 }
281 
282 static void add_ap_files(struct ieee80211_sub_if_data *sdata)
283 {
284 	DEBUGFS_ADD(drop_unencrypted);
285 	DEBUGFS_ADD(rc_rateidx_mask_2ghz);
286 	DEBUGFS_ADD(rc_rateidx_mask_5ghz);
287 
288 	DEBUGFS_ADD(num_sta_ps);
289 	DEBUGFS_ADD(dtim_count);
290 	DEBUGFS_ADD(num_buffered_multicast);
291 }
292 
293 static void add_wds_files(struct ieee80211_sub_if_data *sdata)
294 {
295 	DEBUGFS_ADD(drop_unencrypted);
296 	DEBUGFS_ADD(rc_rateidx_mask_2ghz);
297 	DEBUGFS_ADD(rc_rateidx_mask_5ghz);
298 
299 	DEBUGFS_ADD(peer);
300 }
301 
302 static void add_vlan_files(struct ieee80211_sub_if_data *sdata)
303 {
304 	DEBUGFS_ADD(drop_unencrypted);
305 	DEBUGFS_ADD(rc_rateidx_mask_2ghz);
306 	DEBUGFS_ADD(rc_rateidx_mask_5ghz);
307 }
308 
309 static void add_monitor_files(struct ieee80211_sub_if_data *sdata)
310 {
311 }
312 
313 #ifdef CONFIG_MAC80211_MESH
314 
315 static void add_mesh_stats(struct ieee80211_sub_if_data *sdata)
316 {
317 	struct dentry *dir = debugfs_create_dir("mesh_stats",
318 						sdata->debugfs.dir);
319 
320 #define MESHSTATS_ADD(name)\
321 	debugfs_create_file(#name, 0400, dir, sdata, &name##_ops);
322 
323 	MESHSTATS_ADD(fwded_mcast);
324 	MESHSTATS_ADD(fwded_unicast);
325 	MESHSTATS_ADD(fwded_frames);
326 	MESHSTATS_ADD(dropped_frames_ttl);
327 	MESHSTATS_ADD(dropped_frames_no_route);
328 	MESHSTATS_ADD(estab_plinks);
329 #undef MESHSTATS_ADD
330 }
331 
332 static void add_mesh_config(struct ieee80211_sub_if_data *sdata)
333 {
334 	struct dentry *dir = debugfs_create_dir("mesh_config",
335 						sdata->debugfs.dir);
336 
337 #define MESHPARAMS_ADD(name) \
338 	debugfs_create_file(#name, 0600, dir, sdata, &name##_ops);
339 
340 	MESHPARAMS_ADD(dot11MeshMaxRetries);
341 	MESHPARAMS_ADD(dot11MeshRetryTimeout);
342 	MESHPARAMS_ADD(dot11MeshConfirmTimeout);
343 	MESHPARAMS_ADD(dot11MeshHoldingTimeout);
344 	MESHPARAMS_ADD(dot11MeshTTL);
345 	MESHPARAMS_ADD(auto_open_plinks);
346 	MESHPARAMS_ADD(dot11MeshMaxPeerLinks);
347 	MESHPARAMS_ADD(dot11MeshHWMPactivePathTimeout);
348 	MESHPARAMS_ADD(dot11MeshHWMPpreqMinInterval);
349 	MESHPARAMS_ADD(dot11MeshHWMPnetDiameterTraversalTime);
350 	MESHPARAMS_ADD(dot11MeshHWMPmaxPREQretries);
351 	MESHPARAMS_ADD(path_refresh_time);
352 	MESHPARAMS_ADD(min_discovery_timeout);
353 
354 #undef MESHPARAMS_ADD
355 }
356 #endif
357 
358 static void add_files(struct ieee80211_sub_if_data *sdata)
359 {
360 	if (!sdata->debugfs.dir)
361 		return;
362 
363 	switch (sdata->vif.type) {
364 	case NL80211_IFTYPE_MESH_POINT:
365 #ifdef CONFIG_MAC80211_MESH
366 		add_mesh_stats(sdata);
367 		add_mesh_config(sdata);
368 #endif
369 		break;
370 	case NL80211_IFTYPE_STATION:
371 		add_sta_files(sdata);
372 		break;
373 	case NL80211_IFTYPE_ADHOC:
374 		/* XXX */
375 		break;
376 	case NL80211_IFTYPE_AP:
377 		add_ap_files(sdata);
378 		break;
379 	case NL80211_IFTYPE_WDS:
380 		add_wds_files(sdata);
381 		break;
382 	case NL80211_IFTYPE_MONITOR:
383 		add_monitor_files(sdata);
384 		break;
385 	case NL80211_IFTYPE_AP_VLAN:
386 		add_vlan_files(sdata);
387 		break;
388 	default:
389 		break;
390 	}
391 }
392 
393 void ieee80211_debugfs_add_netdev(struct ieee80211_sub_if_data *sdata)
394 {
395 	char buf[10+IFNAMSIZ];
396 
397 	sprintf(buf, "netdev:%s", sdata->name);
398 	sdata->debugfs.dir = debugfs_create_dir(buf,
399 		sdata->local->hw.wiphy->debugfsdir);
400 	add_files(sdata);
401 }
402 
403 void ieee80211_debugfs_remove_netdev(struct ieee80211_sub_if_data *sdata)
404 {
405 	if (!sdata->debugfs.dir)
406 		return;
407 
408 	debugfs_remove_recursive(sdata->debugfs.dir);
409 	sdata->debugfs.dir = NULL;
410 }
411 
412 void ieee80211_debugfs_rename_netdev(struct ieee80211_sub_if_data *sdata)
413 {
414 	struct dentry *dir;
415 	char buf[10 + IFNAMSIZ];
416 
417 	dir = sdata->debugfs.dir;
418 
419 	if (!dir)
420 		return;
421 
422 	sprintf(buf, "netdev:%s", sdata->name);
423 	if (!debugfs_rename(dir->d_parent, dir, dir->d_parent, buf))
424 		printk(KERN_ERR "mac80211: debugfs: failed to rename debugfs "
425 		       "dir to %s\n", buf);
426 }
427