drivers/pci/pci-driver.c

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