Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * file.c - part of debugfs, a tiny little debug file system | |
3 | * | |
4 | * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com> | |
5 | * Copyright (C) 2004 IBM Inc. | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or | |
8 | * modify it under the terms of the GNU General Public License version | |
9 | * 2 as published by the Free Software Foundation. | |
10 | * | |
11 | * debugfs is for people to use instead of /proc or /sys. | |
883ce42e | 12 | * See Documentation/DocBook/filesystems for more details. |
1da177e4 LT |
13 | * |
14 | */ | |
15 | ||
1da177e4 LT |
16 | #include <linux/module.h> |
17 | #include <linux/fs.h> | |
1a087c6a | 18 | #include <linux/seq_file.h> |
1da177e4 | 19 | #include <linux/pagemap.h> |
66f54963 | 20 | #include <linux/namei.h> |
1da177e4 | 21 | #include <linux/debugfs.h> |
03e099fb | 22 | #include <linux/io.h> |
9fe2a701 | 23 | #include <linux/slab.h> |
3a76e5e0 | 24 | #include <linux/atomic.h> |
1da177e4 LT |
25 | |
26 | static ssize_t default_read_file(struct file *file, char __user *buf, | |
27 | size_t count, loff_t *ppos) | |
28 | { | |
29 | return 0; | |
30 | } | |
31 | ||
32 | static ssize_t default_write_file(struct file *file, const char __user *buf, | |
33 | size_t count, loff_t *ppos) | |
34 | { | |
35 | return count; | |
36 | } | |
37 | ||
4b6f5d20 | 38 | const struct file_operations debugfs_file_operations = { |
1da177e4 LT |
39 | .read = default_read_file, |
40 | .write = default_write_file, | |
234e3405 | 41 | .open = simple_open, |
6038f373 | 42 | .llseek = noop_llseek, |
1da177e4 LT |
43 | }; |
44 | ||
66f54963 PO |
45 | static void *debugfs_follow_link(struct dentry *dentry, struct nameidata *nd) |
46 | { | |
47 | nd_set_link(nd, dentry->d_inode->i_private); | |
48 | return NULL; | |
49 | } | |
50 | ||
51 | const struct inode_operations debugfs_link_operations = { | |
52 | .readlink = generic_readlink, | |
53 | .follow_link = debugfs_follow_link, | |
54 | }; | |
55 | ||
8b88b099 | 56 | static int debugfs_u8_set(void *data, u64 val) |
acaefc25 AB |
57 | { |
58 | *(u8 *)data = val; | |
8b88b099 | 59 | return 0; |
acaefc25 | 60 | } |
8b88b099 | 61 | static int debugfs_u8_get(void *data, u64 *val) |
acaefc25 | 62 | { |
8b88b099 CH |
63 | *val = *(u8 *)data; |
64 | return 0; | |
acaefc25 AB |
65 | } |
66 | DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n"); | |
e4792aa3 RG |
67 | DEFINE_SIMPLE_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n"); |
68 | DEFINE_SIMPLE_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n"); | |
1da177e4 LT |
69 | |
70 | /** | |
6468b3af | 71 | * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value |
1da177e4 LT |
72 | * @name: a pointer to a string containing the name of the file to create. |
73 | * @mode: the permission that the file should have | |
74 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 75 | * directory dentry if set. If this parameter is %NULL, then the |
1da177e4 LT |
76 | * file will be created in the root of the debugfs filesystem. |
77 | * @value: a pointer to the variable that the file should read to and write | |
78 | * from. | |
79 | * | |
80 | * This function creates a file in debugfs with the given name that | |
81 | * contains the value of the variable @value. If the @mode variable is so | |
82 | * set, it can be read from, and written to. | |
83 | * | |
84 | * This function will return a pointer to a dentry if it succeeds. This | |
85 | * pointer must be passed to the debugfs_remove() function when the file is | |
86 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 87 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 88 | * |
6468b3af | 89 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
1da177e4 | 90 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 91 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
1da177e4 LT |
92 | * code. |
93 | */ | |
f4ae40a6 | 94 | struct dentry *debugfs_create_u8(const char *name, umode_t mode, |
1da177e4 LT |
95 | struct dentry *parent, u8 *value) |
96 | { | |
e4792aa3 RG |
97 | /* if there are no write bits set, make read only */ |
98 | if (!(mode & S_IWUGO)) | |
99 | return debugfs_create_file(name, mode, parent, value, &fops_u8_ro); | |
100 | /* if there are no read bits set, make write only */ | |
101 | if (!(mode & S_IRUGO)) | |
102 | return debugfs_create_file(name, mode, parent, value, &fops_u8_wo); | |
103 | ||
1da177e4 LT |
104 | return debugfs_create_file(name, mode, parent, value, &fops_u8); |
105 | } | |
106 | EXPORT_SYMBOL_GPL(debugfs_create_u8); | |
107 | ||
8b88b099 | 108 | static int debugfs_u16_set(void *data, u64 val) |
acaefc25 AB |
109 | { |
110 | *(u16 *)data = val; | |
8b88b099 | 111 | return 0; |
acaefc25 | 112 | } |
8b88b099 | 113 | static int debugfs_u16_get(void *data, u64 *val) |
acaefc25 | 114 | { |
8b88b099 CH |
115 | *val = *(u16 *)data; |
116 | return 0; | |
acaefc25 AB |
117 | } |
118 | DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n"); | |
e4792aa3 RG |
119 | DEFINE_SIMPLE_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n"); |
120 | DEFINE_SIMPLE_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n"); | |
acaefc25 | 121 | |
1da177e4 | 122 | /** |
6468b3af | 123 | * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value |
1da177e4 LT |
124 | * @name: a pointer to a string containing the name of the file to create. |
125 | * @mode: the permission that the file should have | |
126 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 127 | * directory dentry if set. If this parameter is %NULL, then the |
1da177e4 LT |
128 | * file will be created in the root of the debugfs filesystem. |
129 | * @value: a pointer to the variable that the file should read to and write | |
130 | * from. | |
131 | * | |
132 | * This function creates a file in debugfs with the given name that | |
133 | * contains the value of the variable @value. If the @mode variable is so | |
134 | * set, it can be read from, and written to. | |
135 | * | |
136 | * This function will return a pointer to a dentry if it succeeds. This | |
137 | * pointer must be passed to the debugfs_remove() function when the file is | |
138 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 139 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 140 | * |
6468b3af | 141 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
1da177e4 | 142 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 143 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
1da177e4 LT |
144 | * code. |
145 | */ | |
f4ae40a6 | 146 | struct dentry *debugfs_create_u16(const char *name, umode_t mode, |
1da177e4 LT |
147 | struct dentry *parent, u16 *value) |
148 | { | |
e4792aa3 RG |
149 | /* if there are no write bits set, make read only */ |
150 | if (!(mode & S_IWUGO)) | |
151 | return debugfs_create_file(name, mode, parent, value, &fops_u16_ro); | |
152 | /* if there are no read bits set, make write only */ | |
153 | if (!(mode & S_IRUGO)) | |
154 | return debugfs_create_file(name, mode, parent, value, &fops_u16_wo); | |
155 | ||
1da177e4 LT |
156 | return debugfs_create_file(name, mode, parent, value, &fops_u16); |
157 | } | |
158 | EXPORT_SYMBOL_GPL(debugfs_create_u16); | |
159 | ||
8b88b099 | 160 | static int debugfs_u32_set(void *data, u64 val) |
acaefc25 AB |
161 | { |
162 | *(u32 *)data = val; | |
8b88b099 | 163 | return 0; |
acaefc25 | 164 | } |
8b88b099 | 165 | static int debugfs_u32_get(void *data, u64 *val) |
acaefc25 | 166 | { |
8b88b099 CH |
167 | *val = *(u32 *)data; |
168 | return 0; | |
acaefc25 AB |
169 | } |
170 | DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n"); | |
e4792aa3 RG |
171 | DEFINE_SIMPLE_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n"); |
172 | DEFINE_SIMPLE_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n"); | |
acaefc25 | 173 | |
1da177e4 | 174 | /** |
6468b3af | 175 | * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value |
1da177e4 LT |
176 | * @name: a pointer to a string containing the name of the file to create. |
177 | * @mode: the permission that the file should have | |
178 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 179 | * directory dentry if set. If this parameter is %NULL, then the |
1da177e4 LT |
180 | * file will be created in the root of the debugfs filesystem. |
181 | * @value: a pointer to the variable that the file should read to and write | |
182 | * from. | |
183 | * | |
184 | * This function creates a file in debugfs with the given name that | |
185 | * contains the value of the variable @value. If the @mode variable is so | |
186 | * set, it can be read from, and written to. | |
187 | * | |
188 | * This function will return a pointer to a dentry if it succeeds. This | |
189 | * pointer must be passed to the debugfs_remove() function when the file is | |
190 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 191 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 192 | * |
6468b3af | 193 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
1da177e4 | 194 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 195 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
1da177e4 LT |
196 | * code. |
197 | */ | |
f4ae40a6 | 198 | struct dentry *debugfs_create_u32(const char *name, umode_t mode, |
1da177e4 LT |
199 | struct dentry *parent, u32 *value) |
200 | { | |
e4792aa3 RG |
201 | /* if there are no write bits set, make read only */ |
202 | if (!(mode & S_IWUGO)) | |
203 | return debugfs_create_file(name, mode, parent, value, &fops_u32_ro); | |
204 | /* if there are no read bits set, make write only */ | |
205 | if (!(mode & S_IRUGO)) | |
206 | return debugfs_create_file(name, mode, parent, value, &fops_u32_wo); | |
207 | ||
1da177e4 LT |
208 | return debugfs_create_file(name, mode, parent, value, &fops_u32); |
209 | } | |
210 | EXPORT_SYMBOL_GPL(debugfs_create_u32); | |
211 | ||
8b88b099 | 212 | static int debugfs_u64_set(void *data, u64 val) |
8447891f ME |
213 | { |
214 | *(u64 *)data = val; | |
8b88b099 | 215 | return 0; |
8447891f ME |
216 | } |
217 | ||
8b88b099 | 218 | static int debugfs_u64_get(void *data, u64 *val) |
8447891f | 219 | { |
8b88b099 CH |
220 | *val = *(u64 *)data; |
221 | return 0; | |
8447891f ME |
222 | } |
223 | DEFINE_SIMPLE_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n"); | |
e4792aa3 RG |
224 | DEFINE_SIMPLE_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n"); |
225 | DEFINE_SIMPLE_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n"); | |
8447891f ME |
226 | |
227 | /** | |
228 | * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value | |
229 | * @name: a pointer to a string containing the name of the file to create. | |
230 | * @mode: the permission that the file should have | |
231 | * @parent: a pointer to the parent dentry for this file. This should be a | |
232 | * directory dentry if set. If this parameter is %NULL, then the | |
233 | * file will be created in the root of the debugfs filesystem. | |
234 | * @value: a pointer to the variable that the file should read to and write | |
235 | * from. | |
236 | * | |
237 | * This function creates a file in debugfs with the given name that | |
238 | * contains the value of the variable @value. If the @mode variable is so | |
239 | * set, it can be read from, and written to. | |
240 | * | |
241 | * This function will return a pointer to a dentry if it succeeds. This | |
242 | * pointer must be passed to the debugfs_remove() function when the file is | |
243 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
244 | * you are responsible here.) If an error occurs, %NULL will be returned. | |
245 | * | |
246 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be | |
247 | * returned. It is not wise to check for this value, but rather, check for | |
248 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling | |
249 | * code. | |
250 | */ | |
f4ae40a6 | 251 | struct dentry *debugfs_create_u64(const char *name, umode_t mode, |
8447891f ME |
252 | struct dentry *parent, u64 *value) |
253 | { | |
e4792aa3 RG |
254 | /* if there are no write bits set, make read only */ |
255 | if (!(mode & S_IWUGO)) | |
256 | return debugfs_create_file(name, mode, parent, value, &fops_u64_ro); | |
257 | /* if there are no read bits set, make write only */ | |
258 | if (!(mode & S_IRUGO)) | |
259 | return debugfs_create_file(name, mode, parent, value, &fops_u64_wo); | |
260 | ||
8447891f ME |
261 | return debugfs_create_file(name, mode, parent, value, &fops_u64); |
262 | } | |
263 | EXPORT_SYMBOL_GPL(debugfs_create_u64); | |
264 | ||
2ebefc50 | 265 | DEFINE_SIMPLE_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n"); |
e4792aa3 RG |
266 | DEFINE_SIMPLE_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n"); |
267 | DEFINE_SIMPLE_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n"); | |
2ebefc50 RG |
268 | |
269 | DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n"); | |
e4792aa3 RG |
270 | DEFINE_SIMPLE_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n"); |
271 | DEFINE_SIMPLE_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n"); | |
2ebefc50 RG |
272 | |
273 | DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n"); | |
e4792aa3 RG |
274 | DEFINE_SIMPLE_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n"); |
275 | DEFINE_SIMPLE_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n"); | |
2ebefc50 | 276 | |
15b0beaa HY |
277 | DEFINE_SIMPLE_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n"); |
278 | ||
e6716b87 | 279 | /* |
15b0beaa | 280 | * 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 | 281 | * |
e6716b87 RD |
282 | * These functions are exactly the same as the above functions (but use a hex |
283 | * output for the decimal challenged). For details look at the above unsigned | |
2ebefc50 RG |
284 | * decimal functions. |
285 | */ | |
e6716b87 RD |
286 | |
287 | /** | |
288 | * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value | |
289 | * @name: a pointer to a string containing the name of the file to create. | |
290 | * @mode: the permission that the file should have | |
291 | * @parent: a pointer to the parent dentry for this file. This should be a | |
292 | * directory dentry if set. If this parameter is %NULL, then the | |
293 | * file will be created in the root of the debugfs filesystem. | |
294 | * @value: a pointer to the variable that the file should read to and write | |
295 | * from. | |
296 | */ | |
f4ae40a6 | 297 | struct dentry *debugfs_create_x8(const char *name, umode_t mode, |
2ebefc50 RG |
298 | struct dentry *parent, u8 *value) |
299 | { | |
e4792aa3 RG |
300 | /* if there are no write bits set, make read only */ |
301 | if (!(mode & S_IWUGO)) | |
302 | return debugfs_create_file(name, mode, parent, value, &fops_x8_ro); | |
303 | /* if there are no read bits set, make write only */ | |
304 | if (!(mode & S_IRUGO)) | |
305 | return debugfs_create_file(name, mode, parent, value, &fops_x8_wo); | |
306 | ||
2ebefc50 RG |
307 | return debugfs_create_file(name, mode, parent, value, &fops_x8); |
308 | } | |
309 | EXPORT_SYMBOL_GPL(debugfs_create_x8); | |
310 | ||
e6716b87 RD |
311 | /** |
312 | * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value | |
313 | * @name: a pointer to a string containing the name of the file to create. | |
314 | * @mode: the permission that the file should have | |
315 | * @parent: a pointer to the parent dentry for this file. This should be a | |
316 | * directory dentry if set. If this parameter is %NULL, then the | |
317 | * file will be created in the root of the debugfs filesystem. | |
318 | * @value: a pointer to the variable that the file should read to and write | |
319 | * from. | |
320 | */ | |
f4ae40a6 | 321 | struct dentry *debugfs_create_x16(const char *name, umode_t mode, |
2ebefc50 RG |
322 | struct dentry *parent, u16 *value) |
323 | { | |
e4792aa3 RG |
324 | /* if there are no write bits set, make read only */ |
325 | if (!(mode & S_IWUGO)) | |
326 | return debugfs_create_file(name, mode, parent, value, &fops_x16_ro); | |
327 | /* if there are no read bits set, make write only */ | |
328 | if (!(mode & S_IRUGO)) | |
329 | return debugfs_create_file(name, mode, parent, value, &fops_x16_wo); | |
330 | ||
2ebefc50 RG |
331 | return debugfs_create_file(name, mode, parent, value, &fops_x16); |
332 | } | |
333 | EXPORT_SYMBOL_GPL(debugfs_create_x16); | |
334 | ||
e6716b87 RD |
335 | /** |
336 | * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value | |
337 | * @name: a pointer to a string containing the name of the file to create. | |
338 | * @mode: the permission that the file should have | |
339 | * @parent: a pointer to the parent dentry for this file. This should be a | |
340 | * directory dentry if set. If this parameter is %NULL, then the | |
341 | * file will be created in the root of the debugfs filesystem. | |
342 | * @value: a pointer to the variable that the file should read to and write | |
343 | * from. | |
344 | */ | |
f4ae40a6 | 345 | struct dentry *debugfs_create_x32(const char *name, umode_t mode, |
2ebefc50 RG |
346 | struct dentry *parent, u32 *value) |
347 | { | |
e4792aa3 RG |
348 | /* if there are no write bits set, make read only */ |
349 | if (!(mode & S_IWUGO)) | |
350 | return debugfs_create_file(name, mode, parent, value, &fops_x32_ro); | |
351 | /* if there are no read bits set, make write only */ | |
352 | if (!(mode & S_IRUGO)) | |
353 | return debugfs_create_file(name, mode, parent, value, &fops_x32_wo); | |
354 | ||
2ebefc50 RG |
355 | return debugfs_create_file(name, mode, parent, value, &fops_x32); |
356 | } | |
357 | EXPORT_SYMBOL_GPL(debugfs_create_x32); | |
358 | ||
15b0beaa HY |
359 | /** |
360 | * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value | |
361 | * @name: a pointer to a string containing the name of the file to create. | |
362 | * @mode: the permission that the file should have | |
363 | * @parent: a pointer to the parent dentry for this file. This should be a | |
364 | * directory dentry if set. If this parameter is %NULL, then the | |
365 | * file will be created in the root of the debugfs filesystem. | |
366 | * @value: a pointer to the variable that the file should read to and write | |
367 | * from. | |
368 | */ | |
f4ae40a6 | 369 | struct dentry *debugfs_create_x64(const char *name, umode_t mode, |
15b0beaa HY |
370 | struct dentry *parent, u64 *value) |
371 | { | |
372 | return debugfs_create_file(name, mode, parent, value, &fops_x64); | |
373 | } | |
374 | EXPORT_SYMBOL_GPL(debugfs_create_x64); | |
375 | ||
5e078787 IPG |
376 | |
377 | static int debugfs_size_t_set(void *data, u64 val) | |
378 | { | |
379 | *(size_t *)data = val; | |
380 | return 0; | |
381 | } | |
382 | static int debugfs_size_t_get(void *data, u64 *val) | |
383 | { | |
384 | *val = *(size_t *)data; | |
385 | return 0; | |
386 | } | |
387 | DEFINE_SIMPLE_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set, | |
388 | "%llu\n"); /* %llu and %zu are more or less the same */ | |
389 | ||
390 | /** | |
391 | * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value | |
392 | * @name: a pointer to a string containing the name of the file to create. | |
393 | * @mode: the permission that the file should have | |
394 | * @parent: a pointer to the parent dentry for this file. This should be a | |
395 | * directory dentry if set. If this parameter is %NULL, then the | |
396 | * file will be created in the root of the debugfs filesystem. | |
397 | * @value: a pointer to the variable that the file should read to and write | |
398 | * from. | |
399 | */ | |
f4ae40a6 | 400 | struct dentry *debugfs_create_size_t(const char *name, umode_t mode, |
5e078787 IPG |
401 | struct dentry *parent, size_t *value) |
402 | { | |
403 | return debugfs_create_file(name, mode, parent, value, &fops_size_t); | |
404 | } | |
405 | EXPORT_SYMBOL_GPL(debugfs_create_size_t); | |
406 | ||
3a76e5e0 SJ |
407 | static int debugfs_atomic_t_set(void *data, u64 val) |
408 | { | |
409 | atomic_set((atomic_t *)data, val); | |
410 | return 0; | |
411 | } | |
412 | static int debugfs_atomic_t_get(void *data, u64 *val) | |
413 | { | |
414 | *val = atomic_read((atomic_t *)data); | |
415 | return 0; | |
416 | } | |
417 | DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get, | |
418 | debugfs_atomic_t_set, "%lld\n"); | |
419 | DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL, "%lld\n"); | |
420 | DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set, "%lld\n"); | |
421 | ||
422 | /** | |
423 | * debugfs_create_atomic_t - create a debugfs file that is used to read and | |
424 | * write an atomic_t value | |
425 | * @name: a pointer to a string containing the name of the file to create. | |
426 | * @mode: the permission that the file should have | |
427 | * @parent: a pointer to the parent dentry for this file. This should be a | |
428 | * directory dentry if set. If this parameter is %NULL, then the | |
429 | * file will be created in the root of the debugfs filesystem. | |
430 | * @value: a pointer to the variable that the file should read to and write | |
431 | * from. | |
432 | */ | |
433 | struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, | |
434 | struct dentry *parent, atomic_t *value) | |
435 | { | |
436 | /* if there are no write bits set, make read only */ | |
437 | if (!(mode & S_IWUGO)) | |
438 | return debugfs_create_file(name, mode, parent, value, | |
439 | &fops_atomic_t_ro); | |
440 | /* if there are no read bits set, make write only */ | |
441 | if (!(mode & S_IRUGO)) | |
442 | return debugfs_create_file(name, mode, parent, value, | |
443 | &fops_atomic_t_wo); | |
444 | ||
445 | return debugfs_create_file(name, mode, parent, value, &fops_atomic_t); | |
446 | } | |
447 | EXPORT_SYMBOL_GPL(debugfs_create_atomic_t); | |
5e078787 | 448 | |
1da177e4 LT |
449 | static ssize_t read_file_bool(struct file *file, char __user *user_buf, |
450 | size_t count, loff_t *ppos) | |
451 | { | |
452 | char buf[3]; | |
453 | u32 *val = file->private_data; | |
454 | ||
455 | if (*val) | |
456 | buf[0] = 'Y'; | |
457 | else | |
458 | buf[0] = 'N'; | |
459 | buf[1] = '\n'; | |
460 | buf[2] = 0x00; | |
461 | return simple_read_from_buffer(user_buf, count, ppos, buf, 2); | |
462 | } | |
463 | ||
464 | static ssize_t write_file_bool(struct file *file, const char __user *user_buf, | |
465 | size_t count, loff_t *ppos) | |
466 | { | |
467 | char buf[32]; | |
c42d2237 | 468 | size_t buf_size; |
8705b48e | 469 | bool bv; |
1da177e4 LT |
470 | u32 *val = file->private_data; |
471 | ||
472 | buf_size = min(count, (sizeof(buf)-1)); | |
473 | if (copy_from_user(buf, user_buf, buf_size)) | |
474 | return -EFAULT; | |
475 | ||
8705b48e JC |
476 | if (strtobool(buf, &bv) == 0) |
477 | *val = bv; | |
478 | ||
1da177e4 LT |
479 | return count; |
480 | } | |
481 | ||
4b6f5d20 | 482 | static const struct file_operations fops_bool = { |
1da177e4 LT |
483 | .read = read_file_bool, |
484 | .write = write_file_bool, | |
234e3405 | 485 | .open = simple_open, |
6038f373 | 486 | .llseek = default_llseek, |
1da177e4 LT |
487 | }; |
488 | ||
489 | /** | |
6468b3af | 490 | * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value |
1da177e4 LT |
491 | * @name: a pointer to a string containing the name of the file to create. |
492 | * @mode: the permission that the file should have | |
493 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 494 | * directory dentry if set. If this parameter is %NULL, then the |
1da177e4 LT |
495 | * file will be created in the root of the debugfs filesystem. |
496 | * @value: a pointer to the variable that the file should read to and write | |
497 | * from. | |
498 | * | |
499 | * This function creates a file in debugfs with the given name that | |
500 | * contains the value of the variable @value. If the @mode variable is so | |
501 | * set, it can be read from, and written to. | |
502 | * | |
503 | * This function will return a pointer to a dentry if it succeeds. This | |
504 | * pointer must be passed to the debugfs_remove() function when the file is | |
505 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 506 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 507 | * |
6468b3af | 508 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
1da177e4 | 509 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 510 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
1da177e4 LT |
511 | * code. |
512 | */ | |
f4ae40a6 | 513 | struct dentry *debugfs_create_bool(const char *name, umode_t mode, |
1da177e4 LT |
514 | struct dentry *parent, u32 *value) |
515 | { | |
516 | return debugfs_create_file(name, mode, parent, value, &fops_bool); | |
517 | } | |
518 | EXPORT_SYMBOL_GPL(debugfs_create_bool); | |
519 | ||
dd308bc3 ME |
520 | static ssize_t read_file_blob(struct file *file, char __user *user_buf, |
521 | size_t count, loff_t *ppos) | |
522 | { | |
523 | struct debugfs_blob_wrapper *blob = file->private_data; | |
524 | return simple_read_from_buffer(user_buf, count, ppos, blob->data, | |
525 | blob->size); | |
526 | } | |
527 | ||
00977a59 | 528 | static const struct file_operations fops_blob = { |
dd308bc3 | 529 | .read = read_file_blob, |
234e3405 | 530 | .open = simple_open, |
6038f373 | 531 | .llseek = default_llseek, |
dd308bc3 ME |
532 | }; |
533 | ||
534 | /** | |
400ced61 | 535 | * debugfs_create_blob - create a debugfs file that is used to read a binary blob |
dd308bc3 ME |
536 | * @name: a pointer to a string containing the name of the file to create. |
537 | * @mode: the permission that the file should have | |
538 | * @parent: a pointer to the parent dentry for this file. This should be a | |
6468b3af | 539 | * directory dentry if set. If this parameter is %NULL, then the |
dd308bc3 ME |
540 | * file will be created in the root of the debugfs filesystem. |
541 | * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer | |
542 | * to the blob data and the size of the data. | |
543 | * | |
544 | * This function creates a file in debugfs with the given name that exports | |
545 | * @blob->data as a binary blob. If the @mode variable is so set it can be | |
546 | * read from. Writing is not supported. | |
547 | * | |
548 | * This function will return a pointer to a dentry if it succeeds. This | |
549 | * pointer must be passed to the debugfs_remove() function when the file is | |
550 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 551 | * you are responsible here.) If an error occurs, %NULL will be returned. |
dd308bc3 | 552 | * |
6468b3af | 553 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
dd308bc3 | 554 | * returned. It is not wise to check for this value, but rather, check for |
6468b3af | 555 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
dd308bc3 ME |
556 | * code. |
557 | */ | |
f4ae40a6 | 558 | struct dentry *debugfs_create_blob(const char *name, umode_t mode, |
dd308bc3 ME |
559 | struct dentry *parent, |
560 | struct debugfs_blob_wrapper *blob) | |
561 | { | |
562 | return debugfs_create_file(name, mode, parent, blob, &fops_blob); | |
563 | } | |
564 | EXPORT_SYMBOL_GPL(debugfs_create_blob); | |
1a087c6a | 565 | |
9fe2a701 SV |
566 | struct array_data { |
567 | void *array; | |
568 | u32 elements; | |
569 | }; | |
570 | ||
e05e279e LT |
571 | static size_t u32_format_array(char *buf, size_t bufsize, |
572 | u32 *array, int array_size) | |
9fe2a701 SV |
573 | { |
574 | size_t ret = 0; | |
9fe2a701 | 575 | |
e05e279e | 576 | while (--array_size >= 0) { |
9fe2a701 | 577 | size_t len; |
e05e279e | 578 | char term = array_size ? ' ' : '\n'; |
9fe2a701 | 579 | |
e05e279e | 580 | len = snprintf(buf, bufsize, "%u%c", *array++, term); |
9fe2a701 SV |
581 | ret += len; |
582 | ||
e05e279e LT |
583 | buf += len; |
584 | bufsize -= len; | |
9fe2a701 | 585 | } |
9fe2a701 SV |
586 | return ret; |
587 | } | |
588 | ||
36048853 | 589 | static int u32_array_open(struct inode *inode, struct file *file) |
9fe2a701 | 590 | { |
9fe2a701 | 591 | struct array_data *data = inode->i_private; |
e05e279e LT |
592 | int size, elements = data->elements; |
593 | char *buf; | |
594 | ||
595 | /* | |
596 | * Max size: | |
597 | * - 10 digits + ' '/'\n' = 11 bytes per number | |
598 | * - terminating NUL character | |
599 | */ | |
600 | size = elements*11; | |
601 | buf = kmalloc(size+1, GFP_KERNEL); | |
602 | if (!buf) | |
36048853 | 603 | return -ENOMEM; |
e05e279e LT |
604 | buf[size] = 0; |
605 | ||
606 | file->private_data = buf; | |
607 | u32_format_array(buf, size, data->array, data->elements); | |
608 | ||
36048853 DR |
609 | return nonseekable_open(inode, file); |
610 | } | |
9fe2a701 | 611 | |
36048853 DR |
612 | static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len, |
613 | loff_t *ppos) | |
614 | { | |
615 | size_t size = strlen(file->private_data); | |
9fe2a701 SV |
616 | |
617 | return simple_read_from_buffer(buf, len, ppos, | |
618 | file->private_data, size); | |
619 | } | |
620 | ||
621 | static int u32_array_release(struct inode *inode, struct file *file) | |
622 | { | |
623 | kfree(file->private_data); | |
624 | ||
625 | return 0; | |
626 | } | |
627 | ||
628 | static const struct file_operations u32_array_fops = { | |
629 | .owner = THIS_MODULE, | |
630 | .open = u32_array_open, | |
631 | .release = u32_array_release, | |
632 | .read = u32_array_read, | |
633 | .llseek = no_llseek, | |
634 | }; | |
635 | ||
636 | /** | |
637 | * debugfs_create_u32_array - create a debugfs file that is used to read u32 | |
638 | * array. | |
639 | * @name: a pointer to a string containing the name of the file to create. | |
640 | * @mode: the permission that the file should have. | |
641 | * @parent: a pointer to the parent dentry for this file. This should be a | |
642 | * directory dentry if set. If this parameter is %NULL, then the | |
643 | * file will be created in the root of the debugfs filesystem. | |
644 | * @array: u32 array that provides data. | |
645 | * @elements: total number of elements in the array. | |
646 | * | |
647 | * This function creates a file in debugfs with the given name that exports | |
648 | * @array as data. If the @mode variable is so set it can be read from. | |
649 | * Writing is not supported. Seek within the file is also not supported. | |
650 | * Once array is created its size can not be changed. | |
651 | * | |
652 | * The function returns a pointer to dentry on success. If debugfs is not | |
653 | * enabled in the kernel, the value -%ENODEV will be returned. | |
654 | */ | |
655 | struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, | |
656 | struct dentry *parent, | |
657 | u32 *array, u32 elements) | |
658 | { | |
659 | struct array_data *data = kmalloc(sizeof(*data), GFP_KERNEL); | |
660 | ||
661 | if (data == NULL) | |
662 | return NULL; | |
663 | ||
664 | data->array = array; | |
665 | data->elements = elements; | |
666 | ||
667 | return debugfs_create_file(name, mode, parent, data, &u32_array_fops); | |
668 | } | |
669 | EXPORT_SYMBOL_GPL(debugfs_create_u32_array); | |
670 | ||
3b85e4ab HC |
671 | #ifdef CONFIG_HAS_IOMEM |
672 | ||
1a087c6a AR |
673 | /* |
674 | * The regset32 stuff is used to print 32-bit registers using the | |
675 | * seq_file utilities. We offer printing a register set in an already-opened | |
676 | * sequential file or create a debugfs file that only prints a regset32. | |
677 | */ | |
678 | ||
679 | /** | |
680 | * debugfs_print_regs32 - use seq_print to describe a set of registers | |
681 | * @s: the seq_file structure being used to generate output | |
682 | * @regs: an array if struct debugfs_reg32 structures | |
b5763acc | 683 | * @nregs: the length of the above array |
1a087c6a AR |
684 | * @base: the base address to be used in reading the registers |
685 | * @prefix: a string to be prefixed to every output line | |
686 | * | |
687 | * This function outputs a text block describing the current values of | |
688 | * some 32-bit hardware registers. It is meant to be used within debugfs | |
689 | * files based on seq_file that need to show registers, intermixed with other | |
690 | * information. The prefix argument may be used to specify a leading string, | |
691 | * because some peripherals have several blocks of identical registers, | |
692 | * for example configuration of dma channels | |
693 | */ | |
8ee4dd9f | 694 | int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, |
1a087c6a AR |
695 | int nregs, void __iomem *base, char *prefix) |
696 | { | |
697 | int i, ret = 0; | |
698 | ||
699 | for (i = 0; i < nregs; i++, regs++) { | |
700 | if (prefix) | |
701 | ret += seq_printf(s, "%s", prefix); | |
702 | ret += seq_printf(s, "%s = 0x%08x\n", regs->name, | |
5858441c | 703 | readl(base + regs->offset)); |
1a087c6a AR |
704 | } |
705 | return ret; | |
706 | } | |
707 | EXPORT_SYMBOL_GPL(debugfs_print_regs32); | |
708 | ||
709 | static int debugfs_show_regset32(struct seq_file *s, void *data) | |
710 | { | |
711 | struct debugfs_regset32 *regset = s->private; | |
712 | ||
713 | debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, ""); | |
714 | return 0; | |
715 | } | |
716 | ||
717 | static int debugfs_open_regset32(struct inode *inode, struct file *file) | |
718 | { | |
719 | return single_open(file, debugfs_show_regset32, inode->i_private); | |
720 | } | |
721 | ||
722 | static const struct file_operations fops_regset32 = { | |
723 | .open = debugfs_open_regset32, | |
724 | .read = seq_read, | |
725 | .llseek = seq_lseek, | |
726 | .release = single_release, | |
727 | }; | |
728 | ||
729 | /** | |
730 | * debugfs_create_regset32 - create a debugfs file that returns register values | |
731 | * @name: a pointer to a string containing the name of the file to create. | |
732 | * @mode: the permission that the file should have | |
733 | * @parent: a pointer to the parent dentry for this file. This should be a | |
734 | * directory dentry if set. If this parameter is %NULL, then the | |
735 | * file will be created in the root of the debugfs filesystem. | |
736 | * @regset: a pointer to a struct debugfs_regset32, which contains a pointer | |
737 | * to an array of register definitions, the array size and the base | |
738 | * address where the register bank is to be found. | |
739 | * | |
740 | * This function creates a file in debugfs with the given name that reports | |
741 | * the names and values of a set of 32-bit registers. If the @mode variable | |
742 | * is so set it can be read from. Writing is not supported. | |
743 | * | |
744 | * This function will return a pointer to a dentry if it succeeds. This | |
745 | * pointer must be passed to the debugfs_remove() function when the file is | |
746 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
747 | * you are responsible here.) If an error occurs, %NULL will be returned. | |
748 | * | |
749 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be | |
750 | * returned. It is not wise to check for this value, but rather, check for | |
751 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling | |
752 | * code. | |
753 | */ | |
88187398 | 754 | struct dentry *debugfs_create_regset32(const char *name, umode_t mode, |
1a087c6a AR |
755 | struct dentry *parent, |
756 | struct debugfs_regset32 *regset) | |
757 | { | |
758 | return debugfs_create_file(name, mode, parent, regset, &fops_regset32); | |
759 | } | |
760 | EXPORT_SYMBOL_GPL(debugfs_create_regset32); | |
3b85e4ab HC |
761 | |
762 | #endif /* CONFIG_HAS_IOMEM */ |