drivers/pci/pci-driver.c

   1 /*
   2  * drivers/pci/pci-driver.c
   3  *
   4  */
   5
   6 #include <linux/pci.h>
   7 #include <linux/module.h>
   8 #include <linux/init.h>
   9 #include <linux/device.h>
  10 #include <linux/mempolicy.h>
  11 #include <linux/string.h>
  12 #include <linux/slab.h>
  13 #include <linux/sched.h>
  14 #include "pci.h"
  15
  16 /*
  17  *  Registration of PCI drivers and handling of hot-pluggable devices.
  18  */
  19
  20 /* multithreaded probe logic */
  21 static int pci_multithread_probe =
  22 #ifdef CONFIG_PCI_MULTITHREAD_PROBE
  23         1;
  24 #else
  25         0;
  26 #endif
  27 __module_param_call("", pci_multithread_probe, param_set_bool, param_get_bool, &pci_multithread_probe, 0644);
  28
  29
  30 /*
  31  * Dynamic device IDs are disabled for !CONFIG_HOTPLUG
  32  */
  33
  34 struct pci_dynid {
  35         struct list_head node;
  36         struct pci_device_id id;
  37 };
  38
  39 #ifdef CONFIG_HOTPLUG
  40
  41 /**
  42  * store_new_id - add a new PCI device ID to this driver and re-probe devices
  43  * @driver: target device driver
  44  * @buf: buffer for scanning device ID data
  45  * @count: input size
  46  *
  47  * Adds a new dynamic pci device ID to this driver,
  48  * and causes the driver to probe for all devices again.
  49  */
  50 static ssize_t
  51 store_new_id(struct device_driver *driver, const char *buf, size_t count)
  52 {
  53         struct pci_dynid *dynid;
  54         struct pci_driver *pdrv = to_pci_driver(driver);
  55         __u32 vendor=PCI_ANY_ID, device=PCI_ANY_ID, subvendor=PCI_ANY_ID,
  56                 subdevice=PCI_ANY_ID, class=0, class_mask=0;
  57         unsigned long driver_data=0;
  58         int fields=0;
  59         int retval = 0;
  60
  61         fields = sscanf(buf, "%x %x %x %x %x %x %lux",
  62                         &vendor, &device, &subvendor, &subdevice,
  63                         &class, &class_mask, &driver_data);
  64         if (fields < 0)
  65                 return -EINVAL;
  66
  67         dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
  68         if (!dynid)
  69                 return -ENOMEM;
  70
  71         INIT_LIST_HEAD(&dynid->node);
  72         dynid->id.vendor = vendor;
  73         dynid->id.device = device;
  74         dynid->id.subvendor = subvendor;
  75         dynid->id.subdevice = subdevice;
  76         dynid->id.class = class;
  77         dynid->id.class_mask = class_mask;
  78         dynid->id.driver_data = pdrv->dynids.use_driver_data ?
  79                 driver_data : 0UL;
  80
  81         spin_lock(&pdrv->dynids.lock);
  82         list_add_tail(&pdrv->dynids.list, &dynid->node);
  83         spin_unlock(&pdrv->dynids.lock);
  84
  85         if (get_driver(&pdrv->driver)) {
  86                 retval = driver_attach(&pdrv->driver);
  87                 put_driver(&pdrv->driver);
  88         }
  89
  90         if (retval)
  91                 return retval;
  92         return count;
  93 }
  94 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
  95
  96 static void
  97 pci_free_dynids(struct pci_driver *drv)
  98 {
  99         struct pci_dynid *dynid, *n;
 100
 101         spin_lock(&drv->dynids.lock);
 102         list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
 103                 list_del(&dynid->node);
 104                 kfree(dynid);
 105         }
 106         spin_unlock(&drv->dynids.lock);
 107 }
 108
 109 static int
 110 pci_create_newid_file(struct pci_driver *drv)
 111 {
 112         int error = 0;
 113         if (drv->probe != NULL)
 114                 error = sysfs_create_file(&drv->driver.kobj,
 115                                           &driver_attr_new_id.attr);
 116         return error;
 117 }
 118
 119 #else /* !CONFIG_HOTPLUG */
 120 static inline void pci_free_dynids(struct pci_driver *drv) {}
 121 static inline int pci_create_newid_file(struct pci_driver *drv)
 122 {
 123         return 0;
 124 }
 125 #endif
 126
 127 /**
 128  * pci_match_id - See if a pci device matches a given pci_id table
 129  * @ids: array of PCI device id structures to search in
 130  * @dev: the PCI device structure to match against.
 131  *
 132  * Used by a driver to check whether a PCI device present in the
 133  * system is in its list of supported devices.  Returns the matching
 134  * pci_device_id structure or %NULL if there is no match.
 135  *
 136  * Depreciated, don't use this as it will not catch any dynamic ids
 137  * that a driver might want to check for.
 138  */
 139 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
 140                                          struct pci_dev *dev)
 141 {
 142         if (ids) {
 143                 while (ids->vendor || ids->subvendor || ids->class_mask) {
 144                         if (pci_match_one_device(ids, dev))
 145                                 return ids;
 146                         ids++;
 147                 }
 148         }
 149         return NULL;
 150 }
 151
 152 /**
 153  * pci_match_device - Tell if a PCI device structure has a matching
 154  *                    PCI device id structure
 155  * @drv: the PCI driver to match against
 156  * @dev: the PCI device structure to match against
 157  *
 158  * Used by a driver to check whether a PCI device present in the
 159  * system is in its list of supported devices.  Returns the matching
 160  * pci_device_id structure or %NULL if there is no match.
 161  */
 162 const struct pci_device_id *pci_match_device(struct pci_driver *drv,
 163                                              struct pci_dev *dev)
 164 {
 165         struct pci_dynid *dynid;
 166
 167         /* Look at the dynamic ids first, before the static ones */
 168         spin_lock(&drv->dynids.lock);
 169         list_for_each_entry(dynid, &drv->dynids.list, node) {
 170                 if (pci_match_one_device(&dynid->id, dev)) {
 171                         spin_unlock(&drv->dynids.lock);
 172                         return &dynid->id;
 173                 }
 174         }
 175         spin_unlock(&drv->dynids.lock);
 176
 177         return pci_match_id(drv->id_table, dev);
 178 }
 179
 180 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
 181                           const struct pci_device_id *id)
 182 {
 183         int error;
 184 #ifdef CONFIG_NUMA
 185         /* Execute driver initialization on node where the
 186            device's bus is attached to.  This way the driver likely
 187            allocates its local memory on the right node without
 188            any need to change it. */
 189         struct mempolicy *oldpol;
 190         cpumask_t oldmask = current->cpus_allowed;
 191         int node = pcibus_to_node(dev->bus);
 192         if (node >= 0 && node_online(node))
 193             set_cpus_allowed(current, node_to_cpumask(node));
 194         /* And set default memory allocation policy */
 195         oldpol = current->mempolicy;
 196         current->mempolicy = &default_policy;
 197         mpol_get(current->mempolicy);
 198 #endif
 199         error = drv->probe(dev, id);
 200 #ifdef CONFIG_NUMA
 201         set_cpus_allowed(current, oldmask);
 202         mpol_free(current->mempolicy);
 203         current->mempolicy = oldpol;
 204 #endif
 205         return error;
 206 }
 207
 208 /**
 209  * __pci_device_probe()
 210  * @drv: driver to call to check if it wants the PCI device
 211  * @pci_dev: PCI device being probed
 212  *
 213  * returns 0 on success, else error.
 214  * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
 215  */
 216 static int
 217 __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
 218 {
 219         const struct pci_device_id *id;
 220         int error = 0;
 221
 222         if (!pci_dev->driver && drv->probe) {
 223                 error = -ENODEV;
 224
 225                 id = pci_match_device(drv, pci_dev);
 226                 if (id)
 227                         error = pci_call_probe(drv, pci_dev, id);
 228                 if (error >= 0) {
 229                         pci_dev->driver = drv;
 230                         error = 0;
 231                 }
 232         }
 233         return error;
 234 }
 235
 236 static int pci_device_probe(struct device * dev)
 237 {
 238         int error = 0;
 239         struct pci_driver *drv;
 240         struct pci_dev *pci_dev;
 241
 242         drv = to_pci_driver(dev->driver);
 243         pci_dev = to_pci_dev(dev);
 244         pci_dev_get(pci_dev);
 245         error = __pci_device_probe(drv, pci_dev);
 246         if (error)
 247                 pci_dev_put(pci_dev);
 248
 249         return error;
 250 }
 251
 252 static int pci_device_remove(struct device * dev)
 253 {
 254         struct pci_dev * pci_dev = to_pci_dev(dev);
 255         struct pci_driver * drv = pci_dev->driver;
 256
 257         if (drv) {
 258                 if (drv->remove)
 259                         drv->remove(pci_dev);
 260                 pci_dev->driver = NULL;
 261         }
 262
 263         /*
 264          * If the device is still on, set the power state as "unknown",
 265          * since it might change by the next time we load the driver.
 266          */
 267         if (pci_dev->current_state == PCI_D0)
 268                 pci_dev->current_state = PCI_UNKNOWN;
 269
 270         /*
 271          * We would love to complain here if pci_dev->is_enabled is set, that
 272          * the driver should have called pci_disable_device(), but the
 273          * unfortunate fact is there are too many odd BIOS and bridge setups
 274          * that don't like drivers doing that all of the time.
 275          * Oh well, we can dream of sane hardware when we sleep, no matter how
 276          * horrible the crap we have to deal with is when we are awake...
 277          */
 278
 279         pci_dev_put(pci_dev);
 280         return 0;
 281 }
 282
 283 static int pci_device_suspend(struct device * dev, pm_message_t state)
 284 {
 285         struct pci_dev * pci_dev = to_pci_dev(dev);
 286         struct pci_driver * drv = pci_dev->driver;
 287         int i = 0;
 288
 289         if (drv && drv->suspend) {
 290                 i = drv->suspend(pci_dev, state);
 291                 suspend_report_result(drv->suspend, i);
 292         } else {
 293                 pci_save_state(pci_dev);
 294                 /*
 295                  * mark its power state as "unknown", since we don't know if
 296                  * e.g. the BIOS will change its device state when we suspend.
 297                  */
 298                 if (pci_dev->current_state == PCI_D0)
 299                         pci_dev->current_state = PCI_UNKNOWN;
 300         }
 301         return i;
 302 }
 303
 304 static int pci_device_suspend_late(struct device * dev, pm_message_t state)
 305 {
 306         struct pci_dev * pci_dev = to_pci_dev(dev);
 307         struct pci_driver * drv = pci_dev->driver;
 308         int i = 0;
 309
 310         if (drv && drv->suspend_late) {
 311                 i = drv->suspend_late(pci_dev, state);
 312                 suspend_report_result(drv->suspend_late, i);
 313         }
 314         return i;
 315 }
 316
 317 /*
 318  * Default resume method for devices that have no driver provided resume,
 319  * or not even a driver at all.
 320  */
 321 static int pci_default_resume(struct pci_dev *pci_dev)
 322 {
 323         int retval = 0;
 324
 325         /* restore the PCI config space */
 326         pci_restore_state(pci_dev);
 327         /* if the device was enabled before suspend, reenable */
 328         if (atomic_read(&pci_dev->enable_cnt))
 329                 retval = __pci_enable_device(pci_dev);
 330         /* if the device was busmaster before the suspend, make it busmaster again */
 331         if (pci_dev->is_busmaster)
 332                 pci_set_master(pci_dev);
 333
 334         return retval;
 335 }
 336
 337 static int pci_device_resume(struct device * dev)
 338 {
 339         int error;
 340         struct pci_dev * pci_dev = to_pci_dev(dev);
 341         struct pci_driver * drv = pci_dev->driver;
 342
 343         if (drv && drv->resume)
 344                 error = drv->resume(pci_dev);
 345         else
 346                 error = pci_default_resume(pci_dev);
 347         return error;
 348 }
 349
 350 static int pci_device_resume_early(struct device * dev)
 351 {
 352         int error = 0;
 353         struct pci_dev * pci_dev = to_pci_dev(dev);
 354         struct pci_driver * drv = pci_dev->driver;
 355
 356         if (drv && drv->resume_early)
 357                 error = drv->resume_early(pci_dev);
 358         return error;
 359 }
 360
 361 static void pci_device_shutdown(struct device *dev)
 362 {
 363         struct pci_dev *pci_dev = to_pci_dev(dev);
 364         struct pci_driver *drv = pci_dev->driver;
 365
 366         if (drv && drv->shutdown)
 367                 drv->shutdown(pci_dev);
 368 }
 369
 370 #define kobj_to_pci_driver(obj) container_of(obj, struct device_driver, kobj)
 371 #define attr_to_driver_attribute(obj) container_of(obj, struct driver_attribute, attr)
 372
 373 static ssize_t
 374 pci_driver_attr_show(struct kobject * kobj, struct attribute *attr, char *buf)
 375 {
 376         struct device_driver *driver = kobj_to_pci_driver(kobj);
 377         struct driver_attribute *dattr = attr_to_driver_attribute(attr);
 378         ssize_t ret;
 379
 380         if (!get_driver(driver))
 381                 return -ENODEV;
 382
 383         ret = dattr->show ? dattr->show(driver, buf) : -EIO;
 384
 385         put_driver(driver);
 386         return ret;
 387 }
 388
 389 static ssize_t
 390 pci_driver_attr_store(struct kobject * kobj, struct attribute *attr,
 391                       const char *buf, size_t count)
 392 {
 393         struct device_driver *driver = kobj_to_pci_driver(kobj);
 394         struct driver_attribute *dattr = attr_to_driver_attribute(attr);
 395         ssize_t ret;
 396
 397         if (!get_driver(driver))
 398                 return -ENODEV;
 399
 400         ret = dattr->store ? dattr->store(driver, buf, count) : -EIO;
 401
 402         put_driver(driver);
 403         return ret;
 404 }
 405
 406 static struct sysfs_ops pci_driver_sysfs_ops = {
 407         .show = pci_driver_attr_show,
 408         .store = pci_driver_attr_store,
 409 };
 410 static struct kobj_type pci_driver_kobj_type = {
 411         .sysfs_ops = &pci_driver_sysfs_ops,
 412 };
 413
 414 /**
 415  * __pci_register_driver - register a new pci driver
 416  * @drv: the driver structure to register
 417  * @owner: owner module of drv
 418  *
 419  * Adds the driver structure to the list of registered drivers.
 420  * Returns a negative value on error, otherwise 0.
 421  * If no error occurred, the driver remains registered even if
 422  * no device was claimed during registration.
 423  */
 424 int __pci_register_driver(struct pci_driver *drv, struct module *owner)
 425 {
 426         int error;
 427
 428         /* initialize common driver fields */
 429         drv->driver.name = drv->name;
 430         drv->driver.bus = &pci_bus_type;
 431         drv->driver.owner = owner;
 432         drv->driver.kobj.ktype = &pci_driver_kobj_type;
 433
 434         if (pci_multithread_probe)
 435                 drv->driver.multithread_probe = pci_multithread_probe;
 436         else
 437                 drv->driver.multithread_probe = drv->multithread_probe;
 438
 439         spin_lock_init(&drv->dynids.lock);
 440         INIT_LIST_HEAD(&drv->dynids.list);
 441
 442         /* register with core */
 443         error = driver_register(&drv->driver);
 444         if (error)
 445                 return error;
 446
 447         error = pci_create_newid_file(drv);
 448         if (error)
 449                 driver_unregister(&drv->driver);
 450
 451         return error;
 452 }
 453
 454 /**
 455  * pci_unregister_driver - unregister a pci driver
 456  * @drv: the driver structure to unregister
 457  *
 458  * Deletes the driver structure from the list of registered PCI drivers,
 459  * gives it a chance to clean up by calling its remove() function for
 460  * each device it was responsible for, and marks those devices as
 461  * driverless.
 462  */
 463
 464 void
 465 pci_unregister_driver(struct pci_driver *drv)
 466 {
 467         driver_unregister(&drv->driver);
 468         pci_free_dynids(drv);
 469 }
 470
 471 static struct pci_driver pci_compat_driver = {
 472         .name = "compat"
 473 };
 474
 475 /**
 476  * pci_dev_driver - get the pci_driver of a device
 477  * @dev: the device to query
 478  *
 479  * Returns the appropriate pci_driver structure or %NULL if there is no
 480  * registered driver for the device.
 481  */
 482 struct pci_driver *
 483 pci_dev_driver(const struct pci_dev *dev)
 484 {
 485         if (dev->driver)
 486                 return dev->driver;
 487         else {
 488                 int i;
 489                 for(i=0; i<=PCI_ROM_RESOURCE; i++)
 490                         if (dev->resource[i].flags & IORESOURCE_BUSY)
 491                                 return &pci_compat_driver;
 492         }
 493         return NULL;
 494 }
 495
 496 /**
 497  * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
 498  * @dev: the PCI device structure to match against
 499  * @drv: the device driver to search for matching PCI device id structures
 500  *
 501  * Used by a driver to check whether a PCI device present in the
 502  * system is in its list of supported devices. Returns the matching
 503  * pci_device_id structure or %NULL if there is no match.
 504  */
 505 static int pci_bus_match(struct device *dev, struct device_driver *drv)
 506 {
 507         struct pci_dev *pci_dev = to_pci_dev(dev);
 508         struct pci_driver *pci_drv = to_pci_driver(drv);
 509         const struct pci_device_id *found_id;
 510
 511         found_id = pci_match_device(pci_drv, pci_dev);
 512         if (found_id)
 513                 return 1;
 514
 515         return 0;
 516 }
 517
 518 /**
 519  * pci_dev_get - increments the reference count of the pci device structure
 520  * @dev: the device being referenced
 521  *
 522  * Each live reference to a device should be refcounted.
 523  *
 524  * Drivers for PCI devices should normally record such references in
 525  * their probe() methods, when they bind to a device, and release
 526  * them by calling pci_dev_put(), in their disconnect() methods.
 527  *
 528  * A pointer to the device with the incremented reference counter is returned.
 529  */
 530 struct pci_dev *pci_dev_get(struct pci_dev *dev)
 531 {
 532         if (dev)
 533                 get_device(&dev->dev);
 534         return dev;
 535 }
 536
 537 /**
 538  * pci_dev_put - release a use of the pci device structure
 539  * @dev: device that's been disconnected
 540  *
 541  * Must be called when a user of a device is finished with it.  When the last
 542  * user of the device calls this function, the memory of the device is freed.
 543  */
 544 void pci_dev_put(struct pci_dev *dev)
 545 {
 546         if (dev)
 547                 put_device(&dev->dev);
 548 }
 549
 550 #ifndef CONFIG_HOTPLUG
 551 int pci_uevent(struct device *dev, char **envp, int num_envp,
 552                char *buffer, int buffer_size)
 553 {
 554         return -ENODEV;
 555 }
 556 #endif
 557
 558 struct bus_type pci_bus_type = {
 559         .name           = "pci",
 560         .match          = pci_bus_match,
 561         .uevent         = pci_uevent,
 562         .probe          = pci_device_probe,
 563         .remove         = pci_device_remove,
 564         .suspend        = pci_device_suspend,
 565         .suspend_late   = pci_device_suspend_late,
 566         .resume_early   = pci_device_resume_early,
 567         .resume         = pci_device_resume,
 568         .shutdown       = pci_device_shutdown,
 569         .dev_attrs      = pci_dev_attrs,
 570 };
 571
 572 static int __init pci_driver_init(void)
 573 {
 574         return bus_register(&pci_bus_type);
 575 }
 576
 577 postcore_initcall(pci_driver_init);
 578
 579 EXPORT_SYMBOL(pci_match_id);
 580 EXPORT_SYMBOL(pci_match_device);
 581 EXPORT_SYMBOL(__pci_register_driver);
 582 EXPORT_SYMBOL(pci_unregister_driver);
 583 EXPORT_SYMBOL(pci_dev_driver);
 584 EXPORT_SYMBOL(pci_bus_type);
 585 EXPORT_SYMBOL(pci_dev_get);
 586 EXPORT_SYMBOL(pci_dev_put);