blob: ea62afa4fd5747fc9b3cbdab6b374177b9300895 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * file.c - part of debugfs, a tiny little debug file system
3 *
4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
5 * Copyright (C) 2004 IBM Inc.
6 *
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.
10 *
11 * debugfs is for people to use instead of /proc or /sys.
Robert P. J. Day883ce422008-04-25 08:52:51 -040012 * See Documentation/DocBook/filesystems for more details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
14 */
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/module.h>
17#include <linux/fs.h>
Alessandro Rubini1a087c62011-11-18 14:50:21 +010018#include <linux/seq_file.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/pagemap.h>
Peter Oberparleiter66f54962007-02-13 12:13:54 +010020#include <linux/namei.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/debugfs.h>
Alessandro Rubini03e099f2011-11-21 10:01:40 +010022#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24static ssize_t default_read_file(struct file *file, char __user *buf,
25 size_t count, loff_t *ppos)
26{
27 return 0;
28}
29
30static ssize_t default_write_file(struct file *file, const char __user *buf,
31 size_t count, loff_t *ppos)
32{
33 return count;
34}
35
36static int default_open(struct inode *inode, struct file *file)
37{
Theodore Ts'o8e18e292006-09-27 01:50:46 -070038 if (inode->i_private)
39 file->private_data = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41 return 0;
42}
43
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -080044const struct file_operations debugfs_file_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 .read = default_read_file,
46 .write = default_write_file,
47 .open = default_open,
Arnd Bergmann6038f372010-08-15 18:52:59 +020048 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -070049};
50
Peter Oberparleiter66f54962007-02-13 12:13:54 +010051static void *debugfs_follow_link(struct dentry *dentry, struct nameidata *nd)
52{
53 nd_set_link(nd, dentry->d_inode->i_private);
54 return NULL;
55}
56
57const struct inode_operations debugfs_link_operations = {
58 .readlink = generic_readlink,
59 .follow_link = debugfs_follow_link,
60};
61
Christoph Hellwig8b88b092008-02-08 04:20:26 -080062static int debugfs_u8_set(void *data, u64 val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +020063{
64 *(u8 *)data = val;
Christoph Hellwig8b88b092008-02-08 04:20:26 -080065 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +020066}
Christoph Hellwig8b88b092008-02-08 04:20:26 -080067static int debugfs_u8_get(void *data, u64 *val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +020068{
Christoph Hellwig8b88b092008-02-08 04:20:26 -080069 *val = *(u8 *)data;
70 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +020071}
72DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
Robin Getze4792aa2009-06-02 03:00:47 -040073DEFINE_SIMPLE_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n");
74DEFINE_SIMPLE_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76/**
Randy Dunlap6468b3a2006-07-20 08:16:42 -070077 * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 * @name: a pointer to a string containing the name of the file to create.
79 * @mode: the permission that the file should have
80 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -070081 * directory dentry if set. If this parameter is %NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 * file will be created in the root of the debugfs filesystem.
83 * @value: a pointer to the variable that the file should read to and write
84 * from.
85 *
86 * This function creates a file in debugfs with the given name that
87 * contains the value of the variable @value. If the @mode variable is so
88 * set, it can be read from, and written to.
89 *
90 * This function will return a pointer to a dentry if it succeeds. This
91 * pointer must be passed to the debugfs_remove() function when the file is
92 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -070093 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -070095 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -070097 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 * code.
99 */
100struct dentry *debugfs_create_u8(const char *name, mode_t mode,
101 struct dentry *parent, u8 *value)
102{
Robin Getze4792aa2009-06-02 03:00:47 -0400103 /* if there are no write bits set, make read only */
104 if (!(mode & S_IWUGO))
105 return debugfs_create_file(name, mode, parent, value, &fops_u8_ro);
106 /* if there are no read bits set, make write only */
107 if (!(mode & S_IRUGO))
108 return debugfs_create_file(name, mode, parent, value, &fops_u8_wo);
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 return debugfs_create_file(name, mode, parent, value, &fops_u8);
111}
112EXPORT_SYMBOL_GPL(debugfs_create_u8);
113
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800114static int debugfs_u16_set(void *data, u64 val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200115{
116 *(u16 *)data = val;
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800117 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200118}
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800119static int debugfs_u16_get(void *data, u64 *val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200120{
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800121 *val = *(u16 *)data;
122 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200123}
124DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400125DEFINE_SIMPLE_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n");
126DEFINE_SIMPLE_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128/**
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700129 * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 * @name: a pointer to a string containing the name of the file to create.
131 * @mode: the permission that the file should have
132 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700133 * directory dentry if set. If this parameter is %NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 * file will be created in the root of the debugfs filesystem.
135 * @value: a pointer to the variable that the file should read to and write
136 * from.
137 *
138 * This function creates a file in debugfs with the given name that
139 * contains the value of the variable @value. If the @mode variable is so
140 * set, it can be read from, and written to.
141 *
142 * This function will return a pointer to a dentry if it succeeds. This
143 * pointer must be passed to the debugfs_remove() function when the file is
144 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700145 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700147 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700149 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * code.
151 */
152struct dentry *debugfs_create_u16(const char *name, mode_t mode,
153 struct dentry *parent, u16 *value)
154{
Robin Getze4792aa2009-06-02 03:00:47 -0400155 /* if there are no write bits set, make read only */
156 if (!(mode & S_IWUGO))
157 return debugfs_create_file(name, mode, parent, value, &fops_u16_ro);
158 /* if there are no read bits set, make write only */
159 if (!(mode & S_IRUGO))
160 return debugfs_create_file(name, mode, parent, value, &fops_u16_wo);
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 return debugfs_create_file(name, mode, parent, value, &fops_u16);
163}
164EXPORT_SYMBOL_GPL(debugfs_create_u16);
165
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800166static int debugfs_u32_set(void *data, u64 val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200167{
168 *(u32 *)data = val;
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800169 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200170}
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800171static int debugfs_u32_get(void *data, u64 *val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200172{
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800173 *val = *(u32 *)data;
174 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200175}
176DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400177DEFINE_SIMPLE_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n");
178DEFINE_SIMPLE_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180/**
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700181 * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 * @name: a pointer to a string containing the name of the file to create.
183 * @mode: the permission that the file should have
184 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700185 * directory dentry if set. If this parameter is %NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 * file will be created in the root of the debugfs filesystem.
187 * @value: a pointer to the variable that the file should read to and write
188 * from.
189 *
190 * This function creates a file in debugfs with the given name that
191 * contains the value of the variable @value. If the @mode variable is so
192 * set, it can be read from, and written to.
193 *
194 * This function will return a pointer to a dentry if it succeeds. This
195 * pointer must be passed to the debugfs_remove() function when the file is
196 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700197 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700199 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700201 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 * code.
203 */
204struct dentry *debugfs_create_u32(const char *name, mode_t mode,
205 struct dentry *parent, u32 *value)
206{
Robin Getze4792aa2009-06-02 03:00:47 -0400207 /* if there are no write bits set, make read only */
208 if (!(mode & S_IWUGO))
209 return debugfs_create_file(name, mode, parent, value, &fops_u32_ro);
210 /* if there are no read bits set, make write only */
211 if (!(mode & S_IRUGO))
212 return debugfs_create_file(name, mode, parent, value, &fops_u32_wo);
213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 return debugfs_create_file(name, mode, parent, value, &fops_u32);
215}
216EXPORT_SYMBOL_GPL(debugfs_create_u32);
217
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800218static int debugfs_u64_set(void *data, u64 val)
Michael Ellerman84478912007-04-17 15:59:36 +1000219{
220 *(u64 *)data = val;
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800221 return 0;
Michael Ellerman84478912007-04-17 15:59:36 +1000222}
223
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800224static int debugfs_u64_get(void *data, u64 *val)
Michael Ellerman84478912007-04-17 15:59:36 +1000225{
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800226 *val = *(u64 *)data;
227 return 0;
Michael Ellerman84478912007-04-17 15:59:36 +1000228}
229DEFINE_SIMPLE_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400230DEFINE_SIMPLE_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
231DEFINE_SIMPLE_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
Michael Ellerman84478912007-04-17 15:59:36 +1000232
233/**
234 * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
235 * @name: a pointer to a string containing the name of the file to create.
236 * @mode: the permission that the file should have
237 * @parent: a pointer to the parent dentry for this file. This should be a
238 * directory dentry if set. If this parameter is %NULL, then the
239 * file will be created in the root of the debugfs filesystem.
240 * @value: a pointer to the variable that the file should read to and write
241 * from.
242 *
243 * This function creates a file in debugfs with the given name that
244 * contains the value of the variable @value. If the @mode variable is so
245 * set, it can be read from, and written to.
246 *
247 * This function will return a pointer to a dentry if it succeeds. This
248 * pointer must be passed to the debugfs_remove() function when the file is
249 * to be removed (no automatic cleanup happens if your module is unloaded,
250 * you are responsible here.) If an error occurs, %NULL will be returned.
251 *
252 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
253 * returned. It is not wise to check for this value, but rather, check for
254 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
255 * code.
256 */
257struct dentry *debugfs_create_u64(const char *name, mode_t mode,
258 struct dentry *parent, u64 *value)
259{
Robin Getze4792aa2009-06-02 03:00:47 -0400260 /* if there are no write bits set, make read only */
261 if (!(mode & S_IWUGO))
262 return debugfs_create_file(name, mode, parent, value, &fops_u64_ro);
263 /* if there are no read bits set, make write only */
264 if (!(mode & S_IRUGO))
265 return debugfs_create_file(name, mode, parent, value, &fops_u64_wo);
266
Michael Ellerman84478912007-04-17 15:59:36 +1000267 return debugfs_create_file(name, mode, parent, value, &fops_u64);
268}
269EXPORT_SYMBOL_GPL(debugfs_create_u64);
270
Robin Getz2ebefc52007-08-02 18:23:50 -0400271DEFINE_SIMPLE_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400272DEFINE_SIMPLE_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n");
273DEFINE_SIMPLE_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n");
Robin Getz2ebefc52007-08-02 18:23:50 -0400274
275DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400276DEFINE_SIMPLE_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n");
277DEFINE_SIMPLE_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n");
Robin Getz2ebefc52007-08-02 18:23:50 -0400278
279DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400280DEFINE_SIMPLE_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n");
281DEFINE_SIMPLE_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n");
Robin Getz2ebefc52007-08-02 18:23:50 -0400282
Huang Ying15b0bea2010-05-18 14:35:23 +0800283DEFINE_SIMPLE_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n");
284
Randy Dunlape6716b82007-10-15 17:30:19 -0700285/*
Huang Ying15b0bea2010-05-18 14:35:23 +0800286 * 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
Randy Dunlape6716b82007-10-15 17:30:19 -0700287 *
288 * These functions are exactly the same as the above functions (but use a hex
289 * output for the decimal challenged). For details look at the above unsigned
290 * decimal functions.
291 */
292
Robin Getz2ebefc52007-08-02 18:23:50 -0400293/**
294 * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
Randy Dunlape6716b82007-10-15 17:30:19 -0700295 * @name: a pointer to a string containing the name of the file to create.
296 * @mode: the permission that the file should have
297 * @parent: a pointer to the parent dentry for this file. This should be a
298 * directory dentry if set. If this parameter is %NULL, then the
299 * file will be created in the root of the debugfs filesystem.
300 * @value: a pointer to the variable that the file should read to and write
301 * from.
Robin Getz2ebefc52007-08-02 18:23:50 -0400302 */
303struct dentry *debugfs_create_x8(const char *name, mode_t mode,
304 struct dentry *parent, u8 *value)
305{
Robin Getze4792aa2009-06-02 03:00:47 -0400306 /* if there are no write bits set, make read only */
307 if (!(mode & S_IWUGO))
308 return debugfs_create_file(name, mode, parent, value, &fops_x8_ro);
309 /* if there are no read bits set, make write only */
310 if (!(mode & S_IRUGO))
311 return debugfs_create_file(name, mode, parent, value, &fops_x8_wo);
312
Robin Getz2ebefc52007-08-02 18:23:50 -0400313 return debugfs_create_file(name, mode, parent, value, &fops_x8);
314}
315EXPORT_SYMBOL_GPL(debugfs_create_x8);
316
Randy Dunlape6716b82007-10-15 17:30:19 -0700317/**
318 * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
319 * @name: a pointer to a string containing the name of the file to create.
320 * @mode: the permission that the file should have
321 * @parent: a pointer to the parent dentry for this file. This should be a
322 * directory dentry if set. If this parameter is %NULL, then the
323 * file will be created in the root of the debugfs filesystem.
324 * @value: a pointer to the variable that the file should read to and write
325 * from.
326 */
Robin Getz2ebefc52007-08-02 18:23:50 -0400327struct dentry *debugfs_create_x16(const char *name, mode_t mode,
328 struct dentry *parent, u16 *value)
329{
Robin Getze4792aa2009-06-02 03:00:47 -0400330 /* if there are no write bits set, make read only */
331 if (!(mode & S_IWUGO))
332 return debugfs_create_file(name, mode, parent, value, &fops_x16_ro);
333 /* if there are no read bits set, make write only */
334 if (!(mode & S_IRUGO))
335 return debugfs_create_file(name, mode, parent, value, &fops_x16_wo);
336
Robin Getz2ebefc52007-08-02 18:23:50 -0400337 return debugfs_create_file(name, mode, parent, value, &fops_x16);
338}
339EXPORT_SYMBOL_GPL(debugfs_create_x16);
340
Randy Dunlape6716b82007-10-15 17:30:19 -0700341/**
342 * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
343 * @name: a pointer to a string containing the name of the file to create.
344 * @mode: the permission that the file should have
345 * @parent: a pointer to the parent dentry for this file. This should be a
346 * directory dentry if set. If this parameter is %NULL, then the
347 * file will be created in the root of the debugfs filesystem.
348 * @value: a pointer to the variable that the file should read to and write
349 * from.
350 */
Robin Getz2ebefc52007-08-02 18:23:50 -0400351struct dentry *debugfs_create_x32(const char *name, mode_t mode,
352 struct dentry *parent, u32 *value)
353{
Robin Getze4792aa2009-06-02 03:00:47 -0400354 /* if there are no write bits set, make read only */
355 if (!(mode & S_IWUGO))
356 return debugfs_create_file(name, mode, parent, value, &fops_x32_ro);
357 /* if there are no read bits set, make write only */
358 if (!(mode & S_IRUGO))
359 return debugfs_create_file(name, mode, parent, value, &fops_x32_wo);
360
Robin Getz2ebefc52007-08-02 18:23:50 -0400361 return debugfs_create_file(name, mode, parent, value, &fops_x32);
362}
363EXPORT_SYMBOL_GPL(debugfs_create_x32);
364
Huang Ying15b0bea2010-05-18 14:35:23 +0800365/**
366 * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
367 * @name: a pointer to a string containing the name of the file to create.
368 * @mode: the permission that the file should have
369 * @parent: a pointer to the parent dentry for this file. This should be a
370 * directory dentry if set. If this parameter is %NULL, then the
371 * file will be created in the root of the debugfs filesystem.
372 * @value: a pointer to the variable that the file should read to and write
373 * from.
374 */
375struct dentry *debugfs_create_x64(const char *name, mode_t mode,
376 struct dentry *parent, u64 *value)
377{
378 return debugfs_create_file(name, mode, parent, value, &fops_x64);
379}
380EXPORT_SYMBOL_GPL(debugfs_create_x64);
381
Inaky Perez-Gonzalez5e078782008-12-20 16:57:39 -0800382
383static int debugfs_size_t_set(void *data, u64 val)
384{
385 *(size_t *)data = val;
386 return 0;
387}
388static int debugfs_size_t_get(void *data, u64 *val)
389{
390 *val = *(size_t *)data;
391 return 0;
392}
393DEFINE_SIMPLE_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
394 "%llu\n"); /* %llu and %zu are more or less the same */
395
396/**
397 * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
398 * @name: a pointer to a string containing the name of the file to create.
399 * @mode: the permission that the file should have
400 * @parent: a pointer to the parent dentry for this file. This should be a
401 * directory dentry if set. If this parameter is %NULL, then the
402 * file will be created in the root of the debugfs filesystem.
403 * @value: a pointer to the variable that the file should read to and write
404 * from.
405 */
406struct dentry *debugfs_create_size_t(const char *name, mode_t mode,
407 struct dentry *parent, size_t *value)
408{
409 return debugfs_create_file(name, mode, parent, value, &fops_size_t);
410}
411EXPORT_SYMBOL_GPL(debugfs_create_size_t);
412
413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414static ssize_t read_file_bool(struct file *file, char __user *user_buf,
415 size_t count, loff_t *ppos)
416{
417 char buf[3];
418 u32 *val = file->private_data;
419
420 if (*val)
421 buf[0] = 'Y';
422 else
423 buf[0] = 'N';
424 buf[1] = '\n';
425 buf[2] = 0x00;
426 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
427}
428
429static ssize_t write_file_bool(struct file *file, const char __user *user_buf,
430 size_t count, loff_t *ppos)
431{
432 char buf[32];
Stephen Boydc42d2232011-05-12 16:50:07 -0700433 size_t buf_size;
Jonathan Cameron8705b482011-04-19 12:43:46 +0100434 bool bv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 u32 *val = file->private_data;
436
437 buf_size = min(count, (sizeof(buf)-1));
438 if (copy_from_user(buf, user_buf, buf_size))
439 return -EFAULT;
440
Jonathan Cameron8705b482011-04-19 12:43:46 +0100441 if (strtobool(buf, &bv) == 0)
442 *val = bv;
443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 return count;
445}
446
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800447static const struct file_operations fops_bool = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 .read = read_file_bool,
449 .write = write_file_bool,
450 .open = default_open,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200451 .llseek = default_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452};
453
454/**
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700455 * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 * @name: a pointer to a string containing the name of the file to create.
457 * @mode: the permission that the file should have
458 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700459 * directory dentry if set. If this parameter is %NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 * file will be created in the root of the debugfs filesystem.
461 * @value: a pointer to the variable that the file should read to and write
462 * from.
463 *
464 * This function creates a file in debugfs with the given name that
465 * contains the value of the variable @value. If the @mode variable is so
466 * set, it can be read from, and written to.
467 *
468 * This function will return a pointer to a dentry if it succeeds. This
469 * pointer must be passed to the debugfs_remove() function when the file is
470 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700471 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700473 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700475 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 * code.
477 */
478struct dentry *debugfs_create_bool(const char *name, mode_t mode,
479 struct dentry *parent, u32 *value)
480{
481 return debugfs_create_file(name, mode, parent, value, &fops_bool);
482}
483EXPORT_SYMBOL_GPL(debugfs_create_bool);
484
Michael Ellermandd308bc2006-03-07 21:41:59 +1100485static ssize_t read_file_blob(struct file *file, char __user *user_buf,
486 size_t count, loff_t *ppos)
487{
488 struct debugfs_blob_wrapper *blob = file->private_data;
489 return simple_read_from_buffer(user_buf, count, ppos, blob->data,
490 blob->size);
491}
492
Arjan van de Ven00977a52007-02-12 00:55:34 -0800493static const struct file_operations fops_blob = {
Michael Ellermandd308bc2006-03-07 21:41:59 +1100494 .read = read_file_blob,
495 .open = default_open,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200496 .llseek = default_llseek,
Michael Ellermandd308bc2006-03-07 21:41:59 +1100497};
498
499/**
Jonathan Corbet400ced62009-05-25 10:15:27 -0600500 * debugfs_create_blob - create a debugfs file that is used to read a binary blob
Michael Ellermandd308bc2006-03-07 21:41:59 +1100501 * @name: a pointer to a string containing the name of the file to create.
502 * @mode: the permission that the file should have
503 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700504 * directory dentry if set. If this parameter is %NULL, then the
Michael Ellermandd308bc2006-03-07 21:41:59 +1100505 * file will be created in the root of the debugfs filesystem.
506 * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
507 * to the blob data and the size of the data.
508 *
509 * This function creates a file in debugfs with the given name that exports
510 * @blob->data as a binary blob. If the @mode variable is so set it can be
511 * read from. Writing is not supported.
512 *
513 * This function will return a pointer to a dentry if it succeeds. This
514 * pointer must be passed to the debugfs_remove() function when the file is
515 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700516 * you are responsible here.) If an error occurs, %NULL will be returned.
Michael Ellermandd308bc2006-03-07 21:41:59 +1100517 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700518 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Michael Ellermandd308bc2006-03-07 21:41:59 +1100519 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700520 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Michael Ellermandd308bc2006-03-07 21:41:59 +1100521 * code.
522 */
523struct dentry *debugfs_create_blob(const char *name, mode_t mode,
524 struct dentry *parent,
525 struct debugfs_blob_wrapper *blob)
526{
527 return debugfs_create_file(name, mode, parent, blob, &fops_blob);
528}
529EXPORT_SYMBOL_GPL(debugfs_create_blob);
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100530
Heiko Carstens3b85e4a2011-12-27 15:08:28 +0100531#ifdef CONFIG_HAS_IOMEM
532
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100533/*
534 * The regset32 stuff is used to print 32-bit registers using the
535 * seq_file utilities. We offer printing a register set in an already-opened
536 * sequential file or create a debugfs file that only prints a regset32.
537 */
538
539/**
540 * debugfs_print_regs32 - use seq_print to describe a set of registers
541 * @s: the seq_file structure being used to generate output
542 * @regs: an array if struct debugfs_reg32 structures
543 * @mregs: the length of the above array
544 * @base: the base address to be used in reading the registers
545 * @prefix: a string to be prefixed to every output line
546 *
547 * This function outputs a text block describing the current values of
548 * some 32-bit hardware registers. It is meant to be used within debugfs
549 * files based on seq_file that need to show registers, intermixed with other
550 * information. The prefix argument may be used to specify a leading string,
551 * because some peripherals have several blocks of identical registers,
552 * for example configuration of dma channels
553 */
Alessandro Rubini8ee4dd92011-11-18 23:53:29 +0100554int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100555 int nregs, void __iomem *base, char *prefix)
556{
557 int i, ret = 0;
558
559 for (i = 0; i < nregs; i++, regs++) {
560 if (prefix)
561 ret += seq_printf(s, "%s", prefix);
562 ret += seq_printf(s, "%s = 0x%08x\n", regs->name,
Dan Carpenter58584412011-11-24 10:22:08 +0300563 readl(base + regs->offset));
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100564 }
565 return ret;
566}
567EXPORT_SYMBOL_GPL(debugfs_print_regs32);
568
569static int debugfs_show_regset32(struct seq_file *s, void *data)
570{
571 struct debugfs_regset32 *regset = s->private;
572
573 debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
574 return 0;
575}
576
577static int debugfs_open_regset32(struct inode *inode, struct file *file)
578{
579 return single_open(file, debugfs_show_regset32, inode->i_private);
580}
581
582static const struct file_operations fops_regset32 = {
583 .open = debugfs_open_regset32,
584 .read = seq_read,
585 .llseek = seq_lseek,
586 .release = single_release,
587};
588
589/**
590 * debugfs_create_regset32 - create a debugfs file that returns register values
591 * @name: a pointer to a string containing the name of the file to create.
592 * @mode: the permission that the file should have
593 * @parent: a pointer to the parent dentry for this file. This should be a
594 * directory dentry if set. If this parameter is %NULL, then the
595 * file will be created in the root of the debugfs filesystem.
596 * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
597 * to an array of register definitions, the array size and the base
598 * address where the register bank is to be found.
599 *
600 * This function creates a file in debugfs with the given name that reports
601 * the names and values of a set of 32-bit registers. If the @mode variable
602 * is so set it can be read from. Writing is not supported.
603 *
604 * This function will return a pointer to a dentry if it succeeds. This
605 * pointer must be passed to the debugfs_remove() function when the file is
606 * to be removed (no automatic cleanup happens if your module is unloaded,
607 * you are responsible here.) If an error occurs, %NULL will be returned.
608 *
609 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
610 * returned. It is not wise to check for this value, but rather, check for
611 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
612 * code.
613 */
614struct dentry *debugfs_create_regset32(const char *name, mode_t mode,
615 struct dentry *parent,
616 struct debugfs_regset32 *regset)
617{
618 return debugfs_create_file(name, mode, parent, regset, &fops_regset32);
619}
620EXPORT_SYMBOL_GPL(debugfs_create_regset32);
Heiko Carstens3b85e4a2011-12-27 15:08:28 +0100621
622#endif /* CONFIG_HAS_IOMEM */