2 * platform.c - platform 'pseudo' bus for legacy devices
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
7 * This file is released under the GPLv2
9 * Please see Documentation/driver-model/platform.txt for more
13 #include <linux/platform_device.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/dma-mapping.h>
17 #include <linux/bootmem.h>
18 #include <linux/err.h>
19 #include <linux/slab.h>
23 #define to_platform_driver(drv) (container_of((drv), struct platform_driver, \
26 struct device platform_bus = {
27 .init_name = "platform",
29 EXPORT_SYMBOL_GPL(platform_bus);
32 * platform_get_resource - get a resource for a device
33 * @dev: platform device
34 * @type: resource type
35 * @num: resource index
37 struct resource *platform_get_resource(struct platform_device *dev,
38 unsigned int type, unsigned int num)
42 for (i = 0; i < dev->num_resources; i++) {
43 struct resource *r = &dev->resource[i];
45 if (type == resource_type(r) && num-- == 0)
50 EXPORT_SYMBOL_GPL(platform_get_resource);
53 * platform_get_irq - get an IRQ for a device
54 * @dev: platform device
55 * @num: IRQ number index
57 int platform_get_irq(struct platform_device *dev, unsigned int num)
59 struct resource *r = platform_get_resource(dev, IORESOURCE_IRQ, num);
61 return r ? r->start : -ENXIO;
63 EXPORT_SYMBOL_GPL(platform_get_irq);
66 * platform_get_resource_byname - get a resource for a device by name
67 * @dev: platform device
68 * @type: resource type
69 * @name: resource name
71 struct resource *platform_get_resource_byname(struct platform_device *dev,
72 unsigned int type, char *name)
76 for (i = 0; i < dev->num_resources; i++) {
77 struct resource *r = &dev->resource[i];
79 if (type == resource_type(r) && !strcmp(r->name, name))
84 EXPORT_SYMBOL_GPL(platform_get_resource_byname);
87 * platform_get_irq - get an IRQ for a device
88 * @dev: platform device
91 int platform_get_irq_byname(struct platform_device *dev, char *name)
93 struct resource *r = platform_get_resource_byname(dev, IORESOURCE_IRQ,
96 return r ? r->start : -ENXIO;
98 EXPORT_SYMBOL_GPL(platform_get_irq_byname);
101 * platform_add_devices - add a numbers of platform devices
102 * @devs: array of platform devices to add
103 * @num: number of platform devices in array
105 int platform_add_devices(struct platform_device **devs, int num)
109 for (i = 0; i < num; i++) {
110 ret = platform_device_register(devs[i]);
113 platform_device_unregister(devs[i]);
120 EXPORT_SYMBOL_GPL(platform_add_devices);
122 struct platform_object {
123 struct platform_device pdev;
128 * platform_device_put
129 * @pdev: platform device to free
131 * Free all memory associated with a platform device. This function must
132 * _only_ be externally called in error cases. All other usage is a bug.
134 void platform_device_put(struct platform_device *pdev)
137 put_device(&pdev->dev);
139 EXPORT_SYMBOL_GPL(platform_device_put);
141 static void platform_device_release(struct device *dev)
143 struct platform_object *pa = container_of(dev, struct platform_object,
146 kfree(pa->pdev.dev.platform_data);
147 kfree(pa->pdev.resource);
152 * platform_device_alloc
153 * @name: base name of the device we're adding
156 * Create a platform device object which can have other objects attached
157 * to it, and which will have attached objects freed when it is released.
159 struct platform_device *platform_device_alloc(const char *name, int id)
161 struct platform_object *pa;
163 pa = kzalloc(sizeof(struct platform_object) + strlen(name), GFP_KERNEL);
165 strcpy(pa->name, name);
166 pa->pdev.name = pa->name;
168 device_initialize(&pa->pdev.dev);
169 pa->pdev.dev.release = platform_device_release;
172 return pa ? &pa->pdev : NULL;
174 EXPORT_SYMBOL_GPL(platform_device_alloc);
177 * platform_device_add_resources
178 * @pdev: platform device allocated by platform_device_alloc to add resources to
179 * @res: set of resources that needs to be allocated for the device
180 * @num: number of resources
182 * Add a copy of the resources to the platform device. The memory
183 * associated with the resources will be freed when the platform device is
186 int platform_device_add_resources(struct platform_device *pdev,
187 struct resource *res, unsigned int num)
191 r = kmalloc(sizeof(struct resource) * num, GFP_KERNEL);
193 memcpy(r, res, sizeof(struct resource) * num);
195 pdev->num_resources = num;
197 return r ? 0 : -ENOMEM;
199 EXPORT_SYMBOL_GPL(platform_device_add_resources);
202 * platform_device_add_data
203 * @pdev: platform device allocated by platform_device_alloc to add resources to
204 * @data: platform specific data for this platform device
205 * @size: size of platform specific data
207 * Add a copy of platform specific data to the platform device's
208 * platform_data pointer. The memory associated with the platform data
209 * will be freed when the platform device is released.
211 int platform_device_add_data(struct platform_device *pdev, const void *data,
216 d = kmalloc(size, GFP_KERNEL);
218 memcpy(d, data, size);
219 pdev->dev.platform_data = d;
220 pdev->platform_data = d;
222 return d ? 0 : -ENOMEM;
224 EXPORT_SYMBOL_GPL(platform_device_add_data);
227 * platform_device_add - add a platform device to device hierarchy
228 * @pdev: platform device we're adding
230 * This is part 2 of platform_device_register(), though may be called
231 * separately _iff_ pdev was allocated by platform_device_alloc().
233 int platform_device_add(struct platform_device *pdev)
240 if (!pdev->dev.parent)
241 pdev->dev.parent = &platform_bus;
243 pdev->dev.bus = &platform_bus_type;
246 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
248 dev_set_name(&pdev->dev, pdev->name);
250 /* We will remove platform_data field from struct device
251 * if all platform devices pass its platform specific data
252 * from platform_device. The conversion is going to be a
253 * long time, so we allow the two cases coexist to make
254 * this kind of fix more easily*/
255 if (pdev->platform_data && pdev->dev.platform_data) {
257 "%s: use which platform_data?\n",
258 dev_name(&pdev->dev));
259 } else if (pdev->platform_data) {
260 pdev->dev.platform_data = pdev->platform_data;
261 } else if (pdev->dev.platform_data) {
262 pdev->platform_data = pdev->dev.platform_data;
265 for (i = 0; i < pdev->num_resources; i++) {
266 struct resource *p, *r = &pdev->resource[i];
269 r->name = dev_name(&pdev->dev);
273 if (resource_type(r) == IORESOURCE_MEM)
275 else if (resource_type(r) == IORESOURCE_IO)
276 p = &ioport_resource;
279 if (p && insert_resource(p, r)) {
281 "%s: failed to claim resource %d\n",
282 dev_name(&pdev->dev), i);
288 pr_debug("Registering platform device '%s'. Parent at %s\n",
289 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
291 ret = device_add(&pdev->dev);
297 struct resource *r = &pdev->resource[i];
298 unsigned long type = resource_type(r);
300 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
306 EXPORT_SYMBOL_GPL(platform_device_add);
309 * platform_device_del - remove a platform-level device
310 * @pdev: platform device we're removing
312 * Note that this function will also release all memory- and port-based
313 * resources owned by the device (@dev->resource). This function must
314 * _only_ be externally called in error cases. All other usage is a bug.
316 void platform_device_del(struct platform_device *pdev)
321 device_del(&pdev->dev);
323 for (i = 0; i < pdev->num_resources; i++) {
324 struct resource *r = &pdev->resource[i];
325 unsigned long type = resource_type(r);
327 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
332 EXPORT_SYMBOL_GPL(platform_device_del);
335 * platform_device_register - add a platform-level device
336 * @pdev: platform device we're adding
338 int platform_device_register(struct platform_device *pdev)
340 device_initialize(&pdev->dev);
341 return platform_device_add(pdev);
343 EXPORT_SYMBOL_GPL(platform_device_register);
346 * platform_device_unregister - unregister a platform-level device
347 * @pdev: platform device we're unregistering
349 * Unregistration is done in 2 steps. First we release all resources
350 * and remove it from the subsystem, then we drop reference count by
351 * calling platform_device_put().
353 void platform_device_unregister(struct platform_device *pdev)
355 platform_device_del(pdev);
356 platform_device_put(pdev);
358 EXPORT_SYMBOL_GPL(platform_device_unregister);
361 * platform_device_register_simple
362 * @name: base name of the device we're adding
364 * @res: set of resources that needs to be allocated for the device
365 * @num: number of resources
367 * This function creates a simple platform device that requires minimal
368 * resource and memory management. Canned release function freeing memory
369 * allocated for the device allows drivers using such devices to be
370 * unloaded without waiting for the last reference to the device to be
373 * This interface is primarily intended for use with legacy drivers which
374 * probe hardware directly. Because such drivers create sysfs device nodes
375 * themselves, rather than letting system infrastructure handle such device
376 * enumeration tasks, they don't fully conform to the Linux driver model.
377 * In particular, when such drivers are built as modules, they can't be
380 struct platform_device *platform_device_register_simple(const char *name,
382 struct resource *res,
385 struct platform_device *pdev;
388 pdev = platform_device_alloc(name, id);
395 retval = platform_device_add_resources(pdev, res, num);
400 retval = platform_device_add(pdev);
407 platform_device_put(pdev);
408 return ERR_PTR(retval);
410 EXPORT_SYMBOL_GPL(platform_device_register_simple);
413 * platform_device_register_data
414 * @parent: parent device for the device we're adding
415 * @name: base name of the device we're adding
417 * @data: platform specific data for this platform device
418 * @size: size of platform specific data
420 * This function creates a simple platform device that requires minimal
421 * resource and memory management. Canned release function freeing memory
422 * allocated for the device allows drivers using such devices to be
423 * unloaded without waiting for the last reference to the device to be
426 struct platform_device *platform_device_register_data(
427 struct device *parent,
428 const char *name, int id,
429 const void *data, size_t size)
431 struct platform_device *pdev;
434 pdev = platform_device_alloc(name, id);
440 pdev->dev.parent = parent;
443 retval = platform_device_add_data(pdev, data, size);
448 retval = platform_device_add(pdev);
455 platform_device_put(pdev);
456 return ERR_PTR(retval);
459 static int platform_drv_probe(struct device *_dev)
461 struct platform_driver *drv = to_platform_driver(_dev->driver);
462 struct platform_device *dev = to_platform_device(_dev);
464 return drv->probe(dev);
467 static int platform_drv_probe_fail(struct device *_dev)
472 static int platform_drv_remove(struct device *_dev)
474 struct platform_driver *drv = to_platform_driver(_dev->driver);
475 struct platform_device *dev = to_platform_device(_dev);
477 return drv->remove(dev);
480 static void platform_drv_shutdown(struct device *_dev)
482 struct platform_driver *drv = to_platform_driver(_dev->driver);
483 struct platform_device *dev = to_platform_device(_dev);
488 static int platform_drv_suspend(struct device *_dev, pm_message_t state)
490 struct platform_driver *drv = to_platform_driver(_dev->driver);
491 struct platform_device *dev = to_platform_device(_dev);
493 return drv->suspend(dev, state);
496 static int platform_drv_resume(struct device *_dev)
498 struct platform_driver *drv = to_platform_driver(_dev->driver);
499 struct platform_device *dev = to_platform_device(_dev);
501 return drv->resume(dev);
505 * platform_driver_register
506 * @drv: platform driver structure
508 int platform_driver_register(struct platform_driver *drv)
510 drv->driver.bus = &platform_bus_type;
512 drv->driver.probe = platform_drv_probe;
514 drv->driver.remove = platform_drv_remove;
516 drv->driver.shutdown = platform_drv_shutdown;
518 drv->driver.suspend = platform_drv_suspend;
520 drv->driver.resume = platform_drv_resume;
521 return driver_register(&drv->driver);
523 EXPORT_SYMBOL_GPL(platform_driver_register);
526 * platform_driver_unregister
527 * @drv: platform driver structure
529 void platform_driver_unregister(struct platform_driver *drv)
531 driver_unregister(&drv->driver);
533 EXPORT_SYMBOL_GPL(platform_driver_unregister);
536 * platform_driver_probe - register driver for non-hotpluggable device
537 * @drv: platform driver structure
538 * @probe: the driver probe routine, probably from an __init section
540 * Use this instead of platform_driver_register() when you know the device
541 * is not hotpluggable and has already been registered, and you want to
542 * remove its run-once probe() infrastructure from memory after the driver
543 * has bound to the device.
545 * One typical use for this would be with drivers for controllers integrated
546 * into system-on-chip processors, where the controller devices have been
547 * configured as part of board setup.
549 * Returns zero if the driver registered and bound to a device, else returns
550 * a negative error code and with the driver not registered.
552 int __init_or_module platform_driver_probe(struct platform_driver *drv,
553 int (*probe)(struct platform_device *))
557 /* temporary section violation during probe() */
559 retval = code = platform_driver_register(drv);
561 /* Fixup that section violation, being paranoid about code scanning
562 * the list of drivers in order to probe new devices. Check to see
563 * if the probe was successful, and make sure any forced probes of
566 spin_lock(&platform_bus_type.p->klist_drivers.k_lock);
568 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
570 drv->driver.probe = platform_drv_probe_fail;
571 spin_unlock(&platform_bus_type.p->klist_drivers.k_lock);
574 platform_driver_unregister(drv);
577 EXPORT_SYMBOL_GPL(platform_driver_probe);
579 /* modalias support enables more hands-off userspace setup:
580 * (a) environment variable lets new-style hotplug events work once system is
581 * fully running: "modprobe $MODALIAS"
582 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
583 * mishandled before system is fully running: "modprobe $(cat modalias)"
585 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
588 struct platform_device *pdev = to_platform_device(dev);
589 int len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
591 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
594 static struct device_attribute platform_dev_attrs[] = {
599 static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
601 struct platform_device *pdev = to_platform_device(dev);
603 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
604 (pdev->id_entry) ? pdev->id_entry->name : pdev->name);
608 static const struct platform_device_id *platform_match_id(
609 struct platform_device_id *id,
610 struct platform_device *pdev)
612 while (id->name[0]) {
613 if (strcmp(pdev->name, id->name) == 0) {
623 * platform_match - bind platform device to platform driver.
627 * Platform device IDs are assumed to be encoded like this:
628 * "<name><instance>", where <name> is a short description of the type of
629 * device, like "pci" or "floppy", and <instance> is the enumerated
630 * instance of the device, like '0' or '42'. Driver IDs are simply
631 * "<name>". So, extract the <name> from the platform_device structure,
632 * and compare it against the name of the driver. Return whether they match
635 static int platform_match(struct device *dev, struct device_driver *drv)
637 struct platform_device *pdev = to_platform_device(dev);
638 struct platform_driver *pdrv = to_platform_driver(drv);
640 /* match against the id table first */
642 return platform_match_id(pdrv->id_table, pdev) != NULL;
644 /* fall-back to driver name match */
645 return (strcmp(pdev->name, drv->name) == 0);
648 #ifdef CONFIG_PM_SLEEP
650 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
654 if (dev->driver && dev->driver->suspend)
655 ret = dev->driver->suspend(dev, mesg);
660 static int platform_legacy_suspend_late(struct device *dev, pm_message_t mesg)
662 struct platform_driver *pdrv = to_platform_driver(dev->driver);
663 struct platform_device *pdev = to_platform_device(dev);
666 if (dev->driver && pdrv->suspend_late)
667 ret = pdrv->suspend_late(pdev, mesg);
672 static int platform_legacy_resume_early(struct device *dev)
674 struct platform_driver *pdrv = to_platform_driver(dev->driver);
675 struct platform_device *pdev = to_platform_device(dev);
678 if (dev->driver && pdrv->resume_early)
679 ret = pdrv->resume_early(pdev);
684 static int platform_legacy_resume(struct device *dev)
688 if (dev->driver && dev->driver->resume)
689 ret = dev->driver->resume(dev);
694 static int platform_pm_prepare(struct device *dev)
696 struct device_driver *drv = dev->driver;
699 if (drv && drv->pm && drv->pm->prepare)
700 ret = drv->pm->prepare(dev);
705 static void platform_pm_complete(struct device *dev)
707 struct device_driver *drv = dev->driver;
709 if (drv && drv->pm && drv->pm->complete)
710 drv->pm->complete(dev);
713 #ifdef CONFIG_SUSPEND
715 static int platform_pm_suspend(struct device *dev)
717 struct device_driver *drv = dev->driver;
724 if (drv->pm->suspend)
725 ret = drv->pm->suspend(dev);
727 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
733 static int platform_pm_suspend_noirq(struct device *dev)
735 struct device_driver *drv = dev->driver;
742 if (drv->pm->suspend_noirq)
743 ret = drv->pm->suspend_noirq(dev);
745 ret = platform_legacy_suspend_late(dev, PMSG_SUSPEND);
751 static int platform_pm_resume(struct device *dev)
753 struct device_driver *drv = dev->driver;
761 ret = drv->pm->resume(dev);
763 ret = platform_legacy_resume(dev);
769 static int platform_pm_resume_noirq(struct device *dev)
771 struct device_driver *drv = dev->driver;
778 if (drv->pm->resume_noirq)
779 ret = drv->pm->resume_noirq(dev);
781 ret = platform_legacy_resume_early(dev);
787 #else /* !CONFIG_SUSPEND */
789 #define platform_pm_suspend NULL
790 #define platform_pm_resume NULL
791 #define platform_pm_suspend_noirq NULL
792 #define platform_pm_resume_noirq NULL
794 #endif /* !CONFIG_SUSPEND */
796 #ifdef CONFIG_HIBERNATION
798 static int platform_pm_freeze(struct device *dev)
800 struct device_driver *drv = dev->driver;
808 ret = drv->pm->freeze(dev);
810 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
816 static int platform_pm_freeze_noirq(struct device *dev)
818 struct device_driver *drv = dev->driver;
825 if (drv->pm->freeze_noirq)
826 ret = drv->pm->freeze_noirq(dev);
828 ret = platform_legacy_suspend_late(dev, PMSG_FREEZE);
834 static int platform_pm_thaw(struct device *dev)
836 struct device_driver *drv = dev->driver;
844 ret = drv->pm->thaw(dev);
846 ret = platform_legacy_resume(dev);
852 static int platform_pm_thaw_noirq(struct device *dev)
854 struct device_driver *drv = dev->driver;
861 if (drv->pm->thaw_noirq)
862 ret = drv->pm->thaw_noirq(dev);
864 ret = platform_legacy_resume_early(dev);
870 static int platform_pm_poweroff(struct device *dev)
872 struct device_driver *drv = dev->driver;
879 if (drv->pm->poweroff)
880 ret = drv->pm->poweroff(dev);
882 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
888 static int platform_pm_poweroff_noirq(struct device *dev)
890 struct device_driver *drv = dev->driver;
897 if (drv->pm->poweroff_noirq)
898 ret = drv->pm->poweroff_noirq(dev);
900 ret = platform_legacy_suspend_late(dev, PMSG_HIBERNATE);
906 static int platform_pm_restore(struct device *dev)
908 struct device_driver *drv = dev->driver;
915 if (drv->pm->restore)
916 ret = drv->pm->restore(dev);
918 ret = platform_legacy_resume(dev);
924 static int platform_pm_restore_noirq(struct device *dev)
926 struct device_driver *drv = dev->driver;
933 if (drv->pm->restore_noirq)
934 ret = drv->pm->restore_noirq(dev);
936 ret = platform_legacy_resume_early(dev);
942 #else /* !CONFIG_HIBERNATION */
944 #define platform_pm_freeze NULL
945 #define platform_pm_thaw NULL
946 #define platform_pm_poweroff NULL
947 #define platform_pm_restore NULL
948 #define platform_pm_freeze_noirq NULL
949 #define platform_pm_thaw_noirq NULL
950 #define platform_pm_poweroff_noirq NULL
951 #define platform_pm_restore_noirq NULL
953 #endif /* !CONFIG_HIBERNATION */
955 static struct dev_pm_ops platform_dev_pm_ops = {
956 .prepare = platform_pm_prepare,
957 .complete = platform_pm_complete,
958 .suspend = platform_pm_suspend,
959 .resume = platform_pm_resume,
960 .freeze = platform_pm_freeze,
961 .thaw = platform_pm_thaw,
962 .poweroff = platform_pm_poweroff,
963 .restore = platform_pm_restore,
964 .suspend_noirq = platform_pm_suspend_noirq,
965 .resume_noirq = platform_pm_resume_noirq,
966 .freeze_noirq = platform_pm_freeze_noirq,
967 .thaw_noirq = platform_pm_thaw_noirq,
968 .poweroff_noirq = platform_pm_poweroff_noirq,
969 .restore_noirq = platform_pm_restore_noirq,
972 #define PLATFORM_PM_OPS_PTR (&platform_dev_pm_ops)
974 #else /* !CONFIG_PM_SLEEP */
976 #define PLATFORM_PM_OPS_PTR NULL
978 #endif /* !CONFIG_PM_SLEEP */
980 struct bus_type platform_bus_type = {
982 .dev_attrs = platform_dev_attrs,
983 .match = platform_match,
984 .uevent = platform_uevent,
985 .pm = PLATFORM_PM_OPS_PTR,
987 EXPORT_SYMBOL_GPL(platform_bus_type);
989 int __init platform_bus_init(void)
993 error = device_register(&platform_bus);
996 error = bus_register(&platform_bus_type);
998 device_unregister(&platform_bus);
1002 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
1003 u64 dma_get_required_mask(struct device *dev)
1005 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
1006 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
1009 if (!high_totalram) {
1010 /* convert to mask just covering totalram */
1011 low_totalram = (1 << (fls(low_totalram) - 1));
1012 low_totalram += low_totalram - 1;
1013 mask = low_totalram;
1015 high_totalram = (1 << (fls(high_totalram) - 1));
1016 high_totalram += high_totalram - 1;
1017 mask = (((u64)high_totalram) << 32) + 0xffffffff;
1021 EXPORT_SYMBOL_GPL(dma_get_required_mask);