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