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
 260 /*
 261  * 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
 262  *
 263  * These functions are exactly the same as the above functions (but use a hex
 264  * output for the decimal challenged). For details look at the above unsigned
 265  * decimal functions.
 266  */
 267
 268 /**
 269  * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
 270  * @name: a pointer to a string containing the name of the file to create.
 271  * @mode: the permission that the file should have
 272  * @parent: a pointer to the parent dentry for this file.  This should be a
 273  *          directory dentry if set.  If this parameter is %NULL, then the
 274  *          file will be created in the root of the debugfs filesystem.
 275  * @value: a pointer to the variable that the file should read to and write
 276  *         from.
 277  */
 278 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
 279                                  struct dentry *parent, u8 *value)
 280 {
 281         return debugfs_create_mode(name, mode, parent, value, &fops_x8,
 282                                    &fops_x8_ro, &fops_x8_wo);
 283 }
 284 EXPORT_SYMBOL_GPL(debugfs_create_x8);
 285
 286 /**
 287  * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
 288  * @name: a pointer to a string containing the name of the file to create.
 289  * @mode: the permission that the file should have
 290  * @parent: a pointer to the parent dentry for this file.  This should be a
 291  *          directory dentry if set.  If this parameter is %NULL, then the
 292  *          file will be created in the root of the debugfs filesystem.
 293  * @value: a pointer to the variable that the file should read to and write
 294  *         from.
 295  */
 296 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
 297                                  struct dentry *parent, u16 *value)
 298 {
 299         return debugfs_create_mode(name, mode, parent, value, &fops_x16,
 300                                    &fops_x16_ro, &fops_x16_wo);
 301 }
 302 EXPORT_SYMBOL_GPL(debugfs_create_x16);
 303
 304 /**
 305  * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
 306  * @name: a pointer to a string containing the name of the file to create.
 307  * @mode: the permission that the file should have
 308  * @parent: a pointer to the parent dentry for this file.  This should be a
 309  *          directory dentry if set.  If this parameter is %NULL, then the
 310  *          file will be created in the root of the debugfs filesystem.
 311  * @value: a pointer to the variable that the file should read to and write
 312  *         from.
 313  */
 314 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
 315                                  struct dentry *parent, u32 *value)
 316 {
 317         return debugfs_create_mode(name, mode, parent, value, &fops_x32,
 318                                    &fops_x32_ro, &fops_x32_wo);
 319 }
 320 EXPORT_SYMBOL_GPL(debugfs_create_x32);
 321
 322 /**
 323  * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
 324  * @name: a pointer to a string containing the name of the file to create.
 325  * @mode: the permission that the file should have
 326  * @parent: a pointer to the parent dentry for this file.  This should be a
 327  *          directory dentry if set.  If this parameter is %NULL, then the
 328  *          file will be created in the root of the debugfs filesystem.
 329  * @value: a pointer to the variable that the file should read to and write
 330  *         from.
 331  */
 332 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
 333                                  struct dentry *parent, u64 *value)
 334 {
 335         return debugfs_create_file(name, mode, parent, value, &fops_x64);
 336 }
 337 EXPORT_SYMBOL_GPL(debugfs_create_x64);
 338
 339
 340 static int debugfs_size_t_set(void *data, u64 val)
 341 {
 342         *(size_t *)data = val;
 343         return 0;
 344 }
 345 static int debugfs_size_t_get(void *data, u64 *val)
 346 {
 347         *val = *(size_t *)data;
 348         return 0;
 349 }
 350 DEFINE_SIMPLE_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
 351                         "%llu\n");      /* %llu and %zu are more or less the same */
 352
 353 /**
 354  * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
 355  * @name: a pointer to a string containing the name of the file to create.
 356  * @mode: the permission that the file should have
 357  * @parent: a pointer to the parent dentry for this file.  This should be a
 358  *          directory dentry if set.  If this parameter is %NULL, then the
 359  *          file will be created in the root of the debugfs filesystem.
 360  * @value: a pointer to the variable that the file should read to and write
 361  *         from.
 362  */
 363 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
 364                                      struct dentry *parent, size_t *value)
 365 {
 366         return debugfs_create_file(name, mode, parent, value, &fops_size_t);
 367 }
 368 EXPORT_SYMBOL_GPL(debugfs_create_size_t);
 369
 370 static int debugfs_atomic_t_set(void *data, u64 val)
 371 {
 372         atomic_set((atomic_t *)data, val);
 373         return 0;
 374 }
 375 static int debugfs_atomic_t_get(void *data, u64 *val)
 376 {
 377         *val = atomic_read((atomic_t *)data);
 378         return 0;
 379 }
 380 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get,
 381                         debugfs_atomic_t_set, "%lld\n");
 382 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL, "%lld\n");
 383 DEFINE_SIMPLE_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set, "%lld\n");
 384
 385 /**
 386  * debugfs_create_atomic_t - create a debugfs file that is used to read and
 387  * write an atomic_t value
 388  * @name: a pointer to a string containing the name of the file to create.
 389  * @mode: the permission that the file should have
 390  * @parent: a pointer to the parent dentry for this file.  This should be a
 391  *          directory dentry if set.  If this parameter is %NULL, then the
 392  *          file will be created in the root of the debugfs filesystem.
 393  * @value: a pointer to the variable that the file should read to and write
 394  *         from.
 395  */
 396 struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
 397                                  struct dentry *parent, atomic_t *value)
 398 {
 399         return debugfs_create_mode(name, mode, parent, value, &fops_atomic_t,
 400                                    &fops_atomic_t_ro, &fops_atomic_t_wo);
 401 }
 402 EXPORT_SYMBOL_GPL(debugfs_create_atomic_t);
 403
 404 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
 405                                size_t count, loff_t *ppos)
 406 {
 407         char buf[3];
 408         bool *val = file->private_data;
 409
 410         if (*val)
 411                 buf[0] = 'Y';
 412         else
 413                 buf[0] = 'N';
 414         buf[1] = '\n';
 415         buf[2] = 0x00;
 416         return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
 417 }
 418 EXPORT_SYMBOL_GPL(debugfs_read_file_bool);
 419
 420 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
 421                                 size_t count, loff_t *ppos)
 422 {
 423         char buf[32];
 424         size_t buf_size;
 425         bool bv;
 426         bool *val = file->private_data;
 427
 428         buf_size = min(count, (sizeof(buf)-1));
 429         if (copy_from_user(buf, user_buf, buf_size))
 430                 return -EFAULT;
 431
 432         buf[buf_size] = '\0';
 433         if (strtobool(buf, &bv) == 0)
 434                 *val = bv;
 435
 436         return count;
 437 }
 438 EXPORT_SYMBOL_GPL(debugfs_write_file_bool);
 439
 440 static const struct file_operations fops_bool = {
 441         .read =         debugfs_read_file_bool,
 442         .write =        debugfs_write_file_bool,
 443         .open =         simple_open,
 444         .llseek =       default_llseek,
 445 };
 446
 447 /**
 448  * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
 449  * @name: a pointer to a string containing the name of the file to create.
 450  * @mode: the permission that the file should have
 451  * @parent: a pointer to the parent dentry for this file.  This should be a
 452  *          directory dentry if set.  If this parameter is %NULL, then the
 453  *          file will be created in the root of the debugfs filesystem.
 454  * @value: a pointer to the variable that the file should read to and write
 455  *         from.
 456  *
 457  * This function creates a file in debugfs with the given name that
 458  * contains the value of the variable @value.  If the @mode variable is so
 459  * set, it can be read from, and written to.
 460  *
 461  * This function will return a pointer to a dentry if it succeeds.  This
 462  * pointer must be passed to the debugfs_remove() function when the file is
 463  * to be removed (no automatic cleanup happens if your module is unloaded,
 464  * you are responsible here.)  If an error occurs, %NULL will be returned.
 465  *
 466  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 467  * returned.  It is not wise to check for this value, but rather, check for
 468  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 469  * code.
 470  */
 471 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 472                                    struct dentry *parent, bool *value)
 473 {
 474         return debugfs_create_file(name, mode, parent, value, &fops_bool);
 475 }
 476 EXPORT_SYMBOL_GPL(debugfs_create_bool);
 477
 478 static ssize_t read_file_blob(struct file *file, char __user *user_buf,
 479                               size_t count, loff_t *ppos)
 480 {
 481         struct debugfs_blob_wrapper *blob = file->private_data;
 482         return simple_read_from_buffer(user_buf, count, ppos, blob->data,
 483                         blob->size);
 484 }
 485
 486 static const struct file_operations fops_blob = {
 487         .read =         read_file_blob,
 488         .open =         simple_open,
 489         .llseek =       default_llseek,
 490 };
 491
 492 /**
 493  * debugfs_create_blob - create a debugfs file that is used to read a binary blob
 494  * @name: a pointer to a string containing the name of the file to create.
 495  * @mode: the permission that the file should have
 496  * @parent: a pointer to the parent dentry for this file.  This should be a
 497  *          directory dentry if set.  If this parameter is %NULL, then the
 498  *          file will be created in the root of the debugfs filesystem.
 499  * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
 500  *        to the blob data and the size of the data.
 501  *
 502  * This function creates a file in debugfs with the given name that exports
 503  * @blob->data as a binary blob. If the @mode variable is so set it can be
 504  * read from. Writing is not supported.
 505  *
 506  * This function will return a pointer to a dentry if it succeeds.  This
 507  * pointer must be passed to the debugfs_remove() function when the file is
 508  * to be removed (no automatic cleanup happens if your module is unloaded,
 509  * you are responsible here.)  If an error occurs, %NULL will be returned.
 510  *
 511  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 512  * returned.  It is not wise to check for this value, but rather, check for
 513  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 514  * code.
 515  */
 516 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 517                                    struct dentry *parent,
 518                                    struct debugfs_blob_wrapper *blob)
 519 {
 520         return debugfs_create_file(name, mode, parent, blob, &fops_blob);
 521 }
 522 EXPORT_SYMBOL_GPL(debugfs_create_blob);
 523
 524 struct array_data {
 525         void *array;
 526         u32 elements;
 527 };
 528
 529 static size_t u32_format_array(char *buf, size_t bufsize,
 530                                u32 *array, int array_size)
 531 {
 532         size_t ret = 0;
 533
 534         while (--array_size >= 0) {
 535                 size_t len;
 536                 char term = array_size ? ' ' : '\n';
 537
 538                 len = snprintf(buf, bufsize, "%u%c", *array++, term);
 539                 ret += len;
 540
 541                 buf += len;
 542                 bufsize -= len;
 543         }
 544         return ret;
 545 }
 546
 547 static int u32_array_open(struct inode *inode, struct file *file)
 548 {
 549         struct array_data *data = inode->i_private;
 550         int size, elements = data->elements;
 551         char *buf;
 552
 553         /*
 554          * Max size:
 555          *  - 10 digits + ' '/'\n' = 11 bytes per number
 556          *  - terminating NUL character
 557          */
 558         size = elements*11;
 559         buf = kmalloc(size+1, GFP_KERNEL);
 560         if (!buf)
 561                 return -ENOMEM;
 562         buf[size] = 0;
 563
 564         file->private_data = buf;
 565         u32_format_array(buf, size, data->array, data->elements);
 566
 567         return nonseekable_open(inode, file);
 568 }
 569
 570 static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len,
 571                               loff_t *ppos)
 572 {
 573         size_t size = strlen(file->private_data);
 574
 575         return simple_read_from_buffer(buf, len, ppos,
 576                                         file->private_data, size);
 577 }
 578
 579 static int u32_array_release(struct inode *inode, struct file *file)
 580 {
 581         kfree(file->private_data);
 582
 583         return 0;
 584 }
 585
 586 static const struct file_operations u32_array_fops = {
 587         .owner   = THIS_MODULE,
 588         .open    = u32_array_open,
 589         .release = u32_array_release,
 590         .read    = u32_array_read,
 591         .llseek  = no_llseek,
 592 };
 593
 594 /**
 595  * debugfs_create_u32_array - create a debugfs file that is used to read u32
 596  * array.
 597  * @name: a pointer to a string containing the name of the file to create.
 598  * @mode: the permission that the file should have.
 599  * @parent: a pointer to the parent dentry for this file.  This should be a
 600  *          directory dentry if set.  If this parameter is %NULL, then the
 601  *          file will be created in the root of the debugfs filesystem.
 602  * @array: u32 array that provides data.
 603  * @elements: total number of elements in the array.
 604  *
 605  * This function creates a file in debugfs with the given name that exports
 606  * @array as data. If the @mode variable is so set it can be read from.
 607  * Writing is not supported. Seek within the file is also not supported.
 608  * Once array is created its size can not be changed.
 609  *
 610  * The function returns a pointer to dentry on success. If debugfs is not
 611  * enabled in the kernel, the value -%ENODEV will be returned.
 612  */
 613 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
 614                                             struct dentry *parent,
 615                                             u32 *array, u32 elements)
 616 {
 617         struct array_data *data = kmalloc(sizeof(*data), GFP_KERNEL);
 618
 619         if (data == NULL)
 620                 return NULL;
 621
 622         data->array = array;
 623         data->elements = elements;
 624
 625         return debugfs_create_file(name, mode, parent, data, &u32_array_fops);
 626 }
 627 EXPORT_SYMBOL_GPL(debugfs_create_u32_array);
 628
 629 #ifdef CONFIG_HAS_IOMEM
 630
 631 /*
 632  * The regset32 stuff is used to print 32-bit registers using the
 633  * seq_file utilities. We offer printing a register set in an already-opened
 634  * sequential file or create a debugfs file that only prints a regset32.
 635  */
 636
 637 /**
 638  * debugfs_print_regs32 - use seq_print to describe a set of registers
 639  * @s: the seq_file structure being used to generate output
 640  * @regs: an array if struct debugfs_reg32 structures
 641  * @nregs: the length of the above array
 642  * @base: the base address to be used in reading the registers
 643  * @prefix: a string to be prefixed to every output line
 644  *
 645  * This function outputs a text block describing the current values of
 646  * some 32-bit hardware registers. It is meant to be used within debugfs
 647  * files based on seq_file that need to show registers, intermixed with other
 648  * information. The prefix argument may be used to specify a leading string,
 649  * because some peripherals have several blocks of identical registers,
 650  * for example configuration of dma channels
 651  */
 652 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 653                           int nregs, void __iomem *base, char *prefix)
 654 {
 655         int i;
 656
 657         for (i = 0; i < nregs; i++, regs++) {
 658                 if (prefix)
 659                         seq_printf(s, "%s", prefix);
 660                 seq_printf(s, "%s = 0x%08x\n", regs->name,
 661                            readl(base + regs->offset));
 662                 if (seq_has_overflowed(s))
 663                         break;
 664         }
 665 }
 666 EXPORT_SYMBOL_GPL(debugfs_print_regs32);
 667
 668 static int debugfs_show_regset32(struct seq_file *s, void *data)
 669 {
 670         struct debugfs_regset32 *regset = s->private;
 671
 672         debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
 673         return 0;
 674 }
 675
 676 static int debugfs_open_regset32(struct inode *inode, struct file *file)
 677 {
 678         return single_open(file, debugfs_show_regset32, inode->i_private);
 679 }
 680
 681 static const struct file_operations fops_regset32 = {
 682         .open =         debugfs_open_regset32,
 683         .read =         seq_read,
 684         .llseek =       seq_lseek,
 685         .release =      single_release,
 686 };
 687
 688 /**
 689  * debugfs_create_regset32 - create a debugfs file that returns register values
 690  * @name: a pointer to a string containing the name of the file to create.
 691  * @mode: the permission that the file should have
 692  * @parent: a pointer to the parent dentry for this file.  This should be a
 693  *          directory dentry if set.  If this parameter is %NULL, then the
 694  *          file will be created in the root of the debugfs filesystem.
 695  * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
 696  *          to an array of register definitions, the array size and the base
 697  *          address where the register bank is to be found.
 698  *
 699  * This function creates a file in debugfs with the given name that reports
 700  * the names and values of a set of 32-bit registers. If the @mode variable
 701  * is so set it can be read from. Writing is not supported.
 702  *
 703  * This function will return a pointer to a dentry if it succeeds.  This
 704  * pointer must be passed to the debugfs_remove() function when the file is
 705  * to be removed (no automatic cleanup happens if your module is unloaded,
 706  * you are responsible here.)  If an error occurs, %NULL will be returned.
 707  *
 708  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 709  * returned.  It is not wise to check for this value, but rather, check for
 710  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 711  * code.
 712  */
 713 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
 714                                        struct dentry *parent,
 715                                        struct debugfs_regset32 *regset)
 716 {
 717         return debugfs_create_file(name, mode, parent, regset, &fops_regset32);
 718 }
 719 EXPORT_SYMBOL_GPL(debugfs_create_regset32);
 720
 721 #endif /* CONFIG_HAS_IOMEM */
 722
 723 struct debugfs_devm_entry {
 724         int (*read)(struct seq_file *seq, void *data);
 725         struct device *dev;
 726 };
 727
 728 static int debugfs_devm_entry_open(struct inode *inode, struct file *f)
 729 {
 730         struct debugfs_devm_entry *entry = inode->i_private;
 731
 732         return single_open(f, entry->read, entry->dev);
 733 }
 734
 735 static const struct file_operations debugfs_devm_entry_ops = {
 736         .owner = THIS_MODULE,
 737         .open = debugfs_devm_entry_open,
 738         .release = single_release,
 739         .read = seq_read,
 740         .llseek = seq_lseek
 741 };
 742
 743 /**
 744  * debugfs_create_devm_seqfile - create a debugfs file that is bound to device.
 745  *
 746  * @dev: device related to this debugfs file.
 747  * @name: name of the debugfs file.
 748  * @parent: a pointer to the parent dentry for this file.  This should be a
 749  *      directory dentry if set.  If this parameter is %NULL, then the
 750  *      file will be created in the root of the debugfs filesystem.
 751  * @read_fn: function pointer called to print the seq_file content.
 752  */
 753 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
 754                                            struct dentry *parent,
 755                                            int (*read_fn)(struct seq_file *s,
 756                                                           void *data))
 757 {
 758         struct debugfs_devm_entry *entry;
 759
 760         if (IS_ERR(parent))
 761                 return ERR_PTR(-ENOENT);
 762
 763         entry = devm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
 764         if (!entry)
 765                 return ERR_PTR(-ENOMEM);
 766
 767         entry->read = read_fn;
 768         entry->dev = dev;
 769
 770         return debugfs_create_file(name, S_IRUGO, parent, entry,
 771                                    &debugfs_devm_entry_ops);
 772 }
 773 EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile);
 774