[linux-2.6-block.git] / net / wireless / debugfs.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * cfg80211 debugfs
 *
 * Copyright 2009	Luis R. Rodriguez <lrodriguez@atheros.com>
 * Copyright 2007	Johannes Berg <johannes@sipsolutions.net>
 * Copyright (C) 2023 Intel Corporation
 */

#include <linux/slab.h>
#include "core.h"
#include "debugfs.h"

#define DEBUGFS_READONLY_FILE(name, buflen, fmt, value...)		\
static ssize_t name## _read(struct file *file, char __user *userbuf,	\
			    size_t count, loff_t *ppos)			\
{									\
	struct wiphy *wiphy = file->private_data;			\
	char buf[buflen];						\
	int res;							\
									\
	res = scnprintf(buf, buflen, fmt "\n", ##value);		\
	return simple_read_from_buffer(userbuf, count, ppos, buf, res);	\
}									\
									\
static const struct file_operations name## _ops = {			\
	.read = name## _read,						\
	.open = simple_open,						\
	.llseek = generic_file_llseek,					\
}

DEBUGFS_READONLY_FILE(rts_threshold, 20, "%d",
		      wiphy->rts_threshold);
DEBUGFS_READONLY_FILE(fragmentation_threshold, 20, "%d",
		      wiphy->frag_threshold);
DEBUGFS_READONLY_FILE(short_retry_limit, 20, "%d",
		      wiphy->retry_short);
DEBUGFS_READONLY_FILE(long_retry_limit, 20, "%d",
		      wiphy->retry_long);

static int ht_print_chan(struct ieee80211_channel *chan,
			 char *buf, int buf_size, int offset)
{
	if (WARN_ON(offset > buf_size))
		return 0;

	if (chan->flags & IEEE80211_CHAN_DISABLED)
		return scnprintf(buf + offset,
				 buf_size - offset,
				 "%d Disabled\n",
				 chan->center_freq);

	return scnprintf(buf + offset,
			 buf_size - offset,
			 "%d HT40 %c%c\n",
			 chan->center_freq,
			 (chan->flags & IEEE80211_CHAN_NO_HT40MINUS) ?
				' ' : '-',
			 (chan->flags & IEEE80211_CHAN_NO_HT40PLUS) ?
				' ' : '+');
}

static ssize_t ht40allow_map_read(struct file *file,
				  char __user *user_buf,
				  size_t count, loff_t *ppos)
{
	struct wiphy *wiphy = file->private_data;
	char *buf;
	unsigned int offset = 0, buf_size = PAGE_SIZE, i;
	enum nl80211_band band;
	struct ieee80211_supported_band *sband;
	ssize_t r;

	buf = kzalloc(buf_size, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	for (band = 0; band < NUM_NL80211_BANDS; band++) {
		sband = wiphy->bands[band];
		if (!sband)
			continue;
		for (i = 0; i < sband->n_channels; i++)
			offset += ht_print_chan(&sband->channels[i],
						buf, buf_size, offset);
	}

	r = simple_read_from_buffer(user_buf, count, ppos, buf, offset);

	kfree(buf);

	return r;
}

static const struct file_operations ht40allow_map_ops = {
	.read = ht40allow_map_read,
	.open = simple_open,
	.llseek = default_llseek,
};

#define DEBUGFS_ADD(name)						\
	debugfs_create_file(#name, 0444, phyd, &rdev->wiphy, &name## _ops)

void cfg80211_debugfs_rdev_add(struct cfg80211_registered_device *rdev)
{
	struct dentry *phyd = rdev->wiphy.debugfsdir;

	DEBUGFS_ADD(rts_threshold);
	DEBUGFS_ADD(fragmentation_threshold);
	DEBUGFS_ADD(short_retry_limit);
	DEBUGFS_ADD(long_retry_limit);
	DEBUGFS_ADD(ht40allow_map);
}

struct debugfs_read_work {
	struct wiphy_work work;
	ssize_t (*handler)(struct wiphy *wiphy,
			   struct file *file,
			   char *buf,
			   size_t count,
			   void *data);
	struct wiphy *wiphy;
	struct file *file;
	char *buf;
	size_t bufsize;
	void *data;
	ssize_t ret;
	struct completion completion;
};

static void wiphy_locked_debugfs_read_work(struct wiphy *wiphy,
					   struct wiphy_work *work)
{
	struct debugfs_read_work *w = container_of(work, typeof(*w), work);

	w->ret = w->handler(w->wiphy, w->file, w->buf, w->bufsize, w->data);
	complete(&w->completion);
}

static void wiphy_locked_debugfs_read_cancel(struct dentry *dentry,
					     void *data)
{
	struct debugfs_read_work *w = data;

	wiphy_work_cancel(w->wiphy, &w->work);
	complete(&w->completion);
}

ssize_t wiphy_locked_debugfs_read(struct wiphy *wiphy, struct file *file,
				  char *buf, size_t bufsize,
				  char __user *userbuf, size_t count,
				  loff_t *ppos,
				  ssize_t (*handler)(struct wiphy *wiphy,
						     struct file *file,
						     char *buf,
						     size_t bufsize,
						     void *data),
				  void *data)
{
	struct debugfs_read_work work = {
		.handler = handler,
		.wiphy = wiphy,
		.file = file,
		.buf = buf,
		.bufsize = bufsize,
		.data = data,
		.ret = -ENODEV,
		.completion = COMPLETION_INITIALIZER_ONSTACK(work.completion),
	};
	struct debugfs_cancellation cancellation = {
		.cancel = wiphy_locked_debugfs_read_cancel,
		.cancel_data = &work,
	};

	/* don't leak stack data or whatever */
	memset(buf, 0, bufsize);

	wiphy_work_init(&work.work, wiphy_locked_debugfs_read_work);
	wiphy_work_queue(wiphy, &work.work);

	debugfs_enter_cancellation(file, &cancellation);
	wait_for_completion(&work.completion);
	debugfs_leave_cancellation(file, &cancellation);

	if (work.ret < 0)
		return work.ret;

	if (WARN_ON(work.ret > bufsize))
		return -EINVAL;

	return simple_read_from_buffer(userbuf, count, ppos, buf, work.ret);
}
EXPORT_SYMBOL_GPL(wiphy_locked_debugfs_read);

struct debugfs_write_work {
	struct wiphy_work work;
	ssize_t (*handler)(struct wiphy *wiphy,
			   struct file *file,
			   char *buf,
			   size_t count,
			   void *data);
	struct wiphy *wiphy;
	struct file *file;
	char *buf;
	size_t count;
	void *data;
	ssize_t ret;
	struct completion completion;
};

static void wiphy_locked_debugfs_write_work(struct wiphy *wiphy,
					    struct wiphy_work *work)
{
	struct debugfs_write_work *w = container_of(work, typeof(*w), work);

	w->ret = w->handler(w->wiphy, w->file, w->buf, w->count, w->data);
	complete(&w->completion);
}

static void wiphy_locked_debugfs_write_cancel(struct dentry *dentry,
					      void *data)
{
	struct debugfs_write_work *w = data;

	wiphy_work_cancel(w->wiphy, &w->work);
	complete(&w->completion);
}

ssize_t wiphy_locked_debugfs_write(struct wiphy *wiphy,
				   struct file *file, char *buf, size_t bufsize,
				   const char __user *userbuf, size_t count,
				   ssize_t (*handler)(struct wiphy *wiphy,
						      struct file *file,
						      char *buf,
						      size_t count,
						      void *data),
				   void *data)
{
	struct debugfs_write_work work = {
		.handler = handler,
		.wiphy = wiphy,
		.file = file,
		.buf = buf,
		.count = count,
		.data = data,
		.ret = -ENODEV,
		.completion = COMPLETION_INITIALIZER_ONSTACK(work.completion),
	};
	struct debugfs_cancellation cancellation = {
		.cancel = wiphy_locked_debugfs_write_cancel,
		.cancel_data = &work,
	};

	/* mostly used for strings so enforce NUL-termination for safety */
	if (count >= bufsize)
		return -EINVAL;

	memset(buf, 0, bufsize);

	if (copy_from_user(buf, userbuf, count))
		return -EFAULT;

	wiphy_work_init(&work.work, wiphy_locked_debugfs_write_work);
	wiphy_work_queue(wiphy, &work.work);

	debugfs_enter_cancellation(file, &cancellation);
	wait_for_completion(&work.completion);
	debugfs_leave_cancellation(file, &cancellation);

	return work.ret;
}
EXPORT_SYMBOL_GPL(wiphy_locked_debugfs_write);
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
1ac61302 LR	2	/*
	3	* cfg80211 debugfs
	4	*
	5	* Copyright 2009 Luis R. Rodriguez <lrodriguez@atheros.com>
	6	* Copyright 2007 Johannes Berg <johannes@sipsolutions.net>
b590b9ae	7	* Copyright (C) 2023 Intel Corporation
1ac61302 LR	8	*/
1ac61302 LR	9
5a0e3ad6	10	#include <linux/slab.h>
1ac61302 LR	11	#include "core.h"
	12	#include "debugfs.h"
	13
1ac61302 LR	14	#define DEBUGFS_READONLY_FILE(name, buflen, fmt, value...) \
	15	static ssize_t name## _read(struct file file, char __user userbuf, \
	16	size_t count, loff_t *ppos) \
	17	{ \
b699b71d	18	struct wiphy *wiphy = file->private_data; \
1ac61302 LR	19	char buf[buflen]; \
	20	int res; \
	21	\
	22	res = scnprintf(buf, buflen, fmt "\n", ##value); \
	23	return simple_read_from_buffer(userbuf, count, ppos, buf, res); \
	24	} \
	25	\
	26	static const struct file_operations name## _ops = { \
	27	.read = name## _read, \
234e3405	28	.open = simple_open, \
2b18ab36	29	.llseek = generic_file_llseek, \
b699b71d	30	}
1ac61302 LR	31
1ac61302 LR	32	DEBUGFS_READONLY_FILE(rts_threshold, 20, "%d",
b699b71d	33	wiphy->rts_threshold);
1ac61302 LR	34	DEBUGFS_READONLY_FILE(fragmentation_threshold, 20, "%d",
	35	wiphy->frag_threshold);
	36	DEBUGFS_READONLY_FILE(short_retry_limit, 20, "%d",
b699b71d	37	wiphy->retry_short);
1ac61302 LR	38	DEBUGFS_READONLY_FILE(long_retry_limit, 20, "%d",
	39	wiphy->retry_long);
	40
80a3511d LR	41	static int ht_print_chan(struct ieee80211_channel *chan,
	42	char *buf, int buf_size, int offset)
	43	{
	44	if (WARN_ON(offset > buf_size))
	45	return 0;
	46
	47	if (chan->flags & IEEE80211_CHAN_DISABLED)
f364ef99 EP	48	return scnprintf(buf + offset,
	49	buf_size - offset,
	50	"%d Disabled\n",
	51	chan->center_freq);
80a3511d	52
f364ef99 EP	53	return scnprintf(buf + offset,
	54	buf_size - offset,
	55	"%d HT40 %c%c\n",
	56	chan->center_freq,
	57	(chan->flags & IEEE80211_CHAN_NO_HT40MINUS) ?
	58	' ' : '-',
	59	(chan->flags & IEEE80211_CHAN_NO_HT40PLUS) ?
	60	' ' : '+');
80a3511d LR	61	}
	62
	63	static ssize_t ht40allow_map_read(struct file *file,
	64	char __user *user_buf,
	65	size_t count, loff_t *ppos)
	66	{
	67	struct wiphy *wiphy = file->private_data;
	68	char *buf;
d776763f	69	unsigned int offset = 0, buf_size = PAGE_SIZE, i;
57fbcce3	70	enum nl80211_band band;
80a3511d	71	struct ieee80211_supported_band *sband;
d776763f	72	ssize_t r;
80a3511d LR	73
	74	buf = kzalloc(buf_size, GFP_KERNEL);
	75	if (!buf)
	76	return -ENOMEM;
	77
57fbcce3	78	for (band = 0; band < NUM_NL80211_BANDS; band++) {
80a3511d LR	79	sband = wiphy->bands[band];
	80	if (!sband)
	81	continue;
	82	for (i = 0; i < sband->n_channels; i++)
	83	offset += ht_print_chan(&sband->channels[i],
	84	buf, buf_size, offset);
	85	}
	86
80a3511d LR	87	r = simple_read_from_buffer(user_buf, count, ppos, buf, offset);
	88
	89	kfree(buf);
	90
	91	return r;
	92	}
	93
	94	static const struct file_operations ht40allow_map_ops = {
	95	.read = ht40allow_map_read,
234e3405	96	.open = simple_open,
6038f373	97	.llseek = default_llseek,
80a3511d LR	98	};
80a3511d LR	99
1ac61302	100	#define DEBUGFS_ADD(name) \
b699b71d	101	debugfs_create_file(#name, 0444, phyd, &rdev->wiphy, &name## _ops)
1ac61302	102
79c97e97	103	void cfg80211_debugfs_rdev_add(struct cfg80211_registered_device *rdev)
1ac61302	104	{
79c97e97	105	struct dentry *phyd = rdev->wiphy.debugfsdir;
1ac61302 LR	106
	107	DEBUGFS_ADD(rts_threshold);
	108	DEBUGFS_ADD(fragmentation_threshold);
	109	DEBUGFS_ADD(short_retry_limit);
	110	DEBUGFS_ADD(long_retry_limit);
80a3511d	111	DEBUGFS_ADD(ht40allow_map);
1ac61302	112	}
b590b9ae JB	113
	114	struct debugfs_read_work {
	115	struct wiphy_work work;
	116	ssize_t (handler)(struct wiphy wiphy,
	117	struct file *file,
	118	char *buf,
	119	size_t count,
	120	void *data);
	121	struct wiphy *wiphy;
	122	struct file *file;
	123	char *buf;
	124	size_t bufsize;
	125	void *data;
	126	ssize_t ret;
	127	struct completion completion;
	128	};
	129
	130	static void wiphy_locked_debugfs_read_work(struct wiphy *wiphy,
	131	struct wiphy_work *work)
	132	{
	133	struct debugfs_read_work w = container_of(work, typeof(w), work);
	134
	135	w->ret = w->handler(w->wiphy, w->file, w->buf, w->bufsize, w->data);
	136	complete(&w->completion);
	137	}
	138
	139	static void wiphy_locked_debugfs_read_cancel(struct dentry *dentry,
	140	void *data)
	141	{
	142	struct debugfs_read_work *w = data;
	143
	144	wiphy_work_cancel(w->wiphy, &w->work);
	145	complete(&w->completion);
	146	}
	147
	148	ssize_t wiphy_locked_debugfs_read(struct wiphy wiphy, struct file file,
	149	char *buf, size_t bufsize,
	150	char __user *userbuf, size_t count,
	151	loff_t *ppos,
	152	ssize_t (handler)(struct wiphy wiphy,
	153	struct file *file,
	154	char *buf,
	155	size_t bufsize,
	156	void *data),
	157	void *data)
	158	{
	159	struct debugfs_read_work work = {
	160	.handler = handler,
	161	.wiphy = wiphy,
	162	.file = file,
	163	.buf = buf,
	164	.bufsize = bufsize,
	165	.data = data,
	166	.ret = -ENODEV,
	167	.completion = COMPLETION_INITIALIZER_ONSTACK(work.completion),
	168	};
	169	struct debugfs_cancellation cancellation = {
	170	.cancel = wiphy_locked_debugfs_read_cancel,
	171	.cancel_data = &work,
	172	};
	173
	174	/* don't leak stack data or whatever */
	175	memset(buf, 0, bufsize);
	176
177	wiphy_work_init(&work.work, wiphy_locked_debugfs_read_work);
178	wiphy_work_queue(wiphy, &work.work);
179
180	debugfs_enter_cancellation(file, &cancellation);
181	wait_for_completion(&work.completion);
182	debugfs_leave_cancellation(file, &cancellation);
183
184	if (work.ret < 0)
185	return work.ret;
186
187	if (WARN_ON(work.ret > bufsize))
188	return -EINVAL;
189
190	return simple_read_from_buffer(userbuf, count, ppos, buf, work.ret);
191	}
192	EXPORT_SYMBOL_GPL(wiphy_locked_debugfs_read);
193
194	struct debugfs_write_work {
195	struct wiphy_work work;
196	ssize_t (handler)(struct wiphy wiphy,
197	struct file *file,
198	char *buf,
199	size_t count,
200	void *data);
201	struct wiphy *wiphy;
202	struct file *file;
203	char *buf;
204	size_t count;
205	void *data;
206	ssize_t ret;
207	struct completion completion;
208	};
209
210	static void wiphy_locked_debugfs_write_work(struct wiphy *wiphy,
211	struct wiphy_work *work)
212	{
213	struct debugfs_write_work w = container_of(work, typeof(w), work);
214
215	w->ret = w->handler(w->wiphy, w->file, w->buf, w->count, w->data);
216	complete(&w->completion);
217	}
218
219	static void wiphy_locked_debugfs_write_cancel(struct dentry *dentry,
220	void *data)
221	{
222	struct debugfs_write_work *w = data;
223
224	wiphy_work_cancel(w->wiphy, &w->work);
225	complete(&w->completion);
226	}
227
228	ssize_t wiphy_locked_debugfs_write(struct wiphy *wiphy,
229	struct file file, char buf, size_t bufsize,
230	const char __user *userbuf, size_t count,
231	ssize_t (handler)(struct wiphy wiphy,
232	struct file *file,
233	char *buf,
234	size_t count,
235	void *data),
236	void *data)
237	{
238	struct debugfs_write_work work = {
239	.handler = handler,
240	.wiphy = wiphy,
241	.file = file,
242	.buf = buf,
243	.count = count,
244	.data = data,
245	.ret = -ENODEV,
246	.completion = COMPLETION_INITIALIZER_ONSTACK(work.completion),
247	};
248	struct debugfs_cancellation cancellation = {
249	.cancel = wiphy_locked_debugfs_write_cancel,
250	.cancel_data = &work,
251	};
252
253	/* mostly used for strings so enforce NUL-termination for safety */
254	if (count >= bufsize)
255	return -EINVAL;
256
257	memset(buf, 0, bufsize);
258
259	if (copy_from_user(buf, userbuf, count))
260	return -EFAULT;
261
262	wiphy_work_init(&work.work, wiphy_locked_debugfs_write_work);
263	wiphy_work_queue(wiphy, &work.work);
264
265	debugfs_enter_cancellation(file, &cancellation);
266	wait_for_completion(&work.completion);
267	debugfs_leave_cancellation(file, &cancellation);
268
269	return work.ret;
270	}
271	EXPORT_SYMBOL_GPL(wiphy_locked_debugfs_write);