debugfs-related mode_t whack-a-mole
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / fs / debugfs / file.c
CommitLineData
1da177e4
LT
1/*
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.
883ce42e 12 * See Documentation/DocBook/filesystems for more details.
1da177e4
LT
13 *
14 */
15
1da177e4
LT
16#include <linux/module.h>
17#include <linux/fs.h>
1a087c6a 18#include <linux/seq_file.h>
1da177e4 19#include <linux/pagemap.h>
66f54963 20#include <linux/namei.h>
1da177e4 21#include <linux/debugfs.h>
03e099fb 22#include <linux/io.h>
1da177e4
LT
23
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{
8e18e294
TT
38 if (inode->i_private)
39 file->private_data = inode->i_private;
1da177e4
LT
40
41 return 0;
42}
43
4b6f5d20 44const struct file_operations debugfs_file_operations = {
1da177e4
LT
45 .read = default_read_file,
46 .write = default_write_file,
47 .open = default_open,
6038f373 48 .llseek = noop_llseek,
1da177e4
LT
49};
50
66f54963
PO
51static 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
8b88b099 62static int debugfs_u8_set(void *data, u64 val)
acaefc25
AB
63{
64 *(u8 *)data = val;
8b88b099 65 return 0;
acaefc25 66}
8b88b099 67static int debugfs_u8_get(void *data, u64 *val)
acaefc25 68{
8b88b099
CH
69 *val = *(u8 *)data;
70 return 0;
acaefc25
AB
71}
72DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
e4792aa3
RG
73DEFINE_SIMPLE_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n");
74DEFINE_SIMPLE_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");
1da177e4
LT
75
76/**
6468b3af 77 * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
1da177e4
LT
78 * @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
6468b3af 81 * directory dentry if set. If this parameter is %NULL, then the
1da177e4
LT
82 * 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,
6468b3af 93 * you are responsible here.) If an error occurs, %NULL will be returned.
1da177e4 94 *
6468b3af 95 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
1da177e4 96 * returned. It is not wise to check for this value, but rather, check for
6468b3af 97 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
1da177e4
LT
98 * code.
99 */
f4ae40a6 100struct dentry *debugfs_create_u8(const char *name, umode_t mode,
1da177e4
LT
101 struct dentry *parent, u8 *value)
102{
e4792aa3
RG
103 /* 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
1da177e4
LT
110 return debugfs_create_file(name, mode, parent, value, &fops_u8);
111}
112EXPORT_SYMBOL_GPL(debugfs_create_u8);
113
8b88b099 114static int debugfs_u16_set(void *data, u64 val)
acaefc25
AB
115{
116 *(u16 *)data = val;
8b88b099 117 return 0;
acaefc25 118}
8b88b099 119static int debugfs_u16_get(void *data, u64 *val)
acaefc25 120{
8b88b099
CH
121 *val = *(u16 *)data;
122 return 0;
acaefc25
AB
123}
124DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
e4792aa3
RG
125DEFINE_SIMPLE_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n");
126DEFINE_SIMPLE_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");
acaefc25 127
1da177e4 128/**
6468b3af 129 * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
1da177e4
LT
130 * @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
6468b3af 133 * directory dentry if set. If this parameter is %NULL, then the
1da177e4
LT
134 * 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,
6468b3af 145 * you are responsible here.) If an error occurs, %NULL will be returned.
1da177e4 146 *
6468b3af 147 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
1da177e4 148 * returned. It is not wise to check for this value, but rather, check for
6468b3af 149 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
1da177e4
LT
150 * code.
151 */
f4ae40a6 152struct dentry *debugfs_create_u16(const char *name, umode_t mode,
1da177e4
LT
153 struct dentry *parent, u16 *value)
154{
e4792aa3
RG
155 /* 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
1da177e4
LT
162 return debugfs_create_file(name, mode, parent, value, &fops_u16);
163}
164EXPORT_SYMBOL_GPL(debugfs_create_u16);
165
8b88b099 166static int debugfs_u32_set(void *data, u64 val)
acaefc25
AB
167{
168 *(u32 *)data = val;
8b88b099 169 return 0;
acaefc25 170}
8b88b099 171static int debugfs_u32_get(void *data, u64 *val)
acaefc25 172{
8b88b099
CH
173 *val = *(u32 *)data;
174 return 0;
acaefc25
AB
175}
176DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
e4792aa3
RG
177DEFINE_SIMPLE_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n");
178DEFINE_SIMPLE_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");
acaefc25 179
1da177e4 180/**
6468b3af 181 * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
1da177e4
LT
182 * @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
6468b3af 185 * directory dentry if set. If this parameter is %NULL, then the
1da177e4
LT
186 * 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,
6468b3af 197 * you are responsible here.) If an error occurs, %NULL will be returned.
1da177e4 198 *
6468b3af 199 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
1da177e4 200 * returned. It is not wise to check for this value, but rather, check for
6468b3af 201 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
1da177e4
LT
202 * code.
203 */
f4ae40a6 204struct dentry *debugfs_create_u32(const char *name, umode_t mode,
1da177e4
LT
205 struct dentry *parent, u32 *value)
206{
e4792aa3
RG
207 /* 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
1da177e4
LT
214 return debugfs_create_file(name, mode, parent, value, &fops_u32);
215}
216EXPORT_SYMBOL_GPL(debugfs_create_u32);
217
8b88b099 218static int debugfs_u64_set(void *data, u64 val)
8447891f
ME
219{
220 *(u64 *)data = val;
8b88b099 221 return 0;
8447891f
ME
222}
223
8b88b099 224static int debugfs_u64_get(void *data, u64 *val)
8447891f 225{
8b88b099
CH
226 *val = *(u64 *)data;
227 return 0;
8447891f
ME
228}
229DEFINE_SIMPLE_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
e4792aa3
RG
230DEFINE_SIMPLE_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
231DEFINE_SIMPLE_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
8447891f
ME
232
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 */
f4ae40a6 257struct dentry *debugfs_create_u64(const char *name, umode_t mode,
8447891f
ME
258 struct dentry *parent, u64 *value)
259{
e4792aa3
RG
260 /* 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
8447891f
ME
267 return debugfs_create_file(name, mode, parent, value, &fops_u64);
268}
269EXPORT_SYMBOL_GPL(debugfs_create_u64);
270
2ebefc50 271DEFINE_SIMPLE_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
e4792aa3
RG
272DEFINE_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");
2ebefc50
RG
274
275DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n");
e4792aa3
RG
276DEFINE_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");
2ebefc50
RG
278
279DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n");
e4792aa3
RG
280DEFINE_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");
2ebefc50 282
15b0beaa
HY
283DEFINE_SIMPLE_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n");
284
e6716b87 285/*
15b0beaa 286 * 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
2ebefc50 287 *
e6716b87
RD
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
2ebefc50
RG
290 * decimal functions.
291 */
e6716b87
RD
292
293/**
294 * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
295 * @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.
302 */
f4ae40a6 303struct dentry *debugfs_create_x8(const char *name, umode_t mode,
2ebefc50
RG
304 struct dentry *parent, u8 *value)
305{
e4792aa3
RG
306 /* 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
2ebefc50
RG
313 return debugfs_create_file(name, mode, parent, value, &fops_x8);
314}
315EXPORT_SYMBOL_GPL(debugfs_create_x8);
316
e6716b87
RD
317/**
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 */
f4ae40a6 327struct dentry *debugfs_create_x16(const char *name, umode_t mode,
2ebefc50
RG
328 struct dentry *parent, u16 *value)
329{
e4792aa3
RG
330 /* 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
2ebefc50
RG
337 return debugfs_create_file(name, mode, parent, value, &fops_x16);
338}
339EXPORT_SYMBOL_GPL(debugfs_create_x16);
340
e6716b87
RD
341/**
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 */
f4ae40a6 351struct dentry *debugfs_create_x32(const char *name, umode_t mode,
2ebefc50
RG
352 struct dentry *parent, u32 *value)
353{
e4792aa3
RG
354 /* 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
2ebefc50
RG
361 return debugfs_create_file(name, mode, parent, value, &fops_x32);
362}
363EXPORT_SYMBOL_GPL(debugfs_create_x32);
364
15b0beaa
HY
365/**
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 */
f4ae40a6 375struct dentry *debugfs_create_x64(const char *name, umode_t mode,
15b0beaa
HY
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
5e078787
IPG
382
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 */
f4ae40a6 406struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
5e078787
IPG
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
1da177e4
LT
414static 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];
c42d2237 433 size_t buf_size;
8705b48e 434 bool bv;
1da177e4
LT
435 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
8705b48e
JC
441 if (strtobool(buf, &bv) == 0)
442 *val = bv;
443
1da177e4
LT
444 return count;
445}
446
4b6f5d20 447static const struct file_operations fops_bool = {
1da177e4
LT
448 .read = read_file_bool,
449 .write = write_file_bool,
450 .open = default_open,
6038f373 451 .llseek = default_llseek,
1da177e4
LT
452};
453
454/**
6468b3af 455 * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
1da177e4
LT
456 * @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
6468b3af 459 * directory dentry if set. If this parameter is %NULL, then the
1da177e4
LT
460 * 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,
6468b3af 471 * you are responsible here.) If an error occurs, %NULL will be returned.
1da177e4 472 *
6468b3af 473 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
1da177e4 474 * returned. It is not wise to check for this value, but rather, check for
6468b3af 475 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
1da177e4
LT
476 * code.
477 */
f4ae40a6 478struct dentry *debugfs_create_bool(const char *name, umode_t mode,
1da177e4
LT
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
dd308bc3
ME
485static 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
00977a59 493static const struct file_operations fops_blob = {
dd308bc3
ME
494 .read = read_file_blob,
495 .open = default_open,
6038f373 496 .llseek = default_llseek,
dd308bc3
ME
497};
498
499/**
400ced61 500 * debugfs_create_blob - create a debugfs file that is used to read a binary blob
dd308bc3
ME
501 * @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
6468b3af 504 * directory dentry if set. If this parameter is %NULL, then the
dd308bc3
ME
505 * 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,
6468b3af 516 * you are responsible here.) If an error occurs, %NULL will be returned.
dd308bc3 517 *
6468b3af 518 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
dd308bc3 519 * returned. It is not wise to check for this value, but rather, check for
6468b3af 520 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
dd308bc3
ME
521 * code.
522 */
f4ae40a6 523struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc3
ME
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);
1a087c6a 530
3b85e4ab
HC
531#ifdef CONFIG_HAS_IOMEM
532
1a087c6a
AR
533/*
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
b5763acc 543 * @nregs: the length of the above array
1a087c6a
AR
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 */
8ee4dd9f 554int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
1a087c6a
AR
555 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,
5858441c 563 readl(base + regs->offset));
1a087c6a
AR
564 }
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 */
88187398 614struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
1a087c6a
AR
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);
3b85e4ab
HC
621
622#endif /* CONFIG_HAS_IOMEM */