2 * file.c - part of debugfs, a tiny little debug file system
4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
5 * Copyright (C) 2004 IBM Inc.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
11 * debugfs is for people to use instead of /proc or /sys.
12 * See Documentation/DocBook/filesystems for more details.
16 #include <linux/module.h>
18 #include <linux/seq_file.h>
19 #include <linux/pagemap.h>
20 #include <linux/debugfs.h>
22 #include <linux/slab.h>
23 #include <linux/atomic.h>
24 #include <linux/device.h>
26 static ssize_t default_read_file(struct file *file, char __user *buf,
27 size_t count, loff_t *ppos)
32 static ssize_t default_write_file(struct file *file, const char __user *buf,
33 size_t count, loff_t *ppos)
38 const struct file_operations debugfs_file_operations = {
39 .read = default_read_file,
40 .write = default_write_file,
42 .llseek = noop_llseek,
45 static struct dentry *debugfs_create_mode(const char *name, umode_t mode,
46 struct dentry *parent, void *value,
47 const struct file_operations *fops,
48 const struct file_operations *fops_ro,
49 const struct file_operations *fops_wo)
51 /* if there are no write bits set, make read only */
52 if (!(mode & S_IWUGO))
53 return debugfs_create_file(name, mode, parent, value, fops_ro);
54 /* if there are no read bits set, make write only */
55 if (!(mode & S_IRUGO))
56 return debugfs_create_file(name, mode, parent, value, fops_wo);
58 return debugfs_create_file(name, mode, parent, value, fops);
61 static int debugfs_u8_set(void *data, u64 val)
66 static int debugfs_u8_get(void *data, u64 *val)
71 DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
72 DEFINE_SIMPLE_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n");
73 DEFINE_SIMPLE_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");
76 * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
77 * @name: a pointer to a string containing the name of the file to create.
78 * @mode: the permission that the file should have
79 * @parent: a pointer to the parent dentry for this file. This should be a
80 * directory dentry if set. If this parameter is %NULL, then the
81 * file will be created in the root of the debugfs filesystem.
82 * @value: a pointer to the variable that the file should read to and write
85 * This function creates a file in debugfs with the given name that
86 * contains the value of the variable @value. If the @mode variable is so
87 * set, it can be read from, and written to.
89 * This function will return a pointer to a dentry if it succeeds. This
90 * pointer must be passed to the debugfs_remove() function when the file is
91 * to be removed (no automatic cleanup happens if your module is unloaded,
92 * you are responsible here.) If an error occurs, %NULL will be returned.
94 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
95 * returned. It is not wise to check for this value, but rather, check for
96 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
99 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
100 struct dentry *parent, u8 *value)
102 return debugfs_create_mode(name, mode, parent, value, &fops_u8,
103 &fops_u8_ro, &fops_u8_wo);
105 EXPORT_SYMBOL_GPL(debugfs_create_u8);
107 static int debugfs_u16_set(void *data, u64 val)
112 static int debugfs_u16_get(void *data, u64 *val)
117 DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
118 DEFINE_SIMPLE_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n");
119 DEFINE_SIMPLE_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");
122 * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
123 * @name: a pointer to a string containing the name of the file to create.
124 * @mode: the permission that the file should have
125 * @parent: a pointer to the parent dentry for this file. This should be a
126 * directory dentry if set. If this parameter is %NULL, then the
127 * file will be created in the root of the debugfs filesystem.
128 * @value: a pointer to the variable that the file should read to and write
131 * This function creates a file in debugfs with the given name that
132 * contains the value of the variable @value. If the @mode variable is so
133 * set, it can be read from, and written to.
135 * This function will return a pointer to a dentry if it succeeds. This
136 * pointer must be passed to the debugfs_remove() function when the file is
137 * to be removed (no automatic cleanup happens if your module is unloaded,
138 * you are responsible here.) If an error occurs, %NULL will be returned.
140 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
141 * returned. It is not wise to check for this value, but rather, check for
142 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
145 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
146 struct dentry *parent, u16 *value)
148 return debugfs_create_mode(name, mode, parent, value, &fops_u16,
149 &fops_u16_ro, &fops_u16_wo);
151 EXPORT_SYMBOL_GPL(debugfs_create_u16);
153 static int debugfs_u32_set(void *data, u64 val)
158 static int debugfs_u32_get(void *data, u64 *val)
163 DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
164 DEFINE_SIMPLE_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n");
165 DEFINE_SIMPLE_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");
168 * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
169 * @name: a pointer to a string containing the name of the file to create.
170 * @mode: the permission that the file should have
171 * @parent: a pointer to the parent dentry for this file. This should be a
172 * directory dentry if set. If this parameter is %NULL, then the
173 * file will be created in the root of the debugfs filesystem.
174 * @value: a pointer to the variable that the file should read to and write
177 * This function creates a file in debugfs with the given name that
178 * contains the value of the variable @value. If the @mode variable is so
179 * set, it can be read from, and written to.
181 * This function will return a pointer to a dentry if it succeeds. This
182 * pointer must be passed to the debugfs_remove() function when the file is
183 * to be removed (no automatic cleanup happens if your module is unloaded,
184 * you are responsible here.) If an error occurs, %NULL will be returned.
186 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
187 * returned. It is not wise to check for this value, but rather, check for
188 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
191 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
192 struct dentry *parent, u32 *value)
194 return debugfs_create_mode(name, mode, parent, value, &fops_u32,
195 &fops_u32_ro, &fops_u32_wo);
197 EXPORT_SYMBOL_GPL(debugfs_create_u32);
199 static int debugfs_u64_set(void *data, u64 val)
205 static int debugfs_u64_get(void *data, u64 *val)
210 DEFINE_SIMPLE_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
211 DEFINE_SIMPLE_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
212 DEFINE_SIMPLE_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
215 * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
216 * @name: a pointer to a string containing the name of the file to create.
217 * @mode: the permission that the file should have
218 * @parent: a pointer to the parent dentry for this file. This should be a
219 * directory dentry if set. If this parameter is %NULL, then the
220 * file will be created in the root of the debugfs filesystem.
221 * @value: a pointer to the variable that the file should read to and write
224 * This function creates a file in debugfs with the given name that
225 * contains the value of the variable @value. If the @mode variable is so
226 * set, it can be read from, and written to.
228 * This function will return a pointer to a dentry if it succeeds. This
229 * pointer must be passed to the debugfs_remove() function when the file is
230 * to be removed (no automatic cleanup happens if your module is unloaded,
231 * you are responsible here.) If an error occurs, %NULL will be returned.
233 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
234 * returned. It is not wise to check for this value, but rather, check for
235 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
238 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
239 struct dentry *parent, u64 *value)
241 return debugfs_create_mode(name, mode, parent, value, &fops_u64,
242 &fops_u64_ro, &fops_u64_wo);
244 EXPORT_SYMBOL_GPL(debugfs_create_u64);
246 DEFINE_SIMPLE_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
247 DEFINE_SIMPLE_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n");
248 DEFINE_SIMPLE_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n");
250 DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n");
251 DEFINE_SIMPLE_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n");
252 DEFINE_SIMPLE_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n");
254 DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n");
255 DEFINE_SIMPLE_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n");
256 DEFINE_SIMPLE_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n");
258 DEFINE_SIMPLE_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n");
259 DEFINE_SIMPLE_ATTRIBUTE(fops_x64_ro, debugfs_u64_get, NULL, "0x%016llx\n");
260 DEFINE_SIMPLE_ATTRIBUTE(fops_x64_wo, NULL, debugfs_u64_set, "0x%016llx\n");
263 * 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
265 * These functions are exactly the same as the above functions (but use a hex
266 * output for the decimal challenged). For details look at the above unsigned
271 * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
272 * @name: a pointer to a string containing the name of the file to create.
273 * @mode: the permission that the file should have
274 * @parent: a pointer to the parent dentry for this file. This should be a
275 * directory dentry if set. If this parameter is %NULL, then the
276 * file will be created in the root of the debugfs filesystem.
277 * @value: a pointer to the variable that the file should read to and write
280 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
281 struct dentry *parent, u8 *value)
283 return debugfs_create_mode(name, mode, parent, value, &fops_x8,
284 &fops_x8_ro, &fops_x8_wo);
286 EXPORT_SYMBOL_GPL(debugfs_create_x8);
289 * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
290 * @name: a pointer to a string containing the name of the file to create.
291 * @mode: the permission that the file should have
292 * @parent: a pointer to the parent dentry for this file. This should be a
293 * directory dentry if set. If this parameter is %NULL, then the
294 * file will be created in the root of the debugfs filesystem.
295 * @value: a pointer to the variable that the file should read to and write
298 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
299 struct dentry *parent, u16 *value)
301 return debugfs_create_mode(name, mode, parent, value, &fops_x16,
302 &fops_x16_ro, &fops_x16_wo);
304 EXPORT_SYMBOL_GPL(debugfs_create_x16);
307 * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
308 * @name: a pointer to a string containing the name of the file to create.
309 * @mode: the permission that the file should have
310 * @parent: a pointer to the parent dentry for this file. This should be a
311 * directory dentry if set. If this parameter is %NULL, then the
312 * file will be created in the root of the debugfs filesystem.
313 * @value: a pointer to the variable that the file should read to and write
316 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
317 struct dentry *parent, u32 *value)
319 return debugfs_create_mode(name, mode, parent, value, &fops_x32,
320 &fops_x32_ro, &fops_x32_wo);
322 EXPORT_SYMBOL_GPL(debugfs_create_x32);
325 * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
326 * @name: a pointer to a string containing the name of the file to create.
327 * @mode: the permission that the file should have
328 * @parent: a pointer to the parent dentry for this file. This should be a
329 * directory dentry if set. If this parameter is %NULL, then the
330 * file will be created in the root of the debugfs filesystem.
331 * @value: a pointer to the variable that the file should read to and write
334 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
335 struct dentry *parent, u64 *value)
337 return debugfs_create_mode(name, mode, parent, value, &fops_x64,
338 &fops_x64_ro, &fops_x64_wo);
340 EXPORT_SYMBOL_GPL(debugfs_create_x64);
343 static int debugfs_size_t_set(void *data, u64 val)
345 *(size_t *)data = val;
348 static int debugfs_size_t_get(void *data, u64 *val)
350 *val = *(size_t *)data;
353 DEFINE_SIMPLE_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
354 "%llu\n"); /* %llu and %zu are more or less the same */
355 DEFINE_SIMPLE_ATTRIBUTE(fops_size_t_ro, debugfs_size_t_get, NULL, "%llu\n");
356 DEFINE_SIMPLE_ATTRIBUTE(fops_size_t_wo, NULL, debugfs_size_t_set, "%llu\n");
359 * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
360 * @name: a pointer to a string containing the name of the file to create.
361 * @mode: the permission that the file should have
362 * @parent: a pointer to the parent dentry for this file. This should be a
363 * directory dentry if set. If this parameter is %NULL, then the
364 * file will be created in the root of the debugfs filesystem.
365 * @value: a pointer to the variable that the file should read to and write
368 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
369 struct dentry *parent, size_t *value)
371 return debugfs_create_mode(name, mode, parent, value, &fops_size_t,
372 &fops_size_t_ro, &fops_size_t_wo);
374 EXPORT_SYMBOL_GPL(debugfs_create_size_t);
376 static int debugfs_atomic_t_set(void *data, u64 val)
378 atomic_set((atomic_t *)data, val);
381 static int debugfs_atomic_t_get(void *data, u64 *val)
383 *val = atomic_read((atomic_t *)data);
386 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get,
387 debugfs_atomic_t_set, "%lld\n");
388 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL, "%lld\n");
389 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set, "%lld\n");
392 * debugfs_create_atomic_t - create a debugfs file that is used to read and
393 * write an atomic_t value
394 * @name: a pointer to a string containing the name of the file to create.
395 * @mode: the permission that the file should have
396 * @parent: a pointer to the parent dentry for this file. This should be a
397 * directory dentry if set. If this parameter is %NULL, then the
398 * file will be created in the root of the debugfs filesystem.
399 * @value: a pointer to the variable that the file should read to and write
402 struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
403 struct dentry *parent, atomic_t *value)
405 return debugfs_create_mode(name, mode, parent, value, &fops_atomic_t,
406 &fops_atomic_t_ro, &fops_atomic_t_wo);
408 EXPORT_SYMBOL_GPL(debugfs_create_atomic_t);
410 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
411 size_t count, loff_t *ppos)
414 bool *val = file->private_data;
422 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
424 EXPORT_SYMBOL_GPL(debugfs_read_file_bool);
426 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
427 size_t count, loff_t *ppos)
432 bool *val = file->private_data;
434 buf_size = min(count, (sizeof(buf)-1));
435 if (copy_from_user(buf, user_buf, buf_size))
438 buf[buf_size] = '\0';
439 if (strtobool(buf, &bv) == 0)
444 EXPORT_SYMBOL_GPL(debugfs_write_file_bool);
446 static const struct file_operations fops_bool = {
447 .read = debugfs_read_file_bool,
448 .write = debugfs_write_file_bool,
450 .llseek = default_llseek,
453 static const struct file_operations fops_bool_ro = {
454 .read = debugfs_read_file_bool,
456 .llseek = default_llseek,
459 static const struct file_operations fops_bool_wo = {
460 .write = debugfs_write_file_bool,
462 .llseek = default_llseek,
466 * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
467 * @name: a pointer to a string containing the name of the file to create.
468 * @mode: the permission that the file should have
469 * @parent: a pointer to the parent dentry for this file. This should be a
470 * directory dentry if set. If this parameter is %NULL, then the
471 * file will be created in the root of the debugfs filesystem.
472 * @value: a pointer to the variable that the file should read to and write
475 * This function creates a file in debugfs with the given name that
476 * contains the value of the variable @value. If the @mode variable is so
477 * set, it can be read from, and written to.
479 * This function will return a pointer to a dentry if it succeeds. This
480 * pointer must be passed to the debugfs_remove() function when the file is
481 * to be removed (no automatic cleanup happens if your module is unloaded,
482 * you are responsible here.) If an error occurs, %NULL will be returned.
484 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
485 * returned. It is not wise to check for this value, but rather, check for
486 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
489 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
490 struct dentry *parent, bool *value)
492 return debugfs_create_mode(name, mode, parent, value, &fops_bool,
493 &fops_bool_ro, &fops_bool_wo);
495 EXPORT_SYMBOL_GPL(debugfs_create_bool);
497 static ssize_t read_file_blob(struct file *file, char __user *user_buf,
498 size_t count, loff_t *ppos)
500 struct debugfs_blob_wrapper *blob = file->private_data;
501 return simple_read_from_buffer(user_buf, count, ppos, blob->data,
505 static const struct file_operations fops_blob = {
506 .read = read_file_blob,
508 .llseek = default_llseek,
512 * debugfs_create_blob - create a debugfs file that is used to read a binary blob
513 * @name: a pointer to a string containing the name of the file to create.
514 * @mode: the permission that the file should have
515 * @parent: a pointer to the parent dentry for this file. This should be a
516 * directory dentry if set. If this parameter is %NULL, then the
517 * file will be created in the root of the debugfs filesystem.
518 * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
519 * to the blob data and the size of the data.
521 * This function creates a file in debugfs with the given name that exports
522 * @blob->data as a binary blob. If the @mode variable is so set it can be
523 * read from. Writing is not supported.
525 * This function will return a pointer to a dentry if it succeeds. This
526 * pointer must be passed to the debugfs_remove() function when the file is
527 * to be removed (no automatic cleanup happens if your module is unloaded,
528 * you are responsible here.) If an error occurs, %NULL will be returned.
530 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
531 * returned. It is not wise to check for this value, but rather, check for
532 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
535 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
536 struct dentry *parent,
537 struct debugfs_blob_wrapper *blob)
539 return debugfs_create_file(name, mode, parent, blob, &fops_blob);
541 EXPORT_SYMBOL_GPL(debugfs_create_blob);
548 static size_t u32_format_array(char *buf, size_t bufsize,
549 u32 *array, int array_size)
553 while (--array_size >= 0) {
555 char term = array_size ? ' ' : '\n';
557 len = snprintf(buf, bufsize, "%u%c", *array++, term);
566 static int u32_array_open(struct inode *inode, struct file *file)
568 struct array_data *data = inode->i_private;
569 int size, elements = data->elements;
574 * - 10 digits + ' '/'\n' = 11 bytes per number
575 * - terminating NUL character
578 buf = kmalloc(size+1, GFP_KERNEL);
583 file->private_data = buf;
584 u32_format_array(buf, size, data->array, data->elements);
586 return nonseekable_open(inode, file);
589 static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len,
592 size_t size = strlen(file->private_data);
594 return simple_read_from_buffer(buf, len, ppos,
595 file->private_data, size);
598 static int u32_array_release(struct inode *inode, struct file *file)
600 kfree(file->private_data);
605 static const struct file_operations u32_array_fops = {
606 .owner = THIS_MODULE,
607 .open = u32_array_open,
608 .release = u32_array_release,
609 .read = u32_array_read,
614 * debugfs_create_u32_array - create a debugfs file that is used to read u32
616 * @name: a pointer to a string containing the name of the file to create.
617 * @mode: the permission that the file should have.
618 * @parent: a pointer to the parent dentry for this file. This should be a
619 * directory dentry if set. If this parameter is %NULL, then the
620 * file will be created in the root of the debugfs filesystem.
621 * @array: u32 array that provides data.
622 * @elements: total number of elements in the array.
624 * This function creates a file in debugfs with the given name that exports
625 * @array as data. If the @mode variable is so set it can be read from.
626 * Writing is not supported. Seek within the file is also not supported.
627 * Once array is created its size can not be changed.
629 * The function returns a pointer to dentry on success. If debugfs is not
630 * enabled in the kernel, the value -%ENODEV will be returned.
632 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
633 struct dentry *parent,
634 u32 *array, u32 elements)
636 struct array_data *data = kmalloc(sizeof(*data), GFP_KERNEL);
642 data->elements = elements;
644 return debugfs_create_file(name, mode, parent, data, &u32_array_fops);
646 EXPORT_SYMBOL_GPL(debugfs_create_u32_array);
648 #ifdef CONFIG_HAS_IOMEM
651 * The regset32 stuff is used to print 32-bit registers using the
652 * seq_file utilities. We offer printing a register set in an already-opened
653 * sequential file or create a debugfs file that only prints a regset32.
657 * debugfs_print_regs32 - use seq_print to describe a set of registers
658 * @s: the seq_file structure being used to generate output
659 * @regs: an array if struct debugfs_reg32 structures
660 * @nregs: the length of the above array
661 * @base: the base address to be used in reading the registers
662 * @prefix: a string to be prefixed to every output line
664 * This function outputs a text block describing the current values of
665 * some 32-bit hardware registers. It is meant to be used within debugfs
666 * files based on seq_file that need to show registers, intermixed with other
667 * information. The prefix argument may be used to specify a leading string,
668 * because some peripherals have several blocks of identical registers,
669 * for example configuration of dma channels
671 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
672 int nregs, void __iomem *base, char *prefix)
676 for (i = 0; i < nregs; i++, regs++) {
678 seq_printf(s, "%s", prefix);
679 seq_printf(s, "%s = 0x%08x\n", regs->name,
680 readl(base + regs->offset));
681 if (seq_has_overflowed(s))
685 EXPORT_SYMBOL_GPL(debugfs_print_regs32);
687 static int debugfs_show_regset32(struct seq_file *s, void *data)
689 struct debugfs_regset32 *regset = s->private;
691 debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
695 static int debugfs_open_regset32(struct inode *inode, struct file *file)
697 return single_open(file, debugfs_show_regset32, inode->i_private);
700 static const struct file_operations fops_regset32 = {
701 .open = debugfs_open_regset32,
704 .release = single_release,
708 * debugfs_create_regset32 - create a debugfs file that returns register values
709 * @name: a pointer to a string containing the name of the file to create.
710 * @mode: the permission that the file should have
711 * @parent: a pointer to the parent dentry for this file. This should be a
712 * directory dentry if set. If this parameter is %NULL, then the
713 * file will be created in the root of the debugfs filesystem.
714 * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
715 * to an array of register definitions, the array size and the base
716 * address where the register bank is to be found.
718 * This function creates a file in debugfs with the given name that reports
719 * the names and values of a set of 32-bit registers. If the @mode variable
720 * is so set it can be read from. Writing is not supported.
722 * This function will return a pointer to a dentry if it succeeds. This
723 * pointer must be passed to the debugfs_remove() function when the file is
724 * to be removed (no automatic cleanup happens if your module is unloaded,
725 * you are responsible here.) If an error occurs, %NULL will be returned.
727 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
728 * returned. It is not wise to check for this value, but rather, check for
729 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
732 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
733 struct dentry *parent,
734 struct debugfs_regset32 *regset)
736 return debugfs_create_file(name, mode, parent, regset, &fops_regset32);
738 EXPORT_SYMBOL_GPL(debugfs_create_regset32);
740 #endif /* CONFIG_HAS_IOMEM */
742 struct debugfs_devm_entry {
743 int (*read)(struct seq_file *seq, void *data);
747 static int debugfs_devm_entry_open(struct inode *inode, struct file *f)
749 struct debugfs_devm_entry *entry = inode->i_private;
751 return single_open(f, entry->read, entry->dev);
754 static const struct file_operations debugfs_devm_entry_ops = {
755 .owner = THIS_MODULE,
756 .open = debugfs_devm_entry_open,
757 .release = single_release,
763 * debugfs_create_devm_seqfile - create a debugfs file that is bound to device.
765 * @dev: device related to this debugfs file.
766 * @name: name of the debugfs file.
767 * @parent: a pointer to the parent dentry for this file. This should be a
768 * directory dentry if set. If this parameter is %NULL, then the
769 * file will be created in the root of the debugfs filesystem.
770 * @read_fn: function pointer called to print the seq_file content.
772 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
773 struct dentry *parent,
774 int (*read_fn)(struct seq_file *s,
777 struct debugfs_devm_entry *entry;
780 return ERR_PTR(-ENOENT);
782 entry = devm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
784 return ERR_PTR(-ENOMEM);
786 entry->read = read_fn;
789 return debugfs_create_file(name, S_IRUGO, parent, entry,
790 &debugfs_devm_entry_ops);
792 EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile);