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 = {
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;
221 return d ? 0 : -ENOMEM;
223 EXPORT_SYMBOL_GPL(platform_device_add_data);
226 * platform_device_add - add a platform device to device hierarchy
227 * @pdev: platform device we're adding
229 * This is part 2 of platform_device_register(), though may be called
230 * separately _iff_ pdev was allocated by platform_device_alloc().
232 int platform_device_add(struct platform_device *pdev)
239 if (!pdev->dev.parent)
240 pdev->dev.parent = &platform_bus;
242 pdev->dev.bus = &platform_bus_type;
245 snprintf(pdev->dev.bus_id, BUS_ID_SIZE, "%s.%d", pdev->name,
248 strlcpy(pdev->dev.bus_id, pdev->name, BUS_ID_SIZE);
250 for (i = 0; i < pdev->num_resources; i++) {
251 struct resource *p, *r = &pdev->resource[i];
254 r->name = pdev->dev.bus_id;
258 if (resource_type(r) == IORESOURCE_MEM)
260 else if (resource_type(r) == IORESOURCE_IO)
261 p = &ioport_resource;
264 if (p && insert_resource(p, r)) {
266 "%s: failed to claim resource %d\n",
267 pdev->dev.bus_id, i);
273 pr_debug("Registering platform device '%s'. Parent at %s\n",
274 pdev->dev.bus_id, pdev->dev.parent->bus_id);
276 ret = device_add(&pdev->dev);
282 struct resource *r = &pdev->resource[i];
283 unsigned long type = resource_type(r);
285 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
291 EXPORT_SYMBOL_GPL(platform_device_add);
294 * platform_device_del - remove a platform-level device
295 * @pdev: platform device we're removing
297 * Note that this function will also release all memory- and port-based
298 * resources owned by the device (@dev->resource). This function must
299 * _only_ be externally called in error cases. All other usage is a bug.
301 void platform_device_del(struct platform_device *pdev)
306 device_del(&pdev->dev);
308 for (i = 0; i < pdev->num_resources; i++) {
309 struct resource *r = &pdev->resource[i];
310 unsigned long type = resource_type(r);
312 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
317 EXPORT_SYMBOL_GPL(platform_device_del);
320 * platform_device_register - add a platform-level device
321 * @pdev: platform device we're adding
323 int platform_device_register(struct platform_device *pdev)
325 device_initialize(&pdev->dev);
326 return platform_device_add(pdev);
328 EXPORT_SYMBOL_GPL(platform_device_register);
331 * platform_device_unregister - unregister a platform-level device
332 * @pdev: platform device we're unregistering
334 * Unregistration is done in 2 steps. First we release all resources
335 * and remove it from the subsystem, then we drop reference count by
336 * calling platform_device_put().
338 void platform_device_unregister(struct platform_device *pdev)
340 platform_device_del(pdev);
341 platform_device_put(pdev);
343 EXPORT_SYMBOL_GPL(platform_device_unregister);
346 * platform_device_register_simple
347 * @name: base name of the device we're adding
349 * @res: set of resources that needs to be allocated for the device
350 * @num: number of resources
352 * This function creates a simple platform device that requires minimal
353 * resource and memory management. Canned release function freeing memory
354 * allocated for the device allows drivers using such devices to be
355 * unloaded without waiting for the last reference to the device to be
358 * This interface is primarily intended for use with legacy drivers which
359 * probe hardware directly. Because such drivers create sysfs device nodes
360 * themselves, rather than letting system infrastructure handle such device
361 * enumeration tasks, they don't fully conform to the Linux driver model.
362 * In particular, when such drivers are built as modules, they can't be
365 struct platform_device *platform_device_register_simple(const char *name,
367 struct resource *res,
370 struct platform_device *pdev;
373 pdev = platform_device_alloc(name, id);
380 retval = platform_device_add_resources(pdev, res, num);
385 retval = platform_device_add(pdev);
392 platform_device_put(pdev);
393 return ERR_PTR(retval);
395 EXPORT_SYMBOL_GPL(platform_device_register_simple);
397 static int platform_drv_probe(struct device *_dev)
399 struct platform_driver *drv = to_platform_driver(_dev->driver);
400 struct platform_device *dev = to_platform_device(_dev);
402 return drv->probe(dev);
405 static int platform_drv_probe_fail(struct device *_dev)
410 static int platform_drv_remove(struct device *_dev)
412 struct platform_driver *drv = to_platform_driver(_dev->driver);
413 struct platform_device *dev = to_platform_device(_dev);
415 return drv->remove(dev);
418 static void platform_drv_shutdown(struct device *_dev)
420 struct platform_driver *drv = to_platform_driver(_dev->driver);
421 struct platform_device *dev = to_platform_device(_dev);
426 static int platform_drv_suspend(struct device *_dev, pm_message_t state)
428 struct platform_driver *drv = to_platform_driver(_dev->driver);
429 struct platform_device *dev = to_platform_device(_dev);
431 return drv->suspend(dev, state);
434 static int platform_drv_resume(struct device *_dev)
436 struct platform_driver *drv = to_platform_driver(_dev->driver);
437 struct platform_device *dev = to_platform_device(_dev);
439 return drv->resume(dev);
443 * platform_driver_register
444 * @drv: platform driver structure
446 int platform_driver_register(struct platform_driver *drv)
448 drv->driver.bus = &platform_bus_type;
450 drv->driver.probe = platform_drv_probe;
452 drv->driver.remove = platform_drv_remove;
454 drv->driver.shutdown = platform_drv_shutdown;
456 drv->driver.suspend = platform_drv_suspend;
458 drv->driver.resume = platform_drv_resume;
460 drv->driver.pm = &drv->pm->base;
461 return driver_register(&drv->driver);
463 EXPORT_SYMBOL_GPL(platform_driver_register);
466 * platform_driver_unregister
467 * @drv: platform driver structure
469 void platform_driver_unregister(struct platform_driver *drv)
471 driver_unregister(&drv->driver);
473 EXPORT_SYMBOL_GPL(platform_driver_unregister);
476 * platform_driver_probe - register driver for non-hotpluggable device
477 * @drv: platform driver structure
478 * @probe: the driver probe routine, probably from an __init section
480 * Use this instead of platform_driver_register() when you know the device
481 * is not hotpluggable and has already been registered, and you want to
482 * remove its run-once probe() infrastructure from memory after the driver
483 * has bound to the device.
485 * One typical use for this would be with drivers for controllers integrated
486 * into system-on-chip processors, where the controller devices have been
487 * configured as part of board setup.
489 * Returns zero if the driver registered and bound to a device, else returns
490 * a negative error code and with the driver not registered.
492 int __init_or_module platform_driver_probe(struct platform_driver *drv,
493 int (*probe)(struct platform_device *))
497 /* temporary section violation during probe() */
499 retval = code = platform_driver_register(drv);
501 /* Fixup that section violation, being paranoid about code scanning
502 * the list of drivers in order to probe new devices. Check to see
503 * if the probe was successful, and make sure any forced probes of
506 spin_lock(&platform_bus_type.p->klist_drivers.k_lock);
508 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
510 drv->driver.probe = platform_drv_probe_fail;
511 spin_unlock(&platform_bus_type.p->klist_drivers.k_lock);
514 platform_driver_unregister(drv);
517 EXPORT_SYMBOL_GPL(platform_driver_probe);
519 /* modalias support enables more hands-off userspace setup:
520 * (a) environment variable lets new-style hotplug events work once system is
521 * fully running: "modprobe $MODALIAS"
522 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
523 * mishandled before system is fully running: "modprobe $(cat modalias)"
525 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
528 struct platform_device *pdev = to_platform_device(dev);
529 int len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
531 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
534 static struct device_attribute platform_dev_attrs[] = {
539 static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
541 struct platform_device *pdev = to_platform_device(dev);
543 add_uevent_var(env, "MODALIAS=platform:%s", pdev->name);
548 * platform_match - bind platform device to platform driver.
552 * Platform device IDs are assumed to be encoded like this:
553 * "<name><instance>", where <name> is a short description of the type of
554 * device, like "pci" or "floppy", and <instance> is the enumerated
555 * instance of the device, like '0' or '42'. Driver IDs are simply
556 * "<name>". So, extract the <name> from the platform_device structure,
557 * and compare it against the name of the driver. Return whether they match
560 static int platform_match(struct device *dev, struct device_driver *drv)
562 struct platform_device *pdev;
564 pdev = container_of(dev, struct platform_device, dev);
565 return (strncmp(pdev->name, drv->name, BUS_ID_SIZE) == 0);
568 #ifdef CONFIG_PM_SLEEP
570 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
574 if (dev->driver && dev->driver->suspend)
575 ret = dev->driver->suspend(dev, mesg);
580 static int platform_legacy_suspend_late(struct device *dev, pm_message_t mesg)
582 struct platform_driver *drv = to_platform_driver(dev->driver);
583 struct platform_device *pdev;
586 pdev = container_of(dev, struct platform_device, dev);
587 if (dev->driver && drv->suspend_late)
588 ret = drv->suspend_late(pdev, mesg);
593 static int platform_legacy_resume_early(struct device *dev)
595 struct platform_driver *drv = to_platform_driver(dev->driver);
596 struct platform_device *pdev;
599 pdev = container_of(dev, struct platform_device, dev);
600 if (dev->driver && drv->resume_early)
601 ret = drv->resume_early(pdev);
606 static int platform_legacy_resume(struct device *dev)
610 if (dev->driver && dev->driver->resume)
611 ret = dev->driver->resume(dev);
616 static int platform_pm_prepare(struct device *dev)
618 struct device_driver *drv = dev->driver;
621 if (drv && drv->pm && drv->pm->prepare)
622 ret = drv->pm->prepare(dev);
627 static void platform_pm_complete(struct device *dev)
629 struct device_driver *drv = dev->driver;
631 if (drv && drv->pm && drv->pm->complete)
632 drv->pm->complete(dev);
635 #ifdef CONFIG_SUSPEND
637 static int platform_pm_suspend(struct device *dev)
639 struct device_driver *drv = dev->driver;
642 if (drv && drv->pm) {
643 if (drv->pm->suspend)
644 ret = drv->pm->suspend(dev);
646 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
652 static int platform_pm_suspend_noirq(struct device *dev)
654 struct platform_driver *pdrv;
660 pdrv = to_platform_driver(dev->driver);
662 if (pdrv->pm->suspend_noirq)
663 ret = pdrv->pm->suspend_noirq(dev);
665 ret = platform_legacy_suspend_late(dev, PMSG_SUSPEND);
671 static int platform_pm_resume(struct device *dev)
673 struct device_driver *drv = dev->driver;
676 if (drv && drv->pm) {
678 ret = drv->pm->resume(dev);
680 ret = platform_legacy_resume(dev);
686 static int platform_pm_resume_noirq(struct device *dev)
688 struct platform_driver *pdrv;
694 pdrv = to_platform_driver(dev->driver);
696 if (pdrv->pm->resume_noirq)
697 ret = pdrv->pm->resume_noirq(dev);
699 ret = platform_legacy_resume_early(dev);
705 #else /* !CONFIG_SUSPEND */
707 #define platform_pm_suspend NULL
708 #define platform_pm_resume NULL
709 #define platform_pm_suspend_noirq NULL
710 #define platform_pm_resume_noirq NULL
712 #endif /* !CONFIG_SUSPEND */
714 #ifdef CONFIG_HIBERNATION
716 static int platform_pm_freeze(struct device *dev)
718 struct device_driver *drv = dev->driver;
726 ret = drv->pm->freeze(dev);
728 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
734 static int platform_pm_freeze_noirq(struct device *dev)
736 struct platform_driver *pdrv;
742 pdrv = to_platform_driver(dev->driver);
744 if (pdrv->pm->freeze_noirq)
745 ret = pdrv->pm->freeze_noirq(dev);
747 ret = platform_legacy_suspend_late(dev, PMSG_FREEZE);
753 static int platform_pm_thaw(struct device *dev)
755 struct device_driver *drv = dev->driver;
758 if (drv && drv->pm) {
760 ret = drv->pm->thaw(dev);
762 ret = platform_legacy_resume(dev);
768 static int platform_pm_thaw_noirq(struct device *dev)
770 struct platform_driver *pdrv;
776 pdrv = to_platform_driver(dev->driver);
778 if (pdrv->pm->thaw_noirq)
779 ret = pdrv->pm->thaw_noirq(dev);
781 ret = platform_legacy_resume_early(dev);
787 static int platform_pm_poweroff(struct device *dev)
789 struct device_driver *drv = dev->driver;
792 if (drv && drv->pm) {
793 if (drv->pm->poweroff)
794 ret = drv->pm->poweroff(dev);
796 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
802 static int platform_pm_poweroff_noirq(struct device *dev)
804 struct platform_driver *pdrv;
810 pdrv = to_platform_driver(dev->driver);
812 if (pdrv->pm->poweroff_noirq)
813 ret = pdrv->pm->poweroff_noirq(dev);
815 ret = platform_legacy_suspend_late(dev, PMSG_HIBERNATE);
821 static int platform_pm_restore(struct device *dev)
823 struct device_driver *drv = dev->driver;
826 if (drv && drv->pm) {
827 if (drv->pm->restore)
828 ret = drv->pm->restore(dev);
830 ret = platform_legacy_resume(dev);
836 static int platform_pm_restore_noirq(struct device *dev)
838 struct platform_driver *pdrv;
844 pdrv = to_platform_driver(dev->driver);
846 if (pdrv->pm->restore_noirq)
847 ret = pdrv->pm->restore_noirq(dev);
849 ret = platform_legacy_resume_early(dev);
855 #else /* !CONFIG_HIBERNATION */
857 #define platform_pm_freeze NULL
858 #define platform_pm_thaw NULL
859 #define platform_pm_poweroff NULL
860 #define platform_pm_restore NULL
861 #define platform_pm_freeze_noirq NULL
862 #define platform_pm_thaw_noirq NULL
863 #define platform_pm_poweroff_noirq NULL
864 #define platform_pm_restore_noirq NULL
866 #endif /* !CONFIG_HIBERNATION */
868 struct pm_ext_ops platform_pm_ops = {
870 .prepare = platform_pm_prepare,
871 .complete = platform_pm_complete,
872 .suspend = platform_pm_suspend,
873 .resume = platform_pm_resume,
874 .freeze = platform_pm_freeze,
875 .thaw = platform_pm_thaw,
876 .poweroff = platform_pm_poweroff,
877 .restore = platform_pm_restore,
879 .suspend_noirq = platform_pm_suspend_noirq,
880 .resume_noirq = platform_pm_resume_noirq,
881 .freeze_noirq = platform_pm_freeze_noirq,
882 .thaw_noirq = platform_pm_thaw_noirq,
883 .poweroff_noirq = platform_pm_poweroff_noirq,
884 .restore_noirq = platform_pm_restore_noirq,
887 #define PLATFORM_PM_OPS_PTR &platform_pm_ops
889 #else /* !CONFIG_PM_SLEEP */
891 #define PLATFORM_PM_OPS_PTR NULL
893 #endif /* !CONFIG_PM_SLEEP */
895 struct bus_type platform_bus_type = {
897 .dev_attrs = platform_dev_attrs,
898 .match = platform_match,
899 .uevent = platform_uevent,
900 .pm = PLATFORM_PM_OPS_PTR,
902 EXPORT_SYMBOL_GPL(platform_bus_type);
904 int __init platform_bus_init(void)
908 error = device_register(&platform_bus);
911 error = bus_register(&platform_bus_type);
913 device_unregister(&platform_bus);
917 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
918 u64 dma_get_required_mask(struct device *dev)
920 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
921 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
924 if (!high_totalram) {
925 /* convert to mask just covering totalram */
926 low_totalram = (1 << (fls(low_totalram) - 1));
927 low_totalram += low_totalram - 1;
930 high_totalram = (1 << (fls(high_totalram) - 1));
931 high_totalram += high_totalram - 1;
932 mask = (((u64)high_totalram) << 32) + 0xffffffff;
936 EXPORT_SYMBOL_GPL(dma_get_required_mask);