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