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