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