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
;
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 dev_set_name(&pdev
->dev
, "%s.%d", pdev
->name
, pdev
->id
);
247 dev_set_name(&pdev
->dev
, pdev
->name
);
249 for (i
= 0; i
< pdev
->num_resources
; i
++) {
250 struct resource
*p
, *r
= &pdev
->resource
[i
];
253 r
->name
= dev_name(&pdev
->dev
);
257 if (resource_type(r
) == IORESOURCE_MEM
)
259 else if (resource_type(r
) == IORESOURCE_IO
)
260 p
= &ioport_resource
;
263 if (p
&& insert_resource(p
, r
)) {
265 "%s: failed to claim resource %d\n",
266 dev_name(&pdev
->dev
), i
);
272 pr_debug("Registering platform device '%s'. Parent at %s\n",
273 dev_name(&pdev
->dev
), dev_name(pdev
->dev
.parent
));
275 ret
= device_add(&pdev
->dev
);
281 struct resource
*r
= &pdev
->resource
[i
];
282 unsigned long type
= resource_type(r
);
284 if (type
== IORESOURCE_MEM
|| type
== IORESOURCE_IO
)
290 EXPORT_SYMBOL_GPL(platform_device_add
);
293 * platform_device_del - remove a platform-level device
294 * @pdev: platform device we're removing
296 * Note that this function will also release all memory- and port-based
297 * resources owned by the device (@dev->resource). This function must
298 * _only_ be externally called in error cases. All other usage is a bug.
300 void platform_device_del(struct platform_device
*pdev
)
305 device_del(&pdev
->dev
);
307 for (i
= 0; i
< pdev
->num_resources
; i
++) {
308 struct resource
*r
= &pdev
->resource
[i
];
309 unsigned long type
= resource_type(r
);
311 if (type
== IORESOURCE_MEM
|| type
== IORESOURCE_IO
)
316 EXPORT_SYMBOL_GPL(platform_device_del
);
319 * platform_device_register - add a platform-level device
320 * @pdev: platform device we're adding
322 int platform_device_register(struct platform_device
*pdev
)
324 device_initialize(&pdev
->dev
);
325 return platform_device_add(pdev
);
327 EXPORT_SYMBOL_GPL(platform_device_register
);
330 * platform_device_unregister - unregister a platform-level device
331 * @pdev: platform device we're unregistering
333 * Unregistration is done in 2 steps. First we release all resources
334 * and remove it from the subsystem, then we drop reference count by
335 * calling platform_device_put().
337 void platform_device_unregister(struct platform_device
*pdev
)
339 platform_device_del(pdev
);
340 platform_device_put(pdev
);
342 EXPORT_SYMBOL_GPL(platform_device_unregister
);
345 * platform_device_register_simple
346 * @name: base name of the device we're adding
348 * @res: set of resources that needs to be allocated for the device
349 * @num: number of resources
351 * This function creates a simple platform device that requires minimal
352 * resource and memory management. Canned release function freeing memory
353 * allocated for the device allows drivers using such devices to be
354 * unloaded without waiting for the last reference to the device to be
357 * This interface is primarily intended for use with legacy drivers which
358 * probe hardware directly. Because such drivers create sysfs device nodes
359 * themselves, rather than letting system infrastructure handle such device
360 * enumeration tasks, they don't fully conform to the Linux driver model.
361 * In particular, when such drivers are built as modules, they can't be
364 struct platform_device
*platform_device_register_simple(const char *name
,
366 struct resource
*res
,
369 struct platform_device
*pdev
;
372 pdev
= platform_device_alloc(name
, id
);
379 retval
= platform_device_add_resources(pdev
, res
, num
);
384 retval
= platform_device_add(pdev
);
391 platform_device_put(pdev
);
392 return ERR_PTR(retval
);
394 EXPORT_SYMBOL_GPL(platform_device_register_simple
);
397 * platform_device_register_data
398 * @parent: parent device for the device we're adding
399 * @name: base name of the device we're adding
401 * @data: platform specific data for this platform device
402 * @size: size of platform specific data
404 * This function creates a simple platform device that requires minimal
405 * resource and memory management. Canned release function freeing memory
406 * allocated for the device allows drivers using such devices to be
407 * unloaded without waiting for the last reference to the device to be
410 struct platform_device
*platform_device_register_data(
411 struct device
*parent
,
412 const char *name
, int id
,
413 const void *data
, size_t size
)
415 struct platform_device
*pdev
;
418 pdev
= platform_device_alloc(name
, id
);
424 pdev
->dev
.parent
= parent
;
427 retval
= platform_device_add_data(pdev
, data
, size
);
432 retval
= platform_device_add(pdev
);
439 platform_device_put(pdev
);
440 return ERR_PTR(retval
);
443 static int platform_drv_probe(struct device
*_dev
)
445 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
446 struct platform_device
*dev
= to_platform_device(_dev
);
448 return drv
->probe(dev
);
451 static int platform_drv_probe_fail(struct device
*_dev
)
456 static int platform_drv_remove(struct device
*_dev
)
458 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
459 struct platform_device
*dev
= to_platform_device(_dev
);
461 return drv
->remove(dev
);
464 static void platform_drv_shutdown(struct device
*_dev
)
466 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
467 struct platform_device
*dev
= to_platform_device(_dev
);
472 static int platform_drv_suspend(struct device
*_dev
, pm_message_t state
)
474 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
475 struct platform_device
*dev
= to_platform_device(_dev
);
477 return drv
->suspend(dev
, state
);
480 static int platform_drv_resume(struct device
*_dev
)
482 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
483 struct platform_device
*dev
= to_platform_device(_dev
);
485 return drv
->resume(dev
);
489 * platform_driver_register
490 * @drv: platform driver structure
492 int platform_driver_register(struct platform_driver
*drv
)
494 drv
->driver
.bus
= &platform_bus_type
;
496 drv
->driver
.probe
= platform_drv_probe
;
498 drv
->driver
.remove
= platform_drv_remove
;
500 drv
->driver
.shutdown
= platform_drv_shutdown
;
502 drv
->driver
.suspend
= platform_drv_suspend
;
504 drv
->driver
.resume
= platform_drv_resume
;
505 return driver_register(&drv
->driver
);
507 EXPORT_SYMBOL_GPL(platform_driver_register
);
510 * platform_driver_unregister
511 * @drv: platform driver structure
513 void platform_driver_unregister(struct platform_driver
*drv
)
515 driver_unregister(&drv
->driver
);
517 EXPORT_SYMBOL_GPL(platform_driver_unregister
);
520 * platform_driver_probe - register driver for non-hotpluggable device
521 * @drv: platform driver structure
522 * @probe: the driver probe routine, probably from an __init section
524 * Use this instead of platform_driver_register() when you know the device
525 * is not hotpluggable and has already been registered, and you want to
526 * remove its run-once probe() infrastructure from memory after the driver
527 * has bound to the device.
529 * One typical use for this would be with drivers for controllers integrated
530 * into system-on-chip processors, where the controller devices have been
531 * configured as part of board setup.
533 * Returns zero if the driver registered and bound to a device, else returns
534 * a negative error code and with the driver not registered.
536 int __init_or_module
platform_driver_probe(struct platform_driver
*drv
,
537 int (*probe
)(struct platform_device
*))
541 /* temporary section violation during probe() */
543 retval
= code
= platform_driver_register(drv
);
545 /* Fixup that section violation, being paranoid about code scanning
546 * the list of drivers in order to probe new devices. Check to see
547 * if the probe was successful, and make sure any forced probes of
550 spin_lock(&platform_bus_type
.p
->klist_drivers
.k_lock
);
552 if (code
== 0 && list_empty(&drv
->driver
.p
->klist_devices
.k_list
))
554 drv
->driver
.probe
= platform_drv_probe_fail
;
555 spin_unlock(&platform_bus_type
.p
->klist_drivers
.k_lock
);
558 platform_driver_unregister(drv
);
561 EXPORT_SYMBOL_GPL(platform_driver_probe
);
563 /* modalias support enables more hands-off userspace setup:
564 * (a) environment variable lets new-style hotplug events work once system is
565 * fully running: "modprobe $MODALIAS"
566 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
567 * mishandled before system is fully running: "modprobe $(cat modalias)"
569 static ssize_t
modalias_show(struct device
*dev
, struct device_attribute
*a
,
572 struct platform_device
*pdev
= to_platform_device(dev
);
573 int len
= snprintf(buf
, PAGE_SIZE
, "platform:%s\n", pdev
->name
);
575 return (len
>= PAGE_SIZE
) ? (PAGE_SIZE
- 1) : len
;
578 static struct device_attribute platform_dev_attrs
[] = {
583 static int platform_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
585 struct platform_device
*pdev
= to_platform_device(dev
);
587 add_uevent_var(env
, "MODALIAS=platform:%s", pdev
->name
);
592 * platform_match - bind platform device to platform driver.
596 * Platform device IDs are assumed to be encoded like this:
597 * "<name><instance>", where <name> is a short description of the type of
598 * device, like "pci" or "floppy", and <instance> is the enumerated
599 * instance of the device, like '0' or '42'. Driver IDs are simply
600 * "<name>". So, extract the <name> from the platform_device structure,
601 * and compare it against the name of the driver. Return whether they match
604 static int platform_match(struct device
*dev
, struct device_driver
*drv
)
606 struct platform_device
*pdev
;
608 pdev
= container_of(dev
, struct platform_device
, dev
);
609 return (strcmp(pdev
->name
, drv
->name
) == 0);
612 #ifdef CONFIG_PM_SLEEP
614 static int platform_legacy_suspend(struct device
*dev
, pm_message_t mesg
)
618 if (dev
->driver
&& dev
->driver
->suspend
)
619 ret
= dev
->driver
->suspend(dev
, mesg
);
624 static int platform_legacy_suspend_late(struct device
*dev
, pm_message_t mesg
)
626 struct platform_driver
*drv
= to_platform_driver(dev
->driver
);
627 struct platform_device
*pdev
;
630 pdev
= container_of(dev
, struct platform_device
, dev
);
631 if (dev
->driver
&& drv
->suspend_late
)
632 ret
= drv
->suspend_late(pdev
, mesg
);
637 static int platform_legacy_resume_early(struct device
*dev
)
639 struct platform_driver
*drv
= to_platform_driver(dev
->driver
);
640 struct platform_device
*pdev
;
643 pdev
= container_of(dev
, struct platform_device
, dev
);
644 if (dev
->driver
&& drv
->resume_early
)
645 ret
= drv
->resume_early(pdev
);
650 static int platform_legacy_resume(struct device
*dev
)
654 if (dev
->driver
&& dev
->driver
->resume
)
655 ret
= dev
->driver
->resume(dev
);
660 static int platform_pm_prepare(struct device
*dev
)
662 struct device_driver
*drv
= dev
->driver
;
665 if (drv
&& drv
->pm
&& drv
->pm
->prepare
)
666 ret
= drv
->pm
->prepare(dev
);
671 static void platform_pm_complete(struct device
*dev
)
673 struct device_driver
*drv
= dev
->driver
;
675 if (drv
&& drv
->pm
&& drv
->pm
->complete
)
676 drv
->pm
->complete(dev
);
679 #ifdef CONFIG_SUSPEND
681 static int platform_pm_suspend(struct device
*dev
)
683 struct device_driver
*drv
= dev
->driver
;
690 if (drv
->pm
->suspend
)
691 ret
= drv
->pm
->suspend(dev
);
693 ret
= platform_legacy_suspend(dev
, PMSG_SUSPEND
);
699 static int platform_pm_suspend_noirq(struct device
*dev
)
701 struct device_driver
*drv
= dev
->driver
;
708 if (drv
->pm
->suspend_noirq
)
709 ret
= drv
->pm
->suspend_noirq(dev
);
711 ret
= platform_legacy_suspend_late(dev
, PMSG_SUSPEND
);
717 static int platform_pm_resume(struct device
*dev
)
719 struct device_driver
*drv
= dev
->driver
;
727 ret
= drv
->pm
->resume(dev
);
729 ret
= platform_legacy_resume(dev
);
735 static int platform_pm_resume_noirq(struct device
*dev
)
737 struct device_driver
*drv
= dev
->driver
;
744 if (drv
->pm
->resume_noirq
)
745 ret
= drv
->pm
->resume_noirq(dev
);
747 ret
= platform_legacy_resume_early(dev
);
753 #else /* !CONFIG_SUSPEND */
755 #define platform_pm_suspend NULL
756 #define platform_pm_resume NULL
757 #define platform_pm_suspend_noirq NULL
758 #define platform_pm_resume_noirq NULL
760 #endif /* !CONFIG_SUSPEND */
762 #ifdef CONFIG_HIBERNATION
764 static int platform_pm_freeze(struct device
*dev
)
766 struct device_driver
*drv
= dev
->driver
;
774 ret
= drv
->pm
->freeze(dev
);
776 ret
= platform_legacy_suspend(dev
, PMSG_FREEZE
);
782 static int platform_pm_freeze_noirq(struct device
*dev
)
784 struct device_driver
*drv
= dev
->driver
;
791 if (drv
->pm
->freeze_noirq
)
792 ret
= drv
->pm
->freeze_noirq(dev
);
794 ret
= platform_legacy_suspend_late(dev
, PMSG_FREEZE
);
800 static int platform_pm_thaw(struct device
*dev
)
802 struct device_driver
*drv
= dev
->driver
;
810 ret
= drv
->pm
->thaw(dev
);
812 ret
= platform_legacy_resume(dev
);
818 static int platform_pm_thaw_noirq(struct device
*dev
)
820 struct device_driver
*drv
= dev
->driver
;
827 if (drv
->pm
->thaw_noirq
)
828 ret
= drv
->pm
->thaw_noirq(dev
);
830 ret
= platform_legacy_resume_early(dev
);
836 static int platform_pm_poweroff(struct device
*dev
)
838 struct device_driver
*drv
= dev
->driver
;
845 if (drv
->pm
->poweroff
)
846 ret
= drv
->pm
->poweroff(dev
);
848 ret
= platform_legacy_suspend(dev
, PMSG_HIBERNATE
);
854 static int platform_pm_poweroff_noirq(struct device
*dev
)
856 struct device_driver
*drv
= dev
->driver
;
863 if (drv
->pm
->poweroff_noirq
)
864 ret
= drv
->pm
->poweroff_noirq(dev
);
866 ret
= platform_legacy_suspend_late(dev
, PMSG_HIBERNATE
);
872 static int platform_pm_restore(struct device
*dev
)
874 struct device_driver
*drv
= dev
->driver
;
881 if (drv
->pm
->restore
)
882 ret
= drv
->pm
->restore(dev
);
884 ret
= platform_legacy_resume(dev
);
890 static int platform_pm_restore_noirq(struct device
*dev
)
892 struct device_driver
*drv
= dev
->driver
;
899 if (drv
->pm
->restore_noirq
)
900 ret
= drv
->pm
->restore_noirq(dev
);
902 ret
= platform_legacy_resume_early(dev
);
908 #else /* !CONFIG_HIBERNATION */
910 #define platform_pm_freeze NULL
911 #define platform_pm_thaw NULL
912 #define platform_pm_poweroff NULL
913 #define platform_pm_restore NULL
914 #define platform_pm_freeze_noirq NULL
915 #define platform_pm_thaw_noirq NULL
916 #define platform_pm_poweroff_noirq NULL
917 #define platform_pm_restore_noirq NULL
919 #endif /* !CONFIG_HIBERNATION */
921 static struct dev_pm_ops platform_dev_pm_ops
= {
922 .prepare
= platform_pm_prepare
,
923 .complete
= platform_pm_complete
,
924 .suspend
= platform_pm_suspend
,
925 .resume
= platform_pm_resume
,
926 .freeze
= platform_pm_freeze
,
927 .thaw
= platform_pm_thaw
,
928 .poweroff
= platform_pm_poweroff
,
929 .restore
= platform_pm_restore
,
930 .suspend_noirq
= platform_pm_suspend_noirq
,
931 .resume_noirq
= platform_pm_resume_noirq
,
932 .freeze_noirq
= platform_pm_freeze_noirq
,
933 .thaw_noirq
= platform_pm_thaw_noirq
,
934 .poweroff_noirq
= platform_pm_poweroff_noirq
,
935 .restore_noirq
= platform_pm_restore_noirq
,
938 #define PLATFORM_PM_OPS_PTR (&platform_dev_pm_ops)
940 #else /* !CONFIG_PM_SLEEP */
942 #define PLATFORM_PM_OPS_PTR NULL
944 #endif /* !CONFIG_PM_SLEEP */
946 struct bus_type platform_bus_type
= {
948 .dev_attrs
= platform_dev_attrs
,
949 .match
= platform_match
,
950 .uevent
= platform_uevent
,
951 .pm
= PLATFORM_PM_OPS_PTR
,
953 EXPORT_SYMBOL_GPL(platform_bus_type
);
955 int __init
platform_bus_init(void)
959 error
= device_register(&platform_bus
);
962 error
= bus_register(&platform_bus_type
);
964 device_unregister(&platform_bus
);
968 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
969 u64
dma_get_required_mask(struct device
*dev
)
971 u32 low_totalram
= ((max_pfn
- 1) << PAGE_SHIFT
);
972 u32 high_totalram
= ((max_pfn
- 1) >> (32 - PAGE_SHIFT
));
975 if (!high_totalram
) {
976 /* convert to mask just covering totalram */
977 low_totalram
= (1 << (fls(low_totalram
) - 1));
978 low_totalram
+= low_totalram
- 1;
981 high_totalram
= (1 << (fls(high_totalram
) - 1));
982 high_totalram
+= high_totalram
- 1;
983 mask
= (((u64
)high_totalram
) << 32) + 0xffffffff;
987 EXPORT_SYMBOL_GPL(dma_get_required_mask
);