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 ((r
->flags
& (IORESOURCE_IO
|IORESOURCE_MEM
|
46 IORESOURCE_IRQ
|IORESOURCE_DMA
)) == type
)
52 EXPORT_SYMBOL_GPL(platform_get_resource
);
55 * platform_get_irq - get an IRQ for a device
56 * @dev: platform device
57 * @num: IRQ number index
59 int platform_get_irq(struct platform_device
*dev
, unsigned int num
)
61 struct resource
*r
= platform_get_resource(dev
, IORESOURCE_IRQ
, num
);
63 return r
? r
->start
: -ENXIO
;
65 EXPORT_SYMBOL_GPL(platform_get_irq
);
68 * platform_get_resource_byname - get a resource for a device by name
69 * @dev: platform device
70 * @type: resource type
71 * @name: resource name
73 struct resource
*platform_get_resource_byname(struct platform_device
*dev
,
74 unsigned int type
, char *name
)
78 for (i
= 0; i
< dev
->num_resources
; i
++) {
79 struct resource
*r
= &dev
->resource
[i
];
81 if ((r
->flags
& (IORESOURCE_IO
|IORESOURCE_MEM
|
82 IORESOURCE_IRQ
|IORESOURCE_DMA
)) == type
)
83 if (!strcmp(r
->name
, name
))
88 EXPORT_SYMBOL_GPL(platform_get_resource_byname
);
91 * platform_get_irq - get an IRQ for a device
92 * @dev: platform device
95 int platform_get_irq_byname(struct platform_device
*dev
, char *name
)
97 struct resource
*r
= platform_get_resource_byname(dev
, IORESOURCE_IRQ
,
100 return r
? r
->start
: -ENXIO
;
102 EXPORT_SYMBOL_GPL(platform_get_irq_byname
);
105 * platform_add_devices - add a numbers of platform devices
106 * @devs: array of platform devices to add
107 * @num: number of platform devices in array
109 int platform_add_devices(struct platform_device
**devs
, int num
)
113 for (i
= 0; i
< num
; i
++) {
114 ret
= platform_device_register(devs
[i
]);
117 platform_device_unregister(devs
[i
]);
124 EXPORT_SYMBOL_GPL(platform_add_devices
);
126 struct platform_object
{
127 struct platform_device pdev
;
132 * platform_device_put
133 * @pdev: platform device to free
135 * Free all memory associated with a platform device. This function must
136 * _only_ be externally called in error cases. All other usage is a bug.
138 void platform_device_put(struct platform_device
*pdev
)
141 put_device(&pdev
->dev
);
143 EXPORT_SYMBOL_GPL(platform_device_put
);
145 static void platform_device_release(struct device
*dev
)
147 struct platform_object
*pa
= container_of(dev
, struct platform_object
,
150 kfree(pa
->pdev
.dev
.platform_data
);
151 kfree(pa
->pdev
.resource
);
156 * platform_device_alloc
157 * @name: base name of the device we're adding
160 * Create a platform device object which can have other objects attached
161 * to it, and which will have attached objects freed when it is released.
163 struct platform_device
*platform_device_alloc(const char *name
, int id
)
165 struct platform_object
*pa
;
167 pa
= kzalloc(sizeof(struct platform_object
) + strlen(name
), GFP_KERNEL
);
169 strcpy(pa
->name
, name
);
170 pa
->pdev
.name
= pa
->name
;
172 device_initialize(&pa
->pdev
.dev
);
173 pa
->pdev
.dev
.release
= platform_device_release
;
176 return pa
? &pa
->pdev
: NULL
;
178 EXPORT_SYMBOL_GPL(platform_device_alloc
);
181 * platform_device_add_resources
182 * @pdev: platform device allocated by platform_device_alloc to add resources to
183 * @res: set of resources that needs to be allocated for the device
184 * @num: number of resources
186 * Add a copy of the resources to the platform device. The memory
187 * associated with the resources will be freed when the platform device is
190 int platform_device_add_resources(struct platform_device
*pdev
,
191 struct resource
*res
, unsigned int num
)
195 r
= kmalloc(sizeof(struct resource
) * num
, GFP_KERNEL
);
197 memcpy(r
, res
, sizeof(struct resource
) * num
);
199 pdev
->num_resources
= num
;
201 return r
? 0 : -ENOMEM
;
203 EXPORT_SYMBOL_GPL(platform_device_add_resources
);
206 * platform_device_add_data
207 * @pdev: platform device allocated by platform_device_alloc to add resources to
208 * @data: platform specific data for this platform device
209 * @size: size of platform specific data
211 * Add a copy of platform specific data to the platform device's
212 * platform_data pointer. The memory associated with the platform data
213 * will be freed when the platform device is released.
215 int platform_device_add_data(struct platform_device
*pdev
, const void *data
,
220 d
= kmalloc(size
, GFP_KERNEL
);
222 memcpy(d
, data
, size
);
223 pdev
->dev
.platform_data
= d
;
225 return d
? 0 : -ENOMEM
;
227 EXPORT_SYMBOL_GPL(platform_device_add_data
);
230 * platform_device_add - add a platform device to device hierarchy
231 * @pdev: platform device we're adding
233 * This is part 2 of platform_device_register(), though may be called
234 * separately _iff_ pdev was allocated by platform_device_alloc().
236 int platform_device_add(struct platform_device
*pdev
)
243 if (!pdev
->dev
.parent
)
244 pdev
->dev
.parent
= &platform_bus
;
246 pdev
->dev
.bus
= &platform_bus_type
;
249 snprintf(pdev
->dev
.bus_id
, BUS_ID_SIZE
, "%s.%d", pdev
->name
,
252 strlcpy(pdev
->dev
.bus_id
, pdev
->name
, BUS_ID_SIZE
);
254 for (i
= 0; i
< pdev
->num_resources
; i
++) {
255 struct resource
*p
, *r
= &pdev
->resource
[i
];
258 r
->name
= pdev
->dev
.bus_id
;
262 if (r
->flags
& IORESOURCE_MEM
)
264 else if (r
->flags
& IORESOURCE_IO
)
265 p
= &ioport_resource
;
268 if (p
&& insert_resource(p
, r
)) {
270 "%s: failed to claim resource %d\n",
271 pdev
->dev
.bus_id
, i
);
277 pr_debug("Registering platform device '%s'. Parent at %s\n",
278 pdev
->dev
.bus_id
, pdev
->dev
.parent
->bus_id
);
280 ret
= device_add(&pdev
->dev
);
286 if (pdev
->resource
[i
].flags
& (IORESOURCE_MEM
|IORESOURCE_IO
))
287 release_resource(&pdev
->resource
[i
]);
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 if (r
->flags
& (IORESOURCE_MEM
|IORESOURCE_IO
))
314 EXPORT_SYMBOL_GPL(platform_device_del
);
317 * platform_device_register - add a platform-level device
318 * @pdev: platform device we're adding
320 int platform_device_register(struct platform_device
*pdev
)
322 device_initialize(&pdev
->dev
);
323 return platform_device_add(pdev
);
325 EXPORT_SYMBOL_GPL(platform_device_register
);
328 * platform_device_unregister - unregister a platform-level device
329 * @pdev: platform device we're unregistering
331 * Unregistration is done in 2 steps. First we release all resources
332 * and remove it from the subsystem, then we drop reference count by
333 * calling platform_device_put().
335 void platform_device_unregister(struct platform_device
*pdev
)
337 platform_device_del(pdev
);
338 platform_device_put(pdev
);
340 EXPORT_SYMBOL_GPL(platform_device_unregister
);
343 * platform_device_register_simple
344 * @name: base name of the device we're adding
346 * @res: set of resources that needs to be allocated for the device
347 * @num: number of resources
349 * This function creates a simple platform device that requires minimal
350 * resource and memory management. Canned release function freeing memory
351 * allocated for the device allows drivers using such devices to be
352 * unloaded without waiting for the last reference to the device to be
355 * This interface is primarily intended for use with legacy drivers which
356 * probe hardware directly. Because such drivers create sysfs device nodes
357 * themselves, rather than letting system infrastructure handle such device
358 * enumeration tasks, they don't fully conform to the Linux driver model.
359 * In particular, when such drivers are built as modules, they can't be
362 struct platform_device
*platform_device_register_simple(const char *name
,
364 struct resource
*res
,
367 struct platform_device
*pdev
;
370 pdev
= platform_device_alloc(name
, id
);
377 retval
= platform_device_add_resources(pdev
, res
, num
);
382 retval
= platform_device_add(pdev
);
389 platform_device_put(pdev
);
390 return ERR_PTR(retval
);
392 EXPORT_SYMBOL_GPL(platform_device_register_simple
);
394 static int platform_drv_probe(struct device
*_dev
)
396 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
397 struct platform_device
*dev
= to_platform_device(_dev
);
399 return drv
->probe(dev
);
402 static int platform_drv_probe_fail(struct device
*_dev
)
407 static int platform_drv_remove(struct device
*_dev
)
409 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
410 struct platform_device
*dev
= to_platform_device(_dev
);
412 return drv
->remove(dev
);
415 static void platform_drv_shutdown(struct device
*_dev
)
417 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
418 struct platform_device
*dev
= to_platform_device(_dev
);
423 static int platform_drv_suspend(struct device
*_dev
, pm_message_t state
)
425 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
426 struct platform_device
*dev
= to_platform_device(_dev
);
428 return drv
->suspend(dev
, state
);
431 static int platform_drv_resume(struct device
*_dev
)
433 struct platform_driver
*drv
= to_platform_driver(_dev
->driver
);
434 struct platform_device
*dev
= to_platform_device(_dev
);
436 return drv
->resume(dev
);
440 * platform_driver_register
441 * @drv: platform driver structure
443 int platform_driver_register(struct platform_driver
*drv
)
445 drv
->driver
.bus
= &platform_bus_type
;
447 drv
->driver
.probe
= platform_drv_probe
;
449 drv
->driver
.remove
= platform_drv_remove
;
451 drv
->driver
.shutdown
= platform_drv_shutdown
;
453 drv
->driver
.suspend
= platform_drv_suspend
;
455 drv
->driver
.resume
= platform_drv_resume
;
457 drv
->driver
.pm
= &drv
->pm
->base
;
458 return driver_register(&drv
->driver
);
460 EXPORT_SYMBOL_GPL(platform_driver_register
);
463 * platform_driver_unregister
464 * @drv: platform driver structure
466 void platform_driver_unregister(struct platform_driver
*drv
)
468 driver_unregister(&drv
->driver
);
470 EXPORT_SYMBOL_GPL(platform_driver_unregister
);
473 * platform_driver_probe - register driver for non-hotpluggable device
474 * @drv: platform driver structure
475 * @probe: the driver probe routine, probably from an __init section
477 * Use this instead of platform_driver_register() when you know the device
478 * is not hotpluggable and has already been registered, and you want to
479 * remove its run-once probe() infrastructure from memory after the driver
480 * has bound to the device.
482 * One typical use for this would be with drivers for controllers integrated
483 * into system-on-chip processors, where the controller devices have been
484 * configured as part of board setup.
486 * Returns zero if the driver registered and bound to a device, else returns
487 * a negative error code and with the driver not registered.
489 int __init_or_module
platform_driver_probe(struct platform_driver
*drv
,
490 int (*probe
)(struct platform_device
*))
494 /* temporary section violation during probe() */
496 retval
= code
= platform_driver_register(drv
);
498 /* Fixup that section violation, being paranoid about code scanning
499 * the list of drivers in order to probe new devices. Check to see
500 * if the probe was successful, and make sure any forced probes of
503 spin_lock(&platform_bus_type
.p
->klist_drivers
.k_lock
);
505 if (code
== 0 && list_empty(&drv
->driver
.p
->klist_devices
.k_list
))
507 drv
->driver
.probe
= platform_drv_probe_fail
;
508 spin_unlock(&platform_bus_type
.p
->klist_drivers
.k_lock
);
511 platform_driver_unregister(drv
);
514 EXPORT_SYMBOL_GPL(platform_driver_probe
);
516 /* modalias support enables more hands-off userspace setup:
517 * (a) environment variable lets new-style hotplug events work once system is
518 * fully running: "modprobe $MODALIAS"
519 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
520 * mishandled before system is fully running: "modprobe $(cat modalias)"
522 static ssize_t
modalias_show(struct device
*dev
, struct device_attribute
*a
,
525 struct platform_device
*pdev
= to_platform_device(dev
);
526 int len
= snprintf(buf
, PAGE_SIZE
, "platform:%s\n", pdev
->name
);
528 return (len
>= PAGE_SIZE
) ? (PAGE_SIZE
- 1) : len
;
531 static struct device_attribute platform_dev_attrs
[] = {
536 static int platform_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
538 struct platform_device
*pdev
= to_platform_device(dev
);
540 add_uevent_var(env
, "MODALIAS=platform:%s", pdev
->name
);
545 * platform_match - bind platform device to platform driver.
549 * Platform device IDs are assumed to be encoded like this:
550 * "<name><instance>", where <name> is a short description of the type of
551 * device, like "pci" or "floppy", and <instance> is the enumerated
552 * instance of the device, like '0' or '42'. Driver IDs are simply
553 * "<name>". So, extract the <name> from the platform_device structure,
554 * and compare it against the name of the driver. Return whether they match
557 static int platform_match(struct device
*dev
, struct device_driver
*drv
)
559 struct platform_device
*pdev
;
561 pdev
= container_of(dev
, struct platform_device
, dev
);
562 return (strncmp(pdev
->name
, drv
->name
, BUS_ID_SIZE
) == 0);
565 #ifdef CONFIG_PM_SLEEP
567 static int platform_legacy_suspend(struct device
*dev
, pm_message_t mesg
)
571 if (dev
->driver
&& dev
->driver
->suspend
)
572 ret
= dev
->driver
->suspend(dev
, mesg
);
577 static int platform_legacy_suspend_late(struct device
*dev
, pm_message_t mesg
)
579 struct platform_driver
*drv
= to_platform_driver(dev
->driver
);
580 struct platform_device
*pdev
;
583 pdev
= container_of(dev
, struct platform_device
, dev
);
584 if (dev
->driver
&& drv
->suspend_late
)
585 ret
= drv
->suspend_late(pdev
, mesg
);
590 static int platform_legacy_resume_early(struct device
*dev
)
592 struct platform_driver
*drv
= to_platform_driver(dev
->driver
);
593 struct platform_device
*pdev
;
596 pdev
= container_of(dev
, struct platform_device
, dev
);
597 if (dev
->driver
&& drv
->resume_early
)
598 ret
= drv
->resume_early(pdev
);
603 static int platform_legacy_resume(struct device
*dev
)
607 if (dev
->driver
&& dev
->driver
->resume
)
608 ret
= dev
->driver
->resume(dev
);
613 static int platform_pm_prepare(struct device
*dev
)
615 struct device_driver
*drv
= dev
->driver
;
618 if (drv
&& drv
->pm
&& drv
->pm
->prepare
)
619 ret
= drv
->pm
->prepare(dev
);
624 static void platform_pm_complete(struct device
*dev
)
626 struct device_driver
*drv
= dev
->driver
;
628 if (drv
&& drv
->pm
&& drv
->pm
->complete
)
629 drv
->pm
->complete(dev
);
632 #ifdef CONFIG_SUSPEND
634 static int platform_pm_suspend(struct device
*dev
)
636 struct device_driver
*drv
= dev
->driver
;
639 if (drv
&& drv
->pm
) {
640 if (drv
->pm
->suspend
)
641 ret
= drv
->pm
->suspend(dev
);
643 ret
= platform_legacy_suspend(dev
, PMSG_SUSPEND
);
649 static int platform_pm_suspend_noirq(struct device
*dev
)
651 struct platform_driver
*pdrv
;
657 pdrv
= to_platform_driver(dev
->driver
);
659 if (pdrv
->pm
->suspend_noirq
)
660 ret
= pdrv
->pm
->suspend_noirq(dev
);
662 ret
= platform_legacy_suspend_late(dev
, PMSG_SUSPEND
);
668 static int platform_pm_resume(struct device
*dev
)
670 struct device_driver
*drv
= dev
->driver
;
673 if (drv
&& drv
->pm
) {
675 ret
= drv
->pm
->resume(dev
);
677 ret
= platform_legacy_resume(dev
);
683 static int platform_pm_resume_noirq(struct device
*dev
)
685 struct platform_driver
*pdrv
;
691 pdrv
= to_platform_driver(dev
->driver
);
693 if (pdrv
->pm
->resume_noirq
)
694 ret
= pdrv
->pm
->resume_noirq(dev
);
696 ret
= platform_legacy_resume_early(dev
);
702 #else /* !CONFIG_SUSPEND */
704 #define platform_pm_suspend NULL
705 #define platform_pm_resume NULL
706 #define platform_pm_suspend_noirq NULL
707 #define platform_pm_resume_noirq NULL
709 #endif /* !CONFIG_SUSPEND */
711 #ifdef CONFIG_HIBERNATION
713 static int platform_pm_freeze(struct device
*dev
)
715 struct device_driver
*drv
= dev
->driver
;
723 ret
= drv
->pm
->freeze(dev
);
725 ret
= platform_legacy_suspend(dev
, PMSG_FREEZE
);
731 static int platform_pm_freeze_noirq(struct device
*dev
)
733 struct platform_driver
*pdrv
;
739 pdrv
= to_platform_driver(dev
->driver
);
741 if (pdrv
->pm
->freeze_noirq
)
742 ret
= pdrv
->pm
->freeze_noirq(dev
);
744 ret
= platform_legacy_suspend_late(dev
, PMSG_FREEZE
);
750 static int platform_pm_thaw(struct device
*dev
)
752 struct device_driver
*drv
= dev
->driver
;
755 if (drv
&& drv
->pm
) {
757 ret
= drv
->pm
->thaw(dev
);
759 ret
= platform_legacy_resume(dev
);
765 static int platform_pm_thaw_noirq(struct device
*dev
)
767 struct platform_driver
*pdrv
;
773 pdrv
= to_platform_driver(dev
->driver
);
775 if (pdrv
->pm
->thaw_noirq
)
776 ret
= pdrv
->pm
->thaw_noirq(dev
);
778 ret
= platform_legacy_resume_early(dev
);
784 static int platform_pm_poweroff(struct device
*dev
)
786 struct device_driver
*drv
= dev
->driver
;
789 if (drv
&& drv
->pm
) {
790 if (drv
->pm
->poweroff
)
791 ret
= drv
->pm
->poweroff(dev
);
793 ret
= platform_legacy_suspend(dev
, PMSG_HIBERNATE
);
799 static int platform_pm_poweroff_noirq(struct device
*dev
)
801 struct platform_driver
*pdrv
;
807 pdrv
= to_platform_driver(dev
->driver
);
809 if (pdrv
->pm
->poweroff_noirq
)
810 ret
= pdrv
->pm
->poweroff_noirq(dev
);
812 ret
= platform_legacy_suspend_late(dev
, PMSG_HIBERNATE
);
818 static int platform_pm_restore(struct device
*dev
)
820 struct device_driver
*drv
= dev
->driver
;
823 if (drv
&& drv
->pm
) {
824 if (drv
->pm
->restore
)
825 ret
= drv
->pm
->restore(dev
);
827 ret
= platform_legacy_resume(dev
);
833 static int platform_pm_restore_noirq(struct device
*dev
)
835 struct platform_driver
*pdrv
;
841 pdrv
= to_platform_driver(dev
->driver
);
843 if (pdrv
->pm
->restore_noirq
)
844 ret
= pdrv
->pm
->restore_noirq(dev
);
846 ret
= platform_legacy_resume_early(dev
);
852 #else /* !CONFIG_HIBERNATION */
854 #define platform_pm_freeze NULL
855 #define platform_pm_thaw NULL
856 #define platform_pm_poweroff NULL
857 #define platform_pm_restore NULL
858 #define platform_pm_freeze_noirq NULL
859 #define platform_pm_thaw_noirq NULL
860 #define platform_pm_poweroff_noirq NULL
861 #define platform_pm_restore_noirq NULL
863 #endif /* !CONFIG_HIBERNATION */
865 struct pm_ext_ops platform_pm_ops
= {
867 .prepare
= platform_pm_prepare
,
868 .complete
= platform_pm_complete
,
869 .suspend
= platform_pm_suspend
,
870 .resume
= platform_pm_resume
,
871 .freeze
= platform_pm_freeze
,
872 .thaw
= platform_pm_thaw
,
873 .poweroff
= platform_pm_poweroff
,
874 .restore
= platform_pm_restore
,
876 .suspend_noirq
= platform_pm_suspend_noirq
,
877 .resume_noirq
= platform_pm_resume_noirq
,
878 .freeze_noirq
= platform_pm_freeze_noirq
,
879 .thaw_noirq
= platform_pm_thaw_noirq
,
880 .poweroff_noirq
= platform_pm_poweroff_noirq
,
881 .restore_noirq
= platform_pm_restore_noirq
,
884 #define PLATFORM_PM_OPS_PTR &platform_pm_ops
886 #else /* !CONFIG_PM_SLEEP */
888 #define PLATFORM_PM_OPS_PTR NULL
890 #endif /* !CONFIG_PM_SLEEP */
892 struct bus_type platform_bus_type
= {
894 .dev_attrs
= platform_dev_attrs
,
895 .match
= platform_match
,
896 .uevent
= platform_uevent
,
897 .pm
= PLATFORM_PM_OPS_PTR
,
899 EXPORT_SYMBOL_GPL(platform_bus_type
);
901 int __init
platform_bus_init(void)
905 error
= device_register(&platform_bus
);
908 error
= bus_register(&platform_bus_type
);
910 device_unregister(&platform_bus
);
914 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
915 u64
dma_get_required_mask(struct device
*dev
)
917 u32 low_totalram
= ((max_pfn
- 1) << PAGE_SHIFT
);
918 u32 high_totalram
= ((max_pfn
- 1) >> (32 - PAGE_SHIFT
));
921 if (!high_totalram
) {
922 /* convert to mask just covering totalram */
923 low_totalram
= (1 << (fls(low_totalram
) - 1));
924 low_totalram
+= low_totalram
- 1;
927 high_totalram
= (1 << (fls(high_totalram
) - 1));
928 high_totalram
+= high_totalram
- 1;
929 mask
= (((u64
)high_totalram
) << 32) + 0xffffffff;
933 EXPORT_SYMBOL_GPL(dma_get_required_mask
);