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 static int debugfs_ulong_set(void *data
, u64 val
)
248 *(unsigned long *)data
= val
;
252 static int debugfs_ulong_get(void *data
, u64
*val
)
254 *val
= *(unsigned long *)data
;
257 DEFINE_SIMPLE_ATTRIBUTE(fops_ulong
, debugfs_ulong_get
, debugfs_ulong_set
, "%llu\n");
258 DEFINE_SIMPLE_ATTRIBUTE(fops_ulong_ro
, debugfs_ulong_get
, NULL
, "%llu\n");
259 DEFINE_SIMPLE_ATTRIBUTE(fops_ulong_wo
, NULL
, debugfs_ulong_set
, "%llu\n");
262 * debugfs_create_ulong - create a debugfs file that is used to read and write
263 * an unsigned long value.
264 * @name: a pointer to a string containing the name of the file to create.
265 * @mode: the permission that the file should have
266 * @parent: a pointer to the parent dentry for this file. This should be a
267 * directory dentry if set. If this parameter is %NULL, then the
268 * file will be created in the root of the debugfs filesystem.
269 * @value: a pointer to the variable that the file should read to and write
272 * This function creates a file in debugfs with the given name that
273 * contains the value of the variable @value. If the @mode variable is so
274 * set, it can be read from, and written to.
276 * This function will return a pointer to a dentry if it succeeds. This
277 * pointer must be passed to the debugfs_remove() function when the file is
278 * to be removed (no automatic cleanup happens if your module is unloaded,
279 * you are responsible here.) If an error occurs, %NULL will be returned.
281 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
282 * returned. It is not wise to check for this value, but rather, check for
283 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
286 struct dentry
*debugfs_create_ulong(const char *name
, umode_t mode
,
287 struct dentry
*parent
, unsigned long *value
)
289 return debugfs_create_mode(name
, mode
, parent
, value
, &fops_ulong
,
290 &fops_ulong_ro
, &fops_ulong_wo
);
292 EXPORT_SYMBOL_GPL(debugfs_create_ulong
);
294 DEFINE_SIMPLE_ATTRIBUTE(fops_x8
, debugfs_u8_get
, debugfs_u8_set
, "0x%02llx\n");
295 DEFINE_SIMPLE_ATTRIBUTE(fops_x8_ro
, debugfs_u8_get
, NULL
, "0x%02llx\n");
296 DEFINE_SIMPLE_ATTRIBUTE(fops_x8_wo
, NULL
, debugfs_u8_set
, "0x%02llx\n");
298 DEFINE_SIMPLE_ATTRIBUTE(fops_x16
, debugfs_u16_get
, debugfs_u16_set
, "0x%04llx\n");
299 DEFINE_SIMPLE_ATTRIBUTE(fops_x16_ro
, debugfs_u16_get
, NULL
, "0x%04llx\n");
300 DEFINE_SIMPLE_ATTRIBUTE(fops_x16_wo
, NULL
, debugfs_u16_set
, "0x%04llx\n");
302 DEFINE_SIMPLE_ATTRIBUTE(fops_x32
, debugfs_u32_get
, debugfs_u32_set
, "0x%08llx\n");
303 DEFINE_SIMPLE_ATTRIBUTE(fops_x32_ro
, debugfs_u32_get
, NULL
, "0x%08llx\n");
304 DEFINE_SIMPLE_ATTRIBUTE(fops_x32_wo
, NULL
, debugfs_u32_set
, "0x%08llx\n");
306 DEFINE_SIMPLE_ATTRIBUTE(fops_x64
, debugfs_u64_get
, debugfs_u64_set
, "0x%016llx\n");
307 DEFINE_SIMPLE_ATTRIBUTE(fops_x64_ro
, debugfs_u64_get
, NULL
, "0x%016llx\n");
308 DEFINE_SIMPLE_ATTRIBUTE(fops_x64_wo
, NULL
, debugfs_u64_set
, "0x%016llx\n");
311 * 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
313 * These functions are exactly the same as the above functions (but use a hex
314 * output for the decimal challenged). For details look at the above unsigned
319 * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
320 * @name: a pointer to a string containing the name of the file to create.
321 * @mode: the permission that the file should have
322 * @parent: a pointer to the parent dentry for this file. This should be a
323 * directory dentry if set. If this parameter is %NULL, then the
324 * file will be created in the root of the debugfs filesystem.
325 * @value: a pointer to the variable that the file should read to and write
328 struct dentry
*debugfs_create_x8(const char *name
, umode_t mode
,
329 struct dentry
*parent
, u8
*value
)
331 return debugfs_create_mode(name
, mode
, parent
, value
, &fops_x8
,
332 &fops_x8_ro
, &fops_x8_wo
);
334 EXPORT_SYMBOL_GPL(debugfs_create_x8
);
337 * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
338 * @name: a pointer to a string containing the name of the file to create.
339 * @mode: the permission that the file should have
340 * @parent: a pointer to the parent dentry for this file. This should be a
341 * directory dentry if set. If this parameter is %NULL, then the
342 * file will be created in the root of the debugfs filesystem.
343 * @value: a pointer to the variable that the file should read to and write
346 struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
347 struct dentry
*parent
, u16
*value
)
349 return debugfs_create_mode(name
, mode
, parent
, value
, &fops_x16
,
350 &fops_x16_ro
, &fops_x16_wo
);
352 EXPORT_SYMBOL_GPL(debugfs_create_x16
);
355 * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
356 * @name: a pointer to a string containing the name of the file to create.
357 * @mode: the permission that the file should have
358 * @parent: a pointer to the parent dentry for this file. This should be a
359 * directory dentry if set. If this parameter is %NULL, then the
360 * file will be created in the root of the debugfs filesystem.
361 * @value: a pointer to the variable that the file should read to and write
364 struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
365 struct dentry
*parent
, u32
*value
)
367 return debugfs_create_mode(name
, mode
, parent
, value
, &fops_x32
,
368 &fops_x32_ro
, &fops_x32_wo
);
370 EXPORT_SYMBOL_GPL(debugfs_create_x32
);
373 * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
374 * @name: a pointer to a string containing the name of the file to create.
375 * @mode: the permission that the file should have
376 * @parent: a pointer to the parent dentry for this file. This should be a
377 * directory dentry if set. If this parameter is %NULL, then the
378 * file will be created in the root of the debugfs filesystem.
379 * @value: a pointer to the variable that the file should read to and write
382 struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
383 struct dentry
*parent
, u64
*value
)
385 return debugfs_create_mode(name
, mode
, parent
, value
, &fops_x64
,
386 &fops_x64_ro
, &fops_x64_wo
);
388 EXPORT_SYMBOL_GPL(debugfs_create_x64
);
391 static int debugfs_size_t_set(void *data
, u64 val
)
393 *(size_t *)data
= val
;
396 static int debugfs_size_t_get(void *data
, u64
*val
)
398 *val
= *(size_t *)data
;
401 DEFINE_SIMPLE_ATTRIBUTE(fops_size_t
, debugfs_size_t_get
, debugfs_size_t_set
,
402 "%llu\n"); /* %llu and %zu are more or less the same */
403 DEFINE_SIMPLE_ATTRIBUTE(fops_size_t_ro
, debugfs_size_t_get
, NULL
, "%llu\n");
404 DEFINE_SIMPLE_ATTRIBUTE(fops_size_t_wo
, NULL
, debugfs_size_t_set
, "%llu\n");
407 * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
408 * @name: a pointer to a string containing the name of the file to create.
409 * @mode: the permission that the file should have
410 * @parent: a pointer to the parent dentry for this file. This should be a
411 * directory dentry if set. If this parameter is %NULL, then the
412 * file will be created in the root of the debugfs filesystem.
413 * @value: a pointer to the variable that the file should read to and write
416 struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
417 struct dentry
*parent
, size_t *value
)
419 return debugfs_create_mode(name
, mode
, parent
, value
, &fops_size_t
,
420 &fops_size_t_ro
, &fops_size_t_wo
);
422 EXPORT_SYMBOL_GPL(debugfs_create_size_t
);
424 static int debugfs_atomic_t_set(void *data
, u64 val
)
426 atomic_set((atomic_t
*)data
, val
);
429 static int debugfs_atomic_t_get(void *data
, u64
*val
)
431 *val
= atomic_read((atomic_t
*)data
);
434 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t
, debugfs_atomic_t_get
,
435 debugfs_atomic_t_set
, "%lld\n");
436 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_ro
, debugfs_atomic_t_get
, NULL
, "%lld\n");
437 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_wo
, NULL
, debugfs_atomic_t_set
, "%lld\n");
440 * debugfs_create_atomic_t - create a debugfs file that is used to read and
441 * write an atomic_t value
442 * @name: a pointer to a string containing the name of the file to create.
443 * @mode: the permission that the file should have
444 * @parent: a pointer to the parent dentry for this file. This should be a
445 * directory dentry if set. If this parameter is %NULL, then the
446 * file will be created in the root of the debugfs filesystem.
447 * @value: a pointer to the variable that the file should read to and write
450 struct dentry
*debugfs_create_atomic_t(const char *name
, umode_t mode
,
451 struct dentry
*parent
, atomic_t
*value
)
453 return debugfs_create_mode(name
, mode
, parent
, value
, &fops_atomic_t
,
454 &fops_atomic_t_ro
, &fops_atomic_t_wo
);
456 EXPORT_SYMBOL_GPL(debugfs_create_atomic_t
);
458 ssize_t
debugfs_read_file_bool(struct file
*file
, char __user
*user_buf
,
459 size_t count
, loff_t
*ppos
)
462 bool *val
= file
->private_data
;
470 return simple_read_from_buffer(user_buf
, count
, ppos
, buf
, 2);
472 EXPORT_SYMBOL_GPL(debugfs_read_file_bool
);
474 ssize_t
debugfs_write_file_bool(struct file
*file
, const char __user
*user_buf
,
475 size_t count
, loff_t
*ppos
)
480 bool *val
= file
->private_data
;
482 buf_size
= min(count
, (sizeof(buf
)-1));
483 if (copy_from_user(buf
, user_buf
, buf_size
))
486 buf
[buf_size
] = '\0';
487 if (strtobool(buf
, &bv
) == 0)
492 EXPORT_SYMBOL_GPL(debugfs_write_file_bool
);
494 static const struct file_operations fops_bool
= {
495 .read
= debugfs_read_file_bool
,
496 .write
= debugfs_write_file_bool
,
498 .llseek
= default_llseek
,
501 static const struct file_operations fops_bool_ro
= {
502 .read
= debugfs_read_file_bool
,
504 .llseek
= default_llseek
,
507 static const struct file_operations fops_bool_wo
= {
508 .write
= debugfs_write_file_bool
,
510 .llseek
= default_llseek
,
514 * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
515 * @name: a pointer to a string containing the name of the file to create.
516 * @mode: the permission that the file should have
517 * @parent: a pointer to the parent dentry for this file. This should be a
518 * directory dentry if set. If this parameter is %NULL, then the
519 * file will be created in the root of the debugfs filesystem.
520 * @value: a pointer to the variable that the file should read to and write
523 * This function creates a file in debugfs with the given name that
524 * contains the value of the variable @value. If the @mode variable is so
525 * set, it can be read from, and written to.
527 * This function will return a pointer to a dentry if it succeeds. This
528 * pointer must be passed to the debugfs_remove() function when the file is
529 * to be removed (no automatic cleanup happens if your module is unloaded,
530 * you are responsible here.) If an error occurs, %NULL will be returned.
532 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
533 * returned. It is not wise to check for this value, but rather, check for
534 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
537 struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
538 struct dentry
*parent
, bool *value
)
540 return debugfs_create_mode(name
, mode
, parent
, value
, &fops_bool
,
541 &fops_bool_ro
, &fops_bool_wo
);
543 EXPORT_SYMBOL_GPL(debugfs_create_bool
);
545 static ssize_t
read_file_blob(struct file
*file
, char __user
*user_buf
,
546 size_t count
, loff_t
*ppos
)
548 struct debugfs_blob_wrapper
*blob
= file
->private_data
;
549 return simple_read_from_buffer(user_buf
, count
, ppos
, blob
->data
,
553 static const struct file_operations fops_blob
= {
554 .read
= read_file_blob
,
556 .llseek
= default_llseek
,
560 * debugfs_create_blob - create a debugfs file that is used to read a binary blob
561 * @name: a pointer to a string containing the name of the file to create.
562 * @mode: the permission that the file should have
563 * @parent: a pointer to the parent dentry for this file. This should be a
564 * directory dentry if set. If this parameter is %NULL, then the
565 * file will be created in the root of the debugfs filesystem.
566 * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
567 * to the blob data and the size of the data.
569 * This function creates a file in debugfs with the given name that exports
570 * @blob->data as a binary blob. If the @mode variable is so set it can be
571 * read from. Writing is not supported.
573 * This function will return a pointer to a dentry if it succeeds. This
574 * pointer must be passed to the debugfs_remove() function when the file is
575 * to be removed (no automatic cleanup happens if your module is unloaded,
576 * you are responsible here.) If an error occurs, %NULL will be returned.
578 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
579 * returned. It is not wise to check for this value, but rather, check for
580 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
583 struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
584 struct dentry
*parent
,
585 struct debugfs_blob_wrapper
*blob
)
587 return debugfs_create_file(name
, mode
, parent
, blob
, &fops_blob
);
589 EXPORT_SYMBOL_GPL(debugfs_create_blob
);
596 static size_t u32_format_array(char *buf
, size_t bufsize
,
597 u32
*array
, int array_size
)
601 while (--array_size
>= 0) {
603 char term
= array_size
? ' ' : '\n';
605 len
= snprintf(buf
, bufsize
, "%u%c", *array
++, term
);
614 static int u32_array_open(struct inode
*inode
, struct file
*file
)
616 struct array_data
*data
= inode
->i_private
;
617 int size
, elements
= data
->elements
;
622 * - 10 digits + ' '/'\n' = 11 bytes per number
623 * - terminating NUL character
626 buf
= kmalloc(size
+1, GFP_KERNEL
);
631 file
->private_data
= buf
;
632 u32_format_array(buf
, size
, data
->array
, data
->elements
);
634 return nonseekable_open(inode
, file
);
637 static ssize_t
u32_array_read(struct file
*file
, char __user
*buf
, size_t len
,
640 size_t size
= strlen(file
->private_data
);
642 return simple_read_from_buffer(buf
, len
, ppos
,
643 file
->private_data
, size
);
646 static int u32_array_release(struct inode
*inode
, struct file
*file
)
648 kfree(file
->private_data
);
653 static const struct file_operations u32_array_fops
= {
654 .owner
= THIS_MODULE
,
655 .open
= u32_array_open
,
656 .release
= u32_array_release
,
657 .read
= u32_array_read
,
662 * debugfs_create_u32_array - create a debugfs file that is used to read u32
664 * @name: a pointer to a string containing the name of the file to create.
665 * @mode: the permission that the file should have.
666 * @parent: a pointer to the parent dentry for this file. This should be a
667 * directory dentry if set. If this parameter is %NULL, then the
668 * file will be created in the root of the debugfs filesystem.
669 * @array: u32 array that provides data.
670 * @elements: total number of elements in the array.
672 * This function creates a file in debugfs with the given name that exports
673 * @array as data. If the @mode variable is so set it can be read from.
674 * Writing is not supported. Seek within the file is also not supported.
675 * Once array is created its size can not be changed.
677 * The function returns a pointer to dentry on success. If debugfs is not
678 * enabled in the kernel, the value -%ENODEV will be returned.
680 struct dentry
*debugfs_create_u32_array(const char *name
, umode_t mode
,
681 struct dentry
*parent
,
682 u32
*array
, u32 elements
)
684 struct array_data
*data
= kmalloc(sizeof(*data
), GFP_KERNEL
);
690 data
->elements
= elements
;
692 return debugfs_create_file(name
, mode
, parent
, data
, &u32_array_fops
);
694 EXPORT_SYMBOL_GPL(debugfs_create_u32_array
);
696 #ifdef CONFIG_HAS_IOMEM
699 * The regset32 stuff is used to print 32-bit registers using the
700 * seq_file utilities. We offer printing a register set in an already-opened
701 * sequential file or create a debugfs file that only prints a regset32.
705 * debugfs_print_regs32 - use seq_print to describe a set of registers
706 * @s: the seq_file structure being used to generate output
707 * @regs: an array if struct debugfs_reg32 structures
708 * @nregs: the length of the above array
709 * @base: the base address to be used in reading the registers
710 * @prefix: a string to be prefixed to every output line
712 * This function outputs a text block describing the current values of
713 * some 32-bit hardware registers. It is meant to be used within debugfs
714 * files based on seq_file that need to show registers, intermixed with other
715 * information. The prefix argument may be used to specify a leading string,
716 * because some peripherals have several blocks of identical registers,
717 * for example configuration of dma channels
719 void debugfs_print_regs32(struct seq_file
*s
, const struct debugfs_reg32
*regs
,
720 int nregs
, void __iomem
*base
, char *prefix
)
724 for (i
= 0; i
< nregs
; i
++, regs
++) {
726 seq_printf(s
, "%s", prefix
);
727 seq_printf(s
, "%s = 0x%08x\n", regs
->name
,
728 readl(base
+ regs
->offset
));
729 if (seq_has_overflowed(s
))
733 EXPORT_SYMBOL_GPL(debugfs_print_regs32
);
735 static int debugfs_show_regset32(struct seq_file
*s
, void *data
)
737 struct debugfs_regset32
*regset
= s
->private;
739 debugfs_print_regs32(s
, regset
->regs
, regset
->nregs
, regset
->base
, "");
743 static int debugfs_open_regset32(struct inode
*inode
, struct file
*file
)
745 return single_open(file
, debugfs_show_regset32
, inode
->i_private
);
748 static const struct file_operations fops_regset32
= {
749 .open
= debugfs_open_regset32
,
752 .release
= single_release
,
756 * debugfs_create_regset32 - create a debugfs file that returns register values
757 * @name: a pointer to a string containing the name of the file to create.
758 * @mode: the permission that the file should have
759 * @parent: a pointer to the parent dentry for this file. This should be a
760 * directory dentry if set. If this parameter is %NULL, then the
761 * file will be created in the root of the debugfs filesystem.
762 * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
763 * to an array of register definitions, the array size and the base
764 * address where the register bank is to be found.
766 * This function creates a file in debugfs with the given name that reports
767 * the names and values of a set of 32-bit registers. If the @mode variable
768 * is so set it can be read from. Writing is not supported.
770 * This function will return a pointer to a dentry if it succeeds. This
771 * pointer must be passed to the debugfs_remove() function when the file is
772 * to be removed (no automatic cleanup happens if your module is unloaded,
773 * you are responsible here.) If an error occurs, %NULL will be returned.
775 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
776 * returned. It is not wise to check for this value, but rather, check for
777 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
780 struct dentry
*debugfs_create_regset32(const char *name
, umode_t mode
,
781 struct dentry
*parent
,
782 struct debugfs_regset32
*regset
)
784 return debugfs_create_file(name
, mode
, parent
, regset
, &fops_regset32
);
786 EXPORT_SYMBOL_GPL(debugfs_create_regset32
);
788 #endif /* CONFIG_HAS_IOMEM */
790 struct debugfs_devm_entry
{
791 int (*read
)(struct seq_file
*seq
, void *data
);
795 static int debugfs_devm_entry_open(struct inode
*inode
, struct file
*f
)
797 struct debugfs_devm_entry
*entry
= inode
->i_private
;
799 return single_open(f
, entry
->read
, entry
->dev
);
802 static const struct file_operations debugfs_devm_entry_ops
= {
803 .owner
= THIS_MODULE
,
804 .open
= debugfs_devm_entry_open
,
805 .release
= single_release
,
811 * debugfs_create_devm_seqfile - create a debugfs file that is bound to device.
813 * @dev: device related to this debugfs file.
814 * @name: name of the debugfs file.
815 * @parent: a pointer to the parent dentry for this file. This should be a
816 * directory dentry if set. If this parameter is %NULL, then the
817 * file will be created in the root of the debugfs filesystem.
818 * @read_fn: function pointer called to print the seq_file content.
820 struct dentry
*debugfs_create_devm_seqfile(struct device
*dev
, const char *name
,
821 struct dentry
*parent
,
822 int (*read_fn
)(struct seq_file
*s
,
825 struct debugfs_devm_entry
*entry
;
828 return ERR_PTR(-ENOENT
);
830 entry
= devm_kzalloc(dev
, sizeof(*entry
), GFP_KERNEL
);
832 return ERR_PTR(-ENOMEM
);
834 entry
->read
= read_fn
;
837 return debugfs_create_file(name
, S_IRUGO
, parent
, entry
,
838 &debugfs_devm_entry_ops
);
840 EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile
);