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 pdev->platform_data = pdev->dev.platform_data;
252 for (i = 0; i < pdev->num_resources; i++) {
253 struct resource *p, *r = &pdev->resource[i];
256 r->name = dev_name(&pdev->dev);
260 if (resource_type(r) == IORESOURCE_MEM)
262 else if (resource_type(r) == IORESOURCE_IO)
263 p = &ioport_resource;
266 if (p && insert_resource(p, r)) {
268 "%s: failed to claim resource %d\n",
269 dev_name(&pdev->dev), i);
275 pr_debug("Registering platform device '%s'. Parent at %s\n",
276 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
278 ret = device_add(&pdev->dev);
284 struct resource *r = &pdev->resource[i];
285 unsigned long type = resource_type(r);
287 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
293 EXPORT_SYMBOL_GPL(platform_device_add);
296 * platform_device_del - remove a platform-level device
297 * @pdev: platform device we're removing
299 * Note that this function will also release all memory- and port-based
300 * resources owned by the device (@dev->resource). This function must
301 * _only_ be externally called in error cases. All other usage is a bug.
303 void platform_device_del(struct platform_device *pdev)
308 device_del(&pdev->dev);
310 for (i = 0; i < pdev->num_resources; i++) {
311 struct resource *r = &pdev->resource[i];
312 unsigned long type = resource_type(r);
314 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
319 EXPORT_SYMBOL_GPL(platform_device_del);
322 * platform_device_register - add a platform-level device
323 * @pdev: platform device we're adding
325 int platform_device_register(struct platform_device *pdev)
327 device_initialize(&pdev->dev);
328 return platform_device_add(pdev);
330 EXPORT_SYMBOL_GPL(platform_device_register);
333 * platform_device_unregister - unregister a platform-level device
334 * @pdev: platform device we're unregistering
336 * Unregistration is done in 2 steps. First we release all resources
337 * and remove it from the subsystem, then we drop reference count by
338 * calling platform_device_put().
340 void platform_device_unregister(struct platform_device *pdev)
342 platform_device_del(pdev);
343 platform_device_put(pdev);
345 EXPORT_SYMBOL_GPL(platform_device_unregister);
348 * platform_device_register_simple
349 * @name: base name of the device we're adding
351 * @res: set of resources that needs to be allocated for the device
352 * @num: number of resources
354 * This function creates a simple platform device that requires minimal
355 * resource and memory management. Canned release function freeing memory
356 * allocated for the device allows drivers using such devices to be
357 * unloaded without waiting for the last reference to the device to be
360 * This interface is primarily intended for use with legacy drivers which
361 * probe hardware directly. Because such drivers create sysfs device nodes
362 * themselves, rather than letting system infrastructure handle such device
363 * enumeration tasks, they don't fully conform to the Linux driver model.
364 * In particular, when such drivers are built as modules, they can't be
367 struct platform_device *platform_device_register_simple(const char *name,
369 struct resource *res,
372 struct platform_device *pdev;
375 pdev = platform_device_alloc(name, id);
382 retval = platform_device_add_resources(pdev, res, num);
387 retval = platform_device_add(pdev);
394 platform_device_put(pdev);
395 return ERR_PTR(retval);
397 EXPORT_SYMBOL_GPL(platform_device_register_simple);
400 * platform_device_register_data
401 * @parent: parent device for the device we're adding
402 * @name: base name of the device we're adding
404 * @data: platform specific data for this platform device
405 * @size: size of platform specific data
407 * This function creates a simple platform device that requires minimal
408 * resource and memory management. Canned release function freeing memory
409 * allocated for the device allows drivers using such devices to be
410 * unloaded without waiting for the last reference to the device to be
413 struct platform_device *platform_device_register_data(
414 struct device *parent,
415 const char *name, int id,
416 const void *data, size_t size)
418 struct platform_device *pdev;
421 pdev = platform_device_alloc(name, id);
427 pdev->dev.parent = parent;
430 retval = platform_device_add_data(pdev, data, size);
435 retval = platform_device_add(pdev);
442 platform_device_put(pdev);
443 return ERR_PTR(retval);
446 static int platform_drv_probe(struct device *_dev)
448 struct platform_driver *drv = to_platform_driver(_dev->driver);
449 struct platform_device *dev = to_platform_device(_dev);
451 return drv->probe(dev);
454 static int platform_drv_probe_fail(struct device *_dev)
459 static int platform_drv_remove(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->remove(dev);
467 static void platform_drv_shutdown(struct device *_dev)
469 struct platform_driver *drv = to_platform_driver(_dev->driver);
470 struct platform_device *dev = to_platform_device(_dev);
475 static int platform_drv_suspend(struct device *_dev, pm_message_t state)
477 struct platform_driver *drv = to_platform_driver(_dev->driver);
478 struct platform_device *dev = to_platform_device(_dev);
480 return drv->suspend(dev, state);
483 static int platform_drv_resume(struct device *_dev)
485 struct platform_driver *drv = to_platform_driver(_dev->driver);
486 struct platform_device *dev = to_platform_device(_dev);
488 return drv->resume(dev);
492 * platform_driver_register
493 * @drv: platform driver structure
495 int platform_driver_register(struct platform_driver *drv)
497 drv->driver.bus = &platform_bus_type;
499 drv->driver.probe = platform_drv_probe;
501 drv->driver.remove = platform_drv_remove;
503 drv->driver.shutdown = platform_drv_shutdown;
505 drv->driver.suspend = platform_drv_suspend;
507 drv->driver.resume = platform_drv_resume;
508 return driver_register(&drv->driver);
510 EXPORT_SYMBOL_GPL(platform_driver_register);
513 * platform_driver_unregister
514 * @drv: platform driver structure
516 void platform_driver_unregister(struct platform_driver *drv)
518 driver_unregister(&drv->driver);
520 EXPORT_SYMBOL_GPL(platform_driver_unregister);
523 * platform_driver_probe - register driver for non-hotpluggable device
524 * @drv: platform driver structure
525 * @probe: the driver probe routine, probably from an __init section
527 * Use this instead of platform_driver_register() when you know the device
528 * is not hotpluggable and has already been registered, and you want to
529 * remove its run-once probe() infrastructure from memory after the driver
530 * has bound to the device.
532 * One typical use for this would be with drivers for controllers integrated
533 * into system-on-chip processors, where the controller devices have been
534 * configured as part of board setup.
536 * Returns zero if the driver registered and bound to a device, else returns
537 * a negative error code and with the driver not registered.
539 int __init_or_module platform_driver_probe(struct platform_driver *drv,
540 int (*probe)(struct platform_device *))
544 /* temporary section violation during probe() */
546 retval = code = platform_driver_register(drv);
548 /* Fixup that section violation, being paranoid about code scanning
549 * the list of drivers in order to probe new devices. Check to see
550 * if the probe was successful, and make sure any forced probes of
553 spin_lock(&platform_bus_type.p->klist_drivers.k_lock);
555 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
557 drv->driver.probe = platform_drv_probe_fail;
558 spin_unlock(&platform_bus_type.p->klist_drivers.k_lock);
561 platform_driver_unregister(drv);
564 EXPORT_SYMBOL_GPL(platform_driver_probe);
566 /* modalias support enables more hands-off userspace setup:
567 * (a) environment variable lets new-style hotplug events work once system is
568 * fully running: "modprobe $MODALIAS"
569 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
570 * mishandled before system is fully running: "modprobe $(cat modalias)"
572 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
575 struct platform_device *pdev = to_platform_device(dev);
576 int len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
578 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
581 static struct device_attribute platform_dev_attrs[] = {
586 static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
588 struct platform_device *pdev = to_platform_device(dev);
590 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
591 (pdev->id_entry) ? pdev->id_entry->name : pdev->name);
595 static const struct platform_device_id *platform_match_id(
596 struct platform_device_id *id,
597 struct platform_device *pdev)
599 while (id->name[0]) {
600 if (strcmp(pdev->name, id->name) == 0) {
610 * platform_match - bind platform device to platform driver.
614 * Platform device IDs are assumed to be encoded like this:
615 * "<name><instance>", where <name> is a short description of the type of
616 * device, like "pci" or "floppy", and <instance> is the enumerated
617 * instance of the device, like '0' or '42'. Driver IDs are simply
618 * "<name>". So, extract the <name> from the platform_device structure,
619 * and compare it against the name of the driver. Return whether they match
622 static int platform_match(struct device *dev, struct device_driver *drv)
624 struct platform_device *pdev = to_platform_device(dev);
625 struct platform_driver *pdrv = to_platform_driver(drv);
627 /* match against the id table first */
629 return platform_match_id(pdrv->id_table, pdev) != NULL;
631 /* fall-back to driver name match */
632 return (strcmp(pdev->name, drv->name) == 0);
635 #ifdef CONFIG_PM_SLEEP
637 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
641 if (dev->driver && dev->driver->suspend)
642 ret = dev->driver->suspend(dev, mesg);
647 static int platform_legacy_suspend_late(struct device *dev, pm_message_t mesg)
649 struct platform_driver *pdrv = to_platform_driver(dev->driver);
650 struct platform_device *pdev = to_platform_device(dev);
653 if (dev->driver && pdrv->suspend_late)
654 ret = pdrv->suspend_late(pdev, mesg);
659 static int platform_legacy_resume_early(struct device *dev)
661 struct platform_driver *pdrv = to_platform_driver(dev->driver);
662 struct platform_device *pdev = to_platform_device(dev);
665 if (dev->driver && pdrv->resume_early)
666 ret = pdrv->resume_early(pdev);
671 static int platform_legacy_resume(struct device *dev)
675 if (dev->driver && dev->driver->resume)
676 ret = dev->driver->resume(dev);
681 static int platform_pm_prepare(struct device *dev)
683 struct device_driver *drv = dev->driver;
686 if (drv && drv->pm && drv->pm->prepare)
687 ret = drv->pm->prepare(dev);
692 static void platform_pm_complete(struct device *dev)
694 struct device_driver *drv = dev->driver;
696 if (drv && drv->pm && drv->pm->complete)
697 drv->pm->complete(dev);
700 #ifdef CONFIG_SUSPEND
702 static int platform_pm_suspend(struct device *dev)
704 struct device_driver *drv = dev->driver;
711 if (drv->pm->suspend)
712 ret = drv->pm->suspend(dev);
714 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
720 static int platform_pm_suspend_noirq(struct device *dev)
722 struct device_driver *drv = dev->driver;
729 if (drv->pm->suspend_noirq)
730 ret = drv->pm->suspend_noirq(dev);
732 ret = platform_legacy_suspend_late(dev, PMSG_SUSPEND);
738 static int platform_pm_resume(struct device *dev)
740 struct device_driver *drv = dev->driver;
748 ret = drv->pm->resume(dev);
750 ret = platform_legacy_resume(dev);
756 static int platform_pm_resume_noirq(struct device *dev)
758 struct device_driver *drv = dev->driver;
765 if (drv->pm->resume_noirq)
766 ret = drv->pm->resume_noirq(dev);
768 ret = platform_legacy_resume_early(dev);
774 #else /* !CONFIG_SUSPEND */
776 #define platform_pm_suspend NULL
777 #define platform_pm_resume NULL
778 #define platform_pm_suspend_noirq NULL
779 #define platform_pm_resume_noirq NULL
781 #endif /* !CONFIG_SUSPEND */
783 #ifdef CONFIG_HIBERNATION
785 static int platform_pm_freeze(struct device *dev)
787 struct device_driver *drv = dev->driver;
795 ret = drv->pm->freeze(dev);
797 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
803 static int platform_pm_freeze_noirq(struct device *dev)
805 struct device_driver *drv = dev->driver;
812 if (drv->pm->freeze_noirq)
813 ret = drv->pm->freeze_noirq(dev);
815 ret = platform_legacy_suspend_late(dev, PMSG_FREEZE);
821 static int platform_pm_thaw(struct device *dev)
823 struct device_driver *drv = dev->driver;
831 ret = drv->pm->thaw(dev);
833 ret = platform_legacy_resume(dev);
839 static int platform_pm_thaw_noirq(struct device *dev)
841 struct device_driver *drv = dev->driver;
848 if (drv->pm->thaw_noirq)
849 ret = drv->pm->thaw_noirq(dev);
851 ret = platform_legacy_resume_early(dev);
857 static int platform_pm_poweroff(struct device *dev)
859 struct device_driver *drv = dev->driver;
866 if (drv->pm->poweroff)
867 ret = drv->pm->poweroff(dev);
869 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
875 static int platform_pm_poweroff_noirq(struct device *dev)
877 struct device_driver *drv = dev->driver;
884 if (drv->pm->poweroff_noirq)
885 ret = drv->pm->poweroff_noirq(dev);
887 ret = platform_legacy_suspend_late(dev, PMSG_HIBERNATE);
893 static int platform_pm_restore(struct device *dev)
895 struct device_driver *drv = dev->driver;
902 if (drv->pm->restore)
903 ret = drv->pm->restore(dev);
905 ret = platform_legacy_resume(dev);
911 static int platform_pm_restore_noirq(struct device *dev)
913 struct device_driver *drv = dev->driver;
920 if (drv->pm->restore_noirq)
921 ret = drv->pm->restore_noirq(dev);
923 ret = platform_legacy_resume_early(dev);
929 #else /* !CONFIG_HIBERNATION */
931 #define platform_pm_freeze NULL
932 #define platform_pm_thaw NULL
933 #define platform_pm_poweroff NULL
934 #define platform_pm_restore NULL
935 #define platform_pm_freeze_noirq NULL
936 #define platform_pm_thaw_noirq NULL
937 #define platform_pm_poweroff_noirq NULL
938 #define platform_pm_restore_noirq NULL
940 #endif /* !CONFIG_HIBERNATION */
942 static struct dev_pm_ops platform_dev_pm_ops = {
943 .prepare = platform_pm_prepare,
944 .complete = platform_pm_complete,
945 .suspend = platform_pm_suspend,
946 .resume = platform_pm_resume,
947 .freeze = platform_pm_freeze,
948 .thaw = platform_pm_thaw,
949 .poweroff = platform_pm_poweroff,
950 .restore = platform_pm_restore,
951 .suspend_noirq = platform_pm_suspend_noirq,
952 .resume_noirq = platform_pm_resume_noirq,
953 .freeze_noirq = platform_pm_freeze_noirq,
954 .thaw_noirq = platform_pm_thaw_noirq,
955 .poweroff_noirq = platform_pm_poweroff_noirq,
956 .restore_noirq = platform_pm_restore_noirq,
959 #define PLATFORM_PM_OPS_PTR (&platform_dev_pm_ops)
961 #else /* !CONFIG_PM_SLEEP */
963 #define PLATFORM_PM_OPS_PTR NULL
965 #endif /* !CONFIG_PM_SLEEP */
967 struct bus_type platform_bus_type = {
969 .dev_attrs = platform_dev_attrs,
970 .match = platform_match,
971 .uevent = platform_uevent,
972 .pm = PLATFORM_PM_OPS_PTR,
974 EXPORT_SYMBOL_GPL(platform_bus_type);
976 int __init platform_bus_init(void)
980 error = device_register(&platform_bus);
983 error = bus_register(&platform_bus_type);
985 device_unregister(&platform_bus);
989 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
990 u64 dma_get_required_mask(struct device *dev)
992 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
993 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
996 if (!high_totalram) {
997 /* convert to mask just covering totalram */
998 low_totalram = (1 << (fls(low_totalram) - 1));
999 low_totalram += low_totalram - 1;
1000 mask = low_totalram;
1002 high_totalram = (1 << (fls(high_totalram) - 1));
1003 high_totalram += high_totalram - 1;
1004 mask = (((u64)high_totalram) << 32) + 0xffffffff;
1008 EXPORT_SYMBOL_GPL(dma_get_required_mask);