blob: 2340f6978d6e29e01c9b90ddaa9abd33beb0ee11 [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>
Srivatsa Vaddagiri9fe2a702012-03-23 13:36:28 +053023#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25static ssize_t default_read_file(struct file *file, char __user *buf,
26 size_t count, loff_t *ppos)
27{
28 return 0;
29}
30
31static ssize_t default_write_file(struct file *file, const char __user *buf,
32 size_t count, loff_t *ppos)
33{
34 return count;
35}
36
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -080037const struct file_operations debugfs_file_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 .read = default_read_file,
39 .write = default_write_file,
Stephen Boyd234e3402012-04-05 14:25:11 -070040 .open = simple_open,
Arnd Bergmann6038f372010-08-15 18:52:59 +020041 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -070042};
43
Peter Oberparleiter66f54962007-02-13 12:13:54 +010044static void *debugfs_follow_link(struct dentry *dentry, struct nameidata *nd)
45{
46 nd_set_link(nd, dentry->d_inode->i_private);
47 return NULL;
48}
49
50const struct inode_operations debugfs_link_operations = {
51 .readlink = generic_readlink,
52 .follow_link = debugfs_follow_link,
53};
54
Christoph Hellwig8b88b092008-02-08 04:20:26 -080055static int debugfs_u8_set(void *data, u64 val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +020056{
57 *(u8 *)data = val;
Christoph Hellwig8b88b092008-02-08 04:20:26 -080058 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +020059}
Christoph Hellwig8b88b092008-02-08 04:20:26 -080060static int debugfs_u8_get(void *data, u64 *val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +020061{
Christoph Hellwig8b88b092008-02-08 04:20:26 -080062 *val = *(u8 *)data;
63 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +020064}
65DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
Robin Getze4792aa2009-06-02 03:00:47 -040066DEFINE_SIMPLE_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n");
67DEFINE_SIMPLE_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69/**
Randy Dunlap6468b3a2006-07-20 08:16:42 -070070 * 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 -070071 * @name: a pointer to a string containing the name of the file to create.
72 * @mode: the permission that the file should have
73 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -070074 * directory dentry if set. If this parameter is %NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * file will be created in the root of the debugfs filesystem.
76 * @value: a pointer to the variable that the file should read to and write
77 * from.
78 *
79 * This function creates a file in debugfs with the given name that
80 * contains the value of the variable @value. If the @mode variable is so
81 * set, it can be read from, and written to.
82 *
83 * This function will return a pointer to a dentry if it succeeds. This
84 * pointer must be passed to the debugfs_remove() function when the file is
85 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -070086 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -070088 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -070090 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 * code.
92 */
Al Virof4ae40a2011-07-24 04:33:43 -040093struct dentry *debugfs_create_u8(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 struct dentry *parent, u8 *value)
95{
Robin Getze4792aa2009-06-02 03:00:47 -040096 /* if there are no write bits set, make read only */
97 if (!(mode & S_IWUGO))
98 return debugfs_create_file(name, mode, parent, value, &fops_u8_ro);
99 /* if there are no read bits set, make write only */
100 if (!(mode & S_IRUGO))
101 return debugfs_create_file(name, mode, parent, value, &fops_u8_wo);
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 return debugfs_create_file(name, mode, parent, value, &fops_u8);
104}
105EXPORT_SYMBOL_GPL(debugfs_create_u8);
106
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800107static int debugfs_u16_set(void *data, u64 val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200108{
109 *(u16 *)data = val;
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800110 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200111}
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800112static int debugfs_u16_get(void *data, u64 *val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200113{
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800114 *val = *(u16 *)data;
115 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200116}
117DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400118DEFINE_SIMPLE_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n");
119DEFINE_SIMPLE_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121/**
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700122 * 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 -0700123 * @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
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700126 * directory dentry if set. If this parameter is %NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 * 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
129 * from.
130 *
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.
134 *
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,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700138 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700140 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700142 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 * code.
144 */
Al Virof4ae40a2011-07-24 04:33:43 -0400145struct dentry *debugfs_create_u16(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 struct dentry *parent, u16 *value)
147{
Robin Getze4792aa2009-06-02 03:00:47 -0400148 /* if there are no write bits set, make read only */
149 if (!(mode & S_IWUGO))
150 return debugfs_create_file(name, mode, parent, value, &fops_u16_ro);
151 /* if there are no read bits set, make write only */
152 if (!(mode & S_IRUGO))
153 return debugfs_create_file(name, mode, parent, value, &fops_u16_wo);
154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 return debugfs_create_file(name, mode, parent, value, &fops_u16);
156}
157EXPORT_SYMBOL_GPL(debugfs_create_u16);
158
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800159static int debugfs_u32_set(void *data, u64 val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200160{
161 *(u32 *)data = val;
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800162 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200163}
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800164static int debugfs_u32_get(void *data, u64 *val)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200165{
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800166 *val = *(u32 *)data;
167 return 0;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200168}
169DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400170DEFINE_SIMPLE_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n");
171DEFINE_SIMPLE_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173/**
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700174 * 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 -0700175 * @name: a pointer to a string containing the name of the file to create.
176 * @mode: the permission that the file should have
177 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700178 * directory dentry if set. If this parameter is %NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 * file will be created in the root of the debugfs filesystem.
180 * @value: a pointer to the variable that the file should read to and write
181 * from.
182 *
183 * This function creates a file in debugfs with the given name that
184 * contains the value of the variable @value. If the @mode variable is so
185 * set, it can be read from, and written to.
186 *
187 * This function will return a pointer to a dentry if it succeeds. This
188 * pointer must be passed to the debugfs_remove() function when the file is
189 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700190 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700192 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700194 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 * code.
196 */
Al Virof4ae40a2011-07-24 04:33:43 -0400197struct dentry *debugfs_create_u32(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 struct dentry *parent, u32 *value)
199{
Robin Getze4792aa2009-06-02 03:00:47 -0400200 /* if there are no write bits set, make read only */
201 if (!(mode & S_IWUGO))
202 return debugfs_create_file(name, mode, parent, value, &fops_u32_ro);
203 /* if there are no read bits set, make write only */
204 if (!(mode & S_IRUGO))
205 return debugfs_create_file(name, mode, parent, value, &fops_u32_wo);
206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 return debugfs_create_file(name, mode, parent, value, &fops_u32);
208}
209EXPORT_SYMBOL_GPL(debugfs_create_u32);
210
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800211static int debugfs_u64_set(void *data, u64 val)
Michael Ellerman84478912007-04-17 15:59:36 +1000212{
213 *(u64 *)data = val;
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800214 return 0;
Michael Ellerman84478912007-04-17 15:59:36 +1000215}
216
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800217static int debugfs_u64_get(void *data, u64 *val)
Michael Ellerman84478912007-04-17 15:59:36 +1000218{
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800219 *val = *(u64 *)data;
220 return 0;
Michael Ellerman84478912007-04-17 15:59:36 +1000221}
222DEFINE_SIMPLE_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400223DEFINE_SIMPLE_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
224DEFINE_SIMPLE_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
Michael Ellerman84478912007-04-17 15:59:36 +1000225
226/**
227 * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
228 * @name: a pointer to a string containing the name of the file to create.
229 * @mode: the permission that the file should have
230 * @parent: a pointer to the parent dentry for this file. This should be a
231 * directory dentry if set. If this parameter is %NULL, then the
232 * file will be created in the root of the debugfs filesystem.
233 * @value: a pointer to the variable that the file should read to and write
234 * from.
235 *
236 * This function creates a file in debugfs with the given name that
237 * contains the value of the variable @value. If the @mode variable is so
238 * set, it can be read from, and written to.
239 *
240 * This function will return a pointer to a dentry if it succeeds. This
241 * pointer must be passed to the debugfs_remove() function when the file is
242 * to be removed (no automatic cleanup happens if your module is unloaded,
243 * you are responsible here.) If an error occurs, %NULL will be returned.
244 *
245 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
246 * returned. It is not wise to check for this value, but rather, check for
247 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
248 * code.
249 */
Al Virof4ae40a2011-07-24 04:33:43 -0400250struct dentry *debugfs_create_u64(const char *name, umode_t mode,
Michael Ellerman84478912007-04-17 15:59:36 +1000251 struct dentry *parent, u64 *value)
252{
Robin Getze4792aa2009-06-02 03:00:47 -0400253 /* if there are no write bits set, make read only */
254 if (!(mode & S_IWUGO))
255 return debugfs_create_file(name, mode, parent, value, &fops_u64_ro);
256 /* if there are no read bits set, make write only */
257 if (!(mode & S_IRUGO))
258 return debugfs_create_file(name, mode, parent, value, &fops_u64_wo);
259
Michael Ellerman84478912007-04-17 15:59:36 +1000260 return debugfs_create_file(name, mode, parent, value, &fops_u64);
261}
262EXPORT_SYMBOL_GPL(debugfs_create_u64);
263
Robin Getz2ebefc52007-08-02 18:23:50 -0400264DEFINE_SIMPLE_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400265DEFINE_SIMPLE_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n");
266DEFINE_SIMPLE_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n");
Robin Getz2ebefc52007-08-02 18:23:50 -0400267
268DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400269DEFINE_SIMPLE_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n");
270DEFINE_SIMPLE_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n");
Robin Getz2ebefc52007-08-02 18:23:50 -0400271
272DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n");
Robin Getze4792aa2009-06-02 03:00:47 -0400273DEFINE_SIMPLE_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n");
274DEFINE_SIMPLE_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n");
Robin Getz2ebefc52007-08-02 18:23:50 -0400275
Huang Ying15b0bea2010-05-18 14:35:23 +0800276DEFINE_SIMPLE_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n");
277
Randy Dunlape6716b82007-10-15 17:30:19 -0700278/*
Huang Ying15b0bea2010-05-18 14:35:23 +0800279 * 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 -0700280 *
281 * These functions are exactly the same as the above functions (but use a hex
282 * output for the decimal challenged). For details look at the above unsigned
283 * decimal functions.
284 */
285
Robin Getz2ebefc52007-08-02 18:23:50 -0400286/**
287 * 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 -0700288 * @name: a pointer to a string containing the name of the file to create.
289 * @mode: the permission that the file should have
290 * @parent: a pointer to the parent dentry for this file. This should be a
291 * directory dentry if set. If this parameter is %NULL, then the
292 * file will be created in the root of the debugfs filesystem.
293 * @value: a pointer to the variable that the file should read to and write
294 * from.
Robin Getz2ebefc52007-08-02 18:23:50 -0400295 */
Al Virof4ae40a2011-07-24 04:33:43 -0400296struct dentry *debugfs_create_x8(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -0400297 struct dentry *parent, u8 *value)
298{
Robin Getze4792aa2009-06-02 03:00:47 -0400299 /* if there are no write bits set, make read only */
300 if (!(mode & S_IWUGO))
301 return debugfs_create_file(name, mode, parent, value, &fops_x8_ro);
302 /* if there are no read bits set, make write only */
303 if (!(mode & S_IRUGO))
304 return debugfs_create_file(name, mode, parent, value, &fops_x8_wo);
305
Robin Getz2ebefc52007-08-02 18:23:50 -0400306 return debugfs_create_file(name, mode, parent, value, &fops_x8);
307}
308EXPORT_SYMBOL_GPL(debugfs_create_x8);
309
Randy Dunlape6716b82007-10-15 17:30:19 -0700310/**
311 * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
312 * @name: a pointer to a string containing the name of the file to create.
313 * @mode: the permission that the file should have
314 * @parent: a pointer to the parent dentry for this file. This should be a
315 * directory dentry if set. If this parameter is %NULL, then the
316 * file will be created in the root of the debugfs filesystem.
317 * @value: a pointer to the variable that the file should read to and write
318 * from.
319 */
Al Virof4ae40a2011-07-24 04:33:43 -0400320struct dentry *debugfs_create_x16(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -0400321 struct dentry *parent, u16 *value)
322{
Robin Getze4792aa2009-06-02 03:00:47 -0400323 /* if there are no write bits set, make read only */
324 if (!(mode & S_IWUGO))
325 return debugfs_create_file(name, mode, parent, value, &fops_x16_ro);
326 /* if there are no read bits set, make write only */
327 if (!(mode & S_IRUGO))
328 return debugfs_create_file(name, mode, parent, value, &fops_x16_wo);
329
Robin Getz2ebefc52007-08-02 18:23:50 -0400330 return debugfs_create_file(name, mode, parent, value, &fops_x16);
331}
332EXPORT_SYMBOL_GPL(debugfs_create_x16);
333
Randy Dunlape6716b82007-10-15 17:30:19 -0700334/**
335 * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
336 * @name: a pointer to a string containing the name of the file to create.
337 * @mode: the permission that the file should have
338 * @parent: a pointer to the parent dentry for this file. This should be a
339 * directory dentry if set. If this parameter is %NULL, then the
340 * file will be created in the root of the debugfs filesystem.
341 * @value: a pointer to the variable that the file should read to and write
342 * from.
343 */
Al Virof4ae40a2011-07-24 04:33:43 -0400344struct dentry *debugfs_create_x32(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -0400345 struct dentry *parent, u32 *value)
346{
Robin Getze4792aa2009-06-02 03:00:47 -0400347 /* if there are no write bits set, make read only */
348 if (!(mode & S_IWUGO))
349 return debugfs_create_file(name, mode, parent, value, &fops_x32_ro);
350 /* if there are no read bits set, make write only */
351 if (!(mode & S_IRUGO))
352 return debugfs_create_file(name, mode, parent, value, &fops_x32_wo);
353
Robin Getz2ebefc52007-08-02 18:23:50 -0400354 return debugfs_create_file(name, mode, parent, value, &fops_x32);
355}
356EXPORT_SYMBOL_GPL(debugfs_create_x32);
357
Huang Ying15b0bea2010-05-18 14:35:23 +0800358/**
359 * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit 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
366 * from.
367 */
Al Virof4ae40a2011-07-24 04:33:43 -0400368struct dentry *debugfs_create_x64(const char *name, umode_t mode,
Huang Ying15b0bea2010-05-18 14:35:23 +0800369 struct dentry *parent, u64 *value)
370{
371 return debugfs_create_file(name, mode, parent, value, &fops_x64);
372}
373EXPORT_SYMBOL_GPL(debugfs_create_x64);
374
Inaky Perez-Gonzalez5e078782008-12-20 16:57:39 -0800375
376static int debugfs_size_t_set(void *data, u64 val)
377{
378 *(size_t *)data = val;
379 return 0;
380}
381static int debugfs_size_t_get(void *data, u64 *val)
382{
383 *val = *(size_t *)data;
384 return 0;
385}
386DEFINE_SIMPLE_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
387 "%llu\n"); /* %llu and %zu are more or less the same */
388
389/**
390 * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
391 * @name: a pointer to a string containing the name of the file to create.
392 * @mode: the permission that the file should have
393 * @parent: a pointer to the parent dentry for this file. This should be a
394 * directory dentry if set. If this parameter is %NULL, then the
395 * file will be created in the root of the debugfs filesystem.
396 * @value: a pointer to the variable that the file should read to and write
397 * from.
398 */
Al Virof4ae40a2011-07-24 04:33:43 -0400399struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
Inaky Perez-Gonzalez5e078782008-12-20 16:57:39 -0800400 struct dentry *parent, size_t *value)
401{
402 return debugfs_create_file(name, mode, parent, value, &fops_size_t);
403}
404EXPORT_SYMBOL_GPL(debugfs_create_size_t);
405
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407static ssize_t read_file_bool(struct file *file, char __user *user_buf,
408 size_t count, loff_t *ppos)
409{
410 char buf[3];
411 u32 *val = file->private_data;
412
413 if (*val)
414 buf[0] = 'Y';
415 else
416 buf[0] = 'N';
417 buf[1] = '\n';
418 buf[2] = 0x00;
419 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
420}
421
422static ssize_t write_file_bool(struct file *file, const char __user *user_buf,
423 size_t count, loff_t *ppos)
424{
425 char buf[32];
Stephen Boydc42d2232011-05-12 16:50:07 -0700426 size_t buf_size;
Jonathan Cameron8705b482011-04-19 12:43:46 +0100427 bool bv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 u32 *val = file->private_data;
429
430 buf_size = min(count, (sizeof(buf)-1));
431 if (copy_from_user(buf, user_buf, buf_size))
432 return -EFAULT;
433
Jonathan Cameron8705b482011-04-19 12:43:46 +0100434 if (strtobool(buf, &bv) == 0)
435 *val = bv;
436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 return count;
438}
439
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800440static const struct file_operations fops_bool = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 .read = read_file_bool,
442 .write = write_file_bool,
Stephen Boyd234e3402012-04-05 14:25:11 -0700443 .open = simple_open,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200444 .llseek = default_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445};
446
447/**
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700448 * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 * @name: a pointer to a string containing the name of the file to create.
450 * @mode: the permission that the file should have
451 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700452 * directory dentry if set. If this parameter is %NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 * file will be created in the root of the debugfs filesystem.
454 * @value: a pointer to the variable that the file should read to and write
455 * from.
456 *
457 * This function creates a file in debugfs with the given name that
458 * contains the value of the variable @value. If the @mode variable is so
459 * set, it can be read from, and written to.
460 *
461 * This function will return a pointer to a dentry if it succeeds. This
462 * pointer must be passed to the debugfs_remove() function when the file is
463 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700464 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700466 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700468 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 * code.
470 */
Al Virof4ae40a2011-07-24 04:33:43 -0400471struct dentry *debugfs_create_bool(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 struct dentry *parent, u32 *value)
473{
474 return debugfs_create_file(name, mode, parent, value, &fops_bool);
475}
476EXPORT_SYMBOL_GPL(debugfs_create_bool);
477
Michael Ellermandd308bc2006-03-07 21:41:59 +1100478static ssize_t read_file_blob(struct file *file, char __user *user_buf,
479 size_t count, loff_t *ppos)
480{
481 struct debugfs_blob_wrapper *blob = file->private_data;
482 return simple_read_from_buffer(user_buf, count, ppos, blob->data,
483 blob->size);
484}
485
Arjan van de Ven00977a52007-02-12 00:55:34 -0800486static const struct file_operations fops_blob = {
Michael Ellermandd308bc2006-03-07 21:41:59 +1100487 .read = read_file_blob,
Stephen Boyd234e3402012-04-05 14:25:11 -0700488 .open = simple_open,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200489 .llseek = default_llseek,
Michael Ellermandd308bc2006-03-07 21:41:59 +1100490};
491
492/**
Jonathan Corbet400ced62009-05-25 10:15:27 -0600493 * debugfs_create_blob - create a debugfs file that is used to read a binary blob
Michael Ellermandd308bc2006-03-07 21:41:59 +1100494 * @name: a pointer to a string containing the name of the file to create.
495 * @mode: the permission that the file should have
496 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700497 * directory dentry if set. If this parameter is %NULL, then the
Michael Ellermandd308bc2006-03-07 21:41:59 +1100498 * file will be created in the root of the debugfs filesystem.
499 * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
500 * to the blob data and the size of the data.
501 *
502 * This function creates a file in debugfs with the given name that exports
503 * @blob->data as a binary blob. If the @mode variable is so set it can be
504 * read from. Writing is not supported.
505 *
506 * This function will return a pointer to a dentry if it succeeds. This
507 * pointer must be passed to the debugfs_remove() function when the file is
508 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700509 * you are responsible here.) If an error occurs, %NULL will be returned.
Michael Ellermandd308bc2006-03-07 21:41:59 +1100510 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700511 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Michael Ellermandd308bc2006-03-07 21:41:59 +1100512 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700513 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Michael Ellermandd308bc2006-03-07 21:41:59 +1100514 * code.
515 */
Al Virof4ae40a2011-07-24 04:33:43 -0400516struct dentry *debugfs_create_blob(const char *name, umode_t mode,
Michael Ellermandd308bc2006-03-07 21:41:59 +1100517 struct dentry *parent,
518 struct debugfs_blob_wrapper *blob)
519{
520 return debugfs_create_file(name, mode, parent, blob, &fops_blob);
521}
522EXPORT_SYMBOL_GPL(debugfs_create_blob);
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100523
Srivatsa Vaddagiri9fe2a702012-03-23 13:36:28 +0530524struct array_data {
525 void *array;
526 u32 elements;
527};
528
529static int u32_array_open(struct inode *inode, struct file *file)
530{
531 file->private_data = NULL;
532 return nonseekable_open(inode, file);
533}
534
535static size_t format_array(char *buf, size_t bufsize, const char *fmt,
536 u32 *array, u32 array_size)
537{
538 size_t ret = 0;
539 u32 i;
540
541 for (i = 0; i < array_size; i++) {
542 size_t len;
543
544 len = snprintf(buf, bufsize, fmt, array[i]);
545 len++; /* ' ' or '\n' */
546 ret += len;
547
548 if (buf) {
549 buf += len;
550 bufsize -= len;
551 buf[-1] = (i == array_size-1) ? '\n' : ' ';
552 }
553 }
554
555 ret++; /* \0 */
556 if (buf)
557 *buf = '\0';
558
559 return ret;
560}
561
562static char *format_array_alloc(const char *fmt, u32 *array,
563 u32 array_size)
564{
565 size_t len = format_array(NULL, 0, fmt, array, array_size);
566 char *ret;
567
568 ret = kmalloc(len, GFP_KERNEL);
569 if (ret == NULL)
570 return NULL;
571
572 format_array(ret, len, fmt, array, array_size);
573 return ret;
574}
575
576static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len,
577 loff_t *ppos)
578{
579 struct inode *inode = file->f_path.dentry->d_inode;
580 struct array_data *data = inode->i_private;
581 size_t size;
582
583 if (*ppos == 0) {
584 if (file->private_data) {
585 kfree(file->private_data);
586 file->private_data = NULL;
587 }
588
589 file->private_data = format_array_alloc("%u", data->array,
590 data->elements);
591 }
592
593 size = 0;
594 if (file->private_data)
595 size = strlen(file->private_data);
596
597 return simple_read_from_buffer(buf, len, ppos,
598 file->private_data, size);
599}
600
601static int u32_array_release(struct inode *inode, struct file *file)
602{
603 kfree(file->private_data);
604
605 return 0;
606}
607
608static const struct file_operations u32_array_fops = {
609 .owner = THIS_MODULE,
610 .open = u32_array_open,
611 .release = u32_array_release,
612 .read = u32_array_read,
613 .llseek = no_llseek,
614};
615
616/**
617 * debugfs_create_u32_array - create a debugfs file that is used to read u32
618 * array.
619 * @name: a pointer to a string containing the name of the file to create.
620 * @mode: the permission that the file should have.
621 * @parent: a pointer to the parent dentry for this file. This should be a
622 * directory dentry if set. If this parameter is %NULL, then the
623 * file will be created in the root of the debugfs filesystem.
624 * @array: u32 array that provides data.
625 * @elements: total number of elements in the array.
626 *
627 * This function creates a file in debugfs with the given name that exports
628 * @array as data. If the @mode variable is so set it can be read from.
629 * Writing is not supported. Seek within the file is also not supported.
630 * Once array is created its size can not be changed.
631 *
632 * The function returns a pointer to dentry on success. If debugfs is not
633 * enabled in the kernel, the value -%ENODEV will be returned.
634 */
635struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
636 struct dentry *parent,
637 u32 *array, u32 elements)
638{
639 struct array_data *data = kmalloc(sizeof(*data), GFP_KERNEL);
640
641 if (data == NULL)
642 return NULL;
643
644 data->array = array;
645 data->elements = elements;
646
647 return debugfs_create_file(name, mode, parent, data, &u32_array_fops);
648}
649EXPORT_SYMBOL_GPL(debugfs_create_u32_array);
650
Heiko Carstens3b85e4a2011-12-27 15:08:28 +0100651#ifdef CONFIG_HAS_IOMEM
652
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100653/*
654 * The regset32 stuff is used to print 32-bit registers using the
655 * seq_file utilities. We offer printing a register set in an already-opened
656 * sequential file or create a debugfs file that only prints a regset32.
657 */
658
659/**
660 * debugfs_print_regs32 - use seq_print to describe a set of registers
661 * @s: the seq_file structure being used to generate output
662 * @regs: an array if struct debugfs_reg32 structures
Randy Dunlapb5763ac2012-01-21 11:02:42 -0800663 * @nregs: the length of the above array
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100664 * @base: the base address to be used in reading the registers
665 * @prefix: a string to be prefixed to every output line
666 *
667 * This function outputs a text block describing the current values of
668 * some 32-bit hardware registers. It is meant to be used within debugfs
669 * files based on seq_file that need to show registers, intermixed with other
670 * information. The prefix argument may be used to specify a leading string,
671 * because some peripherals have several blocks of identical registers,
672 * for example configuration of dma channels
673 */
Alessandro Rubini8ee4dd92011-11-18 23:53:29 +0100674int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100675 int nregs, void __iomem *base, char *prefix)
676{
677 int i, ret = 0;
678
679 for (i = 0; i < nregs; i++, regs++) {
680 if (prefix)
681 ret += seq_printf(s, "%s", prefix);
682 ret += seq_printf(s, "%s = 0x%08x\n", regs->name,
Dan Carpenter58584412011-11-24 10:22:08 +0300683 readl(base + regs->offset));
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100684 }
685 return ret;
686}
687EXPORT_SYMBOL_GPL(debugfs_print_regs32);
688
689static int debugfs_show_regset32(struct seq_file *s, void *data)
690{
691 struct debugfs_regset32 *regset = s->private;
692
693 debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
694 return 0;
695}
696
697static int debugfs_open_regset32(struct inode *inode, struct file *file)
698{
699 return single_open(file, debugfs_show_regset32, inode->i_private);
700}
701
702static const struct file_operations fops_regset32 = {
703 .open = debugfs_open_regset32,
704 .read = seq_read,
705 .llseek = seq_lseek,
706 .release = single_release,
707};
708
709/**
710 * debugfs_create_regset32 - create a debugfs file that returns register values
711 * @name: a pointer to a string containing the name of the file to create.
712 * @mode: the permission that the file should have
713 * @parent: a pointer to the parent dentry for this file. This should be a
714 * directory dentry if set. If this parameter is %NULL, then the
715 * file will be created in the root of the debugfs filesystem.
716 * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
717 * to an array of register definitions, the array size and the base
718 * address where the register bank is to be found.
719 *
720 * This function creates a file in debugfs with the given name that reports
721 * the names and values of a set of 32-bit registers. If the @mode variable
722 * is so set it can be read from. Writing is not supported.
723 *
724 * This function will return a pointer to a dentry if it succeeds. This
725 * pointer must be passed to the debugfs_remove() function when the file is
726 * to be removed (no automatic cleanup happens if your module is unloaded,
727 * you are responsible here.) If an error occurs, %NULL will be returned.
728 *
729 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
730 * returned. It is not wise to check for this value, but rather, check for
731 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
732 * code.
733 */
Al Viro88187392012-03-20 06:00:24 -0400734struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100735 struct dentry *parent,
736 struct debugfs_regset32 *regset)
737{
738 return debugfs_create_file(name, mode, parent, regset, &fops_regset32);
739}
740EXPORT_SYMBOL_GPL(debugfs_create_regset32);
Heiko Carstens3b85e4a2011-12-27 15:08:28 +0100741
742#endif /* CONFIG_HAS_IOMEM */