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 <[email protected]>
   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/fwnode.h>
  16 #include <linux/init.h>
  17 #include <linux/module.h>
  18 #include <linux/slab.h>
  19 #include <linux/string.h>
  20 #include <linux/kdev_t.h>
  21 #include <linux/notifier.h>
  22 #include <linux/of.h>
  23 #include <linux/of_device.h>
  24 #include <linux/genhd.h>
  25 #include <linux/kallsyms.h>
  26 #include <linux/mutex.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 int device_add_groups(struct device *dev, const struct attribute_group **groups)
 459 {
 460         return sysfs_create_groups(&dev->kobj, groups);
 461 }
 462
 463 void device_remove_groups(struct device *dev,
 464                           const struct attribute_group **groups)
 465 {
 466         sysfs_remove_groups(&dev->kobj, groups);
 467 }
 468
 469 static int device_add_attrs(struct device *dev)
 470 {
 471         struct class *class = dev->class;
 472         const struct device_type *type = dev->type;
 473         int error;
 474
 475         if (class) {
 476                 error = device_add_groups(dev, class->dev_groups);
 477                 if (error)
 478                         return error;
 479         }
 480
 481         if (type) {
 482                 error = device_add_groups(dev, type->groups);
 483                 if (error)
 484                         goto err_remove_class_groups;
 485         }
 486
 487         error = device_add_groups(dev, dev->groups);
 488         if (error)
 489                 goto err_remove_type_groups;
 490
 491         if (device_supports_offline(dev) && !dev->offline_disabled) {
 492                 error = device_create_file(dev, &dev_attr_online);
 493                 if (error)
 494                         goto err_remove_dev_groups;
 495         }
 496
 497         return 0;
 498
 499  err_remove_dev_groups:
 500         device_remove_groups(dev, dev->groups);
 501  err_remove_type_groups:
 502         if (type)
 503                 device_remove_groups(dev, type->groups);
 504  err_remove_class_groups:
 505         if (class)
 506                 device_remove_groups(dev, class->dev_groups);
 507
 508         return error;
 509 }
 510
 511 static void device_remove_attrs(struct device *dev)
 512 {
 513         struct class *class = dev->class;
 514         const struct device_type *type = dev->type;
 515
 516         device_remove_file(dev, &dev_attr_online);
 517         device_remove_groups(dev, dev->groups);
 518
 519         if (type)
 520                 device_remove_groups(dev, type->groups);
 521
 522         if (class)
 523                 device_remove_groups(dev, class->dev_groups);
 524 }
 525
 526 static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
 527                         char *buf)
 528 {
 529         return print_dev_t(buf, dev->devt);
 530 }
 531 static DEVICE_ATTR_RO(dev);
 532
 533 /* /sys/devices/ */
 534 struct kset *devices_kset;
 535
 536 /**
 537  * device_create_file - create sysfs attribute file for device.
 538  * @dev: device.
 539  * @attr: device attribute descriptor.
 540  */
 541 int device_create_file(struct device *dev,
 542                        const struct device_attribute *attr)
 543 {
 544         int error = 0;
 545
 546         if (dev) {
 547                 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
 548                         "Attribute %s: write permission without 'store'\n",
 549                         attr->attr.name);
 550                 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
 551                         "Attribute %s: read permission without 'show'\n",
 552                         attr->attr.name);
 553                 error = sysfs_create_file(&dev->kobj, &attr->attr);
 554         }
 555
 556         return error;
 557 }
 558 EXPORT_SYMBOL_GPL(device_create_file);
 559
 560 /**
 561  * device_remove_file - remove sysfs attribute file.
 562  * @dev: device.
 563  * @attr: device attribute descriptor.
 564  */
 565 void device_remove_file(struct device *dev,
 566                         const struct device_attribute *attr)
 567 {
 568         if (dev)
 569                 sysfs_remove_file(&dev->kobj, &attr->attr);
 570 }
 571 EXPORT_SYMBOL_GPL(device_remove_file);
 572
 573 /**
 574  * device_remove_file_self - remove sysfs attribute file from its own method.
 575  * @dev: device.
 576  * @attr: device attribute descriptor.
 577  *
 578  * See kernfs_remove_self() for details.
 579  */
 580 bool device_remove_file_self(struct device *dev,
 581                              const struct device_attribute *attr)
 582 {
 583         if (dev)
 584                 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
 585         else
 586                 return false;
 587 }
 588 EXPORT_SYMBOL_GPL(device_remove_file_self);
 589
 590 /**
 591  * device_create_bin_file - create sysfs binary attribute file for device.
 592  * @dev: device.
 593  * @attr: device binary attribute descriptor.
 594  */
 595 int device_create_bin_file(struct device *dev,
 596                            const struct bin_attribute *attr)
 597 {
 598         int error = -EINVAL;
 599         if (dev)
 600                 error = sysfs_create_bin_file(&dev->kobj, attr);
 601         return error;
 602 }
 603 EXPORT_SYMBOL_GPL(device_create_bin_file);
 604
 605 /**
 606  * device_remove_bin_file - remove sysfs binary attribute file
 607  * @dev: device.
 608  * @attr: device binary attribute descriptor.
 609  */
 610 void device_remove_bin_file(struct device *dev,
 611                             const struct bin_attribute *attr)
 612 {
 613         if (dev)
 614                 sysfs_remove_bin_file(&dev->kobj, attr);
 615 }
 616 EXPORT_SYMBOL_GPL(device_remove_bin_file);
 617
 618 static void klist_children_get(struct klist_node *n)
 619 {
 620         struct device_private *p = to_device_private_parent(n);
 621         struct device *dev = p->device;
 622
 623         get_device(dev);
 624 }
 625
 626 static void klist_children_put(struct klist_node *n)
 627 {
 628         struct device_private *p = to_device_private_parent(n);
 629         struct device *dev = p->device;
 630
 631         put_device(dev);
 632 }
 633
 634 /**
 635  * device_initialize - init device structure.
 636  * @dev: device.
 637  *
 638  * This prepares the device for use by other layers by initializing
 639  * its fields.
 640  * It is the first half of device_register(), if called by
 641  * that function, though it can also be called separately, so one
 642  * may use @dev's fields. In particular, get_device()/put_device()
 643  * may be used for reference counting of @dev after calling this
 644  * function.
 645  *
 646  * All fields in @dev must be initialized by the caller to 0, except
 647  * for those explicitly set to some other value.  The simplest
 648  * approach is to use kzalloc() to allocate the structure containing
 649  * @dev.
 650  *
 651  * NOTE: Use put_device() to give up your reference instead of freeing
 652  * @dev directly once you have called this function.
 653  */
 654 void device_initialize(struct device *dev)
 655 {
 656         dev->kobj.kset = devices_kset;
 657         kobject_init(&dev->kobj, &device_ktype);
 658         INIT_LIST_HEAD(&dev->dma_pools);
 659         mutex_init(&dev->mutex);
 660         lockdep_set_novalidate_class(&dev->mutex);
 661         spin_lock_init(&dev->devres_lock);
 662         INIT_LIST_HEAD(&dev->devres_head);
 663         device_pm_init(dev);
 664         set_dev_node(dev, -1);
 665 }
 666 EXPORT_SYMBOL_GPL(device_initialize);
 667
 668 struct kobject *virtual_device_parent(struct device *dev)
 669 {
 670         static struct kobject *virtual_dir = NULL;
 671
 672         if (!virtual_dir)
 673                 virtual_dir = kobject_create_and_add("virtual",
 674                                                      &devices_kset->kobj);
 675
 676         return virtual_dir;
 677 }
 678
 679 struct class_dir {
 680         struct kobject kobj;
 681         struct class *class;
 682 };
 683
 684 #define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
 685
 686 static void class_dir_release(struct kobject *kobj)
 687 {
 688         struct class_dir *dir = to_class_dir(kobj);
 689         kfree(dir);
 690 }
 691
 692 static const
 693 struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
 694 {
 695         struct class_dir *dir = to_class_dir(kobj);
 696         return dir->class->ns_type;
 697 }
 698
 699 static struct kobj_type class_dir_ktype = {
 700         .release        = class_dir_release,
 701         .sysfs_ops      = &kobj_sysfs_ops,
 702         .child_ns_type  = class_dir_child_ns_type
 703 };
 704
 705 static struct kobject *
 706 class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
 707 {
 708         struct class_dir *dir;
 709         int retval;
 710
 711         dir = kzalloc(sizeof(*dir), GFP_KERNEL);
 712         if (!dir)
 713                 return NULL;
 714
 715         dir->class = class;
 716         kobject_init(&dir->kobj, &class_dir_ktype);
 717
 718         dir->kobj.kset = &class->p->glue_dirs;
 719
 720         retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
 721         if (retval < 0) {
 722                 kobject_put(&dir->kobj);
 723                 return NULL;
 724         }
 725         return &dir->kobj;
 726 }
 727
 728 static DEFINE_MUTEX(gdp_mutex);
 729
 730 static struct kobject *get_device_parent(struct device *dev,
 731                                          struct device *parent)
 732 {
 733         if (dev->class) {
 734                 struct kobject *kobj = NULL;
 735                 struct kobject *parent_kobj;
 736                 struct kobject *k;
 737
 738 #ifdef CONFIG_BLOCK
 739                 /* block disks show up in /sys/block */
 740                 if (sysfs_deprecated && dev->class == &block_class) {
 741                         if (parent && parent->class == &block_class)
 742                                 return &parent->kobj;
 743                         return &block_class.p->subsys.kobj;
 744                 }
 745 #endif
 746
 747                 /*
 748                  * If we have no parent, we live in "virtual".
 749                  * Class-devices with a non class-device as parent, live
 750                  * in a "glue" directory to prevent namespace collisions.
 751                  */
 752                 if (parent == NULL)
 753                         parent_kobj = virtual_device_parent(dev);
 754                 else if (parent->class && !dev->class->ns_type)
 755                         return &parent->kobj;
 756                 else
 757                         parent_kobj = &parent->kobj;
 758
 759                 mutex_lock(&gdp_mutex);
 760
 761                 /* find our class-directory at the parent and reference it */
 762                 spin_lock(&dev->class->p->glue_dirs.list_lock);
 763                 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
 764                         if (k->parent == parent_kobj) {
 765                                 kobj = kobject_get(k);
 766                                 break;
 767                         }
 768                 spin_unlock(&dev->class->p->glue_dirs.list_lock);
 769                 if (kobj) {
 770                         mutex_unlock(&gdp_mutex);
 771                         return kobj;
 772                 }
 773
 774                 /* or create a new class-directory at the parent device */
 775                 k = class_dir_create_and_add(dev->class, parent_kobj);
 776                 /* do not emit an uevent for this simple "glue" directory */
 777                 mutex_unlock(&gdp_mutex);
 778                 return k;
 779         }
 780
 781         /* subsystems can specify a default root directory for their devices */
 782         if (!parent && dev->bus && dev->bus->dev_root)
 783                 return &dev->bus->dev_root->kobj;
 784
 785         if (parent)
 786                 return &parent->kobj;
 787         return NULL;
 788 }
 789
 790 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
 791 {
 792         /* see if we live in a "glue" directory */
 793         if (!glue_dir || !dev->class ||
 794             glue_dir->kset != &dev->class->p->glue_dirs)
 795                 return;
 796
 797         mutex_lock(&gdp_mutex);
 798         kobject_put(glue_dir);
 799         mutex_unlock(&gdp_mutex);
 800 }
 801
 802 static void cleanup_device_parent(struct device *dev)
 803 {
 804         cleanup_glue_dir(dev, dev->kobj.parent);
 805 }
 806
 807 static int device_add_class_symlinks(struct device *dev)
 808 {
 809         int error;
 810
 811         if (!dev->class)
 812                 return 0;
 813
 814         error = sysfs_create_link(&dev->kobj,
 815                                   &dev->class->p->subsys.kobj,
 816                                   "subsystem");
 817         if (error)
 818                 goto out;
 819
 820         if (dev->parent && device_is_not_partition(dev)) {
 821                 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
 822                                           "device");
 823                 if (error)
 824                         goto out_subsys;
 825         }
 826
 827 #ifdef CONFIG_BLOCK
 828         /* /sys/block has directories and does not need symlinks */
 829         if (sysfs_deprecated && dev->class == &block_class)
 830                 return 0;
 831 #endif
 832
 833         /* link in the class directory pointing to the device */
 834         error = sysfs_create_link(&dev->class->p->subsys.kobj,
 835                                   &dev->kobj, dev_name(dev));
 836         if (error)
 837                 goto out_device;
 838
 839         return 0;
 840
 841 out_device:
 842         sysfs_remove_link(&dev->kobj, "device");
 843
 844 out_subsys:
 845         sysfs_remove_link(&dev->kobj, "subsystem");
 846 out:
 847         return error;
 848 }
 849
 850 static void device_remove_class_symlinks(struct device *dev)
 851 {
 852         if (!dev->class)
 853                 return;
 854
 855         if (dev->parent && device_is_not_partition(dev))
 856                 sysfs_remove_link(&dev->kobj, "device");
 857         sysfs_remove_link(&dev->kobj, "subsystem");
 858 #ifdef CONFIG_BLOCK
 859         if (sysfs_deprecated && dev->class == &block_class)
 860                 return;
 861 #endif
 862         sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
 863 }
 864
 865 /**
 866  * dev_set_name - set a device name
 867  * @dev: device
 868  * @fmt: format string for the device's name
 869  */
 870 int dev_set_name(struct device *dev, const char *fmt, ...)
 871 {
 872         va_list vargs;
 873         int err;
 874
 875         va_start(vargs, fmt);
 876         err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
 877         va_end(vargs);
 878         return err;
 879 }
 880 EXPORT_SYMBOL_GPL(dev_set_name);
 881
 882 /**
 883  * device_to_dev_kobj - select a /sys/dev/ directory for the device
 884  * @dev: device
 885  *
 886  * By default we select char/ for new entries.  Setting class->dev_obj
 887  * to NULL prevents an entry from being created.  class->dev_kobj must
 888  * be set (or cleared) before any devices are registered to the class
 889  * otherwise device_create_sys_dev_entry() and
 890  * device_remove_sys_dev_entry() will disagree about the presence of
 891  * the link.
 892  */
 893 static struct kobject *device_to_dev_kobj(struct device *dev)
 894 {
 895         struct kobject *kobj;
 896
 897         if (dev->class)
 898                 kobj = dev->class->dev_kobj;
 899         else
 900                 kobj = sysfs_dev_char_kobj;
 901
 902         return kobj;
 903 }
 904
 905 static int device_create_sys_dev_entry(struct device *dev)
 906 {
 907         struct kobject *kobj = device_to_dev_kobj(dev);
 908         int error = 0;
 909         char devt_str[15];
 910
 911         if (kobj) {
 912                 format_dev_t(devt_str, dev->devt);
 913                 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
 914         }
 915
 916         return error;
 917 }
 918
 919 static void device_remove_sys_dev_entry(struct device *dev)
 920 {
 921         struct kobject *kobj = device_to_dev_kobj(dev);
 922         char devt_str[15];
 923
 924         if (kobj) {
 925                 format_dev_t(devt_str, dev->devt);
 926                 sysfs_remove_link(kobj, devt_str);
 927         }
 928 }
 929
 930 int device_private_init(struct device *dev)
 931 {
 932         dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
 933         if (!dev->p)
 934                 return -ENOMEM;
 935         dev->p->device = dev;
 936         klist_init(&dev->p->klist_children, klist_children_get,
 937                    klist_children_put);
 938         INIT_LIST_HEAD(&dev->p->deferred_probe);
 939         return 0;
 940 }
 941
 942 /**
 943  * device_add - add device to device hierarchy.
 944  * @dev: device.
 945  *
 946  * This is part 2 of device_register(), though may be called
 947  * separately _iff_ device_initialize() has been called separately.
 948  *
 949  * This adds @dev to the kobject hierarchy via kobject_add(), adds it
 950  * to the global and sibling lists for the device, then
 951  * adds it to the other relevant subsystems of the driver model.
 952  *
 953  * Do not call this routine or device_register() more than once for
 954  * any device structure.  The driver model core is not designed to work
 955  * with devices that get unregistered and then spring back to life.
 956  * (Among other things, it's very hard to guarantee that all references
 957  * to the previous incarnation of @dev have been dropped.)  Allocate
 958  * and register a fresh new struct device instead.
 959  *
 960  * NOTE: _Never_ directly free @dev after calling this function, even
 961  * if it returned an error! Always use put_device() to give up your
 962  * reference instead.
 963  */
 964 int device_add(struct device *dev)
 965 {
 966         struct device *parent = NULL;
 967         struct kobject *kobj;
 968         struct class_interface *class_intf;
 969         int error = -EINVAL;
 970
 971         dev = get_device(dev);
 972         if (!dev)
 973                 goto done;
 974
 975         if (!dev->p) {
 976                 error = device_private_init(dev);
 977                 if (error)
 978                         goto done;
 979         }
 980
 981         /*
 982          * for statically allocated devices, which should all be converted
 983          * some day, we need to initialize the name. We prevent reading back
 984          * the name, and force the use of dev_name()
 985          */
 986         if (dev->init_name) {
 987                 dev_set_name(dev, "%s", dev->init_name);
 988                 dev->init_name = NULL;
 989         }
 990
 991         /* subsystems can specify simple device enumeration */
 992         if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
 993                 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
 994
 995         if (!dev_name(dev)) {
 996                 error = -EINVAL;
 997                 goto name_error;
 998         }
 999
1000         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1001
1002         parent = get_device(dev->parent);
1003         kobj = get_device_parent(dev, parent);
1004         if (kobj)
1005                 dev->kobj.parent = kobj;
1006
1007         /* use parent numa_node */
1008         if (parent)
1009                 set_dev_node(dev, dev_to_node(parent));
1010
1011         /* first, register with generic layer. */
1012         /* we require the name to be set before, and pass NULL */
1013         error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
1014         if (error)
1015                 goto Error;
1016
1017         /* notify platform of device entry */
1018         if (platform_notify)
1019                 platform_notify(dev);
1020
1021         error = device_create_file(dev, &dev_attr_uevent);
1022         if (error)
1023                 goto attrError;
1024
1025         error = device_add_class_symlinks(dev);
1026         if (error)
1027                 goto SymlinkError;
1028         error = device_add_attrs(dev);
1029         if (error)
1030                 goto AttrsError;
1031         error = bus_add_device(dev);
1032         if (error)
1033                 goto BusError;
1034         error = dpm_sysfs_add(dev);
1035         if (error)
1036                 goto DPMError;
1037         device_pm_add(dev);
1038
1039         if (MAJOR(dev->devt)) {
1040                 error = device_create_file(dev, &dev_attr_dev);
1041                 if (error)
1042                         goto DevAttrError;
1043
1044                 error = device_create_sys_dev_entry(dev);
1045                 if (error)
1046                         goto SysEntryError;
1047
1048                 devtmpfs_create_node(dev);
1049         }
1050
1051         /* Notify clients of device addition.  This call must come
1052          * after dpm_sysfs_add() and before kobject_uevent().
1053          */
1054         if (dev->bus)
1055                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1056                                              BUS_NOTIFY_ADD_DEVICE, dev);
1057
1058         kobject_uevent(&dev->kobj, KOBJ_ADD);
1059         bus_probe_device(dev);
1060         if (parent)
1061                 klist_add_tail(&dev->p->knode_parent,
1062                                &parent->p->klist_children);
1063
1064         if (dev->class) {
1065                 mutex_lock(&dev->class->p->mutex);
1066                 /* tie the class to the device */
1067                 klist_add_tail(&dev->knode_class,
1068                                &dev->class->p->klist_devices);
1069
1070                 /* notify any interfaces that the device is here */
1071                 list_for_each_entry(class_intf,
1072                                     &dev->class->p->interfaces, node)
1073                         if (class_intf->add_dev)
1074                                 class_intf->add_dev(dev, class_intf);
1075                 mutex_unlock(&dev->class->p->mutex);
1076         }
1077 done:
1078         put_device(dev);
1079         return error;
1080  SysEntryError:
1081         if (MAJOR(dev->devt))
1082                 device_remove_file(dev, &dev_attr_dev);
1083  DevAttrError:
1084         device_pm_remove(dev);
1085         dpm_sysfs_remove(dev);
1086  DPMError:
1087         bus_remove_device(dev);
1088  BusError:
1089         device_remove_attrs(dev);
1090  AttrsError:
1091         device_remove_class_symlinks(dev);
1092  SymlinkError:
1093         device_remove_file(dev, &dev_attr_uevent);
1094  attrError:
1095         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1096         kobject_del(&dev->kobj);
1097  Error:
1098         cleanup_device_parent(dev);
1099         if (parent)
1100                 put_device(parent);
1101 name_error:
1102         kfree(dev->p);
1103         dev->p = NULL;
1104         goto done;
1105 }
1106 EXPORT_SYMBOL_GPL(device_add);
1107
1108 /**
1109  * device_register - register a device with the system.
1110  * @dev: pointer to the device structure
1111  *
1112  * This happens in two clean steps - initialize the device
1113  * and add it to the system. The two steps can be called
1114  * separately, but this is the easiest and most common.
1115  * I.e. you should only call the two helpers separately if
1116  * have a clearly defined need to use and refcount the device
1117  * before it is added to the hierarchy.
1118  *
1119  * For more information, see the kerneldoc for device_initialize()
1120  * and device_add().
1121  *
1122  * NOTE: _Never_ directly free @dev after calling this function, even
1123  * if it returned an error! Always use put_device() to give up the
1124  * reference initialized in this function instead.
1125  */
1126 int device_register(struct device *dev)
1127 {
1128         device_initialize(dev);
1129         return device_add(dev);
1130 }
1131 EXPORT_SYMBOL_GPL(device_register);
1132
1133 /**
1134  * get_device - increment reference count for device.
1135  * @dev: device.
1136  *
1137  * This simply forwards the call to kobject_get(), though
1138  * we do take care to provide for the case that we get a NULL
1139  * pointer passed in.
1140  */
1141 struct device *get_device(struct device *dev)
1142 {
1143         return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
1144 }
1145 EXPORT_SYMBOL_GPL(get_device);
1146
1147 /**
1148  * put_device - decrement reference count.
1149  * @dev: device in question.
1150  */
1151 void put_device(struct device *dev)
1152 {
1153         /* might_sleep(); */
1154         if (dev)
1155                 kobject_put(&dev->kobj);
1156 }
1157 EXPORT_SYMBOL_GPL(put_device);
1158
1159 /**
1160  * device_del - delete device from system.
1161  * @dev: device.
1162  *
1163  * This is the first part of the device unregistration
1164  * sequence. This removes the device from the lists we control
1165  * from here, has it removed from the other driver model
1166  * subsystems it was added to in device_add(), and removes it
1167  * from the kobject hierarchy.
1168  *
1169  * NOTE: this should be called manually _iff_ device_add() was
1170  * also called manually.
1171  */
1172 void device_del(struct device *dev)
1173 {
1174         struct device *parent = dev->parent;
1175         struct class_interface *class_intf;
1176
1177         /* Notify clients of device removal.  This call must come
1178          * before dpm_sysfs_remove().
1179          */
1180         if (dev->bus)
1181                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1182                                              BUS_NOTIFY_DEL_DEVICE, dev);
1183         dpm_sysfs_remove(dev);
1184         if (parent)
1185                 klist_del(&dev->p->knode_parent);
1186         if (MAJOR(dev->devt)) {
1187                 devtmpfs_delete_node(dev);
1188                 device_remove_sys_dev_entry(dev);
1189                 device_remove_file(dev, &dev_attr_dev);
1190         }
1191         if (dev->class) {
1192                 device_remove_class_symlinks(dev);
1193
1194                 mutex_lock(&dev->class->p->mutex);
1195                 /* notify any interfaces that the device is now gone */
1196                 list_for_each_entry(class_intf,
1197                                     &dev->class->p->interfaces, node)
1198                         if (class_intf->remove_dev)
1199                                 class_intf->remove_dev(dev, class_intf);
1200                 /* remove the device from the class list */
1201                 klist_del(&dev->knode_class);
1202                 mutex_unlock(&dev->class->p->mutex);
1203         }
1204         device_remove_file(dev, &dev_attr_uevent);
1205         device_remove_attrs(dev);
1206         bus_remove_device(dev);
1207         device_pm_remove(dev);
1208         driver_deferred_probe_del(dev);
1209
1210         /* Notify the platform of the removal, in case they
1211          * need to do anything...
1212          */
1213         if (platform_notify_remove)
1214                 platform_notify_remove(dev);
1215         if (dev->bus)
1216                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1217                                              BUS_NOTIFY_REMOVED_DEVICE, dev);
1218         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1219         cleanup_device_parent(dev);
1220         kobject_del(&dev->kobj);
1221         put_device(parent);
1222 }
1223 EXPORT_SYMBOL_GPL(device_del);
1224
1225 /**
1226  * device_unregister - unregister device from system.
1227  * @dev: device going away.
1228  *
1229  * We do this in two parts, like we do device_register(). First,
1230  * we remove it from all the subsystems with device_del(), then
1231  * we decrement the reference count via put_device(). If that
1232  * is the final reference count, the device will be cleaned up
1233  * via device_release() above. Otherwise, the structure will
1234  * stick around until the final reference to the device is dropped.
1235  */
1236 void device_unregister(struct device *dev)
1237 {
1238         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1239         device_del(dev);
1240         put_device(dev);
1241 }
1242 EXPORT_SYMBOL_GPL(device_unregister);
1243
1244 static struct device *next_device(struct klist_iter *i)
1245 {
1246         struct klist_node *n = klist_next(i);
1247         struct device *dev = NULL;
1248         struct device_private *p;
1249
1250         if (n) {
1251                 p = to_device_private_parent(n);
1252                 dev = p->device;
1253         }
1254         return dev;
1255 }
1256
1257 /**
1258  * device_get_devnode - path of device node file
1259  * @dev: device
1260  * @mode: returned file access mode
1261  * @uid: returned file owner
1262  * @gid: returned file group
1263  * @tmp: possibly allocated string
1264  *
1265  * Return the relative path of a possible device node.
1266  * Non-default names may need to allocate a memory to compose
1267  * a name. This memory is returned in tmp and needs to be
1268  * freed by the caller.
1269  */
1270 const char *device_get_devnode(struct device *dev,
1271                                umode_t *mode, kuid_t *uid, kgid_t *gid,
1272                                const char **tmp)
1273 {
1274         char *s;
1275
1276         *tmp = NULL;
1277
1278         /* the device type may provide a specific name */
1279         if (dev->type && dev->type->devnode)
1280                 *tmp = dev->type->devnode(dev, mode, uid, gid);
1281         if (*tmp)
1282                 return *tmp;
1283
1284         /* the class may provide a specific name */
1285         if (dev->class && dev->class->devnode)
1286                 *tmp = dev->class->devnode(dev, mode);
1287         if (*tmp)
1288                 return *tmp;
1289
1290         /* return name without allocation, tmp == NULL */
1291         if (strchr(dev_name(dev), '!') == NULL)
1292                 return dev_name(dev);
1293
1294         /* replace '!' in the name with '/' */
1295         *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1296         if (!*tmp)
1297                 return NULL;
1298         while ((s = strchr(*tmp, '!')))
1299                 s[0] = '/';
1300         return *tmp;
1301 }
1302
1303 /**
1304  * device_for_each_child - device child iterator.
1305  * @parent: parent struct device.
1306  * @fn: function to be called for each device.
1307  * @data: data for the callback.
1308  *
1309  * Iterate over @parent's child devices, and call @fn for each,
1310  * passing it @data.
1311  *
1312  * We check the return of @fn each time. If it returns anything
1313  * other than 0, we break out and return that value.
1314  */
1315 int device_for_each_child(struct device *parent, void *data,
1316                           int (*fn)(struct device *dev, void *data))
1317 {
1318         struct klist_iter i;
1319         struct device *child;
1320         int error = 0;
1321
1322         if (!parent->p)
1323                 return 0;
1324
1325         klist_iter_init(&parent->p->klist_children, &i);
1326         while ((child = next_device(&i)) && !error)
1327                 error = fn(child, data);
1328         klist_iter_exit(&i);
1329         return error;
1330 }
1331 EXPORT_SYMBOL_GPL(device_for_each_child);
1332
1333 /**
1334  * device_find_child - device iterator for locating a particular device.
1335  * @parent: parent struct device
1336  * @match: Callback function to check device
1337  * @data: Data to pass to match function
1338  *
1339  * This is similar to the device_for_each_child() function above, but it
1340  * returns a reference to a device that is 'found' for later use, as
1341  * determined by the @match callback.
1342  *
1343  * The callback should return 0 if the device doesn't match and non-zero
1344  * if it does.  If the callback returns non-zero and a reference to the
1345  * current device can be obtained, this function will return to the caller
1346  * and not iterate over any more devices.
1347  *
1348  * NOTE: you will need to drop the reference with put_device() after use.
1349  */
1350 struct device *device_find_child(struct device *parent, void *data,
1351                                  int (*match)(struct device *dev, void *data))
1352 {
1353         struct klist_iter i;
1354         struct device *child;
1355
1356         if (!parent)
1357                 return NULL;
1358
1359         klist_iter_init(&parent->p->klist_children, &i);
1360         while ((child = next_device(&i)))
1361                 if (match(child, data) && get_device(child))
1362                         break;
1363         klist_iter_exit(&i);
1364         return child;
1365 }
1366 EXPORT_SYMBOL_GPL(device_find_child);
1367
1368 int __init devices_init(void)
1369 {
1370         devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1371         if (!devices_kset)
1372                 return -ENOMEM;
1373         dev_kobj = kobject_create_and_add("dev", NULL);
1374         if (!dev_kobj)
1375                 goto dev_kobj_err;
1376         sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1377         if (!sysfs_dev_block_kobj)
1378                 goto block_kobj_err;
1379         sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1380         if (!sysfs_dev_char_kobj)
1381                 goto char_kobj_err;
1382
1383         return 0;
1384
1385  char_kobj_err:
1386         kobject_put(sysfs_dev_block_kobj);
1387  block_kobj_err:
1388         kobject_put(dev_kobj);
1389  dev_kobj_err:
1390         kset_unregister(devices_kset);
1391         return -ENOMEM;
1392 }
1393
1394 static int device_check_offline(struct device *dev, void *not_used)
1395 {
1396         int ret;
1397
1398         ret = device_for_each_child(dev, NULL, device_check_offline);
1399         if (ret)
1400                 return ret;
1401
1402         return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1403 }
1404
1405 /**
1406  * device_offline - Prepare the device for hot-removal.
1407  * @dev: Device to be put offline.
1408  *
1409  * Execute the device bus type's .offline() callback, if present, to prepare
1410  * the device for a subsequent hot-removal.  If that succeeds, the device must
1411  * not be used until either it is removed or its bus type's .online() callback
1412  * is executed.
1413  *
1414  * Call under device_hotplug_lock.
1415  */
1416 int device_offline(struct device *dev)
1417 {
1418         int ret;
1419
1420         if (dev->offline_disabled)
1421                 return -EPERM;
1422
1423         ret = device_for_each_child(dev, NULL, device_check_offline);
1424         if (ret)
1425                 return ret;
1426
1427         device_lock(dev);
1428         if (device_supports_offline(dev)) {
1429                 if (dev->offline) {
1430                         ret = 1;
1431                 } else {
1432                         ret = dev->bus->offline(dev);
1433                         if (!ret) {
1434                                 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1435                                 dev->offline = true;
1436                         }
1437                 }
1438         }
1439         device_unlock(dev);
1440
1441         return ret;
1442 }
1443
1444 /**
1445  * device_online - Put the device back online after successful device_offline().
1446  * @dev: Device to be put back online.
1447  *
1448  * If device_offline() has been successfully executed for @dev, but the device
1449  * has not been removed subsequently, execute its bus type's .online() callback
1450  * to indicate that the device can be used again.
1451  *
1452  * Call under device_hotplug_lock.
1453  */
1454 int device_online(struct device *dev)
1455 {
1456         int ret = 0;
1457
1458         device_lock(dev);
1459         if (device_supports_offline(dev)) {
1460                 if (dev->offline) {
1461                         ret = dev->bus->online(dev);
1462                         if (!ret) {
1463                                 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1464                                 dev->offline = false;
1465                         }
1466                 } else {
1467                         ret = 1;
1468                 }
1469         }
1470         device_unlock(dev);
1471
1472         return ret;
1473 }
1474
1475 struct root_device {
1476         struct device dev;
1477         struct module *owner;
1478 };
1479
1480 static inline struct root_device *to_root_device(struct device *d)
1481 {
1482         return container_of(d, struct root_device, dev);
1483 }
1484
1485 static void root_device_release(struct device *dev)
1486 {
1487         kfree(to_root_device(dev));
1488 }
1489
1490 /**
1491  * __root_device_register - allocate and register a root device
1492  * @name: root device name
1493  * @owner: owner module of the root device, usually THIS_MODULE
1494  *
1495  * This function allocates a root device and registers it
1496  * using device_register(). In order to free the returned
1497  * device, use root_device_unregister().
1498  *
1499  * Root devices are dummy devices which allow other devices
1500  * to be grouped under /sys/devices. Use this function to
1501  * allocate a root device and then use it as the parent of
1502  * any device which should appear under /sys/devices/{name}
1503  *
1504  * The /sys/devices/{name} directory will also contain a
1505  * 'module' symlink which points to the @owner directory
1506  * in sysfs.
1507  *
1508  * Returns &struct device pointer on success, or ERR_PTR() on error.
1509  *
1510  * Note: You probably want to use root_device_register().
1511  */
1512 struct device *__root_device_register(const char *name, struct module *owner)
1513 {
1514         struct root_device *root;
1515         int err = -ENOMEM;
1516
1517         root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1518         if (!root)
1519                 return ERR_PTR(err);
1520
1521         err = dev_set_name(&root->dev, "%s", name);
1522         if (err) {
1523                 kfree(root);
1524                 return ERR_PTR(err);
1525         }
1526
1527         root->dev.release = root_device_release;
1528
1529         err = device_register(&root->dev);
1530         if (err) {
1531                 put_device(&root->dev);
1532                 return ERR_PTR(err);
1533         }
1534
1535 #ifdef CONFIG_MODULES   /* gotta find a "cleaner" way to do this */
1536         if (owner) {
1537                 struct module_kobject *mk = &owner->mkobj;
1538
1539                 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1540                 if (err) {
1541                         device_unregister(&root->dev);
1542                         return ERR_PTR(err);
1543                 }
1544                 root->owner = owner;
1545         }
1546 #endif
1547
1548         return &root->dev;
1549 }
1550 EXPORT_SYMBOL_GPL(__root_device_register);
1551
1552 /**
1553  * root_device_unregister - unregister and free a root device
1554  * @dev: device going away
1555  *
1556  * This function unregisters and cleans up a device that was created by
1557  * root_device_register().
1558  */
1559 void root_device_unregister(struct device *dev)
1560 {
1561         struct root_device *root = to_root_device(dev);
1562
1563         if (root->owner)
1564                 sysfs_remove_link(&root->dev.kobj, "module");
1565
1566         device_unregister(dev);
1567 }
1568 EXPORT_SYMBOL_GPL(root_device_unregister);
1569
1570
1571 static void device_create_release(struct device *dev)
1572 {
1573         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1574         kfree(dev);
1575 }
1576
1577 static struct device *
1578 device_create_groups_vargs(struct class *class, struct device *parent,
1579                            dev_t devt, void *drvdata,
1580                            const struct attribute_group **groups,
1581                            const char *fmt, va_list args)
1582 {
1583         struct device *dev = NULL;
1584         int retval = -ENODEV;
1585
1586         if (class == NULL || IS_ERR(class))
1587                 goto error;
1588
1589         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1590         if (!dev) {
1591                 retval = -ENOMEM;
1592                 goto error;
1593         }
1594
1595         device_initialize(dev);
1596         dev->devt = devt;
1597         dev->class = class;
1598         dev->parent = parent;
1599         dev->groups = groups;
1600         dev->release = device_create_release;
1601         dev_set_drvdata(dev, drvdata);
1602
1603         retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1604         if (retval)
1605                 goto error;
1606
1607         retval = device_add(dev);
1608         if (retval)
1609                 goto error;
1610
1611         return dev;
1612
1613 error:
1614         put_device(dev);
1615         return ERR_PTR(retval);
1616 }
1617
1618 /**
1619  * device_create_vargs - creates a device and registers it with sysfs
1620  * @class: pointer to the struct class that this device should be registered to
1621  * @parent: pointer to the parent struct device of this new device, if any
1622  * @devt: the dev_t for the char device to be added
1623  * @drvdata: the data to be added to the device for callbacks
1624  * @fmt: string for the device's name
1625  * @args: va_list for the device's name
1626  *
1627  * This function can be used by char device classes.  A struct device
1628  * will be created in sysfs, registered to the specified class.
1629  *
1630  * A "dev" file will be created, showing the dev_t for the device, if
1631  * the dev_t is not 0,0.
1632  * If a pointer to a parent struct device is passed in, the newly created
1633  * struct device will be a child of that device in sysfs.
1634  * The pointer to the struct device will be returned from the call.
1635  * Any further sysfs files that might be required can be created using this
1636  * pointer.
1637  *
1638  * Returns &struct device pointer on success, or ERR_PTR() on error.
1639  *
1640  * Note: the struct class passed to this function must have previously
1641  * been created with a call to class_create().
1642  */
1643 struct device *device_create_vargs(struct class *class, struct device *parent,
1644                                    dev_t devt, void *drvdata, const char *fmt,
1645                                    va_list args)
1646 {
1647         return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1648                                           fmt, args);
1649 }
1650 EXPORT_SYMBOL_GPL(device_create_vargs);
1651
1652 /**
1653  * device_create - creates a device and registers it with sysfs
1654  * @class: pointer to the struct class that this device should be registered to
1655  * @parent: pointer to the parent struct device of this new device, if any
1656  * @devt: the dev_t for the char device to be added
1657  * @drvdata: the data to be added to the device for callbacks
1658  * @fmt: string for the device's name
1659  *
1660  * This function can be used by char device classes.  A struct device
1661  * will be created in sysfs, registered to the specified class.
1662  *
1663  * A "dev" file will be created, showing the dev_t for the device, if
1664  * the dev_t is not 0,0.
1665  * If a pointer to a parent struct device is passed in, the newly created
1666  * struct device will be a child of that device in sysfs.
1667  * The pointer to the struct device will be returned from the call.
1668  * Any further sysfs files that might be required can be created using this
1669  * pointer.
1670  *
1671  * Returns &struct device pointer on success, or ERR_PTR() on error.
1672  *
1673  * Note: the struct class passed to this function must have previously
1674  * been created with a call to class_create().
1675  */
1676 struct device *device_create(struct class *class, struct device *parent,
1677                              dev_t devt, void *drvdata, const char *fmt, ...)
1678 {
1679         va_list vargs;
1680         struct device *dev;
1681
1682         va_start(vargs, fmt);
1683         dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1684         va_end(vargs);
1685         return dev;
1686 }
1687 EXPORT_SYMBOL_GPL(device_create);
1688
1689 /**
1690  * device_create_with_groups - creates a device and registers it with sysfs
1691  * @class: pointer to the struct class that this device should be registered to
1692  * @parent: pointer to the parent struct device of this new device, if any
1693  * @devt: the dev_t for the char device to be added
1694  * @drvdata: the data to be added to the device for callbacks
1695  * @groups: NULL-terminated list of attribute groups to be created
1696  * @fmt: string for the device's name
1697  *
1698  * This function can be used by char device classes.  A struct device
1699  * will be created in sysfs, registered to the specified class.
1700  * Additional attributes specified in the groups parameter will also
1701  * be created automatically.
1702  *
1703  * A "dev" file will be created, showing the dev_t for the device, if
1704  * the dev_t is not 0,0.
1705  * If a pointer to a parent struct device is passed in, the newly created
1706  * struct device will be a child of that device in sysfs.
1707  * The pointer to the struct device will be returned from the call.
1708  * Any further sysfs files that might be required can be created using this
1709  * pointer.
1710  *
1711  * Returns &struct device pointer on success, or ERR_PTR() on error.
1712  *
1713  * Note: the struct class passed to this function must have previously
1714  * been created with a call to class_create().
1715  */
1716 struct device *device_create_with_groups(struct class *class,
1717                                          struct device *parent, dev_t devt,
1718                                          void *drvdata,
1719                                          const struct attribute_group **groups,
1720                                          const char *fmt, ...)
1721 {
1722         va_list vargs;
1723         struct device *dev;
1724
1725         va_start(vargs, fmt);
1726         dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1727                                          fmt, vargs);
1728         va_end(vargs);
1729         return dev;
1730 }
1731 EXPORT_SYMBOL_GPL(device_create_with_groups);
1732
1733 static int __match_devt(struct device *dev, const void *data)
1734 {
1735         const dev_t *devt = data;
1736
1737         return dev->devt == *devt;
1738 }
1739
1740 /**
1741  * device_destroy - removes a device that was created with device_create()
1742  * @class: pointer to the struct class that this device was registered with
1743  * @devt: the dev_t of the device that was previously registered
1744  *
1745  * This call unregisters and cleans up a device that was created with a
1746  * call to device_create().
1747  */
1748 void device_destroy(struct class *class, dev_t devt)
1749 {
1750         struct device *dev;
1751
1752         dev = class_find_device(class, NULL, &devt, __match_devt);
1753         if (dev) {
1754                 put_device(dev);
1755                 device_unregister(dev);
1756         }
1757 }
1758 EXPORT_SYMBOL_GPL(device_destroy);
1759
1760 /**
1761  * device_rename - renames a device
1762  * @dev: the pointer to the struct device to be renamed
1763  * @new_name: the new name of the device
1764  *
1765  * It is the responsibility of the caller to provide mutual
1766  * exclusion between two different calls of device_rename
1767  * on the same device to ensure that new_name is valid and
1768  * won't conflict with other devices.
1769  *
1770  * Note: Don't call this function.  Currently, the networking layer calls this
1771  * function, but that will change.  The following text from Kay Sievers offers
1772  * some insight:
1773  *
1774  * Renaming devices is racy at many levels, symlinks and other stuff are not
1775  * replaced atomically, and you get a "move" uevent, but it's not easy to
1776  * connect the event to the old and new device. Device nodes are not renamed at
1777  * all, there isn't even support for that in the kernel now.
1778  *
1779  * In the meantime, during renaming, your target name might be taken by another
1780  * driver, creating conflicts. Or the old name is taken directly after you
1781  * renamed it -- then you get events for the same DEVPATH, before you even see
1782  * the "move" event. It's just a mess, and nothing new should ever rely on
1783  * kernel device renaming. Besides that, it's not even implemented now for
1784  * other things than (driver-core wise very simple) network devices.
1785  *
1786  * We are currently about to change network renaming in udev to completely
1787  * disallow renaming of devices in the same namespace as the kernel uses,
1788  * because we can't solve the problems properly, that arise with swapping names
1789  * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1790  * be allowed to some other name than eth[0-9]*, for the aforementioned
1791  * reasons.
1792  *
1793  * Make up a "real" name in the driver before you register anything, or add
1794  * some other attributes for userspace to find the device, or use udev to add
1795  * symlinks -- but never rename kernel devices later, it's a complete mess. We
1796  * don't even want to get into that and try to implement the missing pieces in
1797  * the core. We really have other pieces to fix in the driver core mess. :)
1798  */
1799 int device_rename(struct device *dev, const char *new_name)
1800 {
1801         struct kobject *kobj = &dev->kobj;
1802         char *old_device_name = NULL;
1803         int error;
1804
1805         dev = get_device(dev);
1806         if (!dev)
1807                 return -EINVAL;
1808
1809         dev_dbg(dev, "renaming to %s\n", new_name);
1810
1811         old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1812         if (!old_device_name) {
1813                 error = -ENOMEM;
1814                 goto out;
1815         }
1816
1817         if (dev->class) {
1818                 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1819                                              kobj, old_device_name,
1820                                              new_name, kobject_namespace(kobj));
1821                 if (error)
1822                         goto out;
1823         }
1824
1825         error = kobject_rename(kobj, new_name);
1826         if (error)
1827                 goto out;
1828
1829 out:
1830         put_device(dev);
1831
1832         kfree(old_device_name);
1833
1834         return error;
1835 }
1836 EXPORT_SYMBOL_GPL(device_rename);
1837
1838 static int device_move_class_links(struct device *dev,
1839                                    struct device *old_parent,
1840                                    struct device *new_parent)
1841 {
1842         int error = 0;
1843
1844         if (old_parent)
1845                 sysfs_remove_link(&dev->kobj, "device");
1846         if (new_parent)
1847                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1848                                           "device");
1849         return error;
1850 }
1851
1852 /**
1853  * device_move - moves a device to a new parent
1854  * @dev: the pointer to the struct device to be moved
1855  * @new_parent: the new parent of the device (can by NULL)
1856  * @dpm_order: how to reorder the dpm_list
1857  */
1858 int device_move(struct device *dev, struct device *new_parent,
1859                 enum dpm_order dpm_order)
1860 {
1861         int error;
1862         struct device *old_parent;
1863         struct kobject *new_parent_kobj;
1864
1865         dev = get_device(dev);
1866         if (!dev)
1867                 return -EINVAL;
1868
1869         device_pm_lock();
1870         new_parent = get_device(new_parent);
1871         new_parent_kobj = get_device_parent(dev, new_parent);
1872
1873         pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1874                  __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1875         error = kobject_move(&dev->kobj, new_parent_kobj);
1876         if (error) {
1877                 cleanup_glue_dir(dev, new_parent_kobj);
1878                 put_device(new_parent);
1879                 goto out;
1880         }
1881         old_parent = dev->parent;
1882         dev->parent = new_parent;
1883         if (old_parent)
1884                 klist_remove(&dev->p->knode_parent);
1885         if (new_parent) {
1886                 klist_add_tail(&dev->p->knode_parent,
1887                                &new_parent->p->klist_children);
1888                 set_dev_node(dev, dev_to_node(new_parent));
1889         }
1890
1891         if (dev->class) {
1892                 error = device_move_class_links(dev, old_parent, new_parent);
1893                 if (error) {
1894                         /* We ignore errors on cleanup since we're hosed anyway... */
1895                         device_move_class_links(dev, new_parent, old_parent);
1896                         if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1897                                 if (new_parent)
1898                                         klist_remove(&dev->p->knode_parent);
1899                                 dev->parent = old_parent;
1900                                 if (old_parent) {
1901                                         klist_add_tail(&dev->p->knode_parent,
1902                                                        &old_parent->p->klist_children);
1903                                         set_dev_node(dev, dev_to_node(old_parent));
1904                                 }
1905                         }
1906                         cleanup_glue_dir(dev, new_parent_kobj);
1907                         put_device(new_parent);
1908                         goto out;
1909                 }
1910         }
1911         switch (dpm_order) {
1912         case DPM_ORDER_NONE:
1913                 break;
1914         case DPM_ORDER_DEV_AFTER_PARENT:
1915                 device_pm_move_after(dev, new_parent);
1916                 break;
1917         case DPM_ORDER_PARENT_BEFORE_DEV:
1918                 device_pm_move_before(new_parent, dev);
1919                 break;
1920         case DPM_ORDER_DEV_LAST:
1921                 device_pm_move_last(dev);
1922                 break;
1923         }
1924
1925         put_device(old_parent);
1926 out:
1927         device_pm_unlock();
1928         put_device(dev);
1929         return error;
1930 }
1931 EXPORT_SYMBOL_GPL(device_move);
1932
1933 /**
1934  * device_shutdown - call ->shutdown() on each device to shutdown.
1935  */
1936 void device_shutdown(void)
1937 {
1938         struct device *dev, *parent;
1939
1940         spin_lock(&devices_kset->list_lock);
1941         /*
1942          * Walk the devices list backward, shutting down each in turn.
1943          * Beware that device unplug events may also start pulling
1944          * devices offline, even as the system is shutting down.
1945          */
1946         while (!list_empty(&devices_kset->list)) {
1947                 dev = list_entry(devices_kset->list.prev, struct device,
1948                                 kobj.entry);
1949
1950                 /*
1951                  * hold reference count of device's parent to
1952                  * prevent it from being freed because parent's
1953                  * lock is to be held
1954                  */
1955                 parent = get_device(dev->parent);
1956                 get_device(dev);
1957                 /*
1958                  * Make sure the device is off the kset list, in the
1959                  * event that dev->*->shutdown() doesn't remove it.
1960                  */
1961                 list_del_init(&dev->kobj.entry);
1962                 spin_unlock(&devices_kset->list_lock);
1963
1964                 /* hold lock to avoid race with probe/release */
1965                 if (parent)
1966                         device_lock(parent);
1967                 device_lock(dev);
1968
1969                 /* Don't allow any more runtime suspends */
1970                 pm_runtime_get_noresume(dev);
1971                 pm_runtime_barrier(dev);
1972
1973                 if (dev->bus && dev->bus->shutdown) {
1974                         if (initcall_debug)
1975                                 dev_info(dev, "shutdown\n");
1976                         dev->bus->shutdown(dev);
1977                 } else if (dev->driver && dev->driver->shutdown) {
1978                         if (initcall_debug)
1979                                 dev_info(dev, "shutdown\n");
1980                         dev->driver->shutdown(dev);
1981                 }
1982
1983                 device_unlock(dev);
1984                 if (parent)
1985                         device_unlock(parent);
1986
1987                 put_device(dev);
1988                 put_device(parent);
1989
1990                 spin_lock(&devices_kset->list_lock);
1991         }
1992         spin_unlock(&devices_kset->list_lock);
1993 }
1994
1995 /*
1996  * Device logging functions
1997  */
1998
1999 #ifdef CONFIG_PRINTK
2000 static int
2001 create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
2002 {
2003         const char *subsys;
2004         size_t pos = 0;
2005
2006         if (dev->class)
2007                 subsys = dev->class->name;
2008         else if (dev->bus)
2009                 subsys = dev->bus->name;
2010         else
2011                 return 0;
2012
2013         pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
2014         if (pos >= hdrlen)
2015                 goto overflow;
2016
2017         /*
2018          * Add device identifier DEVICE=:
2019          *   b12:8         block dev_t
2020          *   c127:3        char dev_t
2021          *   n8            netdev ifindex
2022          *   +sound:card0  subsystem:devname
2023          */
2024         if (MAJOR(dev->devt)) {
2025                 char c;
2026
2027                 if (strcmp(subsys, "block") == 0)
2028                         c = 'b';
2029                 else
2030                         c = 'c';
2031                 pos++;
2032                 pos += snprintf(hdr + pos, hdrlen - pos,
2033                                 "DEVICE=%c%u:%u",
2034                                 c, MAJOR(dev->devt), MINOR(dev->devt));
2035         } else if (strcmp(subsys, "net") == 0) {
2036                 struct net_device *net = to_net_dev(dev);
2037
2038                 pos++;
2039                 pos += snprintf(hdr + pos, hdrlen - pos,
2040                                 "DEVICE=n%u", net->ifindex);
2041         } else {
2042                 pos++;
2043                 pos += snprintf(hdr + pos, hdrlen - pos,
2044                                 "DEVICE=+%s:%s", subsys, dev_name(dev));
2045         }
2046
2047         if (pos >= hdrlen)
2048                 goto overflow;
2049
2050         return pos;
2051
2052 overflow:
2053         dev_WARN(dev, "device/subsystem name too long");
2054         return 0;
2055 }
2056
2057 int dev_vprintk_emit(int level, const struct device *dev,
2058                      const char *fmt, va_list args)
2059 {
2060         char hdr[128];
2061         size_t hdrlen;
2062
2063         hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2064
2065         return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2066 }
2067 EXPORT_SYMBOL(dev_vprintk_emit);
2068
2069 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2070 {
2071         va_list args;
2072         int r;
2073
2074         va_start(args, fmt);
2075
2076         r = dev_vprintk_emit(level, dev, fmt, args);
2077
2078         va_end(args);
2079
2080         return r;
2081 }
2082 EXPORT_SYMBOL(dev_printk_emit);
2083
2084 static void __dev_printk(const char *level, const struct device *dev,
2085                         struct va_format *vaf)
2086 {
2087         if (dev)
2088                 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
2089                                 dev_driver_string(dev), dev_name(dev), vaf);
2090         else
2091                 printk("%s(NULL device *): %pV", level, vaf);
2092 }
2093
2094 void dev_printk(const char *level, const struct device *dev,
2095                 const char *fmt, ...)
2096 {
2097         struct va_format vaf;
2098         va_list args;
2099
2100         va_start(args, fmt);
2101
2102         vaf.fmt = fmt;
2103         vaf.va = &args;
2104
2105         __dev_printk(level, dev, &vaf);
2106
2107         va_end(args);
2108 }
2109 EXPORT_SYMBOL(dev_printk);
2110
2111 #define define_dev_printk_level(func, kern_level)               \
2112 void func(const struct device *dev, const char *fmt, ...)       \
2113 {                                                               \
2114         struct va_format vaf;                                   \
2115         va_list args;                                           \
2116                                                                 \
2117         va_start(args, fmt);                                    \
2118                                                                 \
2119         vaf.fmt = fmt;                                          \
2120         vaf.va = &args;                                         \
2121                                                                 \
2122         __dev_printk(kern_level, dev, &vaf);                    \
2123                                                                 \
2124         va_end(args);                                           \
2125 }                                                               \
2126 EXPORT_SYMBOL(func);
2127
2128 define_dev_printk_level(dev_emerg, KERN_EMERG);
2129 define_dev_printk_level(dev_alert, KERN_ALERT);
2130 define_dev_printk_level(dev_crit, KERN_CRIT);
2131 define_dev_printk_level(dev_err, KERN_ERR);
2132 define_dev_printk_level(dev_warn, KERN_WARNING);
2133 define_dev_printk_level(dev_notice, KERN_NOTICE);
2134 define_dev_printk_level(_dev_info, KERN_INFO);
2135
2136 #endif
2137
2138 static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
2139 {
2140         return fwnode && !IS_ERR(fwnode->secondary);
2141 }
2142
2143 /**
2144  * set_primary_fwnode - Change the primary firmware node of a given device.
2145  * @dev: Device to handle.
2146  * @fwnode: New primary firmware node of the device.
2147  *
2148  * Set the device's firmware node pointer to @fwnode, but if a secondary
2149  * firmware node of the device is present, preserve it.
2150  */
2151 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2152 {
2153         if (fwnode) {
2154                 struct fwnode_handle *fn = dev->fwnode;
2155
2156                 if (fwnode_is_primary(fn))
2157                         fn = fn->secondary;
2158
2159                 fwnode->secondary = fn;
2160                 dev->fwnode = fwnode;
2161         } else {
2162                 dev->fwnode = fwnode_is_primary(dev->fwnode) ?
2163                         dev->fwnode->secondary : NULL;
2164         }
2165 }
2166 EXPORT_SYMBOL_GPL(set_primary_fwnode);
2167
2168 /**
2169  * set_secondary_fwnode - Change the secondary firmware node of a given device.
2170  * @dev: Device to handle.
2171  * @fwnode: New secondary firmware node of the device.
2172  *
2173  * If a primary firmware node of the device is present, set its secondary
2174  * pointer to @fwnode.  Otherwise, set the device's firmware node pointer to
2175  * @fwnode.
2176  */
2177 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2178 {
2179         if (fwnode)
2180                 fwnode->secondary = ERR_PTR(-ENODEV);
2181
2182         if (fwnode_is_primary(dev->fwnode))
2183                 dev->fwnode->secondary = fwnode;
2184         else
2185                 dev->fwnode = fwnode;
2186 }