drivers/base/core.c

   1 /*
   2  * drivers/base/core.c - core driver model code (device registration, etc)
   3  *
   4  * Copyright (c) 2002-3 Patrick Mochel
   5  * Copyright (c) 2002-3 Open Source Development Labs
   6  * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
   7  * Copyright (c) 2006 Novell, Inc.
   8  *
   9  * This file is released under the GPLv2
  10  *
  11  */
  12
  13 #include <linux/device.h>
  14 #include <linux/err.h>
  15 #include <linux/init.h>
  16 #include <linux/module.h>
  17 #include <linux/slab.h>
  18 #include <linux/string.h>
  19 #include <linux/kdev_t.h>
  20 #include <linux/notifier.h>
  21 #include <linux/of.h>
  22 #include <linux/of_device.h>
  23 #include <linux/genhd.h>
  24 #include <linux/kallsyms.h>
  25 #include <linux/mutex.h>
  26 #include <linux/async.h>
  27 #include <linux/pm_runtime.h>
  28 #include <linux/netdevice.h>
  29 #include <linux/sysfs.h>
  30
  31 #include "base.h"
  32 #include "power/power.h"
  33
  34 #ifdef CONFIG_SYSFS_DEPRECATED
  35 #ifdef CONFIG_SYSFS_DEPRECATED_V2
  36 long sysfs_deprecated = 1;
  37 #else
  38 long sysfs_deprecated = 0;
  39 #endif
  40 static int __init sysfs_deprecated_setup(char *arg)
  41 {
  42         return kstrtol(arg, 10, &sysfs_deprecated);
  43 }
  44 early_param("sysfs.deprecated", sysfs_deprecated_setup);
  45 #endif
  46
  47 int (*platform_notify)(struct device *dev) = NULL;
  48 int (*platform_notify_remove)(struct device *dev) = NULL;
  49 static struct kobject *dev_kobj;
  50 struct kobject *sysfs_dev_char_kobj;
  51 struct kobject *sysfs_dev_block_kobj;
  52
  53 static DEFINE_MUTEX(device_hotplug_lock);
  54
  55 void lock_device_hotplug(void)
  56 {
  57         mutex_lock(&device_hotplug_lock);
  58 }
  59
  60 void unlock_device_hotplug(void)
  61 {
  62         mutex_unlock(&device_hotplug_lock);
  63 }
  64
  65 int lock_device_hotplug_sysfs(void)
  66 {
  67         if (mutex_trylock(&device_hotplug_lock))
  68                 return 0;
  69
  70         /* Avoid busy looping (5 ms of sleep should do). */
  71         msleep(5);
  72         return restart_syscall();
  73 }
  74
  75 #ifdef CONFIG_BLOCK
  76 static inline int device_is_not_partition(struct device *dev)
  77 {
  78         return !(dev->type == &part_type);
  79 }
  80 #else
  81 static inline int device_is_not_partition(struct device *dev)
  82 {
  83         return 1;
  84 }
  85 #endif
  86
  87 /**
  88  * dev_driver_string - Return a device's driver name, if at all possible
  89  * @dev: struct device to get the name of
  90  *
  91  * Will return the device's driver's name if it is bound to a device.  If
  92  * the device is not bound to a driver, it will return the name of the bus
  93  * it is attached to.  If it is not attached to a bus either, an empty
  94  * string will be returned.
  95  */
  96 const char *dev_driver_string(const struct device *dev)
  97 {
  98         struct device_driver *drv;
  99
 100         /* dev->driver can change to NULL underneath us because of unbinding,
 101          * so be careful about accessing it.  dev->bus and dev->class should
 102          * never change once they are set, so they don't need special care.
 103          */
 104         drv = ACCESS_ONCE(dev->driver);
 105         return drv ? drv->name :
 106                         (dev->bus ? dev->bus->name :
 107                         (dev->class ? dev->class->name : ""));
 108 }
 109 EXPORT_SYMBOL(dev_driver_string);
 110
 111 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
 112
 113 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
 114                              char *buf)
 115 {
 116         struct device_attribute *dev_attr = to_dev_attr(attr);
 117         struct device *dev = kobj_to_dev(kobj);
 118         ssize_t ret = -EIO;
 119
 120         if (dev_attr->show)
 121                 ret = dev_attr->show(dev, dev_attr, buf);
 122         if (ret >= (ssize_t)PAGE_SIZE) {
 123                 print_symbol("dev_attr_show: %s returned bad count\n",
 124                                 (unsigned long)dev_attr->show);
 125         }
 126         return ret;
 127 }
 128
 129 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
 130                               const char *buf, size_t count)
 131 {
 132         struct device_attribute *dev_attr = to_dev_attr(attr);
 133         struct device *dev = kobj_to_dev(kobj);
 134         ssize_t ret = -EIO;
 135
 136         if (dev_attr->store)
 137                 ret = dev_attr->store(dev, dev_attr, buf, count);
 138         return ret;
 139 }
 140
 141 static const struct sysfs_ops dev_sysfs_ops = {
 142         .show   = dev_attr_show,
 143         .store  = dev_attr_store,
 144 };
 145
 146 #define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
 147
 148 ssize_t device_store_ulong(struct device *dev,
 149                            struct device_attribute *attr,
 150                            const char *buf, size_t size)
 151 {
 152         struct dev_ext_attribute *ea = to_ext_attr(attr);
 153         char *end;
 154         unsigned long new = simple_strtoul(buf, &end, 0);
 155         if (end == buf)
 156                 return -EINVAL;
 157         *(unsigned long *)(ea->var) = new;
 158         /* Always return full write size even if we didn't consume all */
 159         return size;
 160 }
 161 EXPORT_SYMBOL_GPL(device_store_ulong);
 162
 163 ssize_t device_show_ulong(struct device *dev,
 164                           struct device_attribute *attr,
 165                           char *buf)
 166 {
 167         struct dev_ext_attribute *ea = to_ext_attr(attr);
 168         return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
 169 }
 170 EXPORT_SYMBOL_GPL(device_show_ulong);
 171
 172 ssize_t device_store_int(struct device *dev,
 173                          struct device_attribute *attr,
 174                          const char *buf, size_t size)
 175 {
 176         struct dev_ext_attribute *ea = to_ext_attr(attr);
 177         char *end;
 178         long new = simple_strtol(buf, &end, 0);
 179         if (end == buf || new > INT_MAX || new < INT_MIN)
 180                 return -EINVAL;
 181         *(int *)(ea->var) = new;
 182         /* Always return full write size even if we didn't consume all */
 183         return size;
 184 }
 185 EXPORT_SYMBOL_GPL(device_store_int);
 186
 187 ssize_t device_show_int(struct device *dev,
 188                         struct device_attribute *attr,
 189                         char *buf)
 190 {
 191         struct dev_ext_attribute *ea = to_ext_attr(attr);
 192
 193         return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
 194 }
 195 EXPORT_SYMBOL_GPL(device_show_int);
 196
 197 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
 198                           const char *buf, size_t size)
 199 {
 200         struct dev_ext_attribute *ea = to_ext_attr(attr);
 201
 202         if (strtobool(buf, ea->var) < 0)
 203                 return -EINVAL;
 204
 205         return size;
 206 }
 207 EXPORT_SYMBOL_GPL(device_store_bool);
 208
 209 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
 210                          char *buf)
 211 {
 212         struct dev_ext_attribute *ea = to_ext_attr(attr);
 213
 214         return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
 215 }
 216 EXPORT_SYMBOL_GPL(device_show_bool);
 217
 218 /**
 219  * device_release - free device structure.
 220  * @kobj: device's kobject.
 221  *
 222  * This is called once the reference count for the object
 223  * reaches 0. We forward the call to the device's release
 224  * method, which should handle actually freeing the structure.
 225  */
 226 static void device_release(struct kobject *kobj)
 227 {
 228         struct device *dev = kobj_to_dev(kobj);
 229         struct device_private *p = dev->p;
 230
 231         /*
 232          * Some platform devices are driven without driver attached
 233          * and managed resources may have been acquired.  Make sure
 234          * all resources are released.
 235          *
 236          * Drivers still can add resources into device after device
 237          * is deleted but alive, so release devres here to avoid
 238          * possible memory leak.
 239          */
 240         devres_release_all(dev);
 241
 242         if (dev->release)
 243                 dev->release(dev);
 244         else if (dev->type && dev->type->release)
 245                 dev->type->release(dev);
 246         else if (dev->class && dev->class->dev_release)
 247                 dev->class->dev_release(dev);
 248         else
 249                 WARN(1, KERN_ERR "Device '%s' does not have a release() "
 250                         "function, it is broken and must be fixed.\n",
 251                         dev_name(dev));
 252         kfree(p);
 253 }
 254
 255 static const void *device_namespace(struct kobject *kobj)
 256 {
 257         struct device *dev = kobj_to_dev(kobj);
 258         const void *ns = NULL;
 259
 260         if (dev->class && dev->class->ns_type)
 261                 ns = dev->class->namespace(dev);
 262
 263         return ns;
 264 }
 265
 266 static struct kobj_type device_ktype = {
 267         .release        = device_release,
 268         .sysfs_ops      = &dev_sysfs_ops,
 269         .namespace      = device_namespace,
 270 };
 271
 272
 273 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
 274 {
 275         struct kobj_type *ktype = get_ktype(kobj);
 276
 277         if (ktype == &device_ktype) {
 278                 struct device *dev = kobj_to_dev(kobj);
 279                 if (dev->bus)
 280                         return 1;
 281                 if (dev->class)
 282                         return 1;
 283         }
 284         return 0;
 285 }
 286
 287 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
 288 {
 289         struct device *dev = kobj_to_dev(kobj);
 290
 291         if (dev->bus)
 292                 return dev->bus->name;
 293         if (dev->class)
 294                 return dev->class->name;
 295         return NULL;
 296 }
 297
 298 static int dev_uevent(struct kset *kset, struct kobject *kobj,
 299                       struct kobj_uevent_env *env)
 300 {
 301         struct device *dev = kobj_to_dev(kobj);
 302         int retval = 0;
 303
 304         /* add device node properties if present */
 305         if (MAJOR(dev->devt)) {
 306                 const char *tmp;
 307                 const char *name;
 308                 umode_t mode = 0;
 309                 kuid_t uid = GLOBAL_ROOT_UID;
 310                 kgid_t gid = GLOBAL_ROOT_GID;
 311
 312                 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
 313                 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
 314                 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
 315                 if (name) {
 316                         add_uevent_var(env, "DEVNAME=%s", name);
 317                         if (mode)
 318                                 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
 319                         if (!uid_eq(uid, GLOBAL_ROOT_UID))
 320                                 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
 321                         if (!gid_eq(gid, GLOBAL_ROOT_GID))
 322                                 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
 323                         kfree(tmp);
 324                 }
 325         }
 326
 327         if (dev->type && dev->type->name)
 328                 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
 329
 330         if (dev->driver)
 331                 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
 332
 333         /* Add common DT information about the device */
 334         of_device_uevent(dev, env);
 335
 336         /* have the bus specific function add its stuff */
 337         if (dev->bus && dev->bus->uevent) {
 338                 retval = dev->bus->uevent(dev, env);
 339                 if (retval)
 340                         pr_debug("device: '%s': %s: bus uevent() returned %d\n",
 341                                  dev_name(dev), __func__, retval);
 342         }
 343
 344         /* have the class specific function add its stuff */
 345         if (dev->class && dev->class->dev_uevent) {
 346                 retval = dev->class->dev_uevent(dev, env);
 347                 if (retval)
 348                         pr_debug("device: '%s': %s: class uevent() "
 349                                  "returned %d\n", dev_name(dev),
 350                                  __func__, retval);
 351         }
 352
 353         /* have the device type specific function add its stuff */
 354         if (dev->type && dev->type->uevent) {
 355                 retval = dev->type->uevent(dev, env);
 356                 if (retval)
 357                         pr_debug("device: '%s': %s: dev_type uevent() "
 358                                  "returned %d\n", dev_name(dev),
 359                                  __func__, retval);
 360         }
 361
 362         return retval;
 363 }
 364
 365 static const struct kset_uevent_ops device_uevent_ops = {
 366         .filter =       dev_uevent_filter,
 367         .name =         dev_uevent_name,
 368         .uevent =       dev_uevent,
 369 };
 370
 371 static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
 372                            char *buf)
 373 {
 374         struct kobject *top_kobj;
 375         struct kset *kset;
 376         struct kobj_uevent_env *env = NULL;
 377         int i;
 378         size_t count = 0;
 379         int retval;
 380
 381         /* search the kset, the device belongs to */
 382         top_kobj = &dev->kobj;
 383         while (!top_kobj->kset && top_kobj->parent)
 384                 top_kobj = top_kobj->parent;
 385         if (!top_kobj->kset)
 386                 goto out;
 387
 388         kset = top_kobj->kset;
 389         if (!kset->uevent_ops || !kset->uevent_ops->uevent)
 390                 goto out;
 391
 392         /* respect filter */
 393         if (kset->uevent_ops && kset->uevent_ops->filter)
 394                 if (!kset->uevent_ops->filter(kset, &dev->kobj))
 395                         goto out;
 396
 397         env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
 398         if (!env)
 399                 return -ENOMEM;
 400
 401         /* let the kset specific function add its keys */
 402         retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
 403         if (retval)
 404                 goto out;
 405
 406         /* copy keys to file */
 407         for (i = 0; i < env->envp_idx; i++)
 408                 count += sprintf(&buf[count], "%s\n", env->envp[i]);
 409 out:
 410         kfree(env);
 411         return count;
 412 }
 413
 414 static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
 415                             const char *buf, size_t count)
 416 {
 417         enum kobject_action action;
 418
 419         if (kobject_action_type(buf, count, &action) == 0)
 420                 kobject_uevent(&dev->kobj, action);
 421         else
 422                 dev_err(dev, "uevent: unknown action-string\n");
 423         return count;
 424 }
 425 static DEVICE_ATTR_RW(uevent);
 426
 427 static ssize_t online_show(struct device *dev, struct device_attribute *attr,
 428                            char *buf)
 429 {
 430         bool val;
 431
 432         device_lock(dev);
 433         val = !dev->offline;
 434         device_unlock(dev);
 435         return sprintf(buf, "%u\n", val);
 436 }
 437
 438 static ssize_t online_store(struct device *dev, struct device_attribute *attr,
 439                             const char *buf, size_t count)
 440 {
 441         bool val;
 442         int ret;
 443
 444         ret = strtobool(buf, &val);
 445         if (ret < 0)
 446                 return ret;
 447
 448         ret = lock_device_hotplug_sysfs();
 449         if (ret)
 450                 return ret;
 451
 452         ret = val ? device_online(dev) : device_offline(dev);
 453         unlock_device_hotplug();
 454         return ret < 0 ? ret : count;
 455 }
 456 static DEVICE_ATTR_RW(online);
 457
 458 static int device_add_attributes(struct device *dev,
 459                                  struct device_attribute *attrs)
 460 {
 461         int error = 0;
 462         int i;
 463
 464         if (attrs) {
 465                 for (i = 0; attrs[i].attr.name; i++) {
 466                         error = device_create_file(dev, &attrs[i]);
 467                         if (error)
 468                                 break;
 469                 }
 470                 if (error)
 471                         while (--i >= 0)
 472                                 device_remove_file(dev, &attrs[i]);
 473         }
 474         return error;
 475 }
 476
 477 static void device_remove_attributes(struct device *dev,
 478                                      struct device_attribute *attrs)
 479 {
 480         int i;
 481
 482         if (attrs)
 483                 for (i = 0; attrs[i].attr.name; i++)
 484                         device_remove_file(dev, &attrs[i]);
 485 }
 486
 487 static int device_add_bin_attributes(struct device *dev,
 488                                      struct bin_attribute *attrs)
 489 {
 490         int error = 0;
 491         int i;
 492
 493         if (attrs) {
 494                 for (i = 0; attrs[i].attr.name; i++) {
 495                         error = device_create_bin_file(dev, &attrs[i]);
 496                         if (error)
 497                                 break;
 498                 }
 499                 if (error)
 500                         while (--i >= 0)
 501                                 device_remove_bin_file(dev, &attrs[i]);
 502         }
 503         return error;
 504 }
 505
 506 static void device_remove_bin_attributes(struct device *dev,
 507                                          struct bin_attribute *attrs)
 508 {
 509         int i;
 510
 511         if (attrs)
 512                 for (i = 0; attrs[i].attr.name; i++)
 513                         device_remove_bin_file(dev, &attrs[i]);
 514 }
 515
 516 int device_add_groups(struct device *dev, const struct attribute_group **groups)
 517 {
 518         return sysfs_create_groups(&dev->kobj, groups);
 519 }
 520
 521 void device_remove_groups(struct device *dev,
 522                           const struct attribute_group **groups)
 523 {
 524         sysfs_remove_groups(&dev->kobj, groups);
 525 }
 526
 527 static int device_add_attrs(struct device *dev)
 528 {
 529         struct class *class = dev->class;
 530         const struct device_type *type = dev->type;
 531         int error;
 532
 533         if (class) {
 534                 error = device_add_groups(dev, class->dev_groups);
 535                 if (error)
 536                         return error;
 537                 error = device_add_attributes(dev, class->dev_attrs);
 538                 if (error)
 539                         goto err_remove_class_groups;
 540                 error = device_add_bin_attributes(dev, class->dev_bin_attrs);
 541                 if (error)
 542                         goto err_remove_class_attrs;
 543         }
 544
 545         if (type) {
 546                 error = device_add_groups(dev, type->groups);
 547                 if (error)
 548                         goto err_remove_class_bin_attrs;
 549         }
 550
 551         error = device_add_groups(dev, dev->groups);
 552         if (error)
 553                 goto err_remove_type_groups;
 554
 555         if (device_supports_offline(dev) && !dev->offline_disabled) {
 556                 error = device_create_file(dev, &dev_attr_online);
 557                 if (error)
 558                         goto err_remove_type_groups;
 559         }
 560
 561         return 0;
 562
 563  err_remove_type_groups:
 564         if (type)
 565                 device_remove_groups(dev, type->groups);
 566  err_remove_class_bin_attrs:
 567         if (class)
 568                 device_remove_bin_attributes(dev, class->dev_bin_attrs);
 569  err_remove_class_attrs:
 570         if (class)
 571                 device_remove_attributes(dev, class->dev_attrs);
 572  err_remove_class_groups:
 573         if (class)
 574                 device_remove_groups(dev, class->dev_groups);
 575
 576         return error;
 577 }
 578
 579 static void device_remove_attrs(struct device *dev)
 580 {
 581         struct class *class = dev->class;
 582         const struct device_type *type = dev->type;
 583
 584         device_remove_file(dev, &dev_attr_online);
 585         device_remove_groups(dev, dev->groups);
 586
 587         if (type)
 588                 device_remove_groups(dev, type->groups);
 589
 590         if (class) {
 591                 device_remove_attributes(dev, class->dev_attrs);
 592                 device_remove_bin_attributes(dev, class->dev_bin_attrs);
 593                 device_remove_groups(dev, class->dev_groups);
 594         }
 595 }
 596
 597 static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
 598                         char *buf)
 599 {
 600         return print_dev_t(buf, dev->devt);
 601 }
 602 static DEVICE_ATTR_RO(dev);
 603
 604 /* /sys/devices/ */
 605 struct kset *devices_kset;
 606
 607 /**
 608  * device_create_file - create sysfs attribute file for device.
 609  * @dev: device.
 610  * @attr: device attribute descriptor.
 611  */
 612 int device_create_file(struct device *dev,
 613                        const struct device_attribute *attr)
 614 {
 615         int error = 0;
 616
 617         if (dev) {
 618                 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
 619                         "Attribute %s: write permission without 'store'\n",
 620                         attr->attr.name);
 621                 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
 622                         "Attribute %s: read permission without 'show'\n",
 623                         attr->attr.name);
 624                 error = sysfs_create_file(&dev->kobj, &attr->attr);
 625         }
 626
 627         return error;
 628 }
 629 EXPORT_SYMBOL_GPL(device_create_file);
 630
 631 /**
 632  * device_remove_file - remove sysfs attribute file.
 633  * @dev: device.
 634  * @attr: device attribute descriptor.
 635  */
 636 void device_remove_file(struct device *dev,
 637                         const struct device_attribute *attr)
 638 {
 639         if (dev)
 640                 sysfs_remove_file(&dev->kobj, &attr->attr);
 641 }
 642 EXPORT_SYMBOL_GPL(device_remove_file);
 643
 644 /**
 645  * device_create_bin_file - create sysfs binary attribute file for device.
 646  * @dev: device.
 647  * @attr: device binary attribute descriptor.
 648  */
 649 int device_create_bin_file(struct device *dev,
 650                            const struct bin_attribute *attr)
 651 {
 652         int error = -EINVAL;
 653         if (dev)
 654                 error = sysfs_create_bin_file(&dev->kobj, attr);
 655         return error;
 656 }
 657 EXPORT_SYMBOL_GPL(device_create_bin_file);
 658
 659 /**
 660  * device_remove_bin_file - remove sysfs binary attribute file
 661  * @dev: device.
 662  * @attr: device binary attribute descriptor.
 663  */
 664 void device_remove_bin_file(struct device *dev,
 665                             const struct bin_attribute *attr)
 666 {
 667         if (dev)
 668                 sysfs_remove_bin_file(&dev->kobj, attr);
 669 }
 670 EXPORT_SYMBOL_GPL(device_remove_bin_file);
 671
 672 /**
 673  * device_schedule_callback_owner - helper to schedule a callback for a device
 674  * @dev: device.
 675  * @func: callback function to invoke later.
 676  * @owner: module owning the callback routine
 677  *
 678  * Attribute methods must not unregister themselves or their parent device
 679  * (which would amount to the same thing).  Attempts to do so will deadlock,
 680  * since unregistration is mutually exclusive with driver callbacks.
 681  *
 682  * Instead methods can call this routine, which will attempt to allocate
 683  * and schedule a workqueue request to call back @func with @dev as its
 684  * argument in the workqueue's process context.  @dev will be pinned until
 685  * @func returns.
 686  *
 687  * This routine is usually called via the inline device_schedule_callback(),
 688  * which automatically sets @owner to THIS_MODULE.
 689  *
 690  * Returns 0 if the request was submitted, -ENOMEM if storage could not
 691  * be allocated, -ENODEV if a reference to @owner isn't available.
 692  *
 693  * NOTE: This routine won't work if CONFIG_SYSFS isn't set!  It uses an
 694  * underlying sysfs routine (since it is intended for use by attribute
 695  * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
 696  */
 697 int device_schedule_callback_owner(struct device *dev,
 698                 void (*func)(struct device *), struct module *owner)
 699 {
 700         return sysfs_schedule_callback(&dev->kobj,
 701                         (void (*)(void *)) func, dev, owner);
 702 }
 703 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
 704
 705 static void klist_children_get(struct klist_node *n)
 706 {
 707         struct device_private *p = to_device_private_parent(n);
 708         struct device *dev = p->device;
 709
 710         get_device(dev);
 711 }
 712
 713 static void klist_children_put(struct klist_node *n)
 714 {
 715         struct device_private *p = to_device_private_parent(n);
 716         struct device *dev = p->device;
 717
 718         put_device(dev);
 719 }
 720
 721 /**
 722  * device_initialize - init device structure.
 723  * @dev: device.
 724  *
 725  * This prepares the device for use by other layers by initializing
 726  * its fields.
 727  * It is the first half of device_register(), if called by
 728  * that function, though it can also be called separately, so one
 729  * may use @dev's fields. In particular, get_device()/put_device()
 730  * may be used for reference counting of @dev after calling this
 731  * function.
 732  *
 733  * All fields in @dev must be initialized by the caller to 0, except
 734  * for those explicitly set to some other value.  The simplest
 735  * approach is to use kzalloc() to allocate the structure containing
 736  * @dev.
 737  *
 738  * NOTE: Use put_device() to give up your reference instead of freeing
 739  * @dev directly once you have called this function.
 740  */
 741 void device_initialize(struct device *dev)
 742 {
 743         dev->kobj.kset = devices_kset;
 744         kobject_init(&dev->kobj, &device_ktype);
 745         INIT_LIST_HEAD(&dev->dma_pools);
 746         mutex_init(&dev->mutex);
 747         lockdep_set_novalidate_class(&dev->mutex);
 748         spin_lock_init(&dev->devres_lock);
 749         INIT_LIST_HEAD(&dev->devres_head);
 750         device_pm_init(dev);
 751         set_dev_node(dev, -1);
 752 }
 753 EXPORT_SYMBOL_GPL(device_initialize);
 754
 755 struct kobject *virtual_device_parent(struct device *dev)
 756 {
 757         static struct kobject *virtual_dir = NULL;
 758
 759         if (!virtual_dir)
 760                 virtual_dir = kobject_create_and_add("virtual",
 761                                                      &devices_kset->kobj);
 762
 763         return virtual_dir;
 764 }
 765
 766 struct class_dir {
 767         struct kobject kobj;
 768         struct class *class;
 769 };
 770
 771 #define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
 772
 773 static void class_dir_release(struct kobject *kobj)
 774 {
 775         struct class_dir *dir = to_class_dir(kobj);
 776         kfree(dir);
 777 }
 778
 779 static const
 780 struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
 781 {
 782         struct class_dir *dir = to_class_dir(kobj);
 783         return dir->class->ns_type;
 784 }
 785
 786 static struct kobj_type class_dir_ktype = {
 787         .release        = class_dir_release,
 788         .sysfs_ops      = &kobj_sysfs_ops,
 789         .child_ns_type  = class_dir_child_ns_type
 790 };
 791
 792 static struct kobject *
 793 class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
 794 {
 795         struct class_dir *dir;
 796         int retval;
 797
 798         dir = kzalloc(sizeof(*dir), GFP_KERNEL);
 799         if (!dir)
 800                 return NULL;
 801
 802         dir->class = class;
 803         kobject_init(&dir->kobj, &class_dir_ktype);
 804
 805         dir->kobj.kset = &class->p->glue_dirs;
 806
 807         retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
 808         if (retval < 0) {
 809                 kobject_put(&dir->kobj);
 810                 return NULL;
 811         }
 812         return &dir->kobj;
 813 }
 814
 815
 816 static struct kobject *get_device_parent(struct device *dev,
 817                                          struct device *parent)
 818 {
 819         if (dev->class) {
 820                 static DEFINE_MUTEX(gdp_mutex);
 821                 struct kobject *kobj = NULL;
 822                 struct kobject *parent_kobj;
 823                 struct kobject *k;
 824
 825 #ifdef CONFIG_BLOCK
 826                 /* block disks show up in /sys/block */
 827                 if (sysfs_deprecated && dev->class == &block_class) {
 828                         if (parent && parent->class == &block_class)
 829                                 return &parent->kobj;
 830                         return &block_class.p->subsys.kobj;
 831                 }
 832 #endif
 833
 834                 /*
 835                  * If we have no parent, we live in "virtual".
 836                  * Class-devices with a non class-device as parent, live
 837                  * in a "glue" directory to prevent namespace collisions.
 838                  */
 839                 if (parent == NULL)
 840                         parent_kobj = virtual_device_parent(dev);
 841                 else if (parent->class && !dev->class->ns_type)
 842                         return &parent->kobj;
 843                 else
 844                         parent_kobj = &parent->kobj;
 845
 846                 mutex_lock(&gdp_mutex);
 847
 848                 /* find our class-directory at the parent and reference it */
 849                 spin_lock(&dev->class->p->glue_dirs.list_lock);
 850                 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
 851                         if (k->parent == parent_kobj) {
 852                                 kobj = kobject_get(k);
 853                                 break;
 854                         }
 855                 spin_unlock(&dev->class->p->glue_dirs.list_lock);
 856                 if (kobj) {
 857                         mutex_unlock(&gdp_mutex);
 858                         return kobj;
 859                 }
 860
 861                 /* or create a new class-directory at the parent device */
 862                 k = class_dir_create_and_add(dev->class, parent_kobj);
 863                 /* do not emit an uevent for this simple "glue" directory */
 864                 mutex_unlock(&gdp_mutex);
 865                 return k;
 866         }
 867
 868         /* subsystems can specify a default root directory for their devices */
 869         if (!parent && dev->bus && dev->bus->dev_root)
 870                 return &dev->bus->dev_root->kobj;
 871
 872         if (parent)
 873                 return &parent->kobj;
 874         return NULL;
 875 }
 876
 877 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
 878 {
 879         /* see if we live in a "glue" directory */
 880         if (!glue_dir || !dev->class ||
 881             glue_dir->kset != &dev->class->p->glue_dirs)
 882                 return;
 883
 884         kobject_put(glue_dir);
 885 }
 886
 887 static void cleanup_device_parent(struct device *dev)
 888 {
 889         cleanup_glue_dir(dev, dev->kobj.parent);
 890 }
 891
 892 static int device_add_class_symlinks(struct device *dev)
 893 {
 894         int error;
 895
 896         if (!dev->class)
 897                 return 0;
 898
 899         error = sysfs_create_link(&dev->kobj,
 900                                   &dev->class->p->subsys.kobj,
 901                                   "subsystem");
 902         if (error)
 903                 goto out;
 904
 905         if (dev->parent && device_is_not_partition(dev)) {
 906                 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
 907                                           "device");
 908                 if (error)
 909                         goto out_subsys;
 910         }
 911
 912 #ifdef CONFIG_BLOCK
 913         /* /sys/block has directories and does not need symlinks */
 914         if (sysfs_deprecated && dev->class == &block_class)
 915                 return 0;
 916 #endif
 917
 918         /* link in the class directory pointing to the device */
 919         error = sysfs_create_link(&dev->class->p->subsys.kobj,
 920                                   &dev->kobj, dev_name(dev));
 921         if (error)
 922                 goto out_device;
 923
 924         return 0;
 925
 926 out_device:
 927         sysfs_remove_link(&dev->kobj, "device");
 928
 929 out_subsys:
 930         sysfs_remove_link(&dev->kobj, "subsystem");
 931 out:
 932         return error;
 933 }
 934
 935 static void device_remove_class_symlinks(struct device *dev)
 936 {
 937         if (!dev->class)
 938                 return;
 939
 940         if (dev->parent && device_is_not_partition(dev))
 941                 sysfs_remove_link(&dev->kobj, "device");
 942         sysfs_remove_link(&dev->kobj, "subsystem");
 943 #ifdef CONFIG_BLOCK
 944         if (sysfs_deprecated && dev->class == &block_class)
 945                 return;
 946 #endif
 947         sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
 948 }
 949
 950 /**
 951  * dev_set_name - set a device name
 952  * @dev: device
 953  * @fmt: format string for the device's name
 954  */
 955 int dev_set_name(struct device *dev, const char *fmt, ...)
 956 {
 957         va_list vargs;
 958         int err;
 959
 960         va_start(vargs, fmt);
 961         err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
 962         va_end(vargs);
 963         return err;
 964 }
 965 EXPORT_SYMBOL_GPL(dev_set_name);
 966
 967 /**
 968  * device_to_dev_kobj - select a /sys/dev/ directory for the device
 969  * @dev: device
 970  *
 971  * By default we select char/ for new entries.  Setting class->dev_obj
 972  * to NULL prevents an entry from being created.  class->dev_kobj must
 973  * be set (or cleared) before any devices are registered to the class
 974  * otherwise device_create_sys_dev_entry() and
 975  * device_remove_sys_dev_entry() will disagree about the presence of
 976  * the link.
 977  */
 978 static struct kobject *device_to_dev_kobj(struct device *dev)
 979 {
 980         struct kobject *kobj;
 981
 982         if (dev->class)
 983                 kobj = dev->class->dev_kobj;
 984         else
 985                 kobj = sysfs_dev_char_kobj;
 986
 987         return kobj;
 988 }
 989
 990 static int device_create_sys_dev_entry(struct device *dev)
 991 {
 992         struct kobject *kobj = device_to_dev_kobj(dev);
 993         int error = 0;
 994         char devt_str[15];
 995
 996         if (kobj) {
 997                 format_dev_t(devt_str, dev->devt);
 998                 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
 999         }
1000
1001         return error;
1002 }
1003
1004 static void device_remove_sys_dev_entry(struct device *dev)
1005 {
1006         struct kobject *kobj = device_to_dev_kobj(dev);
1007         char devt_str[15];
1008
1009         if (kobj) {
1010                 format_dev_t(devt_str, dev->devt);
1011                 sysfs_remove_link(kobj, devt_str);
1012         }
1013 }
1014
1015 int device_private_init(struct device *dev)
1016 {
1017         dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
1018         if (!dev->p)
1019                 return -ENOMEM;
1020         dev->p->device = dev;
1021         klist_init(&dev->p->klist_children, klist_children_get,
1022                    klist_children_put);
1023         INIT_LIST_HEAD(&dev->p->deferred_probe);
1024         return 0;
1025 }
1026
1027 /**
1028  * device_add - add device to device hierarchy.
1029  * @dev: device.
1030  *
1031  * This is part 2 of device_register(), though may be called
1032  * separately _iff_ device_initialize() has been called separately.
1033  *
1034  * This adds @dev to the kobject hierarchy via kobject_add(), adds it
1035  * to the global and sibling lists for the device, then
1036  * adds it to the other relevant subsystems of the driver model.
1037  *
1038  * Do not call this routine or device_register() more than once for
1039  * any device structure.  The driver model core is not designed to work
1040  * with devices that get unregistered and then spring back to life.
1041  * (Among other things, it's very hard to guarantee that all references
1042  * to the previous incarnation of @dev have been dropped.)  Allocate
1043  * and register a fresh new struct device instead.
1044  *
1045  * NOTE: _Never_ directly free @dev after calling this function, even
1046  * if it returned an error! Always use put_device() to give up your
1047  * reference instead.
1048  */
1049 int device_add(struct device *dev)
1050 {
1051         struct device *parent = NULL;
1052         struct kobject *kobj;
1053         struct class_interface *class_intf;
1054         int error = -EINVAL;
1055
1056         dev = get_device(dev);
1057         if (!dev)
1058                 goto done;
1059
1060         if (!dev->p) {
1061                 error = device_private_init(dev);
1062                 if (error)
1063                         goto done;
1064         }
1065
1066         /*
1067          * for statically allocated devices, which should all be converted
1068          * some day, we need to initialize the name. We prevent reading back
1069          * the name, and force the use of dev_name()
1070          */
1071         if (dev->init_name) {
1072                 dev_set_name(dev, "%s", dev->init_name);
1073                 dev->init_name = NULL;
1074         }
1075
1076         /* subsystems can specify simple device enumeration */
1077         if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1078                 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1079
1080         if (!dev_name(dev)) {
1081                 error = -EINVAL;
1082                 goto name_error;
1083         }
1084
1085         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1086
1087         parent = get_device(dev->parent);
1088         kobj = get_device_parent(dev, parent);
1089         if (kobj)
1090                 dev->kobj.parent = kobj;
1091
1092         /* use parent numa_node */
1093         if (parent)
1094                 set_dev_node(dev, dev_to_node(parent));
1095
1096         /* first, register with generic layer. */
1097         /* we require the name to be set before, and pass NULL */
1098         error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
1099         if (error)
1100                 goto Error;
1101
1102         /* notify platform of device entry */
1103         if (platform_notify)
1104                 platform_notify(dev);
1105
1106         error = device_create_file(dev, &dev_attr_uevent);
1107         if (error)
1108                 goto attrError;
1109
1110         if (MAJOR(dev->devt)) {
1111                 error = device_create_file(dev, &dev_attr_dev);
1112                 if (error)
1113                         goto ueventattrError;
1114
1115                 error = device_create_sys_dev_entry(dev);
1116                 if (error)
1117                         goto devtattrError;
1118
1119                 devtmpfs_create_node(dev);
1120         }
1121
1122         error = device_add_class_symlinks(dev);
1123         if (error)
1124                 goto SymlinkError;
1125         error = device_add_attrs(dev);
1126         if (error)
1127                 goto AttrsError;
1128         error = bus_add_device(dev);
1129         if (error)
1130                 goto BusError;
1131         error = dpm_sysfs_add(dev);
1132         if (error)
1133                 goto DPMError;
1134         device_pm_add(dev);
1135
1136         /* Notify clients of device addition.  This call must come
1137          * after dpm_sysfs_add() and before kobject_uevent().
1138          */
1139         if (dev->bus)
1140                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1141                                              BUS_NOTIFY_ADD_DEVICE, dev);
1142
1143         kobject_uevent(&dev->kobj, KOBJ_ADD);
1144         bus_probe_device(dev);
1145         if (parent)
1146                 klist_add_tail(&dev->p->knode_parent,
1147                                &parent->p->klist_children);
1148
1149         if (dev->class) {
1150                 mutex_lock(&dev->class->p->mutex);
1151                 /* tie the class to the device */
1152                 klist_add_tail(&dev->knode_class,
1153                                &dev->class->p->klist_devices);
1154
1155                 /* notify any interfaces that the device is here */
1156                 list_for_each_entry(class_intf,
1157                                     &dev->class->p->interfaces, node)
1158                         if (class_intf->add_dev)
1159                                 class_intf->add_dev(dev, class_intf);
1160                 mutex_unlock(&dev->class->p->mutex);
1161         }
1162 done:
1163         put_device(dev);
1164         return error;
1165  DPMError:
1166         bus_remove_device(dev);
1167  BusError:
1168         device_remove_attrs(dev);
1169  AttrsError:
1170         device_remove_class_symlinks(dev);
1171  SymlinkError:
1172         if (MAJOR(dev->devt))
1173                 devtmpfs_delete_node(dev);
1174         if (MAJOR(dev->devt))
1175                 device_remove_sys_dev_entry(dev);
1176  devtattrError:
1177         if (MAJOR(dev->devt))
1178                 device_remove_file(dev, &dev_attr_dev);
1179  ueventattrError:
1180         device_remove_file(dev, &dev_attr_uevent);
1181  attrError:
1182         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1183         kobject_del(&dev->kobj);
1184  Error:
1185         cleanup_device_parent(dev);
1186         if (parent)
1187                 put_device(parent);
1188 name_error:
1189         kfree(dev->p);
1190         dev->p = NULL;
1191         goto done;
1192 }
1193 EXPORT_SYMBOL_GPL(device_add);
1194
1195 /**
1196  * device_register - register a device with the system.
1197  * @dev: pointer to the device structure
1198  *
1199  * This happens in two clean steps - initialize the device
1200  * and add it to the system. The two steps can be called
1201  * separately, but this is the easiest and most common.
1202  * I.e. you should only call the two helpers separately if
1203  * have a clearly defined need to use and refcount the device
1204  * before it is added to the hierarchy.
1205  *
1206  * For more information, see the kerneldoc for device_initialize()
1207  * and device_add().
1208  *
1209  * NOTE: _Never_ directly free @dev after calling this function, even
1210  * if it returned an error! Always use put_device() to give up the
1211  * reference initialized in this function instead.
1212  */
1213 int device_register(struct device *dev)
1214 {
1215         device_initialize(dev);
1216         return device_add(dev);
1217 }
1218 EXPORT_SYMBOL_GPL(device_register);
1219
1220 /**
1221  * get_device - increment reference count for device.
1222  * @dev: device.
1223  *
1224  * This simply forwards the call to kobject_get(), though
1225  * we do take care to provide for the case that we get a NULL
1226  * pointer passed in.
1227  */
1228 struct device *get_device(struct device *dev)
1229 {
1230         return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
1231 }
1232 EXPORT_SYMBOL_GPL(get_device);
1233
1234 /**
1235  * put_device - decrement reference count.
1236  * @dev: device in question.
1237  */
1238 void put_device(struct device *dev)
1239 {
1240         /* might_sleep(); */
1241         if (dev)
1242                 kobject_put(&dev->kobj);
1243 }
1244 EXPORT_SYMBOL_GPL(put_device);
1245
1246 /**
1247  * device_del - delete device from system.
1248  * @dev: device.
1249  *
1250  * This is the first part of the device unregistration
1251  * sequence. This removes the device from the lists we control
1252  * from here, has it removed from the other driver model
1253  * subsystems it was added to in device_add(), and removes it
1254  * from the kobject hierarchy.
1255  *
1256  * NOTE: this should be called manually _iff_ device_add() was
1257  * also called manually.
1258  */
1259 void device_del(struct device *dev)
1260 {
1261         struct device *parent = dev->parent;
1262         struct class_interface *class_intf;
1263
1264         /* Notify clients of device removal.  This call must come
1265          * before dpm_sysfs_remove().
1266          */
1267         if (dev->bus)
1268                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1269                                              BUS_NOTIFY_DEL_DEVICE, dev);
1270         dpm_sysfs_remove(dev);
1271         if (parent)
1272                 klist_del(&dev->p->knode_parent);
1273         if (MAJOR(dev->devt)) {
1274                 devtmpfs_delete_node(dev);
1275                 device_remove_sys_dev_entry(dev);
1276                 device_remove_file(dev, &dev_attr_dev);
1277         }
1278         if (dev->class) {
1279                 device_remove_class_symlinks(dev);
1280
1281                 mutex_lock(&dev->class->p->mutex);
1282                 /* notify any interfaces that the device is now gone */
1283                 list_for_each_entry(class_intf,
1284                                     &dev->class->p->interfaces, node)
1285                         if (class_intf->remove_dev)
1286                                 class_intf->remove_dev(dev, class_intf);
1287                 /* remove the device from the class list */
1288                 klist_del(&dev->knode_class);
1289                 mutex_unlock(&dev->class->p->mutex);
1290         }
1291         device_remove_file(dev, &dev_attr_uevent);
1292         device_remove_attrs(dev);
1293         bus_remove_device(dev);
1294         device_pm_remove(dev);
1295         driver_deferred_probe_del(dev);
1296
1297         /* Notify the platform of the removal, in case they
1298          * need to do anything...
1299          */
1300         if (platform_notify_remove)
1301                 platform_notify_remove(dev);
1302         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1303         cleanup_device_parent(dev);
1304         kobject_del(&dev->kobj);
1305         put_device(parent);
1306 }
1307 EXPORT_SYMBOL_GPL(device_del);
1308
1309 /**
1310  * device_unregister - unregister device from system.
1311  * @dev: device going away.
1312  *
1313  * We do this in two parts, like we do device_register(). First,
1314  * we remove it from all the subsystems with device_del(), then
1315  * we decrement the reference count via put_device(). If that
1316  * is the final reference count, the device will be cleaned up
1317  * via device_release() above. Otherwise, the structure will
1318  * stick around until the final reference to the device is dropped.
1319  */
1320 void device_unregister(struct device *dev)
1321 {
1322         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1323         device_del(dev);
1324         put_device(dev);
1325 }
1326 EXPORT_SYMBOL_GPL(device_unregister);
1327
1328 static struct device *next_device(struct klist_iter *i)
1329 {
1330         struct klist_node *n = klist_next(i);
1331         struct device *dev = NULL;
1332         struct device_private *p;
1333
1334         if (n) {
1335                 p = to_device_private_parent(n);
1336                 dev = p->device;
1337         }
1338         return dev;
1339 }
1340
1341 /**
1342  * device_get_devnode - path of device node file
1343  * @dev: device
1344  * @mode: returned file access mode
1345  * @uid: returned file owner
1346  * @gid: returned file group
1347  * @tmp: possibly allocated string
1348  *
1349  * Return the relative path of a possible device node.
1350  * Non-default names may need to allocate a memory to compose
1351  * a name. This memory is returned in tmp and needs to be
1352  * freed by the caller.
1353  */
1354 const char *device_get_devnode(struct device *dev,
1355                                umode_t *mode, kuid_t *uid, kgid_t *gid,
1356                                const char **tmp)
1357 {
1358         char *s;
1359
1360         *tmp = NULL;
1361
1362         /* the device type may provide a specific name */
1363         if (dev->type && dev->type->devnode)
1364                 *tmp = dev->type->devnode(dev, mode, uid, gid);
1365         if (*tmp)
1366                 return *tmp;
1367
1368         /* the class may provide a specific name */
1369         if (dev->class && dev->class->devnode)
1370                 *tmp = dev->class->devnode(dev, mode);
1371         if (*tmp)
1372                 return *tmp;
1373
1374         /* return name without allocation, tmp == NULL */
1375         if (strchr(dev_name(dev), '!') == NULL)
1376                 return dev_name(dev);
1377
1378         /* replace '!' in the name with '/' */
1379         *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1380         if (!*tmp)
1381                 return NULL;
1382         while ((s = strchr(*tmp, '!')))
1383                 s[0] = '/';
1384         return *tmp;
1385 }
1386
1387 /**
1388  * device_for_each_child - device child iterator.
1389  * @parent: parent struct device.
1390  * @fn: function to be called for each device.
1391  * @data: data for the callback.
1392  *
1393  * Iterate over @parent's child devices, and call @fn for each,
1394  * passing it @data.
1395  *
1396  * We check the return of @fn each time. If it returns anything
1397  * other than 0, we break out and return that value.
1398  */
1399 int device_for_each_child(struct device *parent, void *data,
1400                           int (*fn)(struct device *dev, void *data))
1401 {
1402         struct klist_iter i;
1403         struct device *child;
1404         int error = 0;
1405
1406         if (!parent->p)
1407                 return 0;
1408
1409         klist_iter_init(&parent->p->klist_children, &i);
1410         while ((child = next_device(&i)) && !error)
1411                 error = fn(child, data);
1412         klist_iter_exit(&i);
1413         return error;
1414 }
1415 EXPORT_SYMBOL_GPL(device_for_each_child);
1416
1417 /**
1418  * device_find_child - device iterator for locating a particular device.
1419  * @parent: parent struct device
1420  * @match: Callback function to check device
1421  * @data: Data to pass to match function
1422  *
1423  * This is similar to the device_for_each_child() function above, but it
1424  * returns a reference to a device that is 'found' for later use, as
1425  * determined by the @match callback.
1426  *
1427  * The callback should return 0 if the device doesn't match and non-zero
1428  * if it does.  If the callback returns non-zero and a reference to the
1429  * current device can be obtained, this function will return to the caller
1430  * and not iterate over any more devices.
1431  *
1432  * NOTE: you will need to drop the reference with put_device() after use.
1433  */
1434 struct device *device_find_child(struct device *parent, void *data,
1435                                  int (*match)(struct device *dev, void *data))
1436 {
1437         struct klist_iter i;
1438         struct device *child;
1439
1440         if (!parent)
1441                 return NULL;
1442
1443         klist_iter_init(&parent->p->klist_children, &i);
1444         while ((child = next_device(&i)))
1445                 if (match(child, data) && get_device(child))
1446                         break;
1447         klist_iter_exit(&i);
1448         return child;
1449 }
1450 EXPORT_SYMBOL_GPL(device_find_child);
1451
1452 int __init devices_init(void)
1453 {
1454         devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1455         if (!devices_kset)
1456                 return -ENOMEM;
1457         dev_kobj = kobject_create_and_add("dev", NULL);
1458         if (!dev_kobj)
1459                 goto dev_kobj_err;
1460         sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1461         if (!sysfs_dev_block_kobj)
1462                 goto block_kobj_err;
1463         sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1464         if (!sysfs_dev_char_kobj)
1465                 goto char_kobj_err;
1466
1467         return 0;
1468
1469  char_kobj_err:
1470         kobject_put(sysfs_dev_block_kobj);
1471  block_kobj_err:
1472         kobject_put(dev_kobj);
1473  dev_kobj_err:
1474         kset_unregister(devices_kset);
1475         return -ENOMEM;
1476 }
1477
1478 static int device_check_offline(struct device *dev, void *not_used)
1479 {
1480         int ret;
1481
1482         ret = device_for_each_child(dev, NULL, device_check_offline);
1483         if (ret)
1484                 return ret;
1485
1486         return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1487 }
1488
1489 /**
1490  * device_offline - Prepare the device for hot-removal.
1491  * @dev: Device to be put offline.
1492  *
1493  * Execute the device bus type's .offline() callback, if present, to prepare
1494  * the device for a subsequent hot-removal.  If that succeeds, the device must
1495  * not be used until either it is removed or its bus type's .online() callback
1496  * is executed.
1497  *
1498  * Call under device_hotplug_lock.
1499  */
1500 int device_offline(struct device *dev)
1501 {
1502         int ret;
1503
1504         if (dev->offline_disabled)
1505                 return -EPERM;
1506
1507         ret = device_for_each_child(dev, NULL, device_check_offline);
1508         if (ret)
1509                 return ret;
1510
1511         device_lock(dev);
1512         if (device_supports_offline(dev)) {
1513                 if (dev->offline) {
1514                         ret = 1;
1515                 } else {
1516                         ret = dev->bus->offline(dev);
1517                         if (!ret) {
1518                                 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1519                                 dev->offline = true;
1520                         }
1521                 }
1522         }
1523         device_unlock(dev);
1524
1525         return ret;
1526 }
1527
1528 /**
1529  * device_online - Put the device back online after successful device_offline().
1530  * @dev: Device to be put back online.
1531  *
1532  * If device_offline() has been successfully executed for @dev, but the device
1533  * has not been removed subsequently, execute its bus type's .online() callback
1534  * to indicate that the device can be used again.
1535  *
1536  * Call under device_hotplug_lock.
1537  */
1538 int device_online(struct device *dev)
1539 {
1540         int ret = 0;
1541
1542         device_lock(dev);
1543         if (device_supports_offline(dev)) {
1544                 if (dev->offline) {
1545                         ret = dev->bus->online(dev);
1546                         if (!ret) {
1547                                 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1548                                 dev->offline = false;
1549                         }
1550                 } else {
1551                         ret = 1;
1552                 }
1553         }
1554         device_unlock(dev);
1555
1556         return ret;
1557 }
1558
1559 struct root_device {
1560         struct device dev;
1561         struct module *owner;
1562 };
1563
1564 static inline struct root_device *to_root_device(struct device *d)
1565 {
1566         return container_of(d, struct root_device, dev);
1567 }
1568
1569 static void root_device_release(struct device *dev)
1570 {
1571         kfree(to_root_device(dev));
1572 }
1573
1574 /**
1575  * __root_device_register - allocate and register a root device
1576  * @name: root device name
1577  * @owner: owner module of the root device, usually THIS_MODULE
1578  *
1579  * This function allocates a root device and registers it
1580  * using device_register(). In order to free the returned
1581  * device, use root_device_unregister().
1582  *
1583  * Root devices are dummy devices which allow other devices
1584  * to be grouped under /sys/devices. Use this function to
1585  * allocate a root device and then use it as the parent of
1586  * any device which should appear under /sys/devices/{name}
1587  *
1588  * The /sys/devices/{name} directory will also contain a
1589  * 'module' symlink which points to the @owner directory
1590  * in sysfs.
1591  *
1592  * Returns &struct device pointer on success, or ERR_PTR() on error.
1593  *
1594  * Note: You probably want to use root_device_register().
1595  */
1596 struct device *__root_device_register(const char *name, struct module *owner)
1597 {
1598         struct root_device *root;
1599         int err = -ENOMEM;
1600
1601         root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1602         if (!root)
1603                 return ERR_PTR(err);
1604
1605         err = dev_set_name(&root->dev, "%s", name);
1606         if (err) {
1607                 kfree(root);
1608                 return ERR_PTR(err);
1609         }
1610
1611         root->dev.release = root_device_release;
1612
1613         err = device_register(&root->dev);
1614         if (err) {
1615                 put_device(&root->dev);
1616                 return ERR_PTR(err);
1617         }
1618
1619 #ifdef CONFIG_MODULES   /* gotta find a "cleaner" way to do this */
1620         if (owner) {
1621                 struct module_kobject *mk = &owner->mkobj;
1622
1623                 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1624                 if (err) {
1625                         device_unregister(&root->dev);
1626                         return ERR_PTR(err);
1627                 }
1628                 root->owner = owner;
1629         }
1630 #endif
1631
1632         return &root->dev;
1633 }
1634 EXPORT_SYMBOL_GPL(__root_device_register);
1635
1636 /**
1637  * root_device_unregister - unregister and free a root device
1638  * @dev: device going away
1639  *
1640  * This function unregisters and cleans up a device that was created by
1641  * root_device_register().
1642  */
1643 void root_device_unregister(struct device *dev)
1644 {
1645         struct root_device *root = to_root_device(dev);
1646
1647         if (root->owner)
1648                 sysfs_remove_link(&root->dev.kobj, "module");
1649
1650         device_unregister(dev);
1651 }
1652 EXPORT_SYMBOL_GPL(root_device_unregister);
1653
1654
1655 static void device_create_release(struct device *dev)
1656 {
1657         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1658         kfree(dev);
1659 }
1660
1661 static struct device *
1662 device_create_groups_vargs(struct class *class, struct device *parent,
1663                            dev_t devt, void *drvdata,
1664                            const struct attribute_group **groups,
1665                            const char *fmt, va_list args)
1666 {
1667         struct device *dev = NULL;
1668         int retval = -ENODEV;
1669
1670         if (class == NULL || IS_ERR(class))
1671                 goto error;
1672
1673         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1674         if (!dev) {
1675                 retval = -ENOMEM;
1676                 goto error;
1677         }
1678
1679         dev->devt = devt;
1680         dev->class = class;
1681         dev->parent = parent;
1682         dev->groups = groups;
1683         dev->release = device_create_release;
1684         dev_set_drvdata(dev, drvdata);
1685
1686         retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1687         if (retval)
1688                 goto error;
1689
1690         retval = device_register(dev);
1691         if (retval)
1692                 goto error;
1693
1694         return dev;
1695
1696 error:
1697         put_device(dev);
1698         return ERR_PTR(retval);
1699 }
1700
1701 /**
1702  * device_create_vargs - creates a device and registers it with sysfs
1703  * @class: pointer to the struct class that this device should be registered to
1704  * @parent: pointer to the parent struct device of this new device, if any
1705  * @devt: the dev_t for the char device to be added
1706  * @drvdata: the data to be added to the device for callbacks
1707  * @fmt: string for the device's name
1708  * @args: va_list for the device's name
1709  *
1710  * This function can be used by char device classes.  A struct device
1711  * will be created in sysfs, registered to the specified class.
1712  *
1713  * A "dev" file will be created, showing the dev_t for the device, if
1714  * the dev_t is not 0,0.
1715  * If a pointer to a parent struct device is passed in, the newly created
1716  * struct device will be a child of that device in sysfs.
1717  * The pointer to the struct device will be returned from the call.
1718  * Any further sysfs files that might be required can be created using this
1719  * pointer.
1720  *
1721  * Returns &struct device pointer on success, or ERR_PTR() on error.
1722  *
1723  * Note: the struct class passed to this function must have previously
1724  * been created with a call to class_create().
1725  */
1726 struct device *device_create_vargs(struct class *class, struct device *parent,
1727                                    dev_t devt, void *drvdata, const char *fmt,
1728                                    va_list args)
1729 {
1730         return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1731                                           fmt, args);
1732 }
1733 EXPORT_SYMBOL_GPL(device_create_vargs);
1734
1735 /**
1736  * device_create - creates a device and registers it with sysfs
1737  * @class: pointer to the struct class that this device should be registered to
1738  * @parent: pointer to the parent struct device of this new device, if any
1739  * @devt: the dev_t for the char device to be added
1740  * @drvdata: the data to be added to the device for callbacks
1741  * @fmt: string for the device's name
1742  *
1743  * This function can be used by char device classes.  A struct device
1744  * will be created in sysfs, registered to the specified class.
1745  *
1746  * A "dev" file will be created, showing the dev_t for the device, if
1747  * the dev_t is not 0,0.
1748  * If a pointer to a parent struct device is passed in, the newly created
1749  * struct device will be a child of that device in sysfs.
1750  * The pointer to the struct device will be returned from the call.
1751  * Any further sysfs files that might be required can be created using this
1752  * pointer.
1753  *
1754  * Returns &struct device pointer on success, or ERR_PTR() on error.
1755  *
1756  * Note: the struct class passed to this function must have previously
1757  * been created with a call to class_create().
1758  */
1759 struct device *device_create(struct class *class, struct device *parent,
1760                              dev_t devt, void *drvdata, const char *fmt, ...)
1761 {
1762         va_list vargs;
1763         struct device *dev;
1764
1765         va_start(vargs, fmt);
1766         dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1767         va_end(vargs);
1768         return dev;
1769 }
1770 EXPORT_SYMBOL_GPL(device_create);
1771
1772 /**
1773  * device_create_with_groups - creates a device and registers it with sysfs
1774  * @class: pointer to the struct class that this device should be registered to
1775  * @parent: pointer to the parent struct device of this new device, if any
1776  * @devt: the dev_t for the char device to be added
1777  * @drvdata: the data to be added to the device for callbacks
1778  * @groups: NULL-terminated list of attribute groups to be created
1779  * @fmt: string for the device's name
1780  *
1781  * This function can be used by char device classes.  A struct device
1782  * will be created in sysfs, registered to the specified class.
1783  * Additional attributes specified in the groups parameter will also
1784  * be created automatically.
1785  *
1786  * A "dev" file will be created, showing the dev_t for the device, if
1787  * the dev_t is not 0,0.
1788  * If a pointer to a parent struct device is passed in, the newly created
1789  * struct device will be a child of that device in sysfs.
1790  * The pointer to the struct device will be returned from the call.
1791  * Any further sysfs files that might be required can be created using this
1792  * pointer.
1793  *
1794  * Returns &struct device pointer on success, or ERR_PTR() on error.
1795  *
1796  * Note: the struct class passed to this function must have previously
1797  * been created with a call to class_create().
1798  */
1799 struct device *device_create_with_groups(struct class *class,
1800                                          struct device *parent, dev_t devt,
1801                                          void *drvdata,
1802                                          const struct attribute_group **groups,
1803                                          const char *fmt, ...)
1804 {
1805         va_list vargs;
1806         struct device *dev;
1807
1808         va_start(vargs, fmt);
1809         dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1810                                          fmt, vargs);
1811         va_end(vargs);
1812         return dev;
1813 }
1814 EXPORT_SYMBOL_GPL(device_create_with_groups);
1815
1816 static int __match_devt(struct device *dev, const void *data)
1817 {
1818         const dev_t *devt = data;
1819
1820         return dev->devt == *devt;
1821 }
1822
1823 /**
1824  * device_destroy - removes a device that was created with device_create()
1825  * @class: pointer to the struct class that this device was registered with
1826  * @devt: the dev_t of the device that was previously registered
1827  *
1828  * This call unregisters and cleans up a device that was created with a
1829  * call to device_create().
1830  */
1831 void device_destroy(struct class *class, dev_t devt)
1832 {
1833         struct device *dev;
1834
1835         dev = class_find_device(class, NULL, &devt, __match_devt);
1836         if (dev) {
1837                 put_device(dev);
1838                 device_unregister(dev);
1839         }
1840 }
1841 EXPORT_SYMBOL_GPL(device_destroy);
1842
1843 /**
1844  * device_rename - renames a device
1845  * @dev: the pointer to the struct device to be renamed
1846  * @new_name: the new name of the device
1847  *
1848  * It is the responsibility of the caller to provide mutual
1849  * exclusion between two different calls of device_rename
1850  * on the same device to ensure that new_name is valid and
1851  * won't conflict with other devices.
1852  *
1853  * Note: Don't call this function.  Currently, the networking layer calls this
1854  * function, but that will change.  The following text from Kay Sievers offers
1855  * some insight:
1856  *
1857  * Renaming devices is racy at many levels, symlinks and other stuff are not
1858  * replaced atomically, and you get a "move" uevent, but it's not easy to
1859  * connect the event to the old and new device. Device nodes are not renamed at
1860  * all, there isn't even support for that in the kernel now.
1861  *
1862  * In the meantime, during renaming, your target name might be taken by another
1863  * driver, creating conflicts. Or the old name is taken directly after you
1864  * renamed it -- then you get events for the same DEVPATH, before you even see
1865  * the "move" event. It's just a mess, and nothing new should ever rely on
1866  * kernel device renaming. Besides that, it's not even implemented now for
1867  * other things than (driver-core wise very simple) network devices.
1868  *
1869  * We are currently about to change network renaming in udev to completely
1870  * disallow renaming of devices in the same namespace as the kernel uses,
1871  * because we can't solve the problems properly, that arise with swapping names
1872  * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1873  * be allowed to some other name than eth[0-9]*, for the aforementioned
1874  * reasons.
1875  *
1876  * Make up a "real" name in the driver before you register anything, or add
1877  * some other attributes for userspace to find the device, or use udev to add
1878  * symlinks -- but never rename kernel devices later, it's a complete mess. We
1879  * don't even want to get into that and try to implement the missing pieces in
1880  * the core. We really have other pieces to fix in the driver core mess. :)
1881  */
1882 int device_rename(struct device *dev, const char *new_name)
1883 {
1884         char *old_device_name = NULL;
1885         int error;
1886
1887         dev = get_device(dev);
1888         if (!dev)
1889                 return -EINVAL;
1890
1891         pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
1892                  __func__, new_name);
1893
1894         old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1895         if (!old_device_name) {
1896                 error = -ENOMEM;
1897                 goto out;
1898         }
1899
1900         if (dev->class) {
1901                 error = sysfs_rename_link(&dev->class->p->subsys.kobj,
1902                         &dev->kobj, old_device_name, new_name);
1903                 if (error)
1904                         goto out;
1905         }
1906
1907         error = kobject_rename(&dev->kobj, new_name);
1908         if (error)
1909                 goto out;
1910
1911 out:
1912         put_device(dev);
1913
1914         kfree(old_device_name);
1915
1916         return error;
1917 }
1918 EXPORT_SYMBOL_GPL(device_rename);
1919
1920 static int device_move_class_links(struct device *dev,
1921                                    struct device *old_parent,
1922                                    struct device *new_parent)
1923 {
1924         int error = 0;
1925
1926         if (old_parent)
1927                 sysfs_remove_link(&dev->kobj, "device");
1928         if (new_parent)
1929                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1930                                           "device");
1931         return error;
1932 }
1933
1934 /**
1935  * device_move - moves a device to a new parent
1936  * @dev: the pointer to the struct device to be moved
1937  * @new_parent: the new parent of the device (can by NULL)
1938  * @dpm_order: how to reorder the dpm_list
1939  */
1940 int device_move(struct device *dev, struct device *new_parent,
1941                 enum dpm_order dpm_order)
1942 {
1943         int error;
1944         struct device *old_parent;
1945         struct kobject *new_parent_kobj;
1946
1947         dev = get_device(dev);
1948         if (!dev)
1949                 return -EINVAL;
1950
1951         device_pm_lock();
1952         new_parent = get_device(new_parent);
1953         new_parent_kobj = get_device_parent(dev, new_parent);
1954
1955         pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1956                  __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1957         error = kobject_move(&dev->kobj, new_parent_kobj);
1958         if (error) {
1959                 cleanup_glue_dir(dev, new_parent_kobj);
1960                 put_device(new_parent);
1961                 goto out;
1962         }
1963         old_parent = dev->parent;
1964         dev->parent = new_parent;
1965         if (old_parent)
1966                 klist_remove(&dev->p->knode_parent);
1967         if (new_parent) {
1968                 klist_add_tail(&dev->p->knode_parent,
1969                                &new_parent->p->klist_children);
1970                 set_dev_node(dev, dev_to_node(new_parent));
1971         }
1972
1973         if (dev->class) {
1974                 error = device_move_class_links(dev, old_parent, new_parent);
1975                 if (error) {
1976                         /* We ignore errors on cleanup since we're hosed anyway... */
1977                         device_move_class_links(dev, new_parent, old_parent);
1978                         if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1979                                 if (new_parent)
1980                                         klist_remove(&dev->p->knode_parent);
1981                                 dev->parent = old_parent;
1982                                 if (old_parent) {
1983                                         klist_add_tail(&dev->p->knode_parent,
1984                                                        &old_parent->p->klist_children);
1985                                         set_dev_node(dev, dev_to_node(old_parent));
1986                                 }
1987                         }
1988                         cleanup_glue_dir(dev, new_parent_kobj);
1989                         put_device(new_parent);
1990                         goto out;
1991                 }
1992         }
1993         switch (dpm_order) {
1994         case DPM_ORDER_NONE:
1995                 break;
1996         case DPM_ORDER_DEV_AFTER_PARENT:
1997                 device_pm_move_after(dev, new_parent);
1998                 break;
1999         case DPM_ORDER_PARENT_BEFORE_DEV:
2000                 device_pm_move_before(new_parent, dev);
2001                 break;
2002         case DPM_ORDER_DEV_LAST:
2003                 device_pm_move_last(dev);
2004                 break;
2005         }
2006
2007         put_device(old_parent);
2008 out:
2009         device_pm_unlock();
2010         put_device(dev);
2011         return error;
2012 }
2013 EXPORT_SYMBOL_GPL(device_move);
2014
2015 /**
2016  * device_shutdown - call ->shutdown() on each device to shutdown.
2017  */
2018 void device_shutdown(void)
2019 {
2020         struct device *dev, *parent;
2021
2022         spin_lock(&devices_kset->list_lock);
2023         /*
2024          * Walk the devices list backward, shutting down each in turn.
2025          * Beware that device unplug events may also start pulling
2026          * devices offline, even as the system is shutting down.
2027          */
2028         while (!list_empty(&devices_kset->list)) {
2029                 dev = list_entry(devices_kset->list.prev, struct device,
2030                                 kobj.entry);
2031
2032                 /*
2033                  * hold reference count of device's parent to
2034                  * prevent it from being freed because parent's
2035                  * lock is to be held
2036                  */
2037                 parent = get_device(dev->parent);
2038                 get_device(dev);
2039                 /*
2040                  * Make sure the device is off the kset list, in the
2041                  * event that dev->*->shutdown() doesn't remove it.
2042                  */
2043                 list_del_init(&dev->kobj.entry);
2044                 spin_unlock(&devices_kset->list_lock);
2045
2046                 /* hold lock to avoid race with probe/release */
2047                 if (parent)
2048                         device_lock(parent);
2049                 device_lock(dev);
2050
2051                 /* Don't allow any more runtime suspends */
2052                 pm_runtime_get_noresume(dev);
2053                 pm_runtime_barrier(dev);
2054
2055                 if (dev->bus && dev->bus->shutdown) {
2056                         if (initcall_debug)
2057                                 dev_info(dev, "shutdown\n");
2058                         dev->bus->shutdown(dev);
2059                 } else if (dev->driver && dev->driver->shutdown) {
2060                         if (initcall_debug)
2061                                 dev_info(dev, "shutdown\n");
2062                         dev->driver->shutdown(dev);
2063                 }
2064
2065                 device_unlock(dev);
2066                 if (parent)
2067                         device_unlock(parent);
2068
2069                 put_device(dev);
2070                 put_device(parent);
2071
2072                 spin_lock(&devices_kset->list_lock);
2073         }
2074         spin_unlock(&devices_kset->list_lock);
2075         async_synchronize_full();
2076 }
2077
2078 /*
2079  * Device logging functions
2080  */
2081
2082 #ifdef CONFIG_PRINTK
2083 static int
2084 create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
2085 {
2086         const char *subsys;
2087         size_t pos = 0;
2088
2089         if (dev->class)
2090                 subsys = dev->class->name;
2091         else if (dev->bus)
2092                 subsys = dev->bus->name;
2093         else
2094                 return 0;
2095
2096         pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
2097
2098         /*
2099          * Add device identifier DEVICE=:
2100          *   b12:8         block dev_t
2101          *   c127:3        char dev_t
2102          *   n8            netdev ifindex
2103          *   +sound:card0  subsystem:devname
2104          */
2105         if (MAJOR(dev->devt)) {
2106                 char c;
2107
2108                 if (strcmp(subsys, "block") == 0)
2109                         c = 'b';
2110                 else
2111                         c = 'c';
2112                 pos++;
2113                 pos += snprintf(hdr + pos, hdrlen - pos,
2114                                 "DEVICE=%c%u:%u",
2115                                 c, MAJOR(dev->devt), MINOR(dev->devt));
2116         } else if (strcmp(subsys, "net") == 0) {
2117                 struct net_device *net = to_net_dev(dev);
2118
2119                 pos++;
2120                 pos += snprintf(hdr + pos, hdrlen - pos,
2121                                 "DEVICE=n%u", net->ifindex);
2122         } else {
2123                 pos++;
2124                 pos += snprintf(hdr + pos, hdrlen - pos,
2125                                 "DEVICE=+%s:%s", subsys, dev_name(dev));
2126         }
2127
2128         return pos;
2129 }
2130 EXPORT_SYMBOL(create_syslog_header);
2131
2132 int dev_vprintk_emit(int level, const struct device *dev,
2133                      const char *fmt, va_list args)
2134 {
2135         char hdr[128];
2136         size_t hdrlen;
2137
2138         hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2139
2140         return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2141 }
2142 EXPORT_SYMBOL(dev_vprintk_emit);
2143
2144 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2145 {
2146         va_list args;
2147         int r;
2148
2149         va_start(args, fmt);
2150
2151         r = dev_vprintk_emit(level, dev, fmt, args);
2152
2153         va_end(args);
2154
2155         return r;
2156 }
2157 EXPORT_SYMBOL(dev_printk_emit);
2158
2159 static int __dev_printk(const char *level, const struct device *dev,
2160                         struct va_format *vaf)
2161 {
2162         if (!dev)
2163                 return printk("%s(NULL device *): %pV", level, vaf);
2164
2165         return dev_printk_emit(level[1] - '0', dev,
2166                                "%s %s: %pV",
2167                                dev_driver_string(dev), dev_name(dev), vaf);
2168 }
2169
2170 int dev_printk(const char *level, const struct device *dev,
2171                const char *fmt, ...)
2172 {
2173         struct va_format vaf;
2174         va_list args;
2175         int r;
2176
2177         va_start(args, fmt);
2178
2179         vaf.fmt = fmt;
2180         vaf.va = &args;
2181
2182         r = __dev_printk(level, dev, &vaf);
2183
2184         va_end(args);
2185
2186         return r;
2187 }
2188 EXPORT_SYMBOL(dev_printk);
2189
2190 #define define_dev_printk_level(func, kern_level)               \
2191 int func(const struct device *dev, const char *fmt, ...)        \
2192 {                                                               \
2193         struct va_format vaf;                                   \
2194         va_list args;                                           \
2195         int r;                                                  \
2196                                                                 \
2197         va_start(args, fmt);                                    \
2198                                                                 \
2199         vaf.fmt = fmt;                                          \
2200         vaf.va = &args;                                         \
2201                                                                 \
2202         r = __dev_printk(kern_level, dev, &vaf);                \
2203                                                                 \
2204         va_end(args);                                           \
2205                                                                 \
2206         return r;                                               \
2207 }                                                               \
2208 EXPORT_SYMBOL(func);
2209
2210 define_dev_printk_level(dev_emerg, KERN_EMERG);
2211 define_dev_printk_level(dev_alert, KERN_ALERT);
2212 define_dev_printk_level(dev_crit, KERN_CRIT);
2213 define_dev_printk_level(dev_err, KERN_ERR);
2214 define_dev_printk_level(dev_warn, KERN_WARNING);
2215 define_dev_printk_level(dev_notice, KERN_NOTICE);
2216 define_dev_printk_level(_dev_info, KERN_INFO);
2217
2218 #endif