drivers/base/dd.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * drivers/base/dd.c - The core device/driver interactions.
   4  *
   5  * This file contains the (sometimes tricky) code that controls the
   6  * interactions between devices and drivers, which primarily includes
   7  * driver binding and unbinding.
   8  *
   9  * All of this code used to exist in drivers/base/bus.c, but was
  10  * relocated to here in the name of compartmentalization (since it wasn't
  11  * strictly code just for the 'struct bus_type'.
  12  *
  13  * Copyright (c) 2002-5 Patrick Mochel
  14  * Copyright (c) 2002-3 Open Source Development Labs
  15  * Copyright (c) 2007-2009 Greg Kroah-Hartman <gregkh@suse.de>
  16  * Copyright (c) 2007-2009 Novell Inc.
  17  */
  18
  19 #include <linux/debugfs.h>
  20 #include <linux/device.h>
  21 #include <linux/delay.h>
  22 #include <linux/dma-mapping.h>
  23 #include <linux/init.h>
  24 #include <linux/module.h>
  25 #include <linux/kthread.h>
  26 #include <linux/wait.h>
  27 #include <linux/async.h>
  28 #include <linux/pm_runtime.h>
  29 #include <linux/pinctrl/devinfo.h>
  30 #include <linux/slab.h>
  31
  32 #include "base.h"
  33 #include "power/power.h"
  34
  35 /*
  36  * Deferred Probe infrastructure.
  37  *
  38  * Sometimes driver probe order matters, but the kernel doesn't always have
  39  * dependency information which means some drivers will get probed before a
  40  * resource it depends on is available.  For example, an SDHCI driver may
  41  * first need a GPIO line from an i2c GPIO controller before it can be
  42  * initialized.  If a required resource is not available yet, a driver can
  43  * request probing to be deferred by returning -EPROBE_DEFER from its probe hook
  44  *
  45  * Deferred probe maintains two lists of devices, a pending list and an active
  46  * list.  A driver returning -EPROBE_DEFER causes the device to be added to the
  47  * pending list.  A successful driver probe will trigger moving all devices
  48  * from the pending to the active list so that the workqueue will eventually
  49  * retry them.
  50  *
  51  * The deferred_probe_mutex must be held any time the deferred_probe_*_list
  52  * of the (struct device*)->p->deferred_probe pointers are manipulated
  53  */
  54 static DEFINE_MUTEX(deferred_probe_mutex);
  55 static LIST_HEAD(deferred_probe_pending_list);
  56 static LIST_HEAD(deferred_probe_active_list);
  57 static atomic_t deferred_trigger_count = ATOMIC_INIT(0);
  58 static struct dentry *deferred_devices;
  59 static bool initcalls_done;
  60
  61 /* Save the async probe drivers' name from kernel cmdline */
  62 #define ASYNC_DRV_NAMES_MAX_LEN 256
  63 static char async_probe_drv_names[ASYNC_DRV_NAMES_MAX_LEN];
  64
  65 /*
  66  * In some cases, like suspend to RAM or hibernation, It might be reasonable
  67  * to prohibit probing of devices as it could be unsafe.
  68  * Once defer_all_probes is true all drivers probes will be forcibly deferred.
  69  */
  70 static bool defer_all_probes;
  71
  72 /*
  73  * deferred_probe_work_func() - Retry probing devices in the active list.
  74  */
  75 static void deferred_probe_work_func(struct work_struct *work)
  76 {
  77         struct device *dev;
  78         struct device_private *private;
  79         /*
  80          * This block processes every device in the deferred 'active' list.
  81          * Each device is removed from the active list and passed to
  82          * bus_probe_device() to re-attempt the probe.  The loop continues
  83          * until every device in the active list is removed and retried.
  84          *
  85          * Note: Once the device is removed from the list and the mutex is
  86          * released, it is possible for the device get freed by another thread
  87          * and cause a illegal pointer dereference.  This code uses
  88          * get/put_device() to ensure the device structure cannot disappear
  89          * from under our feet.
  90          */
  91         mutex_lock(&deferred_probe_mutex);
  92         while (!list_empty(&deferred_probe_active_list)) {
  93                 private = list_first_entry(&deferred_probe_active_list,
  94                                         typeof(*dev->p), deferred_probe);
  95                 dev = private->device;
  96                 list_del_init(&private->deferred_probe);
  97
  98                 get_device(dev);
  99
 100                 /*
 101                  * Drop the mutex while probing each device; the probe path may
 102                  * manipulate the deferred list
 103                  */
 104                 mutex_unlock(&deferred_probe_mutex);
 105
 106                 /*
 107                  * Force the device to the end of the dpm_list since
 108                  * the PM code assumes that the order we add things to
 109                  * the list is a good order for suspend but deferred
 110                  * probe makes that very unsafe.
 111                  */
 112                 device_pm_move_to_tail(dev);
 113
 114                 dev_dbg(dev, "Retrying from deferred list\n");
 115                 bus_probe_device(dev);
 116                 mutex_lock(&deferred_probe_mutex);
 117
 118                 put_device(dev);
 119         }
 120         mutex_unlock(&deferred_probe_mutex);
 121 }
 122 static DECLARE_WORK(deferred_probe_work, deferred_probe_work_func);
 123
 124 void driver_deferred_probe_add(struct device *dev)
 125 {
 126         mutex_lock(&deferred_probe_mutex);
 127         if (list_empty(&dev->p->deferred_probe)) {
 128                 dev_dbg(dev, "Added to deferred list\n");
 129                 list_add_tail(&dev->p->deferred_probe, &deferred_probe_pending_list);
 130         }
 131         mutex_unlock(&deferred_probe_mutex);
 132 }
 133
 134 void driver_deferred_probe_del(struct device *dev)
 135 {
 136         mutex_lock(&deferred_probe_mutex);
 137         if (!list_empty(&dev->p->deferred_probe)) {
 138                 dev_dbg(dev, "Removed from deferred list\n");
 139                 list_del_init(&dev->p->deferred_probe);
 140                 kfree(dev->p->deferred_probe_reason);
 141                 dev->p->deferred_probe_reason = NULL;
 142         }
 143         mutex_unlock(&deferred_probe_mutex);
 144 }
 145
 146 static bool driver_deferred_probe_enable = false;
 147 /**
 148  * driver_deferred_probe_trigger() - Kick off re-probing deferred devices
 149  *
 150  * This functions moves all devices from the pending list to the active
 151  * list and schedules the deferred probe workqueue to process them.  It
 152  * should be called anytime a driver is successfully bound to a device.
 153  *
 154  * Note, there is a race condition in multi-threaded probe. In the case where
 155  * more than one device is probing at the same time, it is possible for one
 156  * probe to complete successfully while another is about to defer. If the second
 157  * depends on the first, then it will get put on the pending list after the
 158  * trigger event has already occurred and will be stuck there.
 159  *
 160  * The atomic 'deferred_trigger_count' is used to determine if a successful
 161  * trigger has occurred in the midst of probing a driver. If the trigger count
 162  * changes in the midst of a probe, then deferred processing should be triggered
 163  * again.
 164  */
 165 static void driver_deferred_probe_trigger(void)
 166 {
 167         if (!driver_deferred_probe_enable)
 168                 return;
 169
 170         /*
 171          * A successful probe means that all the devices in the pending list
 172          * should be triggered to be reprobed.  Move all the deferred devices
 173          * into the active list so they can be retried by the workqueue
 174          */
 175         mutex_lock(&deferred_probe_mutex);
 176         atomic_inc(&deferred_trigger_count);
 177         list_splice_tail_init(&deferred_probe_pending_list,
 178                               &deferred_probe_active_list);
 179         mutex_unlock(&deferred_probe_mutex);
 180
 181         /*
 182          * Kick the re-probe thread.  It may already be scheduled, but it is
 183          * safe to kick it again.
 184          */
 185         schedule_work(&deferred_probe_work);
 186 }
 187
 188 /**
 189  * device_block_probing() - Block/defer device's probes
 190  *
 191  *      It will disable probing of devices and defer their probes instead.
 192  */
 193 void device_block_probing(void)
 194 {
 195         defer_all_probes = true;
 196         /* sync with probes to avoid races. */
 197         wait_for_device_probe();
 198 }
 199
 200 /**
 201  * device_unblock_probing() - Unblock/enable device's probes
 202  *
 203  *      It will restore normal behavior and trigger re-probing of deferred
 204  * devices.
 205  */
 206 void device_unblock_probing(void)
 207 {
 208         defer_all_probes = false;
 209         driver_deferred_probe_trigger();
 210 }
 211
 212 /**
 213  * device_set_deferred_probe_reason() - Set defer probe reason message for device
 214  * @dev: the pointer to the struct device
 215  * @vaf: the pointer to va_format structure with message
 216  */
 217 void device_set_deferred_probe_reason(const struct device *dev, struct va_format *vaf)
 218 {
 219         const char *drv = dev_driver_string(dev);
 220
 221         mutex_lock(&deferred_probe_mutex);
 222
 223         kfree(dev->p->deferred_probe_reason);
 224         dev->p->deferred_probe_reason = kasprintf(GFP_KERNEL, "%s: %pV", drv, vaf);
 225
 226         mutex_unlock(&deferred_probe_mutex);
 227 }
 228
 229 /*
 230  * deferred_devs_show() - Show the devices in the deferred probe pending list.
 231  */
 232 static int deferred_devs_show(struct seq_file *s, void *data)
 233 {
 234         struct device_private *curr;
 235
 236         mutex_lock(&deferred_probe_mutex);
 237
 238         list_for_each_entry(curr, &deferred_probe_pending_list, deferred_probe)
 239                 seq_printf(s, "%s\t%s", dev_name(curr->device),
 240                            curr->device->p->deferred_probe_reason ?: "\n");
 241
 242         mutex_unlock(&deferred_probe_mutex);
 243
 244         return 0;
 245 }
 246 DEFINE_SHOW_ATTRIBUTE(deferred_devs);
 247
 248 int driver_deferred_probe_timeout;
 249 EXPORT_SYMBOL_GPL(driver_deferred_probe_timeout);
 250 static DECLARE_WAIT_QUEUE_HEAD(probe_timeout_waitqueue);
 251
 252 static int __init deferred_probe_timeout_setup(char *str)
 253 {
 254         int timeout;
 255
 256         if (!kstrtoint(str, 10, &timeout))
 257                 driver_deferred_probe_timeout = timeout;
 258         return 1;
 259 }
 260 __setup("deferred_probe_timeout=", deferred_probe_timeout_setup);
 261
 262 /**
 263  * driver_deferred_probe_check_state() - Check deferred probe state
 264  * @dev: device to check
 265  *
 266  * Return:
 267  * -ENODEV if initcalls have completed and modules are disabled.
 268  * -ETIMEDOUT if the deferred probe timeout was set and has expired
 269  *  and modules are enabled.
 270  * -EPROBE_DEFER in other cases.
 271  *
 272  * Drivers or subsystems can opt-in to calling this function instead of directly
 273  * returning -EPROBE_DEFER.
 274  */
 275 int driver_deferred_probe_check_state(struct device *dev)
 276 {
 277         if (!IS_ENABLED(CONFIG_MODULES) && initcalls_done) {
 278                 dev_warn(dev, "ignoring dependency for device, assuming no driver\n");
 279                 return -ENODEV;
 280         }
 281
 282         if (!driver_deferred_probe_timeout && initcalls_done) {
 283                 dev_warn(dev, "deferred probe timeout, ignoring dependency\n");
 284                 return -ETIMEDOUT;
 285         }
 286
 287         return -EPROBE_DEFER;
 288 }
 289
 290 static void deferred_probe_timeout_work_func(struct work_struct *work)
 291 {
 292         struct device_private *private, *p;
 293
 294         driver_deferred_probe_timeout = 0;
 295         driver_deferred_probe_trigger();
 296         flush_work(&deferred_probe_work);
 297
 298         list_for_each_entry_safe(private, p, &deferred_probe_pending_list, deferred_probe)
 299                 dev_info(private->device, "deferred probe pending\n");
 300         wake_up_all(&probe_timeout_waitqueue);
 301 }
 302 static DECLARE_DELAYED_WORK(deferred_probe_timeout_work, deferred_probe_timeout_work_func);
 303
 304 /**
 305  * deferred_probe_initcall() - Enable probing of deferred devices
 306  *
 307  * We don't want to get in the way when the bulk of drivers are getting probed.
 308  * Instead, this initcall makes sure that deferred probing is delayed until
 309  * late_initcall time.
 310  */
 311 static int deferred_probe_initcall(void)
 312 {
 313         deferred_devices = debugfs_create_file("devices_deferred", 0444, NULL,
 314                                                NULL, &deferred_devs_fops);
 315
 316         driver_deferred_probe_enable = true;
 317         driver_deferred_probe_trigger();
 318         /* Sort as many dependencies as possible before exiting initcalls */
 319         flush_work(&deferred_probe_work);
 320         initcalls_done = true;
 321
 322         /*
 323          * Trigger deferred probe again, this time we won't defer anything
 324          * that is optional
 325          */
 326         driver_deferred_probe_trigger();
 327         flush_work(&deferred_probe_work);
 328
 329         if (driver_deferred_probe_timeout > 0) {
 330                 schedule_delayed_work(&deferred_probe_timeout_work,
 331                         driver_deferred_probe_timeout * HZ);
 332         }
 333         return 0;
 334 }
 335 late_initcall(deferred_probe_initcall);
 336
 337 static void __exit deferred_probe_exit(void)
 338 {
 339         debugfs_remove_recursive(deferred_devices);
 340 }
 341 __exitcall(deferred_probe_exit);
 342
 343 /**
 344  * device_is_bound() - Check if device is bound to a driver
 345  * @dev: device to check
 346  *
 347  * Returns true if passed device has already finished probing successfully
 348  * against a driver.
 349  *
 350  * This function must be called with the device lock held.
 351  */
 352 bool device_is_bound(struct device *dev)
 353 {
 354         return dev->p && klist_node_attached(&dev->p->knode_driver);
 355 }
 356
 357 static void driver_bound(struct device *dev)
 358 {
 359         if (device_is_bound(dev)) {
 360                 pr_warn("%s: device %s already bound\n",
 361                         __func__, kobject_name(&dev->kobj));
 362                 return;
 363         }
 364
 365         pr_debug("driver: '%s': %s: bound to device '%s'\n", dev->driver->name,
 366                  __func__, dev_name(dev));
 367
 368         klist_add_tail(&dev->p->knode_driver, &dev->driver->p->klist_devices);
 369         device_links_driver_bound(dev);
 370
 371         device_pm_check_callbacks(dev);
 372
 373         /*
 374          * Make sure the device is no longer in one of the deferred lists and
 375          * kick off retrying all pending devices
 376          */
 377         driver_deferred_probe_del(dev);
 378         driver_deferred_probe_trigger();
 379
 380         if (dev->bus)
 381                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
 382                                              BUS_NOTIFY_BOUND_DRIVER, dev);
 383
 384         kobject_uevent(&dev->kobj, KOBJ_BIND);
 385 }
 386
 387 static ssize_t coredump_store(struct device *dev, struct device_attribute *attr,
 388                             const char *buf, size_t count)
 389 {
 390         device_lock(dev);
 391         dev->driver->coredump(dev);
 392         device_unlock(dev);
 393
 394         return count;
 395 }
 396 static DEVICE_ATTR_WO(coredump);
 397
 398 static int driver_sysfs_add(struct device *dev)
 399 {
 400         int ret;
 401
 402         if (dev->bus)
 403                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
 404                                              BUS_NOTIFY_BIND_DRIVER, dev);
 405
 406         ret = sysfs_create_link(&dev->driver->p->kobj, &dev->kobj,
 407                                 kobject_name(&dev->kobj));
 408         if (ret)
 409                 goto fail;
 410
 411         ret = sysfs_create_link(&dev->kobj, &dev->driver->p->kobj,
 412                                 "driver");
 413         if (ret)
 414                 goto rm_dev;
 415
 416         if (!IS_ENABLED(CONFIG_DEV_COREDUMP) || !dev->driver->coredump ||
 417             !device_create_file(dev, &dev_attr_coredump))
 418                 return 0;
 419
 420         sysfs_remove_link(&dev->kobj, "driver");
 421
 422 rm_dev:
 423         sysfs_remove_link(&dev->driver->p->kobj,
 424                           kobject_name(&dev->kobj));
 425
 426 fail:
 427         return ret;
 428 }
 429
 430 static void driver_sysfs_remove(struct device *dev)
 431 {
 432         struct device_driver *drv = dev->driver;
 433
 434         if (drv) {
 435                 if (drv->coredump)
 436                         device_remove_file(dev, &dev_attr_coredump);
 437                 sysfs_remove_link(&drv->p->kobj, kobject_name(&dev->kobj));
 438                 sysfs_remove_link(&dev->kobj, "driver");
 439         }
 440 }
 441
 442 /**
 443  * device_bind_driver - bind a driver to one device.
 444  * @dev: device.
 445  *
 446  * Allow manual attachment of a driver to a device.
 447  * Caller must have already set @dev->driver.
 448  *
 449  * Note that this does not modify the bus reference count.
 450  * Please verify that is accounted for before calling this.
 451  * (It is ok to call with no other effort from a driver's probe() method.)
 452  *
 453  * This function must be called with the device lock held.
 454  */
 455 int device_bind_driver(struct device *dev)
 456 {
 457         int ret;
 458
 459         ret = driver_sysfs_add(dev);
 460         if (!ret)
 461                 driver_bound(dev);
 462         else if (dev->bus)
 463                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
 464                                              BUS_NOTIFY_DRIVER_NOT_BOUND, dev);
 465         return ret;
 466 }
 467 EXPORT_SYMBOL_GPL(device_bind_driver);
 468
 469 static atomic_t probe_count = ATOMIC_INIT(0);
 470 static DECLARE_WAIT_QUEUE_HEAD(probe_waitqueue);
 471
 472 static void driver_deferred_probe_add_trigger(struct device *dev,
 473                                               int local_trigger_count)
 474 {
 475         driver_deferred_probe_add(dev);
 476         /* Did a trigger occur while probing? Need to re-trigger if yes */
 477         if (local_trigger_count != atomic_read(&deferred_trigger_count))
 478                 driver_deferred_probe_trigger();
 479 }
 480
 481 static ssize_t state_synced_show(struct device *dev,
 482                                  struct device_attribute *attr, char *buf)
 483 {
 484         bool val;
 485
 486         device_lock(dev);
 487         val = dev->state_synced;
 488         device_unlock(dev);
 489         return sprintf(buf, "%u\n", val);
 490 }
 491 static DEVICE_ATTR_RO(state_synced);
 492
 493 static int really_probe(struct device *dev, struct device_driver *drv)
 494 {
 495         int ret = -EPROBE_DEFER;
 496         int local_trigger_count = atomic_read(&deferred_trigger_count);
 497         bool test_remove = IS_ENABLED(CONFIG_DEBUG_TEST_DRIVER_REMOVE) &&
 498                            !drv->suppress_bind_attrs;
 499
 500         if (defer_all_probes) {
 501                 /*
 502                  * Value of defer_all_probes can be set only by
 503                  * device_block_probing() which, in turn, will call
 504                  * wait_for_device_probe() right after that to avoid any races.
 505                  */
 506                 dev_dbg(dev, "Driver %s force probe deferral\n", drv->name);
 507                 driver_deferred_probe_add(dev);
 508                 return ret;
 509         }
 510
 511         ret = device_links_check_suppliers(dev);
 512         if (ret == -EPROBE_DEFER)
 513                 driver_deferred_probe_add_trigger(dev, local_trigger_count);
 514         if (ret)
 515                 return ret;
 516
 517         atomic_inc(&probe_count);
 518         pr_debug("bus: '%s': %s: probing driver %s with device %s\n",
 519                  drv->bus->name, __func__, drv->name, dev_name(dev));
 520         if (!list_empty(&dev->devres_head)) {
 521                 dev_crit(dev, "Resources present before probing\n");
 522                 ret = -EBUSY;
 523                 goto done;
 524         }
 525
 526 re_probe:
 527         dev->driver = drv;
 528
 529         /* If using pinctrl, bind pins now before probing */
 530         ret = pinctrl_bind_pins(dev);
 531         if (ret)
 532                 goto pinctrl_bind_failed;
 533
 534         if (dev->bus->dma_configure) {
 535                 ret = dev->bus->dma_configure(dev);
 536                 if (ret)
 537                         goto probe_failed;
 538         }
 539
 540         if (driver_sysfs_add(dev)) {
 541                 pr_err("%s: driver_sysfs_add(%s) failed\n",
 542                        __func__, dev_name(dev));
 543                 goto probe_failed;
 544         }
 545
 546         if (dev->pm_domain && dev->pm_domain->activate) {
 547                 ret = dev->pm_domain->activate(dev);
 548                 if (ret)
 549                         goto probe_failed;
 550         }
 551
 552         if (dev->bus->probe) {
 553                 ret = dev->bus->probe(dev);
 554                 if (ret)
 555                         goto probe_failed;
 556         } else if (drv->probe) {
 557                 ret = drv->probe(dev);
 558                 if (ret)
 559                         goto probe_failed;
 560         }
 561
 562         if (device_add_groups(dev, drv->dev_groups)) {
 563                 dev_err(dev, "device_add_groups() failed\n");
 564                 goto dev_groups_failed;
 565         }
 566
 567         if (dev_has_sync_state(dev) &&
 568             device_create_file(dev, &dev_attr_state_synced)) {
 569                 dev_err(dev, "state_synced sysfs add failed\n");
 570                 goto dev_sysfs_state_synced_failed;
 571         }
 572
 573         if (test_remove) {
 574                 test_remove = false;
 575
 576                 device_remove_file(dev, &dev_attr_state_synced);
 577                 device_remove_groups(dev, drv->dev_groups);
 578
 579                 if (dev->bus->remove)
 580                         dev->bus->remove(dev);
 581                 else if (drv->remove)
 582                         drv->remove(dev);
 583
 584                 devres_release_all(dev);
 585                 driver_sysfs_remove(dev);
 586                 dev->driver = NULL;
 587                 dev_set_drvdata(dev, NULL);
 588                 if (dev->pm_domain && dev->pm_domain->dismiss)
 589                         dev->pm_domain->dismiss(dev);
 590                 pm_runtime_reinit(dev);
 591
 592                 goto re_probe;
 593         }
 594
 595         pinctrl_init_done(dev);
 596
 597         if (dev->pm_domain && dev->pm_domain->sync)
 598                 dev->pm_domain->sync(dev);
 599
 600         driver_bound(dev);
 601         ret = 1;
 602         pr_debug("bus: '%s': %s: bound device %s to driver %s\n",
 603                  drv->bus->name, __func__, dev_name(dev), drv->name);
 604         goto done;
 605
 606 dev_sysfs_state_synced_failed:
 607         device_remove_groups(dev, drv->dev_groups);
 608 dev_groups_failed:
 609         if (dev->bus->remove)
 610                 dev->bus->remove(dev);
 611         else if (drv->remove)
 612                 drv->remove(dev);
 613 probe_failed:
 614         if (dev->bus)
 615                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
 616                                              BUS_NOTIFY_DRIVER_NOT_BOUND, dev);
 617 pinctrl_bind_failed:
 618         device_links_no_driver(dev);
 619         devres_release_all(dev);
 620         arch_teardown_dma_ops(dev);
 621         driver_sysfs_remove(dev);
 622         dev->driver = NULL;
 623         dev_set_drvdata(dev, NULL);
 624         if (dev->pm_domain && dev->pm_domain->dismiss)
 625                 dev->pm_domain->dismiss(dev);
 626         pm_runtime_reinit(dev);
 627         dev_pm_set_driver_flags(dev, 0);
 628
 629         switch (ret) {
 630         case -EPROBE_DEFER:
 631                 /* Driver requested deferred probing */
 632                 dev_dbg(dev, "Driver %s requests probe deferral\n", drv->name);
 633                 driver_deferred_probe_add_trigger(dev, local_trigger_count);
 634                 break;
 635         case -ENODEV:
 636         case -ENXIO:
 637                 pr_debug("%s: probe of %s rejects match %d\n",
 638                          drv->name, dev_name(dev), ret);
 639                 break;
 640         default:
 641                 /* driver matched but the probe failed */
 642                 pr_warn("%s: probe of %s failed with error %d\n",
 643                         drv->name, dev_name(dev), ret);
 644         }
 645         /*
 646          * Ignore errors returned by ->probe so that the next driver can try
 647          * its luck.
 648          */
 649         ret = 0;
 650 done:
 651         atomic_dec(&probe_count);
 652         wake_up_all(&probe_waitqueue);
 653         return ret;
 654 }
 655
 656 /*
 657  * For initcall_debug, show the driver probe time.
 658  */
 659 static int really_probe_debug(struct device *dev, struct device_driver *drv)
 660 {
 661         ktime_t calltime, rettime;
 662         int ret;
 663
 664         calltime = ktime_get();
 665         ret = really_probe(dev, drv);
 666         rettime = ktime_get();
 667         pr_debug("probe of %s returned %d after %lld usecs\n",
 668                  dev_name(dev), ret, ktime_us_delta(rettime, calltime));
 669         return ret;
 670 }
 671
 672 /**
 673  * driver_probe_done
 674  * Determine if the probe sequence is finished or not.
 675  *
 676  * Should somehow figure out how to use a semaphore, not an atomic variable...
 677  */
 678 int driver_probe_done(void)
 679 {
 680         int local_probe_count = atomic_read(&probe_count);
 681
 682         pr_debug("%s: probe_count = %d\n", __func__, local_probe_count);
 683         if (local_probe_count)
 684                 return -EBUSY;
 685         return 0;
 686 }
 687
 688 /**
 689  * wait_for_device_probe
 690  * Wait for device probing to be completed.
 691  */
 692 void wait_for_device_probe(void)
 693 {
 694         /* wait for probe timeout */
 695         wait_event(probe_timeout_waitqueue, !driver_deferred_probe_timeout);
 696
 697         /* wait for the deferred probe workqueue to finish */
 698         flush_work(&deferred_probe_work);
 699
 700         /* wait for the known devices to complete their probing */
 701         wait_event(probe_waitqueue, atomic_read(&probe_count) == 0);
 702         async_synchronize_full();
 703 }
 704 EXPORT_SYMBOL_GPL(wait_for_device_probe);
 705
 706 /**
 707  * driver_probe_device - attempt to bind device & driver together
 708  * @drv: driver to bind a device to
 709  * @dev: device to try to bind to the driver
 710  *
 711  * This function returns -ENODEV if the device is not registered,
 712  * 1 if the device is bound successfully and 0 otherwise.
 713  *
 714  * This function must be called with @dev lock held.  When called for a
 715  * USB interface, @dev->parent lock must be held as well.
 716  *
 717  * If the device has a parent, runtime-resume the parent before driver probing.
 718  */
 719 int driver_probe_device(struct device_driver *drv, struct device *dev)
 720 {
 721         int ret = 0;
 722
 723         if (!device_is_registered(dev))
 724                 return -ENODEV;
 725
 726         pr_debug("bus: '%s': %s: matched device %s with driver %s\n",
 727                  drv->bus->name, __func__, dev_name(dev), drv->name);
 728
 729         pm_runtime_get_suppliers(dev);
 730         if (dev->parent)
 731                 pm_runtime_get_sync(dev->parent);
 732
 733         pm_runtime_barrier(dev);
 734         if (initcall_debug)
 735                 ret = really_probe_debug(dev, drv);
 736         else
 737                 ret = really_probe(dev, drv);
 738         pm_request_idle(dev);
 739
 740         if (dev->parent)
 741                 pm_runtime_put(dev->parent);
 742
 743         pm_runtime_put_suppliers(dev);
 744         return ret;
 745 }
 746
 747 static inline bool cmdline_requested_async_probing(const char *drv_name)
 748 {
 749         return parse_option_str(async_probe_drv_names, drv_name);
 750 }
 751
 752 /* The option format is "driver_async_probe=drv_name1,drv_name2,..." */
 753 static int __init save_async_options(char *buf)
 754 {
 755         if (strlen(buf) >= ASYNC_DRV_NAMES_MAX_LEN)
 756                 pr_warn("Too long list of driver names for 'driver_async_probe'!\n");
 757
 758         strlcpy(async_probe_drv_names, buf, ASYNC_DRV_NAMES_MAX_LEN);
 759         return 0;
 760 }
 761 __setup("driver_async_probe=", save_async_options);
 762
 763 bool driver_allows_async_probing(struct device_driver *drv)
 764 {
 765         switch (drv->probe_type) {
 766         case PROBE_PREFER_ASYNCHRONOUS:
 767                 return true;
 768
 769         case PROBE_FORCE_SYNCHRONOUS:
 770                 return false;
 771
 772         default:
 773                 if (cmdline_requested_async_probing(drv->name))
 774                         return true;
 775
 776                 if (module_requested_async_probing(drv->owner))
 777                         return true;
 778
 779                 return false;
 780         }
 781 }
 782
 783 struct device_attach_data {
 784         struct device *dev;
 785
 786         /*
 787          * Indicates whether we are are considering asynchronous probing or
 788          * not. Only initial binding after device or driver registration
 789          * (including deferral processing) may be done asynchronously, the
 790          * rest is always synchronous, as we expect it is being done by
 791          * request from userspace.
 792          */
 793         bool check_async;
 794
 795         /*
 796          * Indicates if we are binding synchronous or asynchronous drivers.
 797          * When asynchronous probing is enabled we'll execute 2 passes
 798          * over drivers: first pass doing synchronous probing and second
 799          * doing asynchronous probing (if synchronous did not succeed -
 800          * most likely because there was no driver requiring synchronous
 801          * probing - and we found asynchronous driver during first pass).
 802          * The 2 passes are done because we can't shoot asynchronous
 803          * probe for given device and driver from bus_for_each_drv() since
 804          * driver pointer is not guaranteed to stay valid once
 805          * bus_for_each_drv() iterates to the next driver on the bus.
 806          */
 807         bool want_async;
 808
 809         /*
 810          * We'll set have_async to 'true' if, while scanning for matching
 811          * driver, we'll encounter one that requests asynchronous probing.
 812          */
 813         bool have_async;
 814 };
 815
 816 static int __device_attach_driver(struct device_driver *drv, void *_data)
 817 {
 818         struct device_attach_data *data = _data;
 819         struct device *dev = data->dev;
 820         bool async_allowed;
 821         int ret;
 822
 823         ret = driver_match_device(drv, dev);
 824         if (ret == 0) {
 825                 /* no match */
 826                 return 0;
 827         } else if (ret == -EPROBE_DEFER) {
 828                 dev_dbg(dev, "Device match requests probe deferral\n");
 829                 driver_deferred_probe_add(dev);
 830         } else if (ret < 0) {
 831                 dev_dbg(dev, "Bus failed to match device: %d\n", ret);
 832                 return ret;
 833         } /* ret > 0 means positive match */
 834
 835         async_allowed = driver_allows_async_probing(drv);
 836
 837         if (async_allowed)
 838                 data->have_async = true;
 839
 840         if (data->check_async && async_allowed != data->want_async)
 841                 return 0;
 842
 843         return driver_probe_device(drv, dev);
 844 }
 845
 846 static void __device_attach_async_helper(void *_dev, async_cookie_t cookie)
 847 {
 848         struct device *dev = _dev;
 849         struct device_attach_data data = {
 850                 .dev            = dev,
 851                 .check_async    = true,
 852                 .want_async     = true,
 853         };
 854
 855         device_lock(dev);
 856
 857         /*
 858          * Check if device has already been removed or claimed. This may
 859          * happen with driver loading, device discovery/registration,
 860          * and deferred probe processing happens all at once with
 861          * multiple threads.
 862          */
 863         if (dev->p->dead || dev->driver)
 864                 goto out_unlock;
 865
 866         if (dev->parent)
 867                 pm_runtime_get_sync(dev->parent);
 868
 869         bus_for_each_drv(dev->bus, NULL, &data, __device_attach_driver);
 870         dev_dbg(dev, "async probe completed\n");
 871
 872         pm_request_idle(dev);
 873
 874         if (dev->parent)
 875                 pm_runtime_put(dev->parent);
 876 out_unlock:
 877         device_unlock(dev);
 878
 879         put_device(dev);
 880 }
 881
 882 static int __device_attach(struct device *dev, bool allow_async)
 883 {
 884         int ret = 0;
 885
 886         device_lock(dev);
 887         if (dev->p->dead) {
 888                 goto out_unlock;
 889         } else if (dev->driver) {
 890                 if (device_is_bound(dev)) {
 891                         ret = 1;
 892                         goto out_unlock;
 893                 }
 894                 ret = device_bind_driver(dev);
 895                 if (ret == 0)
 896                         ret = 1;
 897                 else {
 898                         dev->driver = NULL;
 899                         ret = 0;
 900                 }
 901         } else {
 902                 struct device_attach_data data = {
 903                         .dev = dev,
 904                         .check_async = allow_async,
 905                         .want_async = false,
 906                 };
 907
 908                 if (dev->parent)
 909                         pm_runtime_get_sync(dev->parent);
 910
 911                 ret = bus_for_each_drv(dev->bus, NULL, &data,
 912                                         __device_attach_driver);
 913                 if (!ret && allow_async && data.have_async) {
 914                         /*
 915                          * If we could not find appropriate driver
 916                          * synchronously and we are allowed to do
 917                          * async probes and there are drivers that
 918                          * want to probe asynchronously, we'll
 919                          * try them.
 920                          */
 921                         dev_dbg(dev, "scheduling asynchronous probe\n");
 922                         get_device(dev);
 923                         async_schedule_dev(__device_attach_async_helper, dev);
 924                 } else {
 925                         pm_request_idle(dev);
 926                 }
 927
 928                 if (dev->parent)
 929                         pm_runtime_put(dev->parent);
 930         }
 931 out_unlock:
 932         device_unlock(dev);
 933         return ret;
 934 }
 935
 936 /**
 937  * device_attach - try to attach device to a driver.
 938  * @dev: device.
 939  *
 940  * Walk the list of drivers that the bus has and call
 941  * driver_probe_device() for each pair. If a compatible
 942  * pair is found, break out and return.
 943  *
 944  * Returns 1 if the device was bound to a driver;
 945  * 0 if no matching driver was found;
 946  * -ENODEV if the device is not registered.
 947  *
 948  * When called for a USB interface, @dev->parent lock must be held.
 949  */
 950 int device_attach(struct device *dev)
 951 {
 952         return __device_attach(dev, false);
 953 }
 954 EXPORT_SYMBOL_GPL(device_attach);
 955
 956 void device_initial_probe(struct device *dev)
 957 {
 958         __device_attach(dev, true);
 959 }
 960
 961 /*
 962  * __device_driver_lock - acquire locks needed to manipulate dev->drv
 963  * @dev: Device we will update driver info for
 964  * @parent: Parent device. Needed if the bus requires parent lock
 965  *
 966  * This function will take the required locks for manipulating dev->drv.
 967  * Normally this will just be the @dev lock, but when called for a USB
 968  * interface, @parent lock will be held as well.
 969  */
 970 static void __device_driver_lock(struct device *dev, struct device *parent)
 971 {
 972         if (parent && dev->bus->need_parent_lock)
 973                 device_lock(parent);
 974         device_lock(dev);
 975 }
 976
 977 /*
 978  * __device_driver_unlock - release locks needed to manipulate dev->drv
 979  * @dev: Device we will update driver info for
 980  * @parent: Parent device. Needed if the bus requires parent lock
 981  *
 982  * This function will release the required locks for manipulating dev->drv.
 983  * Normally this will just be the the @dev lock, but when called for a
 984  * USB interface, @parent lock will be released as well.
 985  */
 986 static void __device_driver_unlock(struct device *dev, struct device *parent)
 987 {
 988         device_unlock(dev);
 989         if (parent && dev->bus->need_parent_lock)
 990                 device_unlock(parent);
 991 }
 992
 993 /**
 994  * device_driver_attach - attach a specific driver to a specific device
 995  * @drv: Driver to attach
 996  * @dev: Device to attach it to
 997  *
 998  * Manually attach driver to a device. Will acquire both @dev lock and
 999  * @dev->parent lock if needed.
1000  */
1001 int device_driver_attach(struct device_driver *drv, struct device *dev)
1002 {
1003         int ret = 0;
1004
1005         __device_driver_lock(dev, dev->parent);
1006
1007         /*
1008          * If device has been removed or someone has already successfully
1009          * bound a driver before us just skip the driver probe call.
1010          */
1011         if (!dev->p->dead && !dev->driver)
1012                 ret = driver_probe_device(drv, dev);
1013
1014         __device_driver_unlock(dev, dev->parent);
1015
1016         return ret;
1017 }
1018
1019 static void __driver_attach_async_helper(void *_dev, async_cookie_t cookie)
1020 {
1021         struct device *dev = _dev;
1022         struct device_driver *drv;
1023         int ret = 0;
1024
1025         __device_driver_lock(dev, dev->parent);
1026
1027         drv = dev->p->async_driver;
1028
1029         /*
1030          * If device has been removed or someone has already successfully
1031          * bound a driver before us just skip the driver probe call.
1032          */
1033         if (!dev->p->dead && !dev->driver)
1034                 ret = driver_probe_device(drv, dev);
1035
1036         __device_driver_unlock(dev, dev->parent);
1037
1038         dev_dbg(dev, "driver %s async attach completed: %d\n", drv->name, ret);
1039
1040         put_device(dev);
1041 }
1042
1043 static int __driver_attach(struct device *dev, void *data)
1044 {
1045         struct device_driver *drv = data;
1046         int ret;
1047
1048         /*
1049          * Lock device and try to bind to it. We drop the error
1050          * here and always return 0, because we need to keep trying
1051          * to bind to devices and some drivers will return an error
1052          * simply if it didn't support the device.
1053          *
1054          * driver_probe_device() will spit a warning if there
1055          * is an error.
1056          */
1057
1058         ret = driver_match_device(drv, dev);
1059         if (ret == 0) {
1060                 /* no match */
1061                 return 0;
1062         } else if (ret == -EPROBE_DEFER) {
1063                 dev_dbg(dev, "Device match requests probe deferral\n");
1064                 driver_deferred_probe_add(dev);
1065         } else if (ret < 0) {
1066                 dev_dbg(dev, "Bus failed to match device: %d\n", ret);
1067                 return ret;
1068         } /* ret > 0 means positive match */
1069
1070         if (driver_allows_async_probing(drv)) {
1071                 /*
1072                  * Instead of probing the device synchronously we will
1073                  * probe it asynchronously to allow for more parallelism.
1074                  *
1075                  * We only take the device lock here in order to guarantee
1076                  * that the dev->driver and async_driver fields are protected
1077                  */
1078                 dev_dbg(dev, "probing driver %s asynchronously\n", drv->name);
1079                 device_lock(dev);
1080                 if (!dev->driver) {
1081                         get_device(dev);
1082                         dev->p->async_driver = drv;
1083                         async_schedule_dev(__driver_attach_async_helper, dev);
1084                 }
1085                 device_unlock(dev);
1086                 return 0;
1087         }
1088
1089         device_driver_attach(drv, dev);
1090
1091         return 0;
1092 }
1093
1094 /**
1095  * driver_attach - try to bind driver to devices.
1096  * @drv: driver.
1097  *
1098  * Walk the list of devices that the bus has on it and try to
1099  * match the driver with each one.  If driver_probe_device()
1100  * returns 0 and the @dev->driver is set, we've found a
1101  * compatible pair.
1102  */
1103 int driver_attach(struct device_driver *drv)
1104 {
1105         return bus_for_each_dev(drv->bus, NULL, drv, __driver_attach);
1106 }
1107 EXPORT_SYMBOL_GPL(driver_attach);
1108
1109 /*
1110  * __device_release_driver() must be called with @dev lock held.
1111  * When called for a USB interface, @dev->parent lock must be held as well.
1112  */
1113 static void __device_release_driver(struct device *dev, struct device *parent)
1114 {
1115         struct device_driver *drv;
1116
1117         drv = dev->driver;
1118         if (drv) {
1119                 while (device_links_busy(dev)) {
1120                         __device_driver_unlock(dev, parent);
1121
1122                         device_links_unbind_consumers(dev);
1123
1124                         __device_driver_lock(dev, parent);
1125                         /*
1126                          * A concurrent invocation of the same function might
1127                          * have released the driver successfully while this one
1128                          * was waiting, so check for that.
1129                          */
1130                         if (dev->driver != drv)
1131                                 return;
1132                 }
1133
1134                 pm_runtime_get_sync(dev);
1135                 pm_runtime_clean_up_links(dev);
1136
1137                 driver_sysfs_remove(dev);
1138
1139                 if (dev->bus)
1140                         blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1141                                                      BUS_NOTIFY_UNBIND_DRIVER,
1142                                                      dev);
1143
1144                 pm_runtime_put_sync(dev);
1145
1146                 device_remove_file(dev, &dev_attr_state_synced);
1147                 device_remove_groups(dev, drv->dev_groups);
1148
1149                 if (dev->bus && dev->bus->remove)
1150                         dev->bus->remove(dev);
1151                 else if (drv->remove)
1152                         drv->remove(dev);
1153
1154                 device_links_driver_cleanup(dev);
1155
1156                 devres_release_all(dev);
1157                 arch_teardown_dma_ops(dev);
1158                 dev->driver = NULL;
1159                 dev_set_drvdata(dev, NULL);
1160                 if (dev->pm_domain && dev->pm_domain->dismiss)
1161                         dev->pm_domain->dismiss(dev);
1162                 pm_runtime_reinit(dev);
1163                 dev_pm_set_driver_flags(dev, 0);
1164
1165                 klist_remove(&dev->p->knode_driver);
1166                 device_pm_check_callbacks(dev);
1167                 if (dev->bus)
1168                         blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1169                                                      BUS_NOTIFY_UNBOUND_DRIVER,
1170                                                      dev);
1171
1172                 kobject_uevent(&dev->kobj, KOBJ_UNBIND);
1173         }
1174 }
1175
1176 void device_release_driver_internal(struct device *dev,
1177                                     struct device_driver *drv,
1178                                     struct device *parent)
1179 {
1180         __device_driver_lock(dev, parent);
1181
1182         if (!drv || drv == dev->driver)
1183                 __device_release_driver(dev, parent);
1184
1185         __device_driver_unlock(dev, parent);
1186 }
1187
1188 /**
1189  * device_release_driver - manually detach device from driver.
1190  * @dev: device.
1191  *
1192  * Manually detach device from driver.
1193  * When called for a USB interface, @dev->parent lock must be held.
1194  *
1195  * If this function is to be called with @dev->parent lock held, ensure that
1196  * the device's consumers are unbound in advance or that their locks can be
1197  * acquired under the @dev->parent lock.
1198  */
1199 void device_release_driver(struct device *dev)
1200 {
1201         /*
1202          * If anyone calls device_release_driver() recursively from
1203          * within their ->remove callback for the same device, they
1204          * will deadlock right here.
1205          */
1206         device_release_driver_internal(dev, NULL, NULL);
1207 }
1208 EXPORT_SYMBOL_GPL(device_release_driver);
1209
1210 /**
1211  * device_driver_detach - detach driver from a specific device
1212  * @dev: device to detach driver from
1213  *
1214  * Detach driver from device. Will acquire both @dev lock and @dev->parent
1215  * lock if needed.
1216  */
1217 void device_driver_detach(struct device *dev)
1218 {
1219         device_release_driver_internal(dev, NULL, dev->parent);
1220 }
1221
1222 /**
1223  * driver_detach - detach driver from all devices it controls.
1224  * @drv: driver.
1225  */
1226 void driver_detach(struct device_driver *drv)
1227 {
1228         struct device_private *dev_prv;
1229         struct device *dev;
1230
1231         if (driver_allows_async_probing(drv))
1232                 async_synchronize_full();
1233
1234         for (;;) {
1235                 spin_lock(&drv->p->klist_devices.k_lock);
1236                 if (list_empty(&drv->p->klist_devices.k_list)) {
1237                         spin_unlock(&drv->p->klist_devices.k_lock);
1238                         break;
1239                 }
1240                 dev_prv = list_last_entry(&drv->p->klist_devices.k_list,
1241                                      struct device_private,
1242                                      knode_driver.n_node);
1243                 dev = dev_prv->device;
1244                 get_device(dev);
1245                 spin_unlock(&drv->p->klist_devices.k_lock);
1246                 device_release_driver_internal(dev, drv, dev->parent);
1247                 put_device(dev);
1248         }
1249 }