fs/debugfs/file.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  file.c - part of debugfs, a tiny little debug file system
   4  *
   5  *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
   6  *  Copyright (C) 2004 IBM Inc.
   7  *
   8  *  debugfs is for people to use instead of /proc or /sys.
   9  *  See Documentation/filesystems/ for more details.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/fs.h>
  14 #include <linux/seq_file.h>
  15 #include <linux/pagemap.h>
  16 #include <linux/debugfs.h>
  17 #include <linux/io.h>
  18 #include <linux/slab.h>
  19 #include <linux/atomic.h>
  20 #include <linux/device.h>
  21 #include <linux/pm_runtime.h>
  22 #include <linux/poll.h>
  23 #include <linux/security.h>
  24
  25 #include "internal.h"
  26
  27 struct poll_table_struct;
  28
  29 static ssize_t default_read_file(struct file *file, char __user *buf,
  30                                  size_t count, loff_t *ppos)
  31 {
  32         return 0;
  33 }
  34
  35 static ssize_t default_write_file(struct file *file, const char __user *buf,
  36                                    size_t count, loff_t *ppos)
  37 {
  38         return count;
  39 }
  40
  41 const struct file_operations debugfs_noop_file_operations = {
  42         .read =         default_read_file,
  43         .write =        default_write_file,
  44         .open =         simple_open,
  45         .llseek =       noop_llseek,
  46 };
  47
  48 #define F_DENTRY(filp) ((filp)->f_path.dentry)
  49
  50 const struct file_operations *debugfs_real_fops(const struct file *filp)
  51 {
  52         struct debugfs_fsdata *fsd = F_DENTRY(filp)->d_fsdata;
  53
  54         if ((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT) {
  55                 /*
  56                  * Urgh, we've been called w/o a protecting
  57                  * debugfs_file_get().
  58                  */
  59                 WARN_ON(1);
  60                 return NULL;
  61         }
  62
  63         return fsd->real_fops;
  64 }
  65 EXPORT_SYMBOL_GPL(debugfs_real_fops);
  66
  67 /**
  68  * debugfs_file_get - mark the beginning of file data access
  69  * @dentry: the dentry object whose data is being accessed.
  70  *
  71  * Up to a matching call to debugfs_file_put(), any successive call
  72  * into the file removing functions debugfs_remove() and
  73  * debugfs_remove_recursive() will block. Since associated private
  74  * file data may only get freed after a successful return of any of
  75  * the removal functions, you may safely access it after a successful
  76  * call to debugfs_file_get() without worrying about lifetime issues.
  77  *
  78  * If -%EIO is returned, the file has already been removed and thus,
  79  * it is not safe to access any of its data. If, on the other hand,
  80  * it is allowed to access the file data, zero is returned.
  81  */
  82 int debugfs_file_get(struct dentry *dentry)
  83 {
  84         struct debugfs_fsdata *fsd;
  85         void *d_fsd;
  86
  87         d_fsd = READ_ONCE(dentry->d_fsdata);
  88         if (!((unsigned long)d_fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT)) {
  89                 fsd = d_fsd;
  90         } else {
  91                 fsd = kmalloc(sizeof(*fsd), GFP_KERNEL);
  92                 if (!fsd)
  93                         return -ENOMEM;
  94
  95                 fsd->real_fops = (void *)((unsigned long)d_fsd &
  96                                         ~DEBUGFS_FSDATA_IS_REAL_FOPS_BIT);
  97                 refcount_set(&fsd->active_users, 1);
  98                 init_completion(&fsd->active_users_drained);
  99                 if (cmpxchg(&dentry->d_fsdata, d_fsd, fsd) != d_fsd) {
 100                         kfree(fsd);
 101                         fsd = READ_ONCE(dentry->d_fsdata);
 102                 }
 103         }
 104
 105         /*
 106          * In case of a successful cmpxchg() above, this check is
 107          * strictly necessary and must follow it, see the comment in
 108          * __debugfs_remove_file().
 109          * OTOH, if the cmpxchg() hasn't been executed or wasn't
 110          * successful, this serves the purpose of not starving
 111          * removers.
 112          */
 113         if (d_unlinked(dentry))
 114                 return -EIO;
 115
 116         if (!refcount_inc_not_zero(&fsd->active_users))
 117                 return -EIO;
 118
 119         return 0;
 120 }
 121 EXPORT_SYMBOL_GPL(debugfs_file_get);
 122
 123 /**
 124  * debugfs_file_put - mark the end of file data access
 125  * @dentry: the dentry object formerly passed to
 126  *          debugfs_file_get().
 127  *
 128  * Allow any ongoing concurrent call into debugfs_remove() or
 129  * debugfs_remove_recursive() blocked by a former call to
 130  * debugfs_file_get() to proceed and return to its caller.
 131  */
 132 void debugfs_file_put(struct dentry *dentry)
 133 {
 134         struct debugfs_fsdata *fsd = READ_ONCE(dentry->d_fsdata);
 135
 136         if (refcount_dec_and_test(&fsd->active_users))
 137                 complete(&fsd->active_users_drained);
 138 }
 139 EXPORT_SYMBOL_GPL(debugfs_file_put);
 140
 141 /*
 142  * Only permit access to world-readable files when the kernel is locked down.
 143  * We also need to exclude any file that has ways to write or alter it as root
 144  * can bypass the permissions check.
 145  */
 146 static int debugfs_locked_down(struct inode *inode,
 147                                struct file *filp,
 148                                const struct file_operations *real_fops)
 149 {
 150         if ((inode->i_mode & 07777 & ~0444) == 0 &&
 151             !(filp->f_mode & FMODE_WRITE) &&
 152             !real_fops->unlocked_ioctl &&
 153             !real_fops->compat_ioctl &&
 154             !real_fops->mmap)
 155                 return 0;
 156
 157         if (security_locked_down(LOCKDOWN_DEBUGFS))
 158                 return -EPERM;
 159
 160         return 0;
 161 }
 162
 163 static int open_proxy_open(struct inode *inode, struct file *filp)
 164 {
 165         struct dentry *dentry = F_DENTRY(filp);
 166         const struct file_operations *real_fops = NULL;
 167         int r;
 168
 169         r = debugfs_file_get(dentry);
 170         if (r)
 171                 return r == -EIO ? -ENOENT : r;
 172
 173         real_fops = debugfs_real_fops(filp);
 174
 175         r = debugfs_locked_down(inode, filp, real_fops);
 176         if (r)
 177                 goto out;
 178
 179         if (!fops_get(real_fops)) {
 180 #ifdef CONFIG_MODULES
 181                 if (real_fops->owner &&
 182                     real_fops->owner->state == MODULE_STATE_GOING) {
 183                         r = -ENXIO;
 184                         goto out;
 185                 }
 186 #endif
 187
 188                 /* Huh? Module did not clean up after itself at exit? */
 189                 WARN(1, "debugfs file owner did not clean up at exit: %pd",
 190                         dentry);
 191                 r = -ENXIO;
 192                 goto out;
 193         }
 194         replace_fops(filp, real_fops);
 195
 196         if (real_fops->open)
 197                 r = real_fops->open(inode, filp);
 198
 199 out:
 200         debugfs_file_put(dentry);
 201         return r;
 202 }
 203
 204 const struct file_operations debugfs_open_proxy_file_operations = {
 205         .open = open_proxy_open,
 206 };
 207
 208 #define PROTO(args...) args
 209 #define ARGS(args...) args
 210
 211 #define FULL_PROXY_FUNC(name, ret_type, filp, proto, args)              \
 212 static ret_type full_proxy_ ## name(proto)                              \
 213 {                                                                       \
 214         struct dentry *dentry = F_DENTRY(filp);                 \
 215         const struct file_operations *real_fops;                        \
 216         ret_type r;                                                     \
 217                                                                         \
 218         r = debugfs_file_get(dentry);                                   \
 219         if (unlikely(r))                                                \
 220                 return r;                                               \
 221         real_fops = debugfs_real_fops(filp);                            \
 222         r = real_fops->name(args);                                      \
 223         debugfs_file_put(dentry);                                       \
 224         return r;                                                       \
 225 }
 226
 227 FULL_PROXY_FUNC(llseek, loff_t, filp,
 228                 PROTO(struct file *filp, loff_t offset, int whence),
 229                 ARGS(filp, offset, whence));
 230
 231 FULL_PROXY_FUNC(read, ssize_t, filp,
 232                 PROTO(struct file *filp, char __user *buf, size_t size,
 233                         loff_t *ppos),
 234                 ARGS(filp, buf, size, ppos));
 235
 236 FULL_PROXY_FUNC(write, ssize_t, filp,
 237                 PROTO(struct file *filp, const char __user *buf, size_t size,
 238                         loff_t *ppos),
 239                 ARGS(filp, buf, size, ppos));
 240
 241 FULL_PROXY_FUNC(unlocked_ioctl, long, filp,
 242                 PROTO(struct file *filp, unsigned int cmd, unsigned long arg),
 243                 ARGS(filp, cmd, arg));
 244
 245 static __poll_t full_proxy_poll(struct file *filp,
 246                                 struct poll_table_struct *wait)
 247 {
 248         struct dentry *dentry = F_DENTRY(filp);
 249         __poll_t r = 0;
 250         const struct file_operations *real_fops;
 251
 252         if (debugfs_file_get(dentry))
 253                 return EPOLLHUP;
 254
 255         real_fops = debugfs_real_fops(filp);
 256         r = real_fops->poll(filp, wait);
 257         debugfs_file_put(dentry);
 258         return r;
 259 }
 260
 261 static int full_proxy_release(struct inode *inode, struct file *filp)
 262 {
 263         const struct dentry *dentry = F_DENTRY(filp);
 264         const struct file_operations *real_fops = debugfs_real_fops(filp);
 265         const struct file_operations *proxy_fops = filp->f_op;
 266         int r = 0;
 267
 268         /*
 269          * We must not protect this against removal races here: the
 270          * original releaser should be called unconditionally in order
 271          * not to leak any resources. Releasers must not assume that
 272          * ->i_private is still being meaningful here.
 273          */
 274         if (real_fops->release)
 275                 r = real_fops->release(inode, filp);
 276
 277         replace_fops(filp, d_inode(dentry)->i_fop);
 278         kfree(proxy_fops);
 279         fops_put(real_fops);
 280         return r;
 281 }
 282
 283 static void __full_proxy_fops_init(struct file_operations *proxy_fops,
 284                                 const struct file_operations *real_fops)
 285 {
 286         proxy_fops->release = full_proxy_release;
 287         if (real_fops->llseek)
 288                 proxy_fops->llseek = full_proxy_llseek;
 289         if (real_fops->read)
 290                 proxy_fops->read = full_proxy_read;
 291         if (real_fops->write)
 292                 proxy_fops->write = full_proxy_write;
 293         if (real_fops->poll)
 294                 proxy_fops->poll = full_proxy_poll;
 295         if (real_fops->unlocked_ioctl)
 296                 proxy_fops->unlocked_ioctl = full_proxy_unlocked_ioctl;
 297 }
 298
 299 static int full_proxy_open(struct inode *inode, struct file *filp)
 300 {
 301         struct dentry *dentry = F_DENTRY(filp);
 302         const struct file_operations *real_fops = NULL;
 303         struct file_operations *proxy_fops = NULL;
 304         int r;
 305
 306         r = debugfs_file_get(dentry);
 307         if (r)
 308                 return r == -EIO ? -ENOENT : r;
 309
 310         real_fops = debugfs_real_fops(filp);
 311
 312         r = debugfs_locked_down(inode, filp, real_fops);
 313         if (r)
 314                 goto out;
 315
 316         if (!fops_get(real_fops)) {
 317 #ifdef CONFIG_MODULES
 318                 if (real_fops->owner &&
 319                     real_fops->owner->state == MODULE_STATE_GOING) {
 320                         r = -ENXIO;
 321                         goto out;
 322                 }
 323 #endif
 324
 325                 /* Huh? Module did not cleanup after itself at exit? */
 326                 WARN(1, "debugfs file owner did not clean up at exit: %pd",
 327                         dentry);
 328                 r = -ENXIO;
 329                 goto out;
 330         }
 331
 332         proxy_fops = kzalloc(sizeof(*proxy_fops), GFP_KERNEL);
 333         if (!proxy_fops) {
 334                 r = -ENOMEM;
 335                 goto free_proxy;
 336         }
 337         __full_proxy_fops_init(proxy_fops, real_fops);
 338         replace_fops(filp, proxy_fops);
 339
 340         if (real_fops->open) {
 341                 r = real_fops->open(inode, filp);
 342                 if (r) {
 343                         replace_fops(filp, d_inode(dentry)->i_fop);
 344                         goto free_proxy;
 345                 } else if (filp->f_op != proxy_fops) {
 346                         /* No protection against file removal anymore. */
 347                         WARN(1, "debugfs file owner replaced proxy fops: %pd",
 348                                 dentry);
 349                         goto free_proxy;
 350                 }
 351         }
 352
 353         goto out;
 354 free_proxy:
 355         kfree(proxy_fops);
 356         fops_put(real_fops);
 357 out:
 358         debugfs_file_put(dentry);
 359         return r;
 360 }
 361
 362 const struct file_operations debugfs_full_proxy_file_operations = {
 363         .open = full_proxy_open,
 364 };
 365
 366 ssize_t debugfs_attr_read(struct file *file, char __user *buf,
 367                         size_t len, loff_t *ppos)
 368 {
 369         struct dentry *dentry = F_DENTRY(file);
 370         ssize_t ret;
 371
 372         ret = debugfs_file_get(dentry);
 373         if (unlikely(ret))
 374                 return ret;
 375         ret = simple_attr_read(file, buf, len, ppos);
 376         debugfs_file_put(dentry);
 377         return ret;
 378 }
 379 EXPORT_SYMBOL_GPL(debugfs_attr_read);
 380
 381 ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
 382                          size_t len, loff_t *ppos)
 383 {
 384         struct dentry *dentry = F_DENTRY(file);
 385         ssize_t ret;
 386
 387         ret = debugfs_file_get(dentry);
 388         if (unlikely(ret))
 389                 return ret;
 390         ret = simple_attr_write(file, buf, len, ppos);
 391         debugfs_file_put(dentry);
 392         return ret;
 393 }
 394 EXPORT_SYMBOL_GPL(debugfs_attr_write);
 395
 396 static struct dentry *debugfs_create_mode_unsafe(const char *name, umode_t mode,
 397                                         struct dentry *parent, void *value,
 398                                         const struct file_operations *fops,
 399                                         const struct file_operations *fops_ro,
 400                                         const struct file_operations *fops_wo)
 401 {
 402         /* if there are no write bits set, make read only */
 403         if (!(mode & S_IWUGO))
 404                 return debugfs_create_file_unsafe(name, mode, parent, value,
 405                                                 fops_ro);
 406         /* if there are no read bits set, make write only */
 407         if (!(mode & S_IRUGO))
 408                 return debugfs_create_file_unsafe(name, mode, parent, value,
 409                                                 fops_wo);
 410
 411         return debugfs_create_file_unsafe(name, mode, parent, value, fops);
 412 }
 413
 414 static int debugfs_u8_set(void *data, u64 val)
 415 {
 416         *(u8 *)data = val;
 417         return 0;
 418 }
 419 static int debugfs_u8_get(void *data, u64 *val)
 420 {
 421         *val = *(u8 *)data;
 422         return 0;
 423 }
 424 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
 425 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n");
 426 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");
 427
 428 /**
 429  * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
 430  * @name: a pointer to a string containing the name of the file to create.
 431  * @mode: the permission that the file should have
 432  * @parent: a pointer to the parent dentry for this file.  This should be a
 433  *          directory dentry if set.  If this parameter is %NULL, then the
 434  *          file will be created in the root of the debugfs filesystem.
 435  * @value: a pointer to the variable that the file should read to and write
 436  *         from.
 437  *
 438  * This function creates a file in debugfs with the given name that
 439  * contains the value of the variable @value.  If the @mode variable is so
 440  * set, it can be read from, and written to.
 441  */
 442 void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent,
 443                        u8 *value)
 444 {
 445         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u8,
 446                                    &fops_u8_ro, &fops_u8_wo);
 447 }
 448 EXPORT_SYMBOL_GPL(debugfs_create_u8);
 449
 450 static int debugfs_u16_set(void *data, u64 val)
 451 {
 452         *(u16 *)data = val;
 453         return 0;
 454 }
 455 static int debugfs_u16_get(void *data, u64 *val)
 456 {
 457         *val = *(u16 *)data;
 458         return 0;
 459 }
 460 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
 461 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n");
 462 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");
 463
 464 /**
 465  * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
 466  * @name: a pointer to a string containing the name of the file to create.
 467  * @mode: the permission that the file should have
 468  * @parent: a pointer to the parent dentry for this file.  This should be a
 469  *          directory dentry if set.  If this parameter is %NULL, then the
 470  *          file will be created in the root of the debugfs filesystem.
 471  * @value: a pointer to the variable that the file should read to and write
 472  *         from.
 473  *
 474  * This function creates a file in debugfs with the given name that
 475  * contains the value of the variable @value.  If the @mode variable is so
 476  * set, it can be read from, and written to.
 477  */
 478 void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent,
 479                         u16 *value)
 480 {
 481         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u16,
 482                                    &fops_u16_ro, &fops_u16_wo);
 483 }
 484 EXPORT_SYMBOL_GPL(debugfs_create_u16);
 485
 486 static int debugfs_u32_set(void *data, u64 val)
 487 {
 488         *(u32 *)data = val;
 489         return 0;
 490 }
 491 static int debugfs_u32_get(void *data, u64 *val)
 492 {
 493         *val = *(u32 *)data;
 494         return 0;
 495 }
 496 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
 497 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n");
 498 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");
 499
 500 /**
 501  * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
 502  * @name: a pointer to a string containing the name of the file to create.
 503  * @mode: the permission that the file should have
 504  * @parent: a pointer to the parent dentry for this file.  This should be a
 505  *          directory dentry if set.  If this parameter is %NULL, then the
 506  *          file will be created in the root of the debugfs filesystem.
 507  * @value: a pointer to the variable that the file should read to and write
 508  *         from.
 509  *
 510  * This function creates a file in debugfs with the given name that
 511  * contains the value of the variable @value.  If the @mode variable is so
 512  * set, it can be read from, and written to.
 513  */
 514 void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent,
 515                         u32 *value)
 516 {
 517         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u32,
 518                                    &fops_u32_ro, &fops_u32_wo);
 519 }
 520 EXPORT_SYMBOL_GPL(debugfs_create_u32);
 521
 522 static int debugfs_u64_set(void *data, u64 val)
 523 {
 524         *(u64 *)data = val;
 525         return 0;
 526 }
 527
 528 static int debugfs_u64_get(void *data, u64 *val)
 529 {
 530         *val = *(u64 *)data;
 531         return 0;
 532 }
 533 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
 534 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
 535 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
 536
 537 /**
 538  * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
 539  * @name: a pointer to a string containing the name of the file to create.
 540  * @mode: the permission that the file should have
 541  * @parent: a pointer to the parent dentry for this file.  This should be a
 542  *          directory dentry if set.  If this parameter is %NULL, then the
 543  *          file will be created in the root of the debugfs filesystem.
 544  * @value: a pointer to the variable that the file should read to and write
 545  *         from.
 546  *
 547  * This function creates a file in debugfs with the given name that
 548  * contains the value of the variable @value.  If the @mode variable is so
 549  * set, it can be read from, and written to.
 550  */
 551 void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
 552                         u64 *value)
 553 {
 554         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u64,
 555                                    &fops_u64_ro, &fops_u64_wo);
 556 }
 557 EXPORT_SYMBOL_GPL(debugfs_create_u64);
 558
 559 static int debugfs_ulong_set(void *data, u64 val)
 560 {
 561         *(unsigned long *)data = val;
 562         return 0;
 563 }
 564
 565 static int debugfs_ulong_get(void *data, u64 *val)
 566 {
 567         *val = *(unsigned long *)data;
 568         return 0;
 569 }
 570 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong, debugfs_ulong_get, debugfs_ulong_set,
 571                         "%llu\n");
 572 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_ro, debugfs_ulong_get, NULL, "%llu\n");
 573 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_wo, NULL, debugfs_ulong_set, "%llu\n");
 574
 575 /**
 576  * debugfs_create_ulong - create a debugfs file that is used to read and write
 577  * an unsigned long value.
 578  * @name: a pointer to a string containing the name of the file to create.
 579  * @mode: the permission that the file should have
 580  * @parent: a pointer to the parent dentry for this file.  This should be a
 581  *          directory dentry if set.  If this parameter is %NULL, then the
 582  *          file will be created in the root of the debugfs filesystem.
 583  * @value: a pointer to the variable that the file should read to and write
 584  *         from.
 585  *
 586  * This function creates a file in debugfs with the given name that
 587  * contains the value of the variable @value.  If the @mode variable is so
 588  * set, it can be read from, and written to.
 589  *
 590  * This function will return a pointer to a dentry if it succeeds.  This
 591  * pointer must be passed to the debugfs_remove() function when the file is
 592  * to be removed (no automatic cleanup happens if your module is unloaded,
 593  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
 594  * returned.
 595  *
 596  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
 597  * be returned.
 598  */
 599 struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
 600                                     struct dentry *parent, unsigned long *value)
 601 {
 602         return debugfs_create_mode_unsafe(name, mode, parent, value,
 603                                         &fops_ulong, &fops_ulong_ro,
 604                                         &fops_ulong_wo);
 605 }
 606 EXPORT_SYMBOL_GPL(debugfs_create_ulong);
 607
 608 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
 609 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n");
 610 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n");
 611
 612 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set,
 613                         "0x%04llx\n");
 614 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n");
 615 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n");
 616
 617 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set,
 618                         "0x%08llx\n");
 619 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n");
 620 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n");
 621
 622 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set,
 623                         "0x%016llx\n");
 624 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_ro, debugfs_u64_get, NULL, "0x%016llx\n");
 625 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_wo, NULL, debugfs_u64_set, "0x%016llx\n");
 626
 627 /*
 628  * 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
 629  *
 630  * These functions are exactly the same as the above functions (but use a hex
 631  * output for the decimal challenged). For details look at the above unsigned
 632  * decimal functions.
 633  */
 634
 635 /**
 636  * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
 637  * @name: a pointer to a string containing the name of the file to create.
 638  * @mode: the permission that the file should have
 639  * @parent: a pointer to the parent dentry for this file.  This should be a
 640  *          directory dentry if set.  If this parameter is %NULL, then the
 641  *          file will be created in the root of the debugfs filesystem.
 642  * @value: a pointer to the variable that the file should read to and write
 643  *         from.
 644  */
 645 void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
 646                        u8 *value)
 647 {
 648         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x8,
 649                                    &fops_x8_ro, &fops_x8_wo);
 650 }
 651 EXPORT_SYMBOL_GPL(debugfs_create_x8);
 652
 653 /**
 654  * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
 655  * @name: a pointer to a string containing the name of the file to create.
 656  * @mode: the permission that the file should have
 657  * @parent: a pointer to the parent dentry for this file.  This should be a
 658  *          directory dentry if set.  If this parameter is %NULL, then the
 659  *          file will be created in the root of the debugfs filesystem.
 660  * @value: a pointer to the variable that the file should read to and write
 661  *         from.
 662  */
 663 void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
 664                         u16 *value)
 665 {
 666         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x16,
 667                                    &fops_x16_ro, &fops_x16_wo);
 668 }
 669 EXPORT_SYMBOL_GPL(debugfs_create_x16);
 670
 671 /**
 672  * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
 673  * @name: a pointer to a string containing the name of the file to create.
 674  * @mode: the permission that the file should have
 675  * @parent: a pointer to the parent dentry for this file.  This should be a
 676  *          directory dentry if set.  If this parameter is %NULL, then the
 677  *          file will be created in the root of the debugfs filesystem.
 678  * @value: a pointer to the variable that the file should read to and write
 679  *         from.
 680  */
 681 void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
 682                         u32 *value)
 683 {
 684         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x32,
 685                                    &fops_x32_ro, &fops_x32_wo);
 686 }
 687 EXPORT_SYMBOL_GPL(debugfs_create_x32);
 688
 689 /**
 690  * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
 691  * @name: a pointer to a string containing the name of the file to create.
 692  * @mode: the permission that the file should have
 693  * @parent: a pointer to the parent dentry for this file.  This should be a
 694  *          directory dentry if set.  If this parameter is %NULL, then the
 695  *          file will be created in the root of the debugfs filesystem.
 696  * @value: a pointer to the variable that the file should read to and write
 697  *         from.
 698  */
 699 void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
 700                         u64 *value)
 701 {
 702         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x64,
 703                                    &fops_x64_ro, &fops_x64_wo);
 704 }
 705 EXPORT_SYMBOL_GPL(debugfs_create_x64);
 706
 707
 708 static int debugfs_size_t_set(void *data, u64 val)
 709 {
 710         *(size_t *)data = val;
 711         return 0;
 712 }
 713 static int debugfs_size_t_get(void *data, u64 *val)
 714 {
 715         *val = *(size_t *)data;
 716         return 0;
 717 }
 718 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
 719                         "%llu\n"); /* %llu and %zu are more or less the same */
 720 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_ro, debugfs_size_t_get, NULL, "%llu\n");
 721 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_wo, NULL, debugfs_size_t_set, "%llu\n");
 722
 723 /**
 724  * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
 725  * @name: a pointer to a string containing the name of the file to create.
 726  * @mode: the permission that the file should have
 727  * @parent: a pointer to the parent dentry for this file.  This should be a
 728  *          directory dentry if set.  If this parameter is %NULL, then the
 729  *          file will be created in the root of the debugfs filesystem.
 730  * @value: a pointer to the variable that the file should read to and write
 731  *         from.
 732  */
 733 void debugfs_create_size_t(const char *name, umode_t mode,
 734                            struct dentry *parent, size_t *value)
 735 {
 736         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_size_t,
 737                                    &fops_size_t_ro, &fops_size_t_wo);
 738 }
 739 EXPORT_SYMBOL_GPL(debugfs_create_size_t);
 740
 741 static int debugfs_atomic_t_set(void *data, u64 val)
 742 {
 743         atomic_set((atomic_t *)data, val);
 744         return 0;
 745 }
 746 static int debugfs_atomic_t_get(void *data, u64 *val)
 747 {
 748         *val = atomic_read((atomic_t *)data);
 749         return 0;
 750 }
 751 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get,
 752                         debugfs_atomic_t_set, "%lld\n");
 753 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL,
 754                         "%lld\n");
 755 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set,
 756                         "%lld\n");
 757
 758 /**
 759  * debugfs_create_atomic_t - create a debugfs file that is used to read and
 760  * write an atomic_t value
 761  * @name: a pointer to a string containing the name of the file to create.
 762  * @mode: the permission that the file should have
 763  * @parent: a pointer to the parent dentry for this file.  This should be a
 764  *          directory dentry if set.  If this parameter is %NULL, then the
 765  *          file will be created in the root of the debugfs filesystem.
 766  * @value: a pointer to the variable that the file should read to and write
 767  *         from.
 768  */
 769 void debugfs_create_atomic_t(const char *name, umode_t mode,
 770                              struct dentry *parent, atomic_t *value)
 771 {
 772         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_atomic_t,
 773                                    &fops_atomic_t_ro, &fops_atomic_t_wo);
 774 }
 775 EXPORT_SYMBOL_GPL(debugfs_create_atomic_t);
 776
 777 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
 778                                size_t count, loff_t *ppos)
 779 {
 780         char buf[3];
 781         bool val;
 782         int r;
 783         struct dentry *dentry = F_DENTRY(file);
 784
 785         r = debugfs_file_get(dentry);
 786         if (unlikely(r))
 787                 return r;
 788         val = *(bool *)file->private_data;
 789         debugfs_file_put(dentry);
 790
 791         if (val)
 792                 buf[0] = 'Y';
 793         else
 794                 buf[0] = 'N';
 795         buf[1] = '\n';
 796         buf[2] = 0x00;
 797         return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
 798 }
 799 EXPORT_SYMBOL_GPL(debugfs_read_file_bool);
 800
 801 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
 802                                 size_t count, loff_t *ppos)
 803 {
 804         bool bv;
 805         int r;
 806         bool *val = file->private_data;
 807         struct dentry *dentry = F_DENTRY(file);
 808
 809         r = kstrtobool_from_user(user_buf, count, &bv);
 810         if (!r) {
 811                 r = debugfs_file_get(dentry);
 812                 if (unlikely(r))
 813                         return r;
 814                 *val = bv;
 815                 debugfs_file_put(dentry);
 816         }
 817
 818         return count;
 819 }
 820 EXPORT_SYMBOL_GPL(debugfs_write_file_bool);
 821
 822 static const struct file_operations fops_bool = {
 823         .read =         debugfs_read_file_bool,
 824         .write =        debugfs_write_file_bool,
 825         .open =         simple_open,
 826         .llseek =       default_llseek,
 827 };
 828
 829 static const struct file_operations fops_bool_ro = {
 830         .read =         debugfs_read_file_bool,
 831         .open =         simple_open,
 832         .llseek =       default_llseek,
 833 };
 834
 835 static const struct file_operations fops_bool_wo = {
 836         .write =        debugfs_write_file_bool,
 837         .open =         simple_open,
 838         .llseek =       default_llseek,
 839 };
 840
 841 /**
 842  * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
 843  * @name: a pointer to a string containing the name of the file to create.
 844  * @mode: the permission that the file should have
 845  * @parent: a pointer to the parent dentry for this file.  This should be a
 846  *          directory dentry if set.  If this parameter is %NULL, then the
 847  *          file will be created in the root of the debugfs filesystem.
 848  * @value: a pointer to the variable that the file should read to and write
 849  *         from.
 850  *
 851  * This function creates a file in debugfs with the given name that
 852  * contains the value of the variable @value.  If the @mode variable is so
 853  * set, it can be read from, and written to.
 854  *
 855  * This function will return a pointer to a dentry if it succeeds.  This
 856  * pointer must be passed to the debugfs_remove() function when the file is
 857  * to be removed (no automatic cleanup happens if your module is unloaded,
 858  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
 859  * returned.
 860  *
 861  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
 862  * be returned.
 863  */
 864 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 865                                    struct dentry *parent, bool *value)
 866 {
 867         return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_bool,
 868                                    &fops_bool_ro, &fops_bool_wo);
 869 }
 870 EXPORT_SYMBOL_GPL(debugfs_create_bool);
 871
 872 static ssize_t read_file_blob(struct file *file, char __user *user_buf,
 873                               size_t count, loff_t *ppos)
 874 {
 875         struct debugfs_blob_wrapper *blob = file->private_data;
 876         struct dentry *dentry = F_DENTRY(file);
 877         ssize_t r;
 878
 879         r = debugfs_file_get(dentry);
 880         if (unlikely(r))
 881                 return r;
 882         r = simple_read_from_buffer(user_buf, count, ppos, blob->data,
 883                                 blob->size);
 884         debugfs_file_put(dentry);
 885         return r;
 886 }
 887
 888 static const struct file_operations fops_blob = {
 889         .read =         read_file_blob,
 890         .open =         simple_open,
 891         .llseek =       default_llseek,
 892 };
 893
 894 /**
 895  * debugfs_create_blob - create a debugfs file that is used to read a binary blob
 896  * @name: a pointer to a string containing the name of the file to create.
 897  * @mode: the permission that the file should have
 898  * @parent: a pointer to the parent dentry for this file.  This should be a
 899  *          directory dentry if set.  If this parameter is %NULL, then the
 900  *          file will be created in the root of the debugfs filesystem.
 901  * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
 902  *        to the blob data and the size of the data.
 903  *
 904  * This function creates a file in debugfs with the given name that exports
 905  * @blob->data as a binary blob. If the @mode variable is so set it can be
 906  * read from. Writing is not supported.
 907  *
 908  * This function will return a pointer to a dentry if it succeeds.  This
 909  * pointer must be passed to the debugfs_remove() function when the file is
 910  * to be removed (no automatic cleanup happens if your module is unloaded,
 911  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
 912  * returned.
 913  *
 914  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
 915  * be returned.
 916  */
 917 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 918                                    struct dentry *parent,
 919                                    struct debugfs_blob_wrapper *blob)
 920 {
 921         return debugfs_create_file_unsafe(name, mode, parent, blob, &fops_blob);
 922 }
 923 EXPORT_SYMBOL_GPL(debugfs_create_blob);
 924
 925 static size_t u32_format_array(char *buf, size_t bufsize,
 926                                u32 *array, int array_size)
 927 {
 928         size_t ret = 0;
 929
 930         while (--array_size >= 0) {
 931                 size_t len;
 932                 char term = array_size ? ' ' : '\n';
 933
 934                 len = snprintf(buf, bufsize, "%u%c", *array++, term);
 935                 ret += len;
 936
 937                 buf += len;
 938                 bufsize -= len;
 939         }
 940         return ret;
 941 }
 942
 943 static int u32_array_open(struct inode *inode, struct file *file)
 944 {
 945         struct debugfs_u32_array *data = inode->i_private;
 946         int size, elements = data->n_elements;
 947         char *buf;
 948
 949         /*
 950          * Max size:
 951          *  - 10 digits + ' '/'\n' = 11 bytes per number
 952          *  - terminating NUL character
 953          */
 954         size = elements*11;
 955         buf = kmalloc(size+1, GFP_KERNEL);
 956         if (!buf)
 957                 return -ENOMEM;
 958         buf[size] = 0;
 959
 960         file->private_data = buf;
 961         u32_format_array(buf, size, data->array, data->n_elements);
 962
 963         return nonseekable_open(inode, file);
 964 }
 965
 966 static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len,
 967                               loff_t *ppos)
 968 {
 969         size_t size = strlen(file->private_data);
 970
 971         return simple_read_from_buffer(buf, len, ppos,
 972                                         file->private_data, size);
 973 }
 974
 975 static int u32_array_release(struct inode *inode, struct file *file)
 976 {
 977         kfree(file->private_data);
 978
 979         return 0;
 980 }
 981
 982 static const struct file_operations u32_array_fops = {
 983         .owner   = THIS_MODULE,
 984         .open    = u32_array_open,
 985         .release = u32_array_release,
 986         .read    = u32_array_read,
 987         .llseek  = no_llseek,
 988 };
 989
 990 /**
 991  * debugfs_create_u32_array - create a debugfs file that is used to read u32
 992  * array.
 993  * @name: a pointer to a string containing the name of the file to create.
 994  * @mode: the permission that the file should have.
 995  * @parent: a pointer to the parent dentry for this file.  This should be a
 996  *          directory dentry if set.  If this parameter is %NULL, then the
 997  *          file will be created in the root of the debugfs filesystem.
 998  * @array: wrapper struct containing data pointer and size of the array.
 999  *
1000  * This function creates a file in debugfs with the given name that exports
1001  * @array as data. If the @mode variable is so set it can be read from.
1002  * Writing is not supported. Seek within the file is also not supported.
1003  * Once array is created its size can not be changed.
1004  */
1005 void debugfs_create_u32_array(const char *name, umode_t mode,
1006                               struct dentry *parent,
1007                               struct debugfs_u32_array *array)
1008 {
1009         debugfs_create_file_unsafe(name, mode, parent, array, &u32_array_fops);
1010 }
1011 EXPORT_SYMBOL_GPL(debugfs_create_u32_array);
1012
1013 #ifdef CONFIG_HAS_IOMEM
1014
1015 /*
1016  * The regset32 stuff is used to print 32-bit registers using the
1017  * seq_file utilities. We offer printing a register set in an already-opened
1018  * sequential file or create a debugfs file that only prints a regset32.
1019  */
1020
1021 /**
1022  * debugfs_print_regs32 - use seq_print to describe a set of registers
1023  * @s: the seq_file structure being used to generate output
1024  * @regs: an array if struct debugfs_reg32 structures
1025  * @nregs: the length of the above array
1026  * @base: the base address to be used in reading the registers
1027  * @prefix: a string to be prefixed to every output line
1028  *
1029  * This function outputs a text block describing the current values of
1030  * some 32-bit hardware registers. It is meant to be used within debugfs
1031  * files based on seq_file that need to show registers, intermixed with other
1032  * information. The prefix argument may be used to specify a leading string,
1033  * because some peripherals have several blocks of identical registers,
1034  * for example configuration of dma channels
1035  */
1036 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
1037                           int nregs, void __iomem *base, char *prefix)
1038 {
1039         int i;
1040
1041         for (i = 0; i < nregs; i++, regs++) {
1042                 if (prefix)
1043                         seq_printf(s, "%s", prefix);
1044                 seq_printf(s, "%s = 0x%08x\n", regs->name,
1045                            readl(base + regs->offset));
1046                 if (seq_has_overflowed(s))
1047                         break;
1048         }
1049 }
1050 EXPORT_SYMBOL_GPL(debugfs_print_regs32);
1051
1052 static int debugfs_show_regset32(struct seq_file *s, void *data)
1053 {
1054         struct debugfs_regset32 *regset = s->private;
1055
1056         if (regset->dev)
1057                 pm_runtime_get_sync(regset->dev);
1058
1059         debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
1060
1061         if (regset->dev)
1062                 pm_runtime_put(regset->dev);
1063
1064         return 0;
1065 }
1066
1067 static int debugfs_open_regset32(struct inode *inode, struct file *file)
1068 {
1069         return single_open(file, debugfs_show_regset32, inode->i_private);
1070 }
1071
1072 static const struct file_operations fops_regset32 = {
1073         .open =         debugfs_open_regset32,
1074         .read =         seq_read,
1075         .llseek =       seq_lseek,
1076         .release =      single_release,
1077 };
1078
1079 /**
1080  * debugfs_create_regset32 - create a debugfs file that returns register values
1081  * @name: a pointer to a string containing the name of the file to create.
1082  * @mode: the permission that the file should have
1083  * @parent: a pointer to the parent dentry for this file.  This should be a
1084  *          directory dentry if set.  If this parameter is %NULL, then the
1085  *          file will be created in the root of the debugfs filesystem.
1086  * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
1087  *          to an array of register definitions, the array size and the base
1088  *          address where the register bank is to be found.
1089  *
1090  * This function creates a file in debugfs with the given name that reports
1091  * the names and values of a set of 32-bit registers. If the @mode variable
1092  * is so set it can be read from. Writing is not supported.
1093  */
1094 void debugfs_create_regset32(const char *name, umode_t mode,
1095                              struct dentry *parent,
1096                              struct debugfs_regset32 *regset)
1097 {
1098         debugfs_create_file(name, mode, parent, regset, &fops_regset32);
1099 }
1100 EXPORT_SYMBOL_GPL(debugfs_create_regset32);
1101
1102 #endif /* CONFIG_HAS_IOMEM */
1103
1104 struct debugfs_devm_entry {
1105         int (*read)(struct seq_file *seq, void *data);
1106         struct device *dev;
1107 };
1108
1109 static int debugfs_devm_entry_open(struct inode *inode, struct file *f)
1110 {
1111         struct debugfs_devm_entry *entry = inode->i_private;
1112
1113         return single_open(f, entry->read, entry->dev);
1114 }
1115
1116 static const struct file_operations debugfs_devm_entry_ops = {
1117         .owner = THIS_MODULE,
1118         .open = debugfs_devm_entry_open,
1119         .release = single_release,
1120         .read = seq_read,
1121         .llseek = seq_lseek
1122 };
1123
1124 /**
1125  * debugfs_create_devm_seqfile - create a debugfs file that is bound to device.
1126  *
1127  * @dev: device related to this debugfs file.
1128  * @name: name of the debugfs file.
1129  * @parent: a pointer to the parent dentry for this file.  This should be a
1130  *      directory dentry if set.  If this parameter is %NULL, then the
1131  *      file will be created in the root of the debugfs filesystem.
1132  * @read_fn: function pointer called to print the seq_file content.
1133  */
1134 void debugfs_create_devm_seqfile(struct device *dev, const char *name,
1135                                  struct dentry *parent,
1136                                  int (*read_fn)(struct seq_file *s, void *data))
1137 {
1138         struct debugfs_devm_entry *entry;
1139
1140         if (IS_ERR(parent))
1141                 return;
1142
1143         entry = devm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
1144         if (!entry)
1145                 return;
1146
1147         entry->read = read_fn;
1148         entry->dev = dev;
1149
1150         debugfs_create_file(name, S_IRUGO, parent, entry,
1151                             &debugfs_devm_entry_ops);
1152 }
1153 EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile);