]>
Commit | Line | Data |
---|---|---|
3bce94fd | 1 | // SPDX-License-Identifier: GPL-2.0 |
1da177e4 LT |
2 | /* |
3 | * file.c - part of debugfs, a tiny little debug file system | |
4 | * | |
5 | * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com> | |
6 | * Copyright (C) 2004 IBM Inc. | |
7 | * | |
1da177e4 | 8 | * debugfs is for people to use instead of /proc or /sys. |
e1b4fc7a | 9 | * See Documentation/filesystems/ for more details. |
1da177e4 LT |
10 | */ |
11 | ||
1da177e4 LT |
12 | #include <linux/module.h> |
13 | #include <linux/fs.h> | |
1a087c6a | 14 | #include <linux/seq_file.h> |
1da177e4 LT |
15 | #include <linux/pagemap.h> |
16 | #include <linux/debugfs.h> | |
03e099fb | 17 | #include <linux/io.h> |
9fe2a701 | 18 | #include <linux/slab.h> |
3a76e5e0 | 19 | #include <linux/atomic.h> |
98210b7f | 20 | #include <linux/device.h> |
49d200de | 21 | #include <asm/poll.h> |
9fd4dcec NS |
22 | |
23 | #include "internal.h" | |
1da177e4 | 24 | |
49d200de NS |
25 | struct poll_table_struct; |
26 | ||
1da177e4 LT |
27 | static ssize_t default_read_file(struct file *file, char __user *buf, |
28 | size_t count, loff_t *ppos) | |
29 | { | |
30 | return 0; | |
31 | } | |
32 | ||
33 | static ssize_t default_write_file(struct file *file, const char __user *buf, | |
34 | size_t count, loff_t *ppos) | |
35 | { | |
36 | return count; | |
37 | } | |
38 | ||
9fd4dcec | 39 | const struct file_operations debugfs_noop_file_operations = { |
1da177e4 LT |
40 | .read = default_read_file, |
41 | .write = default_write_file, | |
234e3405 | 42 | .open = simple_open, |
6038f373 | 43 | .llseek = noop_llseek, |
1da177e4 LT |
44 | }; |
45 | ||
9fd4dcec NS |
46 | #define F_DENTRY(filp) ((filp)->f_path.dentry) |
47 | ||
7c8d4698 | 48 | const struct file_operations *debugfs_real_fops(const struct file *filp) |
7c8d4698 NS |
49 | { |
50 | struct debugfs_fsdata *fsd = F_DENTRY(filp)->d_fsdata; | |
055ab8e3 | 51 | |
7d39bc50 NS |
52 | if ((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT) { |
53 | /* | |
54 | * Urgh, we've been called w/o a protecting | |
55 | * debugfs_file_get(). | |
56 | */ | |
57 | WARN_ON(1); | |
58 | return NULL; | |
59 | } | |
60 | ||
7c8d4698 NS |
61 | return fsd->real_fops; |
62 | } | |
63 | EXPORT_SYMBOL_GPL(debugfs_real_fops); | |
64 | ||
e9117a5a NS |
65 | /** |
66 | * debugfs_file_get - mark the beginning of file data access | |
67 | * @dentry: the dentry object whose data is being accessed. | |
68 | * | |
69 | * Up to a matching call to debugfs_file_put(), any successive call | |
70 | * into the file removing functions debugfs_remove() and | |
71 | * debugfs_remove_recursive() will block. Since associated private | |
72 | * file data may only get freed after a successful return of any of | |
73 | * the removal functions, you may safely access it after a successful | |
74 | * call to debugfs_file_get() without worrying about lifetime issues. | |
75 | * | |
76 | * If -%EIO is returned, the file has already been removed and thus, | |
77 | * it is not safe to access any of its data. If, on the other hand, | |
78 | * it is allowed to access the file data, zero is returned. | |
79 | */ | |
80 | int debugfs_file_get(struct dentry *dentry) | |
81 | { | |
7d39bc50 NS |
82 | struct debugfs_fsdata *fsd; |
83 | void *d_fsd; | |
84 | ||
85 | d_fsd = READ_ONCE(dentry->d_fsdata); | |
86 | if (!((unsigned long)d_fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT)) { | |
87 | fsd = d_fsd; | |
88 | } else { | |
89 | fsd = kmalloc(sizeof(*fsd), GFP_KERNEL); | |
90 | if (!fsd) | |
91 | return -ENOMEM; | |
92 | ||
93 | fsd->real_fops = (void *)((unsigned long)d_fsd & | |
94 | ~DEBUGFS_FSDATA_IS_REAL_FOPS_BIT); | |
95 | refcount_set(&fsd->active_users, 1); | |
96 | init_completion(&fsd->active_users_drained); | |
97 | if (cmpxchg(&dentry->d_fsdata, d_fsd, fsd) != d_fsd) { | |
98 | kfree(fsd); | |
99 | fsd = READ_ONCE(dentry->d_fsdata); | |
100 | } | |
101 | } | |
e9117a5a | 102 | |
7d39bc50 NS |
103 | /* |
104 | * In case of a successful cmpxchg() above, this check is | |
105 | * strictly necessary and must follow it, see the comment in | |
106 | * __debugfs_remove_file(). | |
107 | * OTOH, if the cmpxchg() hasn't been executed or wasn't | |
108 | * successful, this serves the purpose of not starving | |
109 | * removers. | |
110 | */ | |
e9117a5a NS |
111 | if (d_unlinked(dentry)) |
112 | return -EIO; | |
113 | ||
114 | if (!refcount_inc_not_zero(&fsd->active_users)) | |
115 | return -EIO; | |
116 | ||
117 | return 0; | |
118 | } | |
119 | EXPORT_SYMBOL_GPL(debugfs_file_get); | |
120 | ||
121 | /** | |
122 | * debugfs_file_put - mark the end of file data access | |
123 | * @dentry: the dentry object formerly passed to | |
124 | * debugfs_file_get(). | |
125 | * | |
126 | * Allow any ongoing concurrent call into debugfs_remove() or | |
127 | * debugfs_remove_recursive() blocked by a former call to | |
128 | * debugfs_file_get() to proceed and return to its caller. | |
129 | */ | |
130 | void debugfs_file_put(struct dentry *dentry) | |
131 | { | |
7d39bc50 | 132 | struct debugfs_fsdata *fsd = READ_ONCE(dentry->d_fsdata); |
e9117a5a NS |
133 | |
134 | if (refcount_dec_and_test(&fsd->active_users)) | |
135 | complete(&fsd->active_users_drained); | |
136 | } | |
137 | EXPORT_SYMBOL_GPL(debugfs_file_put); | |
138 | ||
9fd4dcec NS |
139 | static int open_proxy_open(struct inode *inode, struct file *filp) |
140 | { | |
69d29f9e | 141 | struct dentry *dentry = F_DENTRY(filp); |
9fd4dcec | 142 | const struct file_operations *real_fops = NULL; |
7d39bc50 | 143 | int r; |
9fd4dcec | 144 | |
30429950 DH |
145 | if (kernel_is_locked_down("debugfs")) |
146 | return -EPERM; | |
147 | ||
148 | ||
7d39bc50 NS |
149 | r = debugfs_file_get(dentry); |
150 | if (r) | |
151 | return r == -EIO ? -ENOENT : r; | |
9fd4dcec | 152 | |
86f0e067 | 153 | real_fops = debugfs_real_fops(filp); |
9fd4dcec NS |
154 | real_fops = fops_get(real_fops); |
155 | if (!real_fops) { | |
156 | /* Huh? Module did not clean up after itself at exit? */ | |
157 | WARN(1, "debugfs file owner did not clean up at exit: %pd", | |
158 | dentry); | |
159 | r = -ENXIO; | |
160 | goto out; | |
161 | } | |
162 | replace_fops(filp, real_fops); | |
163 | ||
164 | if (real_fops->open) | |
165 | r = real_fops->open(inode, filp); | |
166 | ||
167 | out: | |
69d29f9e | 168 | debugfs_file_put(dentry); |
9fd4dcec NS |
169 | return r; |
170 | } | |
171 | ||
172 | const struct file_operations debugfs_open_proxy_file_operations = { | |
173 | .open = open_proxy_open, | |
174 | }; | |
175 | ||
49d200de NS |
176 | #define PROTO(args...) args |
177 | #define ARGS(args...) args | |
178 | ||
179 | #define FULL_PROXY_FUNC(name, ret_type, filp, proto, args) \ | |
180 | static ret_type full_proxy_ ## name(proto) \ | |
181 | { \ | |
69d29f9e | 182 | struct dentry *dentry = F_DENTRY(filp); \ |
154b9d75 | 183 | const struct file_operations *real_fops; \ |
49d200de NS |
184 | ret_type r; \ |
185 | \ | |
69d29f9e NS |
186 | r = debugfs_file_get(dentry); \ |
187 | if (unlikely(r)) \ | |
188 | return r; \ | |
154b9d75 | 189 | real_fops = debugfs_real_fops(filp); \ |
69d29f9e NS |
190 | r = real_fops->name(args); \ |
191 | debugfs_file_put(dentry); \ | |
49d200de NS |
192 | return r; \ |
193 | } | |
194 | ||
195 | FULL_PROXY_FUNC(llseek, loff_t, filp, | |
196 | PROTO(struct file *filp, loff_t offset, int whence), | |
197 | ARGS(filp, offset, whence)); | |
198 | ||
199 | FULL_PROXY_FUNC(read, ssize_t, filp, | |
200 | PROTO(struct file *filp, char __user *buf, size_t size, | |
201 | loff_t *ppos), | |
202 | ARGS(filp, buf, size, ppos)); | |
203 | ||
204 | FULL_PROXY_FUNC(write, ssize_t, filp, | |
205 | PROTO(struct file *filp, const char __user *buf, size_t size, | |
206 | loff_t *ppos), | |
207 | ARGS(filp, buf, size, ppos)); | |
208 | ||
209 | FULL_PROXY_FUNC(unlocked_ioctl, long, filp, | |
210 | PROTO(struct file *filp, unsigned int cmd, unsigned long arg), | |
211 | ARGS(filp, cmd, arg)); | |
212 | ||
213 | static unsigned int full_proxy_poll(struct file *filp, | |
214 | struct poll_table_struct *wait) | |
215 | { | |
69d29f9e | 216 | struct dentry *dentry = F_DENTRY(filp); |
49d200de | 217 | unsigned int r = 0; |
154b9d75 | 218 | const struct file_operations *real_fops; |
49d200de | 219 | |
69d29f9e | 220 | if (debugfs_file_get(dentry)) |
49d200de | 221 | return POLLHUP; |
49d200de | 222 | |
154b9d75 | 223 | real_fops = debugfs_real_fops(filp); |
49d200de | 224 | r = real_fops->poll(filp, wait); |
69d29f9e | 225 | debugfs_file_put(dentry); |
49d200de NS |
226 | return r; |
227 | } | |
228 | ||
229 | static int full_proxy_release(struct inode *inode, struct file *filp) | |
230 | { | |
231 | const struct dentry *dentry = F_DENTRY(filp); | |
86f0e067 | 232 | const struct file_operations *real_fops = debugfs_real_fops(filp); |
49d200de NS |
233 | const struct file_operations *proxy_fops = filp->f_op; |
234 | int r = 0; | |
235 | ||
236 | /* | |
237 | * We must not protect this against removal races here: the | |
238 | * original releaser should be called unconditionally in order | |
239 | * not to leak any resources. Releasers must not assume that | |
240 | * ->i_private is still being meaningful here. | |
241 | */ | |
242 | if (real_fops->release) | |
243 | r = real_fops->release(inode, filp); | |
244 | ||
245 | replace_fops(filp, d_inode(dentry)->i_fop); | |
246 | kfree((void *)proxy_fops); | |
247 | fops_put(real_fops); | |
a1a9e5d2 | 248 | return r; |
49d200de NS |
249 | } |
250 | ||
251 | static void __full_proxy_fops_init(struct file_operations *proxy_fops, | |
252 | const struct file_operations *real_fops) | |
253 | { | |
254 | proxy_fops->release = full_proxy_release; | |
255 | if (real_fops->llseek) | |
256 | proxy_fops->llseek = full_proxy_llseek; | |
257 | if (real_fops->read) | |
258 | proxy_fops->read = full_proxy_read; | |
259 | if (real_fops->write) | |
260 | proxy_fops->write = full_proxy_write; | |
261 | if (real_fops->poll) | |
262 | proxy_fops->poll = full_proxy_poll; | |
263 | if (real_fops->unlocked_ioctl) | |
264 | proxy_fops->unlocked_ioctl = full_proxy_unlocked_ioctl; | |
265 | } | |
266 | ||
267 | static int full_proxy_open(struct inode *inode, struct file *filp) | |
268 | { | |
69d29f9e | 269 | struct dentry *dentry = F_DENTRY(filp); |
49d200de NS |
270 | const struct file_operations *real_fops = NULL; |
271 | struct file_operations *proxy_fops = NULL; | |
7d39bc50 | 272 | int r; |
49d200de | 273 | |
30429950 DH |
274 | if (kernel_is_locked_down("debugfs")) |
275 | return -EPERM; | |
276 | ||
7d39bc50 NS |
277 | r = debugfs_file_get(dentry); |
278 | if (r) | |
279 | return r == -EIO ? -ENOENT : r; | |
49d200de | 280 | |
86f0e067 | 281 | real_fops = debugfs_real_fops(filp); |
49d200de NS |
282 | real_fops = fops_get(real_fops); |
283 | if (!real_fops) { | |
284 | /* Huh? Module did not cleanup after itself at exit? */ | |
285 | WARN(1, "debugfs file owner did not clean up at exit: %pd", | |
286 | dentry); | |
287 | r = -ENXIO; | |
288 | goto out; | |
289 | } | |
290 | ||
291 | proxy_fops = kzalloc(sizeof(*proxy_fops), GFP_KERNEL); | |
292 | if (!proxy_fops) { | |
293 | r = -ENOMEM; | |
294 | goto free_proxy; | |
295 | } | |
296 | __full_proxy_fops_init(proxy_fops, real_fops); | |
297 | replace_fops(filp, proxy_fops); | |
298 | ||
299 | if (real_fops->open) { | |
300 | r = real_fops->open(inode, filp); | |
b10e3e90 NS |
301 | if (r) { |
302 | replace_fops(filp, d_inode(dentry)->i_fop); | |
303 | goto free_proxy; | |
304 | } else if (filp->f_op != proxy_fops) { | |
49d200de NS |
305 | /* No protection against file removal anymore. */ |
306 | WARN(1, "debugfs file owner replaced proxy fops: %pd", | |
307 | dentry); | |
308 | goto free_proxy; | |
309 | } | |
310 | } | |
311 | ||
312 | goto out; | |
313 | free_proxy: | |
314 | kfree(proxy_fops); | |
315 | fops_put(real_fops); | |
316 | out: | |
69d29f9e | 317 | debugfs_file_put(dentry); |
49d200de NS |
318 | return r; |
319 | } | |
320 | ||
321 | const struct file_operations debugfs_full_proxy_file_operations = { | |
322 | .open = full_proxy_open, | |
323 | }; | |
324 | ||
c6468808 NS |
325 | ssize_t debugfs_attr_read(struct file *file, char __user *buf, |
326 | size_t len, loff_t *ppos) | |
327 | { | |
69d29f9e | 328 | struct dentry *dentry = F_DENTRY(file); |
c6468808 | 329 | ssize_t ret; |
c6468808 | 330 | |
69d29f9e NS |
331 | ret = debugfs_file_get(dentry); |
332 | if (unlikely(ret)) | |
333 | return ret; | |
334 | ret = simple_attr_read(file, buf, len, ppos); | |
335 | debugfs_file_put(dentry); | |
c6468808 NS |
336 | return ret; |
337 | } | |
338 | EXPORT_SYMBOL_GPL(debugfs_attr_read); | |
339 | ||
340 | ssize_t debugfs_attr_write(struct file *file, const char __user *buf, | |
341 | size_t len, loff_t *ppos) | |
342 | { | |
69d29f9e | 343 | struct dentry *dentry = F_DENTRY(file); |
c6468808 | 344 | ssize_t ret; |
c6468808 | 345 | |
69d29f9e NS |
346 | ret = debugfs_file_get(dentry); |
347 | if (unlikely(ret)) | |
348 | return ret; | |
349 | ret = simple_attr_write(file, buf, len, ppos); | |
350 | debugfs_file_put(dentry); | |
c6468808 NS |
351 | return ret; |
352 | } | |
353 | EXPORT_SYMBOL_GPL(debugfs_attr_write); | |
354 | ||
4909f168 NS |
355 | static struct dentry *debugfs_create_mode_unsafe(const char *name, umode_t mode, |
356 | struct dentry *parent, void *value, | |
357 | const struct file_operations *fops, | |
358 | const struct file_operations *fops_ro, | |
359 | const struct file_operations *fops_wo) | |
360 | { | |
361 | /* if there are no write bits set, make read only */ | |
362 | if (!(mode & S_IWUGO)) | |
363 | return debugfs_create_file_unsafe(name, mode, parent, value, | |
364 | fops_ro); | |
365 | /* if there are no read bits set, make write only */ | |
366 | if (!(mode & S_IRUGO)) | |
367 | return debugfs_create_file_unsafe(name, mode, parent, value, | |
368 | fops_wo); | |
369 | ||
370 | return debugfs_create_file_unsafe(name, mode, parent, value, fops); | |
371 | } | |
372 | ||
8b88b099 | 373 | static int debugfs_u8_set(void *data, u64 val) |
acaefc25 AB |
374 | { |
375 | *(u8 *)data = val; | |
8b88b099 | 376 | return 0; |
acaefc25 | 377 | } |
8b88b099 | 378 | static int debugfs_u8_get(void *data, u64 *val) |
acaefc25 | 379 | { |
8b88b099 CH |
380 | *val = *(u8 *)data; |
381 | return 0; | |
acaefc25 | 382 | } |
4909f168 NS |
383 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n"); |
384 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n"); | |
385 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n"); | |
1da177e4 LT |
386 | |
387 | /** | |
6468b3af | 388 | * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value |
1da177e4 LT |
389 | * @name: a pointer to a string containing the name of the file to create. |
390 | * @mode: the permission that the file should have | |
391 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 392 | * directory dentry if set. If this parameter is %NULL, then the |
1da177e4 LT |
393 | * file will be created in the root of the debugfs filesystem. |
394 | * @value: a pointer to the variable that the file should read to and write | |
395 | * from. | |
396 | * | |
397 | * This function creates a file in debugfs with the given name that | |
398 | * contains the value of the variable @value. If the @mode variable is so | |
399 | * set, it can be read from, and written to. | |
400 | * | |
401 | * This function will return a pointer to a dentry if it succeeds. This | |
402 | * pointer must be passed to the debugfs_remove() function when the file is | |
403 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 404 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 405 | * |
6468b3af | 406 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
1da177e4 | 407 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 408 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
1da177e4 LT |
409 | * code. |
410 | */ | |
f4ae40a6 | 411 | struct dentry *debugfs_create_u8(const char *name, umode_t mode, |
1da177e4 LT |
412 | struct dentry *parent, u8 *value) |
413 | { | |
4909f168 | 414 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u8, |
b97f6799 | 415 | &fops_u8_ro, &fops_u8_wo); |
1da177e4 LT |
416 | } |
417 | EXPORT_SYMBOL_GPL(debugfs_create_u8); | |
418 | ||
8b88b099 | 419 | static int debugfs_u16_set(void *data, u64 val) |
acaefc25 AB |
420 | { |
421 | *(u16 *)data = val; | |
8b88b099 | 422 | return 0; |
acaefc25 | 423 | } |
8b88b099 | 424 | static int debugfs_u16_get(void *data, u64 *val) |
acaefc25 | 425 | { |
8b88b099 CH |
426 | *val = *(u16 *)data; |
427 | return 0; | |
acaefc25 | 428 | } |
4909f168 NS |
429 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n"); |
430 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n"); | |
431 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n"); | |
acaefc25 | 432 | |
1da177e4 | 433 | /** |
6468b3af | 434 | * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value |
1da177e4 LT |
435 | * @name: a pointer to a string containing the name of the file to create. |
436 | * @mode: the permission that the file should have | |
437 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 438 | * directory dentry if set. If this parameter is %NULL, then the |
1da177e4 LT |
439 | * file will be created in the root of the debugfs filesystem. |
440 | * @value: a pointer to the variable that the file should read to and write | |
441 | * from. | |
442 | * | |
443 | * This function creates a file in debugfs with the given name that | |
444 | * contains the value of the variable @value. If the @mode variable is so | |
445 | * set, it can be read from, and written to. | |
446 | * | |
447 | * This function will return a pointer to a dentry if it succeeds. This | |
448 | * pointer must be passed to the debugfs_remove() function when the file is | |
449 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 450 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 451 | * |
6468b3af | 452 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
1da177e4 | 453 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 454 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
1da177e4 LT |
455 | * code. |
456 | */ | |
f4ae40a6 | 457 | struct dentry *debugfs_create_u16(const char *name, umode_t mode, |
1da177e4 LT |
458 | struct dentry *parent, u16 *value) |
459 | { | |
4909f168 | 460 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u16, |
b97f6799 | 461 | &fops_u16_ro, &fops_u16_wo); |
1da177e4 LT |
462 | } |
463 | EXPORT_SYMBOL_GPL(debugfs_create_u16); | |
464 | ||
8b88b099 | 465 | static int debugfs_u32_set(void *data, u64 val) |
acaefc25 AB |
466 | { |
467 | *(u32 *)data = val; | |
8b88b099 | 468 | return 0; |
acaefc25 | 469 | } |
8b88b099 | 470 | static int debugfs_u32_get(void *data, u64 *val) |
acaefc25 | 471 | { |
8b88b099 CH |
472 | *val = *(u32 *)data; |
473 | return 0; | |
acaefc25 | 474 | } |
4909f168 NS |
475 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n"); |
476 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n"); | |
477 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n"); | |
acaefc25 | 478 | |
1da177e4 | 479 | /** |
6468b3af | 480 | * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value |
1da177e4 LT |
481 | * @name: a pointer to a string containing the name of the file to create. |
482 | * @mode: the permission that the file should have | |
483 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 484 | * directory dentry if set. If this parameter is %NULL, then the |
1da177e4 LT |
485 | * file will be created in the root of the debugfs filesystem. |
486 | * @value: a pointer to the variable that the file should read to and write | |
487 | * from. | |
488 | * | |
489 | * This function creates a file in debugfs with the given name that | |
490 | * contains the value of the variable @value. If the @mode variable is so | |
491 | * set, it can be read from, and written to. | |
492 | * | |
493 | * This function will return a pointer to a dentry if it succeeds. This | |
494 | * pointer must be passed to the debugfs_remove() function when the file is | |
495 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 496 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 497 | * |
6468b3af | 498 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
1da177e4 | 499 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 500 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
1da177e4 LT |
501 | * code. |
502 | */ | |
f4ae40a6 | 503 | struct dentry *debugfs_create_u32(const char *name, umode_t mode, |
1da177e4 LT |
504 | struct dentry *parent, u32 *value) |
505 | { | |
4909f168 | 506 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u32, |
b97f6799 | 507 | &fops_u32_ro, &fops_u32_wo); |
1da177e4 LT |
508 | } |
509 | EXPORT_SYMBOL_GPL(debugfs_create_u32); | |
510 | ||
8b88b099 | 511 | static int debugfs_u64_set(void *data, u64 val) |
8447891f ME |
512 | { |
513 | *(u64 *)data = val; | |
8b88b099 | 514 | return 0; |
8447891f ME |
515 | } |
516 | ||
8b88b099 | 517 | static int debugfs_u64_get(void *data, u64 *val) |
8447891f | 518 | { |
8b88b099 CH |
519 | *val = *(u64 *)data; |
520 | return 0; | |
8447891f | 521 | } |
4909f168 NS |
522 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n"); |
523 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n"); | |
524 | DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n"); | |
8447891f ME |
525 | |
526 | /** | |
527 | * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value | |
528 | * @name: a pointer to a string containing the name of the file to create. | |
529 | * @mode: the permission that the file should have | |
530 | * @parent: a pointer to the parent dentry for this file. This should be a | |
531 | * directory dentry if set. If this parameter is %NULL, then the | |
532 | * file will be created in the root of the debugfs filesystem. | |
533 | * @value: a pointer to the variable that the file should read to and write | |
534 | * from. | |
535 | * | |
536 | * This function creates a file in debugfs with the given name that | |
537 | * contains the value of the variable @value. If the @mode variable is so | |
538 | * set, it can be read from, and written to. | |
539 | * | |
540 | * This function will return a pointer to a dentry if it succeeds. This | |
541 | * pointer must be passed to the debugfs_remove() function when the file is | |
542 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
543 | * you are responsible here.) If an error occurs, %NULL will be returned. | |
544 | * | |
545 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be | |
546 | * returned. It is not wise to check for this value, but rather, check for | |
547 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling | |
548 | * code. | |
549 | */ | |
f4ae40a6 | 550 | struct dentry *debugfs_create_u64(const char *name, umode_t mode, |
8447891f ME |
551 | struct dentry *parent, u64 *value) |
552 | { | |
4909f168 | 553 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u64, |
b97f6799 | 554 | &fops_u64_ro, &fops_u64_wo); |
8447891f ME |
555 | } |
556 | EXPORT_SYMBOL_GPL(debugfs_create_u64); | |
557 | ||
c23fe831 VK |
558 | static int debugfs_ulong_set(void *data, u64 val) |
559 | { | |
560 | *(unsigned long *)data = val; | |
561 | return 0; | |
562 | } | |
563 | ||
564 | static int debugfs_ulong_get(void *data, u64 *val) | |
565 | { | |
566 | *val = *(unsigned long *)data; | |
567 | return 0; | |
568 | } | |
4909f168 NS |
569 | DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong, debugfs_ulong_get, debugfs_ulong_set, |
570 | "%llu\n"); | |
571 | DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_ro, debugfs_ulong_get, NULL, "%llu\n"); | |
572 | DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_wo, NULL, debugfs_ulong_set, "%llu\n"); | |
c23fe831 VK |
573 | |
574 | /** | |
575 | * debugfs_create_ulong - create a debugfs file that is used to read and write | |
576 | * an unsigned long value. | |
577 | * @name: a pointer to a string containing the name of the file to create. | |
578 | * @mode: the permission that the file should have | |
579 | * @parent: a pointer to the parent dentry for this file. This should be a | |
580 | * directory dentry if set. If this parameter is %NULL, then the | |
581 | * file will be created in the root of the debugfs filesystem. | |
582 | * @value: a pointer to the variable that the file should read to and write | |
583 | * from. | |
584 | * | |
585 | * This function creates a file in debugfs with the given name that | |
586 | * contains the value of the variable @value. If the @mode variable is so | |
587 | * set, it can be read from, and written to. | |
588 | * | |
589 | * This function will return a pointer to a dentry if it succeeds. This | |
590 | * pointer must be passed to the debugfs_remove() function when the file is | |
591 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
592 | * you are responsible here.) If an error occurs, %NULL will be returned. | |
593 | * | |
594 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be | |
595 | * returned. It is not wise to check for this value, but rather, check for | |
596 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling | |
597 | * code. | |
598 | */ | |
599 | struct dentry *debugfs_create_ulong(const char *name, umode_t mode, | |
600 | struct dentry *parent, unsigned long *value) | |
601 | { | |
4909f168 NS |
602 | return debugfs_create_mode_unsafe(name, mode, parent, value, |
603 | &fops_ulong, &fops_ulong_ro, | |
604 | &fops_ulong_wo); | |
c23fe831 VK |
605 | } |
606 | EXPORT_SYMBOL_GPL(debugfs_create_ulong); | |
607 | ||
4909f168 NS |
608 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n"); |
609 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n"); | |
610 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n"); | |
2ebefc50 | 611 | |
4909f168 NS |
612 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, |
613 | "0x%04llx\n"); | |
614 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n"); | |
615 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n"); | |
2ebefc50 | 616 | |
4909f168 NS |
617 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, |
618 | "0x%08llx\n"); | |
619 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n"); | |
620 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n"); | |
2ebefc50 | 621 | |
4909f168 NS |
622 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, |
623 | "0x%016llx\n"); | |
624 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_ro, debugfs_u64_get, NULL, "0x%016llx\n"); | |
625 | DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_wo, NULL, debugfs_u64_set, "0x%016llx\n"); | |
15b0beaa | 626 | |
e6716b87 | 627 | /* |
15b0beaa | 628 | * 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 | 629 | * |
e6716b87 RD |
630 | * These functions are exactly the same as the above functions (but use a hex |
631 | * output for the decimal challenged). For details look at the above unsigned | |
2ebefc50 RG |
632 | * decimal functions. |
633 | */ | |
e6716b87 RD |
634 | |
635 | /** | |
636 | * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value | |
637 | * @name: a pointer to a string containing the name of the file to create. | |
638 | * @mode: the permission that the file should have | |
639 | * @parent: a pointer to the parent dentry for this file. This should be a | |
640 | * directory dentry if set. If this parameter is %NULL, then the | |
641 | * file will be created in the root of the debugfs filesystem. | |
642 | * @value: a pointer to the variable that the file should read to and write | |
643 | * from. | |
644 | */ | |
f4ae40a6 | 645 | struct dentry *debugfs_create_x8(const char *name, umode_t mode, |
2ebefc50 RG |
646 | struct dentry *parent, u8 *value) |
647 | { | |
4909f168 | 648 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x8, |
b97f6799 | 649 | &fops_x8_ro, &fops_x8_wo); |
2ebefc50 RG |
650 | } |
651 | EXPORT_SYMBOL_GPL(debugfs_create_x8); | |
652 | ||
e6716b87 RD |
653 | /** |
654 | * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value | |
655 | * @name: a pointer to a string containing the name of the file to create. | |
656 | * @mode: the permission that the file should have | |
657 | * @parent: a pointer to the parent dentry for this file. This should be a | |
658 | * directory dentry if set. If this parameter is %NULL, then the | |
659 | * file will be created in the root of the debugfs filesystem. | |
660 | * @value: a pointer to the variable that the file should read to and write | |
661 | * from. | |
662 | */ | |
f4ae40a6 | 663 | struct dentry *debugfs_create_x16(const char *name, umode_t mode, |
2ebefc50 RG |
664 | struct dentry *parent, u16 *value) |
665 | { | |
4909f168 | 666 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x16, |
b97f6799 | 667 | &fops_x16_ro, &fops_x16_wo); |
2ebefc50 RG |
668 | } |
669 | EXPORT_SYMBOL_GPL(debugfs_create_x16); | |
670 | ||
e6716b87 RD |
671 | /** |
672 | * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value | |
673 | * @name: a pointer to a string containing the name of the file to create. | |
674 | * @mode: the permission that the file should have | |
675 | * @parent: a pointer to the parent dentry for this file. This should be a | |
676 | * directory dentry if set. If this parameter is %NULL, then the | |
677 | * file will be created in the root of the debugfs filesystem. | |
678 | * @value: a pointer to the variable that the file should read to and write | |
679 | * from. | |
680 | */ | |
f4ae40a6 | 681 | struct dentry *debugfs_create_x32(const char *name, umode_t mode, |
2ebefc50 RG |
682 | struct dentry *parent, u32 *value) |
683 | { | |
4909f168 | 684 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x32, |
b97f6799 | 685 | &fops_x32_ro, &fops_x32_wo); |
2ebefc50 RG |
686 | } |
687 | EXPORT_SYMBOL_GPL(debugfs_create_x32); | |
688 | ||
15b0beaa HY |
689 | /** |
690 | * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value | |
691 | * @name: a pointer to a string containing the name of the file to create. | |
692 | * @mode: the permission that the file should have | |
693 | * @parent: a pointer to the parent dentry for this file. This should be a | |
694 | * directory dentry if set. If this parameter is %NULL, then the | |
695 | * file will be created in the root of the debugfs filesystem. | |
696 | * @value: a pointer to the variable that the file should read to and write | |
697 | * from. | |
698 | */ | |
f4ae40a6 | 699 | struct dentry *debugfs_create_x64(const char *name, umode_t mode, |
15b0beaa HY |
700 | struct dentry *parent, u64 *value) |
701 | { | |
4909f168 | 702 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x64, |
82b7d4fb | 703 | &fops_x64_ro, &fops_x64_wo); |
15b0beaa HY |
704 | } |
705 | EXPORT_SYMBOL_GPL(debugfs_create_x64); | |
706 | ||
5e078787 IPG |
707 | |
708 | static int debugfs_size_t_set(void *data, u64 val) | |
709 | { | |
710 | *(size_t *)data = val; | |
711 | return 0; | |
712 | } | |
713 | static int debugfs_size_t_get(void *data, u64 *val) | |
714 | { | |
715 | *val = *(size_t *)data; | |
716 | return 0; | |
717 | } | |
4909f168 NS |
718 | DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set, |
719 | "%llu\n"); /* %llu and %zu are more or less the same */ | |
720 | DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_ro, debugfs_size_t_get, NULL, "%llu\n"); | |
721 | DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_wo, NULL, debugfs_size_t_set, "%llu\n"); | |
5e078787 IPG |
722 | |
723 | /** | |
724 | * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value | |
725 | * @name: a pointer to a string containing the name of the file to create. | |
726 | * @mode: the permission that the file should have | |
727 | * @parent: a pointer to the parent dentry for this file. This should be a | |
728 | * directory dentry if set. If this parameter is %NULL, then the | |
729 | * file will be created in the root of the debugfs filesystem. | |
730 | * @value: a pointer to the variable that the file should read to and write | |
731 | * from. | |
732 | */ | |
f4ae40a6 | 733 | struct dentry *debugfs_create_size_t(const char *name, umode_t mode, |
5e078787 IPG |
734 | struct dentry *parent, size_t *value) |
735 | { | |
4909f168 NS |
736 | return debugfs_create_mode_unsafe(name, mode, parent, value, |
737 | &fops_size_t, &fops_size_t_ro, | |
738 | &fops_size_t_wo); | |
5e078787 IPG |
739 | } |
740 | EXPORT_SYMBOL_GPL(debugfs_create_size_t); | |
741 | ||
3a76e5e0 SJ |
742 | static int debugfs_atomic_t_set(void *data, u64 val) |
743 | { | |
744 | atomic_set((atomic_t *)data, val); | |
745 | return 0; | |
746 | } | |
747 | static int debugfs_atomic_t_get(void *data, u64 *val) | |
748 | { | |
749 | *val = atomic_read((atomic_t *)data); | |
750 | return 0; | |
751 | } | |
4909f168 | 752 | DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get, |
3a76e5e0 | 753 | debugfs_atomic_t_set, "%lld\n"); |
4909f168 NS |
754 | DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL, |
755 | "%lld\n"); | |
756 | DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set, | |
757 | "%lld\n"); | |
3a76e5e0 SJ |
758 | |
759 | /** | |
760 | * debugfs_create_atomic_t - create a debugfs file that is used to read and | |
761 | * write an atomic_t value | |
762 | * @name: a pointer to a string containing the name of the file to create. | |
763 | * @mode: the permission that the file should have | |
764 | * @parent: a pointer to the parent dentry for this file. This should be a | |
765 | * directory dentry if set. If this parameter is %NULL, then the | |
766 | * file will be created in the root of the debugfs filesystem. | |
767 | * @value: a pointer to the variable that the file should read to and write | |
768 | * from. | |
769 | */ | |
770 | struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, | |
771 | struct dentry *parent, atomic_t *value) | |
772 | { | |
4909f168 NS |
773 | return debugfs_create_mode_unsafe(name, mode, parent, value, |
774 | &fops_atomic_t, &fops_atomic_t_ro, | |
775 | &fops_atomic_t_wo); | |
3a76e5e0 SJ |
776 | } |
777 | EXPORT_SYMBOL_GPL(debugfs_create_atomic_t); | |
5e078787 | 778 | |
0642ef6f RF |
779 | ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf, |
780 | size_t count, loff_t *ppos) | |
1da177e4 LT |
781 | { |
782 | char buf[3]; | |
4d45f797 | 783 | bool val; |
69d29f9e NS |
784 | int r; |
785 | struct dentry *dentry = F_DENTRY(file); | |
4d45f797 | 786 | |
69d29f9e NS |
787 | r = debugfs_file_get(dentry); |
788 | if (unlikely(r)) | |
4d45f797 | 789 | return r; |
69d29f9e NS |
790 | val = *(bool *)file->private_data; |
791 | debugfs_file_put(dentry); | |
88e412ea | 792 | |
4d45f797 | 793 | if (val) |
1da177e4 LT |
794 | buf[0] = 'Y'; |
795 | else | |
796 | buf[0] = 'N'; | |
797 | buf[1] = '\n'; | |
798 | buf[2] = 0x00; | |
799 | return simple_read_from_buffer(user_buf, count, ppos, buf, 2); | |
800 | } | |
0642ef6f | 801 | EXPORT_SYMBOL_GPL(debugfs_read_file_bool); |
1da177e4 | 802 | |
0642ef6f RF |
803 | ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf, |
804 | size_t count, loff_t *ppos) | |
1da177e4 LT |
805 | { |
806 | char buf[32]; | |
c42d2237 | 807 | size_t buf_size; |
8705b48e | 808 | bool bv; |
69d29f9e | 809 | int r; |
621a5f7a | 810 | bool *val = file->private_data; |
69d29f9e | 811 | struct dentry *dentry = F_DENTRY(file); |
1da177e4 LT |
812 | |
813 | buf_size = min(count, (sizeof(buf)-1)); | |
814 | if (copy_from_user(buf, user_buf, buf_size)) | |
815 | return -EFAULT; | |
816 | ||
a3b2c8c7 | 817 | buf[buf_size] = '\0'; |
4d45f797 | 818 | if (strtobool(buf, &bv) == 0) { |
69d29f9e NS |
819 | r = debugfs_file_get(dentry); |
820 | if (unlikely(r)) | |
4d45f797 | 821 | return r; |
69d29f9e NS |
822 | *val = bv; |
823 | debugfs_file_put(dentry); | |
4d45f797 | 824 | } |
8705b48e | 825 | |
1da177e4 LT |
826 | return count; |
827 | } | |
0642ef6f | 828 | EXPORT_SYMBOL_GPL(debugfs_write_file_bool); |
1da177e4 | 829 | |
4b6f5d20 | 830 | static const struct file_operations fops_bool = { |
0642ef6f RF |
831 | .read = debugfs_read_file_bool, |
832 | .write = debugfs_write_file_bool, | |
234e3405 | 833 | .open = simple_open, |
6038f373 | 834 | .llseek = default_llseek, |
1da177e4 LT |
835 | }; |
836 | ||
6713e8fb SB |
837 | static const struct file_operations fops_bool_ro = { |
838 | .read = debugfs_read_file_bool, | |
839 | .open = simple_open, | |
840 | .llseek = default_llseek, | |
841 | }; | |
842 | ||
843 | static const struct file_operations fops_bool_wo = { | |
844 | .write = debugfs_write_file_bool, | |
845 | .open = simple_open, | |
846 | .llseek = default_llseek, | |
847 | }; | |
848 | ||
1da177e4 | 849 | /** |
6468b3af | 850 | * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value |
1da177e4 LT |
851 | * @name: a pointer to a string containing the name of the file to create. |
852 | * @mode: the permission that the file should have | |
853 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 854 | * directory dentry if set. If this parameter is %NULL, then the |
1da177e4 LT |
855 | * file will be created in the root of the debugfs filesystem. |
856 | * @value: a pointer to the variable that the file should read to and write | |
857 | * from. | |
858 | * | |
859 | * This function creates a file in debugfs with the given name that | |
860 | * contains the value of the variable @value. If the @mode variable is so | |
861 | * set, it can be read from, and written to. | |
862 | * | |
863 | * This function will return a pointer to a dentry if it succeeds. This | |
864 | * pointer must be passed to the debugfs_remove() function when the file is | |
865 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 866 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 867 | * |
6468b3af | 868 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
1da177e4 | 869 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 870 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
1da177e4 LT |
871 | * code. |
872 | */ | |
f4ae40a6 | 873 | struct dentry *debugfs_create_bool(const char *name, umode_t mode, |
621a5f7a | 874 | struct dentry *parent, bool *value) |
1da177e4 | 875 | { |
4d45f797 | 876 | return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_bool, |
6713e8fb | 877 | &fops_bool_ro, &fops_bool_wo); |
1da177e4 LT |
878 | } |
879 | EXPORT_SYMBOL_GPL(debugfs_create_bool); | |
880 | ||
dd308bc3 ME |
881 | static ssize_t read_file_blob(struct file *file, char __user *user_buf, |
882 | size_t count, loff_t *ppos) | |
883 | { | |
884 | struct debugfs_blob_wrapper *blob = file->private_data; | |
69d29f9e | 885 | struct dentry *dentry = F_DENTRY(file); |
83b711cb | 886 | ssize_t r; |
83b711cb | 887 | |
69d29f9e NS |
888 | r = debugfs_file_get(dentry); |
889 | if (unlikely(r)) | |
890 | return r; | |
891 | r = simple_read_from_buffer(user_buf, count, ppos, blob->data, | |
892 | blob->size); | |
893 | debugfs_file_put(dentry); | |
83b711cb | 894 | return r; |
dd308bc3 ME |
895 | } |
896 | ||
00977a59 | 897 | static const struct file_operations fops_blob = { |
dd308bc3 | 898 | .read = read_file_blob, |
234e3405 | 899 | .open = simple_open, |
6038f373 | 900 | .llseek = default_llseek, |
dd308bc3 ME |
901 | }; |
902 | ||
903 | /** | |
400ced61 | 904 | * debugfs_create_blob - create a debugfs file that is used to read a binary blob |
dd308bc3 ME |
905 | * @name: a pointer to a string containing the name of the file to create. |
906 | * @mode: the permission that the file should have | |
907 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 908 | * directory dentry if set. If this parameter is %NULL, then the |
dd308bc3 ME |
909 | * file will be created in the root of the debugfs filesystem. |
910 | * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer | |
911 | * to the blob data and the size of the data. | |
912 | * | |
913 | * This function creates a file in debugfs with the given name that exports | |
914 | * @blob->data as a binary blob. If the @mode variable is so set it can be | |
915 | * read from. Writing is not supported. | |
916 | * | |
917 | * This function will return a pointer to a dentry if it succeeds. This | |
918 | * pointer must be passed to the debugfs_remove() function when the file is | |
919 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 920 | * you are responsible here.) If an error occurs, %NULL will be returned. |
dd308bc3 | 921 | * |
6468b3af | 922 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
dd308bc3 | 923 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 924 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
dd308bc3 ME |
925 | * code. |
926 | */ | |
f4ae40a6 | 927 | struct dentry *debugfs_create_blob(const char *name, umode_t mode, |
dd308bc3 ME |
928 | struct dentry *parent, |
929 | struct debugfs_blob_wrapper *blob) | |
930 | { | |
83b711cb | 931 | return debugfs_create_file_unsafe(name, mode, parent, blob, &fops_blob); |
dd308bc3 ME |
932 | } |
933 | EXPORT_SYMBOL_GPL(debugfs_create_blob); | |
1a087c6a | 934 | |
9fe2a701 SV |
935 | struct array_data { |
936 | void *array; | |
937 | u32 elements; | |
938 | }; | |
939 | ||
e05e279e LT |
940 | static size_t u32_format_array(char *buf, size_t bufsize, |
941 | u32 *array, int array_size) | |
9fe2a701 SV |
942 | { |
943 | size_t ret = 0; | |
9fe2a701 | 944 | |
e05e279e | 945 | while (--array_size >= 0) { |
9fe2a701 | 946 | size_t len; |
e05e279e | 947 | char term = array_size ? ' ' : '\n'; |
9fe2a701 | 948 | |
e05e279e | 949 | len = snprintf(buf, bufsize, "%u%c", *array++, term); |
9fe2a701 SV |
950 | ret += len; |
951 | ||
e05e279e LT |
952 | buf += len; |
953 | bufsize -= len; | |
9fe2a701 | 954 | } |
9fe2a701 SV |
955 | return ret; |
956 | } | |
957 | ||
36048853 | 958 | static int u32_array_open(struct inode *inode, struct file *file) |
9fe2a701 | 959 | { |
9fe2a701 | 960 | struct array_data *data = inode->i_private; |
e05e279e LT |
961 | int size, elements = data->elements; |
962 | char *buf; | |
963 | ||
964 | /* | |
965 | * Max size: | |
966 | * - 10 digits + ' '/'\n' = 11 bytes per number | |
967 | * - terminating NUL character | |
968 | */ | |
969 | size = elements*11; | |
970 | buf = kmalloc(size+1, GFP_KERNEL); | |
971 | if (!buf) | |
36048853 | 972 | return -ENOMEM; |
e05e279e LT |
973 | buf[size] = 0; |
974 | ||
975 | file->private_data = buf; | |
976 | u32_format_array(buf, size, data->array, data->elements); | |
977 | ||
36048853 DR |
978 | return nonseekable_open(inode, file); |
979 | } | |
9fe2a701 | 980 | |
36048853 DR |
981 | static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len, |
982 | loff_t *ppos) | |
983 | { | |
984 | size_t size = strlen(file->private_data); | |
9fe2a701 SV |
985 | |
986 | return simple_read_from_buffer(buf, len, ppos, | |
987 | file->private_data, size); | |
988 | } | |
989 | ||
990 | static int u32_array_release(struct inode *inode, struct file *file) | |
991 | { | |
992 | kfree(file->private_data); | |
993 | ||
994 | return 0; | |
995 | } | |
996 | ||
997 | static const struct file_operations u32_array_fops = { | |
998 | .owner = THIS_MODULE, | |
999 | .open = u32_array_open, | |
1000 | .release = u32_array_release, | |
1001 | .read = u32_array_read, | |
1002 | .llseek = no_llseek, | |
1003 | }; | |
1004 | ||
1005 | /** | |
1006 | * debugfs_create_u32_array - create a debugfs file that is used to read u32 | |
1007 | * array. | |
1008 | * @name: a pointer to a string containing the name of the file to create. | |
1009 | * @mode: the permission that the file should have. | |
1010 | * @parent: a pointer to the parent dentry for this file. This should be a | |
1011 | * directory dentry if set. If this parameter is %NULL, then the | |
1012 | * file will be created in the root of the debugfs filesystem. | |
1013 | * @array: u32 array that provides data. | |
1014 | * @elements: total number of elements in the array. | |
1015 | * | |
1016 | * This function creates a file in debugfs with the given name that exports | |
1017 | * @array as data. If the @mode variable is so set it can be read from. | |
1018 | * Writing is not supported. Seek within the file is also not supported. | |
1019 | * Once array is created its size can not be changed. | |
1020 | * | |
1021 | * The function returns a pointer to dentry on success. If debugfs is not | |
1022 | * enabled in the kernel, the value -%ENODEV will be returned. | |
1023 | */ | |
1024 | struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, | |
1025 | struct dentry *parent, | |
1026 | u32 *array, u32 elements) | |
1027 | { | |
1028 | struct array_data *data = kmalloc(sizeof(*data), GFP_KERNEL); | |
1029 | ||
1030 | if (data == NULL) | |
1031 | return NULL; | |
1032 | ||
1033 | data->array = array; | |
1034 | data->elements = elements; | |
1035 | ||
c4a74f63 NS |
1036 | return debugfs_create_file_unsafe(name, mode, parent, data, |
1037 | &u32_array_fops); | |
9fe2a701 SV |
1038 | } |
1039 | EXPORT_SYMBOL_GPL(debugfs_create_u32_array); | |
1040 | ||
3b85e4ab HC |
1041 | #ifdef CONFIG_HAS_IOMEM |
1042 | ||
1a087c6a AR |
1043 | /* |
1044 | * The regset32 stuff is used to print 32-bit registers using the | |
1045 | * seq_file utilities. We offer printing a register set in an already-opened | |
1046 | * sequential file or create a debugfs file that only prints a regset32. | |
1047 | */ | |
1048 | ||
1049 | /** | |
1050 | * debugfs_print_regs32 - use seq_print to describe a set of registers | |
1051 | * @s: the seq_file structure being used to generate output | |
1052 | * @regs: an array if struct debugfs_reg32 structures | |
b5763acc | 1053 | * @nregs: the length of the above array |
1a087c6a AR |
1054 | * @base: the base address to be used in reading the registers |
1055 | * @prefix: a string to be prefixed to every output line | |
1056 | * | |
1057 | * This function outputs a text block describing the current values of | |
1058 | * some 32-bit hardware registers. It is meant to be used within debugfs | |
1059 | * files based on seq_file that need to show registers, intermixed with other | |
1060 | * information. The prefix argument may be used to specify a leading string, | |
1061 | * because some peripherals have several blocks of identical registers, | |
1062 | * for example configuration of dma channels | |
1063 | */ | |
9761536e JP |
1064 | void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, |
1065 | int nregs, void __iomem *base, char *prefix) | |
1a087c6a | 1066 | { |
9761536e | 1067 | int i; |
1a087c6a AR |
1068 | |
1069 | for (i = 0; i < nregs; i++, regs++) { | |
1070 | if (prefix) | |
9761536e JP |
1071 | seq_printf(s, "%s", prefix); |
1072 | seq_printf(s, "%s = 0x%08x\n", regs->name, | |
1073 | readl(base + regs->offset)); | |
1074 | if (seq_has_overflowed(s)) | |
1075 | break; | |
1a087c6a | 1076 | } |
1a087c6a AR |
1077 | } |
1078 | EXPORT_SYMBOL_GPL(debugfs_print_regs32); | |
1079 | ||
1080 | static int debugfs_show_regset32(struct seq_file *s, void *data) | |
1081 | { | |
1082 | struct debugfs_regset32 *regset = s->private; | |
1083 | ||
1084 | debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, ""); | |
1085 | return 0; | |
1086 | } | |
1087 | ||
1088 | static int debugfs_open_regset32(struct inode *inode, struct file *file) | |
1089 | { | |
1090 | return single_open(file, debugfs_show_regset32, inode->i_private); | |
1091 | } | |
1092 | ||
1093 | static const struct file_operations fops_regset32 = { | |
1094 | .open = debugfs_open_regset32, | |
1095 | .read = seq_read, | |
1096 | .llseek = seq_lseek, | |
1097 | .release = single_release, | |
1098 | }; | |
1099 | ||
1100 | /** | |
1101 | * debugfs_create_regset32 - create a debugfs file that returns register values | |
1102 | * @name: a pointer to a string containing the name of the file to create. | |
1103 | * @mode: the permission that the file should have | |
1104 | * @parent: a pointer to the parent dentry for this file. This should be a | |
1105 | * directory dentry if set. If this parameter is %NULL, then the | |
1106 | * file will be created in the root of the debugfs filesystem. | |
1107 | * @regset: a pointer to a struct debugfs_regset32, which contains a pointer | |
1108 | * to an array of register definitions, the array size and the base | |
1109 | * address where the register bank is to be found. | |
1110 | * | |
1111 | * This function creates a file in debugfs with the given name that reports | |
1112 | * the names and values of a set of 32-bit registers. If the @mode variable | |
1113 | * is so set it can be read from. Writing is not supported. | |
1114 | * | |
1115 | * This function will return a pointer to a dentry if it succeeds. This | |
1116 | * pointer must be passed to the debugfs_remove() function when the file is | |
1117 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
1118 | * you are responsible here.) If an error occurs, %NULL will be returned. | |
1119 | * | |
1120 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be | |
1121 | * returned. It is not wise to check for this value, but rather, check for | |
1122 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling | |
1123 | * code. | |
1124 | */ | |
88187398 | 1125 | struct dentry *debugfs_create_regset32(const char *name, umode_t mode, |
1a087c6a AR |
1126 | struct dentry *parent, |
1127 | struct debugfs_regset32 *regset) | |
1128 | { | |
1129 | return debugfs_create_file(name, mode, parent, regset, &fops_regset32); | |
1130 | } | |
1131 | EXPORT_SYMBOL_GPL(debugfs_create_regset32); | |
3b85e4ab HC |
1132 | |
1133 | #endif /* CONFIG_HAS_IOMEM */ | |
98210b7f AS |
1134 | |
1135 | struct debugfs_devm_entry { | |
1136 | int (*read)(struct seq_file *seq, void *data); | |
1137 | struct device *dev; | |
1138 | }; | |
1139 | ||
1140 | static int debugfs_devm_entry_open(struct inode *inode, struct file *f) | |
1141 | { | |
1142 | struct debugfs_devm_entry *entry = inode->i_private; | |
1143 | ||
1144 | return single_open(f, entry->read, entry->dev); | |
1145 | } | |
1146 | ||
1147 | static const struct file_operations debugfs_devm_entry_ops = { | |
1148 | .owner = THIS_MODULE, | |
1149 | .open = debugfs_devm_entry_open, | |
1150 | .release = single_release, | |
1151 | .read = seq_read, | |
1152 | .llseek = seq_lseek | |
1153 | }; | |
1154 | ||
1155 | /** | |
1156 | * debugfs_create_devm_seqfile - create a debugfs file that is bound to device. | |
1157 | * | |
1158 | * @dev: device related to this debugfs file. | |
1159 | * @name: name of the debugfs file. | |
1160 | * @parent: a pointer to the parent dentry for this file. This should be a | |
1161 | * directory dentry if set. If this parameter is %NULL, then the | |
1162 | * file will be created in the root of the debugfs filesystem. | |
1163 | * @read_fn: function pointer called to print the seq_file content. | |
1164 | */ | |
1165 | struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name, | |
1166 | struct dentry *parent, | |
1167 | int (*read_fn)(struct seq_file *s, | |
1168 | void *data)) | |
1169 | { | |
1170 | struct debugfs_devm_entry *entry; | |
1171 | ||
1172 | if (IS_ERR(parent)) | |
1173 | return ERR_PTR(-ENOENT); | |
1174 | ||
1175 | entry = devm_kzalloc(dev, sizeof(*entry), GFP_KERNEL); | |
1176 | if (!entry) | |
1177 | return ERR_PTR(-ENOMEM); | |
1178 | ||
1179 | entry->read = read_fn; | |
1180 | entry->dev = dev; | |
1181 | ||
1182 | return debugfs_create_file(name, S_IRUGO, parent, entry, | |
1183 | &debugfs_devm_entry_ops); | |
1184 | } | |
1185 | EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile); | |
1186 |