diff options
Diffstat (limited to 'fs/debugfs/file.c')
-rw-r--r-- | fs/debugfs/file.c | 56 |
1 files changed, 25 insertions, 31 deletions
diff --git a/fs/debugfs/file.c b/fs/debugfs/file.c index 39640fd03458..e4b430552c88 100644 --- a/fs/debugfs/file.c +++ b/fs/debugfs/file.c | |||
@@ -55,12 +55,11 @@ static u64 debugfs_u8_get(void *data) | |||
55 | DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n"); | 55 | DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n"); |
56 | 56 | ||
57 | /** | 57 | /** |
58 | * debugfs_create_u8 - create a file in the debugfs filesystem that is used to read and write an unsigned 8 bit value. | 58 | * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value |
59 | * | ||
60 | * @name: a pointer to a string containing the name of the file to create. | 59 | * @name: a pointer to a string containing the name of the file to create. |
61 | * @mode: the permission that the file should have | 60 | * @mode: the permission that the file should have |
62 | * @parent: a pointer to the parent dentry for this file. This should be a | 61 | * @parent: a pointer to the parent dentry for this file. This should be a |
63 | * directory dentry if set. If this paramater is NULL, then the | 62 | * directory dentry if set. If this parameter is %NULL, then the |
64 | * file will be created in the root of the debugfs filesystem. | 63 | * file will be created in the root of the debugfs filesystem. |
65 | * @value: a pointer to the variable that the file should read to and write | 64 | * @value: a pointer to the variable that the file should read to and write |
66 | * from. | 65 | * from. |
@@ -72,11 +71,11 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n"); | |||
72 | * This function will return a pointer to a dentry if it succeeds. This | 71 | * This function will return a pointer to a dentry if it succeeds. This |
73 | * pointer must be passed to the debugfs_remove() function when the file is | 72 | * pointer must be passed to the debugfs_remove() function when the file is |
74 | * to be removed (no automatic cleanup happens if your module is unloaded, | 73 | * to be removed (no automatic cleanup happens if your module is unloaded, |
75 | * you are responsible here.) If an error occurs, NULL will be returned. | 74 | * you are responsible here.) If an error occurs, %NULL will be returned. |
76 | * | 75 | * |
77 | * If debugfs is not enabled in the kernel, the value -ENODEV will be | 76 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
78 | * returned. It is not wise to check for this value, but rather, check for | 77 | * returned. It is not wise to check for this value, but rather, check for |
79 | * NULL or !NULL instead as to eliminate the need for #ifdef in the calling | 78 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
80 | * code. | 79 | * code. |
81 | */ | 80 | */ |
82 | struct dentry *debugfs_create_u8(const char *name, mode_t mode, | 81 | struct dentry *debugfs_create_u8(const char *name, mode_t mode, |
@@ -97,12 +96,11 @@ static u64 debugfs_u16_get(void *data) | |||
97 | DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n"); | 96 | DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n"); |
98 | 97 | ||
99 | /** | 98 | /** |
100 | * debugfs_create_u16 - create a file in the debugfs filesystem that is used to read and write an unsigned 16 bit value. | 99 | * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value |
101 | * | ||
102 | * @name: a pointer to a string containing the name of the file to create. | 100 | * @name: a pointer to a string containing the name of the file to create. |
103 | * @mode: the permission that the file should have | 101 | * @mode: the permission that the file should have |
104 | * @parent: a pointer to the parent dentry for this file. This should be a | 102 | * @parent: a pointer to the parent dentry for this file. This should be a |
105 | * directory dentry if set. If this paramater is NULL, then the | 103 | * directory dentry if set. If this parameter is %NULL, then the |
106 | * file will be created in the root of the debugfs filesystem. | 104 | * file will be created in the root of the debugfs filesystem. |
107 | * @value: a pointer to the variable that the file should read to and write | 105 | * @value: a pointer to the variable that the file should read to and write |
108 | * from. | 106 | * from. |
@@ -114,11 +112,11 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n"); | |||
114 | * This function will return a pointer to a dentry if it succeeds. This | 112 | * This function will return a pointer to a dentry if it succeeds. This |
115 | * pointer must be passed to the debugfs_remove() function when the file is | 113 | * pointer must be passed to the debugfs_remove() function when the file is |
116 | * to be removed (no automatic cleanup happens if your module is unloaded, | 114 | * to be removed (no automatic cleanup happens if your module is unloaded, |
117 | * you are responsible here.) If an error occurs, NULL will be returned. | 115 | * you are responsible here.) If an error occurs, %NULL will be returned. |
118 | * | 116 | * |
119 | * If debugfs is not enabled in the kernel, the value -ENODEV will be | 117 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
120 | * returned. It is not wise to check for this value, but rather, check for | 118 | * returned. It is not wise to check for this value, but rather, check for |
121 | * NULL or !NULL instead as to eliminate the need for #ifdef in the calling | 119 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
122 | * code. | 120 | * code. |
123 | */ | 121 | */ |
124 | struct dentry *debugfs_create_u16(const char *name, mode_t mode, | 122 | struct dentry *debugfs_create_u16(const char *name, mode_t mode, |
@@ -139,12 +137,11 @@ static u64 debugfs_u32_get(void *data) | |||
139 | DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n"); | 137 | DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n"); |
140 | 138 | ||
141 | /** | 139 | /** |
142 | * debugfs_create_u32 - create a file in the debugfs filesystem that is used to read and write an unsigned 32 bit value. | 140 | * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value |
143 | * | ||
144 | * @name: a pointer to a string containing the name of the file to create. | 141 | * @name: a pointer to a string containing the name of the file to create. |
145 | * @mode: the permission that the file should have | 142 | * @mode: the permission that the file should have |
146 | * @parent: a pointer to the parent dentry for this file. This should be a | 143 | * @parent: a pointer to the parent dentry for this file. This should be a |
147 | * directory dentry if set. If this paramater is NULL, then the | 144 | * directory dentry if set. If this parameter is %NULL, then the |
148 | * file will be created in the root of the debugfs filesystem. | 145 | * file will be created in the root of the debugfs filesystem. |
149 | * @value: a pointer to the variable that the file should read to and write | 146 | * @value: a pointer to the variable that the file should read to and write |
150 | * from. | 147 | * from. |
@@ -156,11 +153,11 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n"); | |||
156 | * This function will return a pointer to a dentry if it succeeds. This | 153 | * This function will return a pointer to a dentry if it succeeds. This |
157 | * pointer must be passed to the debugfs_remove() function when the file is | 154 | * pointer must be passed to the debugfs_remove() function when the file is |
158 | * to be removed (no automatic cleanup happens if your module is unloaded, | 155 | * to be removed (no automatic cleanup happens if your module is unloaded, |
159 | * you are responsible here.) If an error occurs, NULL will be returned. | 156 | * you are responsible here.) If an error occurs, %NULL will be returned. |
160 | * | 157 | * |
161 | * If debugfs is not enabled in the kernel, the value -ENODEV will be | 158 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
162 | * returned. It is not wise to check for this value, but rather, check for | 159 | * returned. It is not wise to check for this value, but rather, check for |
163 | * NULL or !NULL instead as to eliminate the need for #ifdef in the calling | 160 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
164 | * code. | 161 | * code. |
165 | */ | 162 | */ |
166 | struct dentry *debugfs_create_u32(const char *name, mode_t mode, | 163 | struct dentry *debugfs_create_u32(const char *name, mode_t mode, |
@@ -219,12 +216,11 @@ static const struct file_operations fops_bool = { | |||
219 | }; | 216 | }; |
220 | 217 | ||
221 | /** | 218 | /** |
222 | * debugfs_create_bool - create a file in the debugfs filesystem that is used to read and write a boolean value. | 219 | * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value |
223 | * | ||
224 | * @name: a pointer to a string containing the name of the file to create. | 220 | * @name: a pointer to a string containing the name of the file to create. |
225 | * @mode: the permission that the file should have | 221 | * @mode: the permission that the file should have |
226 | * @parent: a pointer to the parent dentry for this file. This should be a | 222 | * @parent: a pointer to the parent dentry for this file. This should be a |
227 | * directory dentry if set. If this paramater is NULL, then the | 223 | * directory dentry if set. If this parameter is %NULL, then the |
228 | * file will be created in the root of the debugfs filesystem. | 224 | * file will be created in the root of the debugfs filesystem. |
229 | * @value: a pointer to the variable that the file should read to and write | 225 | * @value: a pointer to the variable that the file should read to and write |
230 | * from. | 226 | * from. |
@@ -236,11 +232,11 @@ static const struct file_operations fops_bool = { | |||
236 | * This function will return a pointer to a dentry if it succeeds. This | 232 | * This function will return a pointer to a dentry if it succeeds. This |
237 | * pointer must be passed to the debugfs_remove() function when the file is | 233 | * pointer must be passed to the debugfs_remove() function when the file is |
238 | * to be removed (no automatic cleanup happens if your module is unloaded, | 234 | * to be removed (no automatic cleanup happens if your module is unloaded, |
239 | * you are responsible here.) If an error occurs, NULL will be returned. | 235 | * you are responsible here.) If an error occurs, %NULL will be returned. |
240 | * | 236 | * |
241 | * If debugfs is not enabled in the kernel, the value -ENODEV will be | 237 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
242 | * returned. It is not wise to check for this value, but rather, check for | 238 | * returned. It is not wise to check for this value, but rather, check for |
243 | * NULL or !NULL instead as to eliminate the need for #ifdef in the calling | 239 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
244 | * code. | 240 | * code. |
245 | */ | 241 | */ |
246 | struct dentry *debugfs_create_bool(const char *name, mode_t mode, | 242 | struct dentry *debugfs_create_bool(const char *name, mode_t mode, |
@@ -264,13 +260,11 @@ static struct file_operations fops_blob = { | |||
264 | }; | 260 | }; |
265 | 261 | ||
266 | /** | 262 | /** |
267 | * debugfs_create_blob - create a file in the debugfs filesystem that is | 263 | * debugfs_create_blob - create a debugfs file that is used to read and write a binary blob |
268 | * used to read and write a binary blob. | ||
269 | * | ||
270 | * @name: a pointer to a string containing the name of the file to create. | 264 | * @name: a pointer to a string containing the name of the file to create. |
271 | * @mode: the permission that the file should have | 265 | * @mode: the permission that the file should have |
272 | * @parent: a pointer to the parent dentry for this file. This should be a | 266 | * @parent: a pointer to the parent dentry for this file. This should be a |
273 | * directory dentry if set. If this paramater is NULL, then the | 267 | * directory dentry if set. If this parameter is %NULL, then the |
274 | * file will be created in the root of the debugfs filesystem. | 268 | * file will be created in the root of the debugfs filesystem. |
275 | * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer | 269 | * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer |
276 | * to the blob data and the size of the data. | 270 | * to the blob data and the size of the data. |
@@ -282,11 +276,11 @@ static struct file_operations fops_blob = { | |||
282 | * This function will return a pointer to a dentry if it succeeds. This | 276 | * This function will return a pointer to a dentry if it succeeds. This |
283 | * pointer must be passed to the debugfs_remove() function when the file is | 277 | * pointer must be passed to the debugfs_remove() function when the file is |
284 | * to be removed (no automatic cleanup happens if your module is unloaded, | 278 | * to be removed (no automatic cleanup happens if your module is unloaded, |
285 | * you are responsible here.) If an error occurs, NULL will be returned. | 279 | * you are responsible here.) If an error occurs, %NULL will be returned. |
286 | * | 280 | * |
287 | * If debugfs is not enabled in the kernel, the value -ENODEV will be | 281 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
288 | * returned. It is not wise to check for this value, but rather, check for | 282 | * returned. It is not wise to check for this value, but rather, check for |
289 | * NULL or !NULL instead as to eliminate the need for #ifdef in the calling | 283 | * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling |
290 | * code. | 284 | * code. |
291 | */ | 285 | */ |
292 | struct dentry *debugfs_create_blob(const char *name, mode_t mode, | 286 | struct dentry *debugfs_create_blob(const char *name, mode_t mode, |