file.c 23.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11
/*
 *  file.c - part of debugfs, a tiny little debug file system
 *
 *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
 *  Copyright (C) 2004 IBM Inc.
 *
 *	This program is free software; you can redistribute it and/or
 *	modify it under the terms of the GNU General Public License version
 *	2 as published by the Free Software Foundation.
 *
 *  debugfs is for people to use instead of /proc or /sys.
12
 *  See Documentation/DocBook/filesystems for more details.
L
Linus Torvalds 已提交
13 14 15 16 17
 *
 */

#include <linux/module.h>
#include <linux/fs.h>
18
#include <linux/seq_file.h>
L
Linus Torvalds 已提交
19
#include <linux/pagemap.h>
20
#include <linux/namei.h>
L
Linus Torvalds 已提交
21
#include <linux/debugfs.h>
22
#include <linux/io.h>
L
Linus Torvalds 已提交
23 24 25 26 27 28 29 30 31 32 33 34 35

static ssize_t default_read_file(struct file *file, char __user *buf,
				 size_t count, loff_t *ppos)
{
	return 0;
}

static ssize_t default_write_file(struct file *file, const char __user *buf,
				   size_t count, loff_t *ppos)
{
	return count;
}

36
const struct file_operations debugfs_file_operations = {
L
Linus Torvalds 已提交
37 38
	.read =		default_read_file,
	.write =	default_write_file,
39
	.open =		simple_open,
40
	.llseek =	noop_llseek,
L
Linus Torvalds 已提交
41 42
};

43 44 45 46 47 48 49 50 51 52 53
static void *debugfs_follow_link(struct dentry *dentry, struct nameidata *nd)
{
	nd_set_link(nd, dentry->d_inode->i_private);
	return NULL;
}

const struct inode_operations debugfs_link_operations = {
	.readlink       = generic_readlink,
	.follow_link    = debugfs_follow_link,
};

54
static int debugfs_u8_set(void *data, u64 val)
55 56
{
	*(u8 *)data = val;
57
	return 0;
58
}
59
static int debugfs_u8_get(void *data, u64 *val)
60
{
61 62
	*val = *(u8 *)data;
	return 0;
63 64
}
DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
65 66
DEFINE_SIMPLE_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n");
DEFINE_SIMPLE_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");
L
Linus Torvalds 已提交
67 68

/**
69
 * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
L
Linus Torvalds 已提交
70 71 72
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
73
 *          directory dentry if set.  If this parameter is %NULL, then the
L
Linus Torvalds 已提交
74 75 76 77 78 79 80 81 82 83 84
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
85
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
86
 *
87
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
L
Linus Torvalds 已提交
88
 * returned.  It is not wise to check for this value, but rather, check for
89
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
L
Linus Torvalds 已提交
90 91
 * code.
 */
A
Al Viro 已提交
92
struct dentry *debugfs_create_u8(const char *name, umode_t mode,
L
Linus Torvalds 已提交
93 94
				 struct dentry *parent, u8 *value)
{
95 96 97 98 99 100 101
	/* if there are no write bits set, make read only */
	if (!(mode & S_IWUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_u8_ro);
	/* if there are no read bits set, make write only */
	if (!(mode & S_IRUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_u8_wo);

L
Linus Torvalds 已提交
102 103 104 105
	return debugfs_create_file(name, mode, parent, value, &fops_u8);
}
EXPORT_SYMBOL_GPL(debugfs_create_u8);

106
static int debugfs_u16_set(void *data, u64 val)
107 108
{
	*(u16 *)data = val;
109
	return 0;
110
}
111
static int debugfs_u16_get(void *data, u64 *val)
112
{
113 114
	*val = *(u16 *)data;
	return 0;
115 116
}
DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
117 118
DEFINE_SIMPLE_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n");
DEFINE_SIMPLE_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");
119

L
Linus Torvalds 已提交
120
/**
121
 * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
L
Linus Torvalds 已提交
122 123 124
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
125
 *          directory dentry if set.  If this parameter is %NULL, then the
L
Linus Torvalds 已提交
126 127 128 129 130 131 132 133 134 135 136
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
137
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
138
 *
139
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
L
Linus Torvalds 已提交
140
 * returned.  It is not wise to check for this value, but rather, check for
141
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
L
Linus Torvalds 已提交
142 143
 * code.
 */
A
Al Viro 已提交
144
struct dentry *debugfs_create_u16(const char *name, umode_t mode,
L
Linus Torvalds 已提交
145 146
				  struct dentry *parent, u16 *value)
{
147 148 149 150 151 152 153
	/* if there are no write bits set, make read only */
	if (!(mode & S_IWUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_u16_ro);
	/* if there are no read bits set, make write only */
	if (!(mode & S_IRUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_u16_wo);

L
Linus Torvalds 已提交
154 155 156 157
	return debugfs_create_file(name, mode, parent, value, &fops_u16);
}
EXPORT_SYMBOL_GPL(debugfs_create_u16);

158
static int debugfs_u32_set(void *data, u64 val)
159 160
{
	*(u32 *)data = val;
161
	return 0;
162
}
163
static int debugfs_u32_get(void *data, u64 *val)
164
{
165 166
	*val = *(u32 *)data;
	return 0;
167 168
}
DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
169 170
DEFINE_SIMPLE_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n");
DEFINE_SIMPLE_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");
171

L
Linus Torvalds 已提交
172
/**
173
 * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
L
Linus Torvalds 已提交
174 175 176
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
177
 *          directory dentry if set.  If this parameter is %NULL, then the
L
Linus Torvalds 已提交
178 179 180 181 182 183 184 185 186 187 188
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
189
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
190
 *
191
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
L
Linus Torvalds 已提交
192
 * returned.  It is not wise to check for this value, but rather, check for
193
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
L
Linus Torvalds 已提交
194 195
 * code.
 */
A
Al Viro 已提交
196
struct dentry *debugfs_create_u32(const char *name, umode_t mode,
L
Linus Torvalds 已提交
197 198
				 struct dentry *parent, u32 *value)
{
199 200 201 202 203 204 205
	/* if there are no write bits set, make read only */
	if (!(mode & S_IWUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_u32_ro);
	/* if there are no read bits set, make write only */
	if (!(mode & S_IRUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_u32_wo);

L
Linus Torvalds 已提交
206 207 208 209
	return debugfs_create_file(name, mode, parent, value, &fops_u32);
}
EXPORT_SYMBOL_GPL(debugfs_create_u32);

210
static int debugfs_u64_set(void *data, u64 val)
211 212
{
	*(u64 *)data = val;
213
	return 0;
214 215
}

216
static int debugfs_u64_get(void *data, u64 *val)
217
{
218 219
	*val = *(u64 *)data;
	return 0;
220 221
}
DEFINE_SIMPLE_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
222 223
DEFINE_SIMPLE_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
DEFINE_SIMPLE_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

/**
 * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
 * you are responsible here.)  If an error occurs, %NULL will be returned.
 *
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 * returned.  It is not wise to check for this value, but rather, check for
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 * code.
 */
A
Al Viro 已提交
249
struct dentry *debugfs_create_u64(const char *name, umode_t mode,
250 251
				 struct dentry *parent, u64 *value)
{
252 253 254 255 256 257 258
	/* if there are no write bits set, make read only */
	if (!(mode & S_IWUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_u64_ro);
	/* if there are no read bits set, make write only */
	if (!(mode & S_IRUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_u64_wo);

259 260 261 262
	return debugfs_create_file(name, mode, parent, value, &fops_u64);
}
EXPORT_SYMBOL_GPL(debugfs_create_u64);

263
DEFINE_SIMPLE_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
264 265
DEFINE_SIMPLE_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n");
DEFINE_SIMPLE_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n");
266 267

DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n");
268 269
DEFINE_SIMPLE_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n");
DEFINE_SIMPLE_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n");
270 271

DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n");
272 273
DEFINE_SIMPLE_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n");
DEFINE_SIMPLE_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n");
274

H
Huang Ying 已提交
275 276
DEFINE_SIMPLE_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n");

R
Randy Dunlap 已提交
277
/*
H
Huang Ying 已提交
278
 * debugfs_create_x{8,16,32,64} - create a debugfs file that is used to read and write an unsigned {8,16,32,64}-bit value
279
 *
R
Randy Dunlap 已提交
280 281
 * These functions are exactly the same as the above functions (but use a hex
 * output for the decimal challenged). For details look at the above unsigned
282 283
 * decimal functions.
 */
R
Randy Dunlap 已提交
284 285 286 287 288 289 290 291 292 293 294

/**
 * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 */
A
Al Viro 已提交
295
struct dentry *debugfs_create_x8(const char *name, umode_t mode,
296 297
				 struct dentry *parent, u8 *value)
{
298 299 300 301 302 303 304
	/* if there are no write bits set, make read only */
	if (!(mode & S_IWUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_x8_ro);
	/* if there are no read bits set, make write only */
	if (!(mode & S_IRUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_x8_wo);

305 306 307 308
	return debugfs_create_file(name, mode, parent, value, &fops_x8);
}
EXPORT_SYMBOL_GPL(debugfs_create_x8);

R
Randy Dunlap 已提交
309 310 311 312 313 314 315 316 317 318
/**
 * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 */
A
Al Viro 已提交
319
struct dentry *debugfs_create_x16(const char *name, umode_t mode,
320 321
				 struct dentry *parent, u16 *value)
{
322 323 324 325 326 327 328
	/* if there are no write bits set, make read only */
	if (!(mode & S_IWUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_x16_ro);
	/* if there are no read bits set, make write only */
	if (!(mode & S_IRUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_x16_wo);

329 330 331 332
	return debugfs_create_file(name, mode, parent, value, &fops_x16);
}
EXPORT_SYMBOL_GPL(debugfs_create_x16);

R
Randy Dunlap 已提交
333 334 335 336 337 338 339 340 341 342
/**
 * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 */
A
Al Viro 已提交
343
struct dentry *debugfs_create_x32(const char *name, umode_t mode,
344 345
				 struct dentry *parent, u32 *value)
{
346 347 348 349 350 351 352
	/* if there are no write bits set, make read only */
	if (!(mode & S_IWUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_x32_ro);
	/* if there are no read bits set, make write only */
	if (!(mode & S_IRUGO))
		return debugfs_create_file(name, mode, parent, value, &fops_x32_wo);

353 354 355 356
	return debugfs_create_file(name, mode, parent, value, &fops_x32);
}
EXPORT_SYMBOL_GPL(debugfs_create_x32);

H
Huang Ying 已提交
357 358 359 360 361 362 363 364 365 366
/**
 * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 */
A
Al Viro 已提交
367
struct dentry *debugfs_create_x64(const char *name, umode_t mode,
H
Huang Ying 已提交
368 369 370 371 372 373
				 struct dentry *parent, u64 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_x64);
}
EXPORT_SYMBOL_GPL(debugfs_create_x64);

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

static int debugfs_size_t_set(void *data, u64 val)
{
	*(size_t *)data = val;
	return 0;
}
static int debugfs_size_t_get(void *data, u64 *val)
{
	*val = *(size_t *)data;
	return 0;
}
DEFINE_SIMPLE_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
			"%llu\n");	/* %llu and %zu are more or less the same */

/**
 * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 */
A
Al Viro 已提交
398
struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
399 400 401 402 403 404 405
				     struct dentry *parent, size_t *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_size_t);
}
EXPORT_SYMBOL_GPL(debugfs_create_size_t);


L
Linus Torvalds 已提交
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
static ssize_t read_file_bool(struct file *file, char __user *user_buf,
			      size_t count, loff_t *ppos)
{
	char buf[3];
	u32 *val = file->private_data;
	
	if (*val)
		buf[0] = 'Y';
	else
		buf[0] = 'N';
	buf[1] = '\n';
	buf[2] = 0x00;
	return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
}

static ssize_t write_file_bool(struct file *file, const char __user *user_buf,
			       size_t count, loff_t *ppos)
{
	char buf[32];
425
	size_t buf_size;
426
	bool bv;
L
Linus Torvalds 已提交
427 428 429 430 431 432
	u32 *val = file->private_data;

	buf_size = min(count, (sizeof(buf)-1));
	if (copy_from_user(buf, user_buf, buf_size))
		return -EFAULT;

433 434 435
	if (strtobool(buf, &bv) == 0)
		*val = bv;

L
Linus Torvalds 已提交
436 437 438
	return count;
}

439
static const struct file_operations fops_bool = {
L
Linus Torvalds 已提交
440 441
	.read =		read_file_bool,
	.write =	write_file_bool,
442
	.open =		simple_open,
443
	.llseek =	default_llseek,
L
Linus Torvalds 已提交
444 445 446
};

/**
447
 * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
L
Linus Torvalds 已提交
448 449 450
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
451
 *          directory dentry if set.  If this parameter is %NULL, then the
L
Linus Torvalds 已提交
452 453 454 455 456 457 458 459 460 461 462
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
463
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
464
 *
465
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
L
Linus Torvalds 已提交
466
 * returned.  It is not wise to check for this value, but rather, check for
467
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
L
Linus Torvalds 已提交
468 469
 * code.
 */
A
Al Viro 已提交
470
struct dentry *debugfs_create_bool(const char *name, umode_t mode,
L
Linus Torvalds 已提交
471 472 473 474 475 476
				   struct dentry *parent, u32 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_bool);
}
EXPORT_SYMBOL_GPL(debugfs_create_bool);

477 478 479 480 481 482 483 484
static ssize_t read_file_blob(struct file *file, char __user *user_buf,
			      size_t count, loff_t *ppos)
{
	struct debugfs_blob_wrapper *blob = file->private_data;
	return simple_read_from_buffer(user_buf, count, ppos, blob->data,
			blob->size);
}

485
static const struct file_operations fops_blob = {
486
	.read =		read_file_blob,
487
	.open =		simple_open,
488
	.llseek =	default_llseek,
489 490 491
};

/**
J
Jonathan Corbet 已提交
492
 * debugfs_create_blob - create a debugfs file that is used to read a binary blob
493 494 495
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
496
 *          directory dentry if set.  If this parameter is %NULL, then the
497 498 499 500 501 502 503 504 505 506 507
 *          file will be created in the root of the debugfs filesystem.
 * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
 *        to the blob data and the size of the data.
 *
 * This function creates a file in debugfs with the given name that exports
 * @blob->data as a binary blob. If the @mode variable is so set it can be
 * read from. Writing is not supported.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
508
 * you are responsible here.)  If an error occurs, %NULL will be returned.
509
 *
510
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
511
 * returned.  It is not wise to check for this value, but rather, check for
512
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
513 514
 * code.
 */
A
Al Viro 已提交
515
struct dentry *debugfs_create_blob(const char *name, umode_t mode,
516 517 518 519 520 521
				   struct dentry *parent,
				   struct debugfs_blob_wrapper *blob)
{
	return debugfs_create_file(name, mode, parent, blob, &fops_blob);
}
EXPORT_SYMBOL_GPL(debugfs_create_blob);
522

523 524
#ifdef CONFIG_HAS_IOMEM

525 526 527 528 529 530 531 532 533 534
/*
 * The regset32 stuff is used to print 32-bit registers using the
 * seq_file utilities. We offer printing a register set in an already-opened
 * sequential file or create a debugfs file that only prints a regset32.
 */

/**
 * debugfs_print_regs32 - use seq_print to describe a set of registers
 * @s: the seq_file structure being used to generate output
 * @regs: an array if struct debugfs_reg32 structures
535
 * @nregs: the length of the above array
536 537 538 539 540 541 542 543 544 545
 * @base: the base address to be used in reading the registers
 * @prefix: a string to be prefixed to every output line
 *
 * This function outputs a text block describing the current values of
 * some 32-bit hardware registers. It is meant to be used within debugfs
 * files based on seq_file that need to show registers, intermixed with other
 * information. The prefix argument may be used to specify a leading string,
 * because some peripherals have several blocks of identical registers,
 * for example configuration of dma channels
 */
546
int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
547 548 549 550 551 552 553 554
			   int nregs, void __iomem *base, char *prefix)
{
	int i, ret = 0;

	for (i = 0; i < nregs; i++, regs++) {
		if (prefix)
			ret += seq_printf(s, "%s", prefix);
		ret += seq_printf(s, "%s = 0x%08x\n", regs->name,
555
				  readl(base + regs->offset));
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
	}
	return ret;
}
EXPORT_SYMBOL_GPL(debugfs_print_regs32);

static int debugfs_show_regset32(struct seq_file *s, void *data)
{
	struct debugfs_regset32 *regset = s->private;

	debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
	return 0;
}

static int debugfs_open_regset32(struct inode *inode, struct file *file)
{
	return single_open(file, debugfs_show_regset32, inode->i_private);
}

static const struct file_operations fops_regset32 = {
	.open =		debugfs_open_regset32,
	.read =		seq_read,
	.llseek =	seq_lseek,
	.release =	single_release,
};

/**
 * debugfs_create_regset32 - create a debugfs file that returns register values
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
 *          to an array of register definitions, the array size and the base
 *          address where the register bank is to be found.
 *
 * This function creates a file in debugfs with the given name that reports
 * the names and values of a set of 32-bit registers. If the @mode variable
 * is so set it can be read from. Writing is not supported.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
 * you are responsible here.)  If an error occurs, %NULL will be returned.
 *
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 * returned.  It is not wise to check for this value, but rather, check for
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 * code.
 */
A
Al Viro 已提交
606
struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
607 608 609 610 611 612
				       struct dentry *parent,
				       struct debugfs_regset32 *regset)
{
	return debugfs_create_file(name, mode, parent, regset, &fops_regset32);
}
EXPORT_SYMBOL_GPL(debugfs_create_regset32);
613 614

#endif /* CONFIG_HAS_IOMEM */