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