fs/debugfs/file.c

   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.
  12  *  See Documentation/DocBook/filesystems for more details.
  13  *
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/fs.h>
  18 #include <linux/seq_file.h>
  19 #include <linux/pagemap.h>
  20 #include <linux/debugfs.h>
  21 #include <linux/io.h>
  22 #include <linux/slab.h>
  23 #include <linux/atomic.h>
  24 #include <linux/device.h>
  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
  38 const struct file_operations debugfs_file_operations = {
  39         .read =         default_read_file,
  40         .write =        default_write_file,
  41         .open =         simple_open,
  42         .llseek =       noop_llseek,
  43 };
  44
  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
  61 static int debugfs_u8_set(void *data, u64 val)
  62 {
  63         *(u8 *)data = val;
  64         return 0;
  65 }
  66 static int debugfs_u8_get(void *data, u64 *val)
  67 {
  68         *val = *(u8 *)data;
  69         return 0;
  70 }
  71 DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
  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");
  74
  75 /**
  76  * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
  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
  80  *          directory dentry if set.  If this parameter is %NULL, then the
  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,
  92  * you are responsible here.)  If an error occurs, %NULL will be returned.
  93  *
  94  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
  95  * returned.  It is not wise to check for this value, but rather, check for
  96  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
  97  * code.
  98  */
  99 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
 100                                  struct dentry *parent, u8 *value)
 101 {
 102         return debugfs_create_mode(name, mode, parent, value, &fops_u8,
 103                                    &fops_u8_ro, &fops_u8_wo);
 104 }
 105 EXPORT_SYMBOL_GPL(debugfs_create_u8);
 106
 107 static int debugfs_u16_set(void *data, u64 val)
 108 {
 109         *(u16 *)data = val;
 110         return 0;
 111 }
 112 static int debugfs_u16_get(void *data, u64 *val)
 113 {
 114         *val = *(u16 *)data;
 115         return 0;
 116 }
 117 DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
 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");
 120
 121 /**
 122  * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
 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
 126  *          directory dentry if set.  If this parameter is %NULL, then the
 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,
 138  * you are responsible here.)  If an error occurs, %NULL will be returned.
 139  *
 140  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 141  * returned.  It is not wise to check for this value, but rather, check for
 142  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 143  * code.
 144  */
 145 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
 146                                   struct dentry *parent, u16 *value)
 147 {
 148         return debugfs_create_mode(name, mode, parent, value, &fops_u16,
 149                                    &fops_u16_ro, &fops_u16_wo);
 150 }
 151 EXPORT_SYMBOL_GPL(debugfs_create_u16);
 152
 153 static int debugfs_u32_set(void *data, u64 val)
 154 {
 155         *(u32 *)data = val;
 156         return 0;
 157 }
 158 static int debugfs_u32_get(void *data, u64 *val)
 159 {
 160         *val = *(u32 *)data;
 161         return 0;
 162 }
 163 DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
 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");
 166
 167 /**
 168  * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
 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
 172  *          directory dentry if set.  If this parameter is %NULL, then the
 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,
 184  * you are responsible here.)  If an error occurs, %NULL will be returned.
 185  *
 186  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 187  * returned.  It is not wise to check for this value, but rather, check for
 188  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 189  * code.
 190  */
 191 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
 192                                  struct dentry *parent, u32 *value)
 193 {
 194         return debugfs_create_mode(name, mode, parent, value, &fops_u32,
 195                                    &fops_u32_ro, &fops_u32_wo);
 196 }
 197 EXPORT_SYMBOL_GPL(debugfs_create_u32);
 198
 199 static int debugfs_u64_set(void *data, u64 val)
 200 {
 201         *(u64 *)data = val;
 202         return 0;
 203 }
 204
 205 static int debugfs_u64_get(void *data, u64 *val)
 206 {
 207         *val = *(u64 *)data;
 208         return 0;
 209 }
 210 DEFINE_SIMPLE_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
 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");
 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  */
 238 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
 239                                  struct dentry *parent, u64 *value)
 240 {
 241         return debugfs_create_mode(name, mode, parent, value, &fops_u64,
 242                                    &fops_u64_ro, &fops_u64_wo);
 243 }
 244 EXPORT_SYMBOL_GPL(debugfs_create_u64);
 245
 246 DEFINE_SIMPLE_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
 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");
 249
 250 DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n");
 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");
 253
 254 DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n");
 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");
 257
 258 DEFINE_SIMPLE_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n");
 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");
 261
 262 /*
 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
 264  *
 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
 267  * decimal functions.
 268  */
 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  */
 280 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
 281                                  struct dentry *parent, u8 *value)
 282 {
 283         return debugfs_create_mode(name, mode, parent, value, &fops_x8,
 284                                    &fops_x8_ro, &fops_x8_wo);
 285 }
 286 EXPORT_SYMBOL_GPL(debugfs_create_x8);
 287
 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  */
 298 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
 299                                  struct dentry *parent, u16 *value)
 300 {
 301         return debugfs_create_mode(name, mode, parent, value, &fops_x16,
 302                                    &fops_x16_ro, &fops_x16_wo);
 303 }
 304 EXPORT_SYMBOL_GPL(debugfs_create_x16);
 305
 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  */
 316 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
 317                                  struct dentry *parent, u32 *value)
 318 {
 319         return debugfs_create_mode(name, mode, parent, value, &fops_x32,
 320                                    &fops_x32_ro, &fops_x32_wo);
 321 }
 322 EXPORT_SYMBOL_GPL(debugfs_create_x32);
 323
 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  */
 334 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
 335                                  struct dentry *parent, u64 *value)
 336 {
 337         return debugfs_create_mode(name, mode, parent, value, &fops_x64,
 338                                    &fops_x64_ro, &fops_x64_wo);
 339 }
 340 EXPORT_SYMBOL_GPL(debugfs_create_x64);
 341
 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 */
 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");
 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  */
 368 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
 369                                      struct dentry *parent, size_t *value)
 370 {
 371         return debugfs_create_mode(name, mode, parent, value, &fops_size_t,
 372                                    &fops_size_t_ro, &fops_size_t_wo);
 373 }
 374 EXPORT_SYMBOL_GPL(debugfs_create_size_t);
 375
 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 {
 405         return debugfs_create_mode(name, mode, parent, value, &fops_atomic_t,
 406                                    &fops_atomic_t_ro, &fops_atomic_t_wo);
 407 }
 408 EXPORT_SYMBOL_GPL(debugfs_create_atomic_t);
 409
 410 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
 411                                size_t count, loff_t *ppos)
 412 {
 413         char buf[3];
 414         bool *val = file->private_data;
 415
 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 }
 424 EXPORT_SYMBOL_GPL(debugfs_read_file_bool);
 425
 426 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
 427                                 size_t count, loff_t *ppos)
 428 {
 429         char buf[32];
 430         size_t buf_size;
 431         bool bv;
 432         bool *val = file->private_data;
 433
 434         buf_size = min(count, (sizeof(buf)-1));
 435         if (copy_from_user(buf, user_buf, buf_size))
 436                 return -EFAULT;
 437
 438         buf[buf_size] = '\0';
 439         if (strtobool(buf, &bv) == 0)
 440                 *val = bv;
 441
 442         return count;
 443 }
 444 EXPORT_SYMBOL_GPL(debugfs_write_file_bool);
 445
 446 static const struct file_operations fops_bool = {
 447         .read =         debugfs_read_file_bool,
 448         .write =        debugfs_write_file_bool,
 449         .open =         simple_open,
 450         .llseek =       default_llseek,
 451 };
 452
 453 /**
 454  * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
 455  * @name: a pointer to a string containing the name of the file to create.
 456  * @mode: the permission that the file should have
 457  * @parent: a pointer to the parent dentry for this file.  This should be a
 458  *          directory dentry if set.  If this parameter is %NULL, then the
 459  *          file will be created in the root of the debugfs filesystem.
 460  * @value: a pointer to the variable that the file should read to and write
 461  *         from.
 462  *
 463  * This function creates a file in debugfs with the given name that
 464  * contains the value of the variable @value.  If the @mode variable is so
 465  * set, it can be read from, and written to.
 466  *
 467  * This function will return a pointer to a dentry if it succeeds.  This
 468  * pointer must be passed to the debugfs_remove() function when the file is
 469  * to be removed (no automatic cleanup happens if your module is unloaded,
 470  * you are responsible here.)  If an error occurs, %NULL will be returned.
 471  *
 472  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 473  * returned.  It is not wise to check for this value, but rather, check for
 474  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 475  * code.
 476  */
 477 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 478                                    struct dentry *parent, bool *value)
 479 {
 480         return debugfs_create_file(name, mode, parent, value, &fops_bool);
 481 }
 482 EXPORT_SYMBOL_GPL(debugfs_create_bool);
 483
 484 static ssize_t read_file_blob(struct file *file, char __user *user_buf,
 485                               size_t count, loff_t *ppos)
 486 {
 487         struct debugfs_blob_wrapper *blob = file->private_data;
 488         return simple_read_from_buffer(user_buf, count, ppos, blob->data,
 489                         blob->size);
 490 }
 491
 492 static const struct file_operations fops_blob = {
 493         .read =         read_file_blob,
 494         .open =         simple_open,
 495         .llseek =       default_llseek,
 496 };
 497
 498 /**
 499  * debugfs_create_blob - create a debugfs file that is used to read a binary blob
 500  * @name: a pointer to a string containing the name of the file to create.
 501  * @mode: the permission that the file should have
 502  * @parent: a pointer to the parent dentry for this file.  This should be a
 503  *          directory dentry if set.  If this parameter is %NULL, then the
 504  *          file will be created in the root of the debugfs filesystem.
 505  * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
 506  *        to the blob data and the size of the data.
 507  *
 508  * This function creates a file in debugfs with the given name that exports
 509  * @blob->data as a binary blob. If the @mode variable is so set it can be
 510  * read from. Writing is not supported.
 511  *
 512  * This function will return a pointer to a dentry if it succeeds.  This
 513  * pointer must be passed to the debugfs_remove() function when the file is
 514  * to be removed (no automatic cleanup happens if your module is unloaded,
 515  * you are responsible here.)  If an error occurs, %NULL will be returned.
 516  *
 517  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 518  * returned.  It is not wise to check for this value, but rather, check for
 519  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 520  * code.
 521  */
 522 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 523                                    struct dentry *parent,
 524                                    struct debugfs_blob_wrapper *blob)
 525 {
 526         return debugfs_create_file(name, mode, parent, blob, &fops_blob);
 527 }
 528 EXPORT_SYMBOL_GPL(debugfs_create_blob);
 529
 530 struct array_data {
 531         void *array;
 532         u32 elements;
 533 };
 534
 535 static size_t u32_format_array(char *buf, size_t bufsize,
 536                                u32 *array, int array_size)
 537 {
 538         size_t ret = 0;
 539
 540         while (--array_size >= 0) {
 541                 size_t len;
 542                 char term = array_size ? ' ' : '\n';
 543
 544                 len = snprintf(buf, bufsize, "%u%c", *array++, term);
 545                 ret += len;
 546
 547                 buf += len;
 548                 bufsize -= len;
 549         }
 550         return ret;
 551 }
 552
 553 static int u32_array_open(struct inode *inode, struct file *file)
 554 {
 555         struct array_data *data = inode->i_private;
 556         int size, elements = data->elements;
 557         char *buf;
 558
 559         /*
 560          * Max size:
 561          *  - 10 digits + ' '/'\n' = 11 bytes per number
 562          *  - terminating NUL character
 563          */
 564         size = elements*11;
 565         buf = kmalloc(size+1, GFP_KERNEL);
 566         if (!buf)
 567                 return -ENOMEM;
 568         buf[size] = 0;
 569
 570         file->private_data = buf;
 571         u32_format_array(buf, size, data->array, data->elements);
 572
 573         return nonseekable_open(inode, file);
 574 }
 575
 576 static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len,
 577                               loff_t *ppos)
 578 {
 579         size_t size = strlen(file->private_data);
 580
 581         return simple_read_from_buffer(buf, len, ppos,
 582                                         file->private_data, size);
 583 }
 584
 585 static int u32_array_release(struct inode *inode, struct file *file)
 586 {
 587         kfree(file->private_data);
 588
 589         return 0;
 590 }
 591
 592 static const struct file_operations u32_array_fops = {
 593         .owner   = THIS_MODULE,
 594         .open    = u32_array_open,
 595         .release = u32_array_release,
 596         .read    = u32_array_read,
 597         .llseek  = no_llseek,
 598 };
 599
 600 /**
 601  * debugfs_create_u32_array - create a debugfs file that is used to read u32
 602  * array.
 603  * @name: a pointer to a string containing the name of the file to create.
 604  * @mode: the permission that the file should have.
 605  * @parent: a pointer to the parent dentry for this file.  This should be a
 606  *          directory dentry if set.  If this parameter is %NULL, then the
 607  *          file will be created in the root of the debugfs filesystem.
 608  * @array: u32 array that provides data.
 609  * @elements: total number of elements in the array.
 610  *
 611  * This function creates a file in debugfs with the given name that exports
 612  * @array as data. If the @mode variable is so set it can be read from.
 613  * Writing is not supported. Seek within the file is also not supported.
 614  * Once array is created its size can not be changed.
 615  *
 616  * The function returns a pointer to dentry on success. If debugfs is not
 617  * enabled in the kernel, the value -%ENODEV will be returned.
 618  */
 619 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
 620                                             struct dentry *parent,
 621                                             u32 *array, u32 elements)
 622 {
 623         struct array_data *data = kmalloc(sizeof(*data), GFP_KERNEL);
 624
 625         if (data == NULL)
 626                 return NULL;
 627
 628         data->array = array;
 629         data->elements = elements;
 630
 631         return debugfs_create_file(name, mode, parent, data, &u32_array_fops);
 632 }
 633 EXPORT_SYMBOL_GPL(debugfs_create_u32_array);
 634
 635 #ifdef CONFIG_HAS_IOMEM
 636
 637 /*
 638  * The regset32 stuff is used to print 32-bit registers using the
 639  * seq_file utilities. We offer printing a register set in an already-opened
 640  * sequential file or create a debugfs file that only prints a regset32.
 641  */
 642
 643 /**
 644  * debugfs_print_regs32 - use seq_print to describe a set of registers
 645  * @s: the seq_file structure being used to generate output
 646  * @regs: an array if struct debugfs_reg32 structures
 647  * @nregs: the length of the above array
 648  * @base: the base address to be used in reading the registers
 649  * @prefix: a string to be prefixed to every output line
 650  *
 651  * This function outputs a text block describing the current values of
 652  * some 32-bit hardware registers. It is meant to be used within debugfs
 653  * files based on seq_file that need to show registers, intermixed with other
 654  * information. The prefix argument may be used to specify a leading string,
 655  * because some peripherals have several blocks of identical registers,
 656  * for example configuration of dma channels
 657  */
 658 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 659                           int nregs, void __iomem *base, char *prefix)
 660 {
 661         int i;
 662
 663         for (i = 0; i < nregs; i++, regs++) {
 664                 if (prefix)
 665                         seq_printf(s, "%s", prefix);
 666                 seq_printf(s, "%s = 0x%08x\n", regs->name,
 667                            readl(base + regs->offset));
 668                 if (seq_has_overflowed(s))
 669                         break;
 670         }
 671 }
 672 EXPORT_SYMBOL_GPL(debugfs_print_regs32);
 673
 674 static int debugfs_show_regset32(struct seq_file *s, void *data)
 675 {
 676         struct debugfs_regset32 *regset = s->private;
 677
 678         debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
 679         return 0;
 680 }
 681
 682 static int debugfs_open_regset32(struct inode *inode, struct file *file)
 683 {
 684         return single_open(file, debugfs_show_regset32, inode->i_private);
 685 }
 686
 687 static const struct file_operations fops_regset32 = {
 688         .open =         debugfs_open_regset32,
 689         .read =         seq_read,
 690         .llseek =       seq_lseek,
 691         .release =      single_release,
 692 };
 693
 694 /**
 695  * debugfs_create_regset32 - create a debugfs file that returns register values
 696  * @name: a pointer to a string containing the name of the file to create.
 697  * @mode: the permission that the file should have
 698  * @parent: a pointer to the parent dentry for this file.  This should be a
 699  *          directory dentry if set.  If this parameter is %NULL, then the
 700  *          file will be created in the root of the debugfs filesystem.
 701  * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
 702  *          to an array of register definitions, the array size and the base
 703  *          address where the register bank is to be found.
 704  *
 705  * This function creates a file in debugfs with the given name that reports
 706  * the names and values of a set of 32-bit registers. If the @mode variable
 707  * is so set it can be read from. Writing is not supported.
 708  *
 709  * This function will return a pointer to a dentry if it succeeds.  This
 710  * pointer must be passed to the debugfs_remove() function when the file is
 711  * to be removed (no automatic cleanup happens if your module is unloaded,
 712  * you are responsible here.)  If an error occurs, %NULL will be returned.
 713  *
 714  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 715  * returned.  It is not wise to check for this value, but rather, check for
 716  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 717  * code.
 718  */
 719 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
 720                                        struct dentry *parent,
 721                                        struct debugfs_regset32 *regset)
 722 {
 723         return debugfs_create_file(name, mode, parent, regset, &fops_regset32);
 724 }
 725 EXPORT_SYMBOL_GPL(debugfs_create_regset32);
 726
 727 #endif /* CONFIG_HAS_IOMEM */
 728
 729 struct debugfs_devm_entry {
 730         int (*read)(struct seq_file *seq, void *data);
 731         struct device *dev;
 732 };
 733
 734 static int debugfs_devm_entry_open(struct inode *inode, struct file *f)
 735 {
 736         struct debugfs_devm_entry *entry = inode->i_private;
 737
 738         return single_open(f, entry->read, entry->dev);
 739 }
 740
 741 static const struct file_operations debugfs_devm_entry_ops = {
 742         .owner = THIS_MODULE,
 743         .open = debugfs_devm_entry_open,
 744         .release = single_release,
 745         .read = seq_read,
 746         .llseek = seq_lseek
 747 };
 748
 749 /**
 750  * debugfs_create_devm_seqfile - create a debugfs file that is bound to device.
 751  *
 752  * @dev: device related to this debugfs file.
 753  * @name: name of the debugfs file.
 754  * @parent: a pointer to the parent dentry for this file.  This should be a
 755  *      directory dentry if set.  If this parameter is %NULL, then the
 756  *      file will be created in the root of the debugfs filesystem.
 757  * @read_fn: function pointer called to print the seq_file content.
 758  */
 759 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
 760                                            struct dentry *parent,
 761                                            int (*read_fn)(struct seq_file *s,
 762                                                           void *data))
 763 {
 764         struct debugfs_devm_entry *entry;
 765
 766         if (IS_ERR(parent))
 767                 return ERR_PTR(-ENOENT);
 768
 769         entry = devm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
 770         if (!entry)
 771                 return ERR_PTR(-ENOMEM);
 772
 773         entry->read = read_fn;
 774         entry->dev = dev;
 775
 776         return debugfs_create_file(name, S_IRUGO, parent, entry,
 777                                    &debugfs_devm_entry_ops);
 778 }
 779 EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile);
 780