1 // SPDX-License-Identifier: GPL-2.0
3 * platform.c - platform 'pseudo' bus for legacy devices
5 * Copyright (c) 2002-3 Patrick Mochel
6 * Copyright (c) 2002-3 Open Source Development Labs
8 * Please see Documentation/driver-api/driver-model/platform.rst for more
12 #include <linux/string.h>
13 #include <linux/platform_device.h>
14 #include <linux/of_device.h>
15 #include <linux/of_irq.h>
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/interrupt.h>
19 #include <linux/ioport.h>
20 #include <linux/dma-mapping.h>
21 #include <linux/memblock.h>
22 #include <linux/err.h>
23 #include <linux/slab.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/pm_domain.h>
26 #include <linux/idr.h>
27 #include <linux/acpi.h>
28 #include <linux/clk/clk-conf.h>
29 #include <linux/limits.h>
30 #include <linux/property.h>
31 #include <linux/kmemleak.h>
32 #include <linux/types.h>
33 #include <linux/iommu.h>
34 #include <linux/dma-map-ops.h>
37 #include "power/power.h"
39 /* For automatically allocated device IDs */
40 static DEFINE_IDA(platform_devid_ida);
42 struct device platform_bus = {
43 .init_name = "platform",
45 EXPORT_SYMBOL_GPL(platform_bus);
48 * platform_get_resource - get a resource for a device
49 * @dev: platform device
50 * @type: resource type
51 * @num: resource index
53 * Return: a pointer to the resource or NULL on failure.
55 struct resource *platform_get_resource(struct platform_device *dev,
56 unsigned int type, unsigned int num)
60 for (i = 0; i < dev->num_resources; i++) {
61 struct resource *r = &dev->resource[i];
63 if (type == resource_type(r) && num-- == 0)
68 EXPORT_SYMBOL_GPL(platform_get_resource);
70 struct resource *platform_get_mem_or_io(struct platform_device *dev,
75 for (i = 0; i < dev->num_resources; i++) {
76 struct resource *r = &dev->resource[i];
78 if ((resource_type(r) & (IORESOURCE_MEM|IORESOURCE_IO)) && num-- == 0)
83 EXPORT_SYMBOL_GPL(platform_get_mem_or_io);
85 #ifdef CONFIG_HAS_IOMEM
87 * devm_platform_get_and_ioremap_resource - call devm_ioremap_resource() for a
88 * platform device and get resource
90 * @pdev: platform device to use both for memory resource lookup as well as
92 * @index: resource index
93 * @res: optional output parameter to store a pointer to the obtained resource.
95 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
99 devm_platform_get_and_ioremap_resource(struct platform_device *pdev,
100 unsigned int index, struct resource **res)
104 r = platform_get_resource(pdev, IORESOURCE_MEM, index);
107 return devm_ioremap_resource(&pdev->dev, r);
109 EXPORT_SYMBOL_GPL(devm_platform_get_and_ioremap_resource);
112 * devm_platform_ioremap_resource - call devm_ioremap_resource() for a platform
115 * @pdev: platform device to use both for memory resource lookup as well as
116 * resource management
117 * @index: resource index
119 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
122 void __iomem *devm_platform_ioremap_resource(struct platform_device *pdev,
125 return devm_platform_get_and_ioremap_resource(pdev, index, NULL);
127 EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource);
130 * devm_platform_ioremap_resource_byname - call devm_ioremap_resource for
131 * a platform device, retrieve the
134 * @pdev: platform device to use both for memory resource lookup as well as
135 * resource management
136 * @name: name of the resource
138 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
142 devm_platform_ioremap_resource_byname(struct platform_device *pdev,
145 struct resource *res;
147 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
148 return devm_ioremap_resource(&pdev->dev, res);
150 EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource_byname);
151 #endif /* CONFIG_HAS_IOMEM */
154 * platform_get_irq_optional - get an optional IRQ for a device
155 * @dev: platform device
156 * @num: IRQ number index
158 * Gets an IRQ for a platform device. Device drivers should check the return
159 * value for errors so as to not pass a negative integer value to the
160 * request_irq() APIs. This is the same as platform_get_irq(), except that it
161 * does not print an error message if an IRQ can not be obtained.
165 * int irq = platform_get_irq_optional(pdev, 0);
169 * Return: non-zero IRQ number on success, negative error number on failure.
171 int platform_get_irq_optional(struct platform_device *dev, unsigned int num)
175 /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
176 if (!dev || num >= dev->archdata.num_irqs)
178 ret = dev->archdata.irqs[num];
183 if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node) {
184 ret = of_irq_get(dev->dev.of_node, num);
185 if (ret > 0 || ret == -EPROBE_DEFER)
189 r = platform_get_resource(dev, IORESOURCE_IRQ, num);
190 if (has_acpi_companion(&dev->dev)) {
191 if (r && r->flags & IORESOURCE_DISABLED) {
192 ret = acpi_irq_get(ACPI_HANDLE(&dev->dev), num, r);
199 * The resources may pass trigger flags to the irqs that need
200 * to be set up. It so happens that the trigger flags for
201 * IORESOURCE_BITS correspond 1-to-1 to the IRQF_TRIGGER*
204 if (r && r->flags & IORESOURCE_BITS) {
205 struct irq_data *irqd;
207 irqd = irq_get_irq_data(r->start);
210 irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS);
219 * For the index 0 interrupt, allow falling back to GpioInt
220 * resources. While a device could have both Interrupt and GpioInt
221 * resources, making this fallback ambiguous, in many common cases
222 * the device will only expose one IRQ, and this fallback
223 * allows a common code path across either kind of resource.
225 if (num == 0 && has_acpi_companion(&dev->dev)) {
226 ret = acpi_dev_gpio_irq_get(ACPI_COMPANION(&dev->dev), num);
227 /* Our callers expect -ENXIO for missing IRQs. */
228 if (ret >= 0 || ret == -EPROBE_DEFER)
236 if (WARN(!ret, "0 is an invalid IRQ number\n"))
240 EXPORT_SYMBOL_GPL(platform_get_irq_optional);
243 * platform_get_irq - get an IRQ for a device
244 * @dev: platform device
245 * @num: IRQ number index
247 * Gets an IRQ for a platform device and prints an error message if finding the
248 * IRQ fails. Device drivers should check the return value for errors so as to
249 * not pass a negative integer value to the request_irq() APIs.
253 * int irq = platform_get_irq(pdev, 0);
257 * Return: non-zero IRQ number on success, negative error number on failure.
259 int platform_get_irq(struct platform_device *dev, unsigned int num)
263 ret = platform_get_irq_optional(dev, num);
265 return dev_err_probe(&dev->dev, ret,
266 "IRQ index %u not found\n", num);
270 EXPORT_SYMBOL_GPL(platform_get_irq);
273 * platform_irq_count - Count the number of IRQs a platform device uses
274 * @dev: platform device
276 * Return: Number of IRQs a platform device uses or EPROBE_DEFER
278 int platform_irq_count(struct platform_device *dev)
282 while ((ret = platform_get_irq_optional(dev, nr)) >= 0)
285 if (ret == -EPROBE_DEFER)
290 EXPORT_SYMBOL_GPL(platform_irq_count);
292 struct irq_affinity_devres {
297 static void platform_disable_acpi_irq(struct platform_device *pdev, int index)
301 r = platform_get_resource(pdev, IORESOURCE_IRQ, index);
303 irqresource_disabled(r, 0);
306 static void devm_platform_get_irqs_affinity_release(struct device *dev,
309 struct irq_affinity_devres *ptr = res;
312 for (i = 0; i < ptr->count; i++) {
313 irq_dispose_mapping(ptr->irq[i]);
315 if (has_acpi_companion(dev))
316 platform_disable_acpi_irq(to_platform_device(dev), i);
321 * devm_platform_get_irqs_affinity - devm method to get a set of IRQs for a
322 * device using an interrupt affinity descriptor
323 * @dev: platform device pointer
324 * @affd: affinity descriptor
325 * @minvec: minimum count of interrupt vectors
326 * @maxvec: maximum count of interrupt vectors
327 * @irqs: pointer holder for IRQ numbers
329 * Gets a set of IRQs for a platform device, and updates IRQ afffinty according
330 * to the passed affinity descriptor
332 * Return: Number of vectors on success, negative error number on failure.
334 int devm_platform_get_irqs_affinity(struct platform_device *dev,
335 struct irq_affinity *affd,
340 struct irq_affinity_devres *ptr;
341 struct irq_affinity_desc *desc;
351 nvec = platform_irq_count(dev);
358 nvec = irq_calc_affinity_vectors(minvec, nvec, affd);
365 size = sizeof(*ptr) + sizeof(unsigned int) * nvec;
366 ptr = devres_alloc(devm_platform_get_irqs_affinity_release, size,
373 for (i = 0; i < nvec; i++) {
374 int irq = platform_get_irq(dev, i);
377 goto err_free_devres;
382 desc = irq_create_affinity_masks(nvec, affd);
385 goto err_free_devres;
388 for (i = 0; i < nvec; i++) {
389 ret = irq_update_affinity_desc(ptr->irq[i], &desc[i]);
391 dev_err(&dev->dev, "failed to update irq%d affinity descriptor (%d)\n",
397 devres_add(&dev->dev, ptr);
411 EXPORT_SYMBOL_GPL(devm_platform_get_irqs_affinity);
414 * platform_get_resource_byname - get a resource for a device by name
415 * @dev: platform device
416 * @type: resource type
417 * @name: resource name
419 struct resource *platform_get_resource_byname(struct platform_device *dev,
425 for (i = 0; i < dev->num_resources; i++) {
426 struct resource *r = &dev->resource[i];
428 if (unlikely(!r->name))
431 if (type == resource_type(r) && !strcmp(r->name, name))
436 EXPORT_SYMBOL_GPL(platform_get_resource_byname);
438 static int __platform_get_irq_byname(struct platform_device *dev,
444 ret = fwnode_irq_get_byname(dev_fwnode(&dev->dev), name);
445 if (ret > 0 || ret == -EPROBE_DEFER)
448 r = platform_get_resource_byname(dev, IORESOURCE_IRQ, name);
450 if (WARN(!r->start, "0 is an invalid IRQ number\n"))
459 * platform_get_irq_byname - get an IRQ for a device by name
460 * @dev: platform device
463 * Get an IRQ like platform_get_irq(), but then by name rather then by index.
465 * Return: non-zero IRQ number on success, negative error number on failure.
467 int platform_get_irq_byname(struct platform_device *dev, const char *name)
471 ret = __platform_get_irq_byname(dev, name);
473 return dev_err_probe(&dev->dev, ret, "IRQ %s not found\n",
477 EXPORT_SYMBOL_GPL(platform_get_irq_byname);
480 * platform_get_irq_byname_optional - get an optional IRQ for a device by name
481 * @dev: platform device
484 * Get an optional IRQ by name like platform_get_irq_byname(). Except that it
485 * does not print an error message if an IRQ can not be obtained.
487 * Return: non-zero IRQ number on success, negative error number on failure.
489 int platform_get_irq_byname_optional(struct platform_device *dev,
492 return __platform_get_irq_byname(dev, name);
494 EXPORT_SYMBOL_GPL(platform_get_irq_byname_optional);
497 * platform_add_devices - add a numbers of platform devices
498 * @devs: array of platform devices to add
499 * @num: number of platform devices in array
501 * Return: 0 on success, negative error number on failure.
503 int platform_add_devices(struct platform_device **devs, int num)
507 for (i = 0; i < num; i++) {
508 ret = platform_device_register(devs[i]);
511 platform_device_unregister(devs[i]);
518 EXPORT_SYMBOL_GPL(platform_add_devices);
520 struct platform_object {
521 struct platform_device pdev;
526 * Set up default DMA mask for platform devices if the they weren't
527 * previously set by the architecture / DT.
529 static void setup_pdev_dma_masks(struct platform_device *pdev)
531 pdev->dev.dma_parms = &pdev->dma_parms;
533 if (!pdev->dev.coherent_dma_mask)
534 pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
535 if (!pdev->dev.dma_mask) {
536 pdev->platform_dma_mask = DMA_BIT_MASK(32);
537 pdev->dev.dma_mask = &pdev->platform_dma_mask;
542 * platform_device_put - destroy a platform device
543 * @pdev: platform device to free
545 * Free all memory associated with a platform device. This function must
546 * _only_ be externally called in error cases. All other usage is a bug.
548 void platform_device_put(struct platform_device *pdev)
550 if (!IS_ERR_OR_NULL(pdev))
551 put_device(&pdev->dev);
553 EXPORT_SYMBOL_GPL(platform_device_put);
555 static void platform_device_release(struct device *dev)
557 struct platform_object *pa = container_of(dev, struct platform_object,
560 of_node_put(pa->pdev.dev.of_node);
561 kfree(pa->pdev.dev.platform_data);
562 kfree(pa->pdev.mfd_cell);
563 kfree(pa->pdev.resource);
564 kfree(pa->pdev.driver_override);
569 * platform_device_alloc - create a platform device
570 * @name: base name of the device we're adding
573 * Create a platform device object which can have other objects attached
574 * to it, and which will have attached objects freed when it is released.
576 struct platform_device *platform_device_alloc(const char *name, int id)
578 struct platform_object *pa;
580 pa = kzalloc(sizeof(*pa) + strlen(name) + 1, GFP_KERNEL);
582 strcpy(pa->name, name);
583 pa->pdev.name = pa->name;
585 device_initialize(&pa->pdev.dev);
586 pa->pdev.dev.release = platform_device_release;
587 setup_pdev_dma_masks(&pa->pdev);
590 return pa ? &pa->pdev : NULL;
592 EXPORT_SYMBOL_GPL(platform_device_alloc);
595 * platform_device_add_resources - add resources to a platform device
596 * @pdev: platform device allocated by platform_device_alloc to add resources to
597 * @res: set of resources that needs to be allocated for the device
598 * @num: number of resources
600 * Add a copy of the resources to the platform device. The memory
601 * associated with the resources will be freed when the platform device is
604 int platform_device_add_resources(struct platform_device *pdev,
605 const struct resource *res, unsigned int num)
607 struct resource *r = NULL;
610 r = kmemdup(res, sizeof(struct resource) * num, GFP_KERNEL);
615 kfree(pdev->resource);
617 pdev->num_resources = num;
620 EXPORT_SYMBOL_GPL(platform_device_add_resources);
623 * platform_device_add_data - add platform-specific data to a platform device
624 * @pdev: platform device allocated by platform_device_alloc to add resources to
625 * @data: platform specific data for this platform device
626 * @size: size of platform specific data
628 * Add a copy of platform specific data to the platform device's
629 * platform_data pointer. The memory associated with the platform data
630 * will be freed when the platform device is released.
632 int platform_device_add_data(struct platform_device *pdev, const void *data,
638 d = kmemdup(data, size, GFP_KERNEL);
643 kfree(pdev->dev.platform_data);
644 pdev->dev.platform_data = d;
647 EXPORT_SYMBOL_GPL(platform_device_add_data);
650 * platform_device_add - add a platform device to device hierarchy
651 * @pdev: platform device we're adding
653 * This is part 2 of platform_device_register(), though may be called
654 * separately _iff_ pdev was allocated by platform_device_alloc().
656 int platform_device_add(struct platform_device *pdev)
664 if (!pdev->dev.parent)
665 pdev->dev.parent = &platform_bus;
667 pdev->dev.bus = &platform_bus_type;
671 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
673 case PLATFORM_DEVID_NONE:
674 dev_set_name(&pdev->dev, "%s", pdev->name);
676 case PLATFORM_DEVID_AUTO:
678 * Automatically allocated device ID. We mark it as such so
679 * that we remember it must be freed, and we append a suffix
680 * to avoid namespace collision with explicit IDs.
682 ret = ida_alloc(&platform_devid_ida, GFP_KERNEL);
686 pdev->id_auto = true;
687 dev_set_name(&pdev->dev, "%s.%d.auto", pdev->name, pdev->id);
691 for (i = 0; i < pdev->num_resources; i++) {
692 struct resource *p, *r = &pdev->resource[i];
695 r->name = dev_name(&pdev->dev);
699 if (resource_type(r) == IORESOURCE_MEM)
701 else if (resource_type(r) == IORESOURCE_IO)
702 p = &ioport_resource;
706 ret = insert_resource(p, r);
708 dev_err(&pdev->dev, "failed to claim resource %d: %pR\n", i, r);
714 pr_debug("Registering platform device '%s'. Parent at %s\n",
715 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
717 ret = device_add(&pdev->dev);
723 ida_free(&platform_devid_ida, pdev->id);
724 pdev->id = PLATFORM_DEVID_AUTO;
728 struct resource *r = &pdev->resource[i];
736 EXPORT_SYMBOL_GPL(platform_device_add);
739 * platform_device_del - remove a platform-level device
740 * @pdev: platform device we're removing
742 * Note that this function will also release all memory- and port-based
743 * resources owned by the device (@dev->resource). This function must
744 * _only_ be externally called in error cases. All other usage is a bug.
746 void platform_device_del(struct platform_device *pdev)
750 if (!IS_ERR_OR_NULL(pdev)) {
751 device_del(&pdev->dev);
754 ida_free(&platform_devid_ida, pdev->id);
755 pdev->id = PLATFORM_DEVID_AUTO;
758 for (i = 0; i < pdev->num_resources; i++) {
759 struct resource *r = &pdev->resource[i];
765 EXPORT_SYMBOL_GPL(platform_device_del);
768 * platform_device_register - add a platform-level device
769 * @pdev: platform device we're adding
771 * NOTE: _Never_ directly free @pdev after calling this function, even if it
772 * returned an error! Always use platform_device_put() to give up the
773 * reference initialised in this function instead.
775 int platform_device_register(struct platform_device *pdev)
777 device_initialize(&pdev->dev);
778 setup_pdev_dma_masks(pdev);
779 return platform_device_add(pdev);
781 EXPORT_SYMBOL_GPL(platform_device_register);
784 * platform_device_unregister - unregister a platform-level device
785 * @pdev: platform device we're unregistering
787 * Unregistration is done in 2 steps. First we release all resources
788 * and remove it from the subsystem, then we drop reference count by
789 * calling platform_device_put().
791 void platform_device_unregister(struct platform_device *pdev)
793 platform_device_del(pdev);
794 platform_device_put(pdev);
796 EXPORT_SYMBOL_GPL(platform_device_unregister);
799 * platform_device_register_full - add a platform-level device with
800 * resources and platform-specific data
802 * @pdevinfo: data used to create device
804 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
806 struct platform_device *platform_device_register_full(
807 const struct platform_device_info *pdevinfo)
810 struct platform_device *pdev;
812 pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
814 return ERR_PTR(-ENOMEM);
816 pdev->dev.parent = pdevinfo->parent;
817 pdev->dev.fwnode = pdevinfo->fwnode;
818 pdev->dev.of_node = of_node_get(to_of_node(pdev->dev.fwnode));
819 pdev->dev.of_node_reused = pdevinfo->of_node_reused;
821 if (pdevinfo->dma_mask) {
822 pdev->platform_dma_mask = pdevinfo->dma_mask;
823 pdev->dev.dma_mask = &pdev->platform_dma_mask;
824 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
827 ret = platform_device_add_resources(pdev,
828 pdevinfo->res, pdevinfo->num_res);
832 ret = platform_device_add_data(pdev,
833 pdevinfo->data, pdevinfo->size_data);
837 if (pdevinfo->properties) {
838 ret = device_create_managed_software_node(&pdev->dev,
839 pdevinfo->properties, NULL);
844 ret = platform_device_add(pdev);
847 ACPI_COMPANION_SET(&pdev->dev, NULL);
848 platform_device_put(pdev);
854 EXPORT_SYMBOL_GPL(platform_device_register_full);
857 * __platform_driver_register - register a driver for platform-level devices
858 * @drv: platform driver structure
859 * @owner: owning module/driver
861 int __platform_driver_register(struct platform_driver *drv,
862 struct module *owner)
864 drv->driver.owner = owner;
865 drv->driver.bus = &platform_bus_type;
867 return driver_register(&drv->driver);
869 EXPORT_SYMBOL_GPL(__platform_driver_register);
872 * platform_driver_unregister - unregister a driver for platform-level devices
873 * @drv: platform driver structure
875 void platform_driver_unregister(struct platform_driver *drv)
877 driver_unregister(&drv->driver);
879 EXPORT_SYMBOL_GPL(platform_driver_unregister);
881 static int platform_probe_fail(struct platform_device *pdev)
886 static int is_bound_to_driver(struct device *dev, void *driver)
888 if (dev->driver == driver)
894 * __platform_driver_probe - register driver for non-hotpluggable device
895 * @drv: platform driver structure
896 * @probe: the driver probe routine, probably from an __init section
897 * @module: module which will be the owner of the driver
899 * Use this instead of platform_driver_register() when you know the device
900 * is not hotpluggable and has already been registered, and you want to
901 * remove its run-once probe() infrastructure from memory after the driver
902 * has bound to the device.
904 * One typical use for this would be with drivers for controllers integrated
905 * into system-on-chip processors, where the controller devices have been
906 * configured as part of board setup.
908 * Note that this is incompatible with deferred probing.
910 * Returns zero if the driver registered and bound to a device, else returns
911 * a negative error code and with the driver not registered.
913 int __init_or_module __platform_driver_probe(struct platform_driver *drv,
914 int (*probe)(struct platform_device *), struct module *module)
918 if (drv->driver.probe_type == PROBE_PREFER_ASYNCHRONOUS) {
919 pr_err("%s: drivers registered with %s can not be probed asynchronously\n",
920 drv->driver.name, __func__);
925 * We have to run our probes synchronously because we check if
926 * we find any devices to bind to and exit with error if there
929 drv->driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
932 * Prevent driver from requesting probe deferral to avoid further
933 * futile probe attempts.
935 drv->prevent_deferred_probe = true;
937 /* make sure driver won't have bind/unbind attributes */
938 drv->driver.suppress_bind_attrs = true;
940 /* temporary section violation during probe() */
942 retval = __platform_driver_register(drv, module);
946 /* Force all new probes of this driver to fail */
947 drv->probe = platform_probe_fail;
949 /* Walk all platform devices and see if any actually bound to this driver.
950 * If not, return an error as the device should have done so by now.
952 if (!bus_for_each_dev(&platform_bus_type, NULL, &drv->driver, is_bound_to_driver)) {
954 platform_driver_unregister(drv);
959 EXPORT_SYMBOL_GPL(__platform_driver_probe);
962 * __platform_create_bundle - register driver and create corresponding device
963 * @driver: platform driver structure
964 * @probe: the driver probe routine, probably from an __init section
965 * @res: set of resources that needs to be allocated for the device
966 * @n_res: number of resources
967 * @data: platform specific data for this platform device
968 * @size: size of platform specific data
969 * @module: module which will be the owner of the driver
971 * Use this in legacy-style modules that probe hardware directly and
972 * register a single platform device and corresponding platform driver.
974 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
976 struct platform_device * __init_or_module __platform_create_bundle(
977 struct platform_driver *driver,
978 int (*probe)(struct platform_device *),
979 struct resource *res, unsigned int n_res,
980 const void *data, size_t size, struct module *module)
982 struct platform_device *pdev;
985 pdev = platform_device_alloc(driver->driver.name, -1);
991 error = platform_device_add_resources(pdev, res, n_res);
995 error = platform_device_add_data(pdev, data, size);
999 error = platform_device_add(pdev);
1003 error = __platform_driver_probe(driver, probe, module);
1010 platform_device_del(pdev);
1012 platform_device_put(pdev);
1014 return ERR_PTR(error);
1016 EXPORT_SYMBOL_GPL(__platform_create_bundle);
1019 * __platform_register_drivers - register an array of platform drivers
1020 * @drivers: an array of drivers to register
1021 * @count: the number of drivers to register
1022 * @owner: module owning the drivers
1024 * Registers platform drivers specified by an array. On failure to register a
1025 * driver, all previously registered drivers will be unregistered. Callers of
1026 * this API should use platform_unregister_drivers() to unregister drivers in
1027 * the reverse order.
1029 * Returns: 0 on success or a negative error code on failure.
1031 int __platform_register_drivers(struct platform_driver * const *drivers,
1032 unsigned int count, struct module *owner)
1037 for (i = 0; i < count; i++) {
1038 pr_debug("registering platform driver %ps\n", drivers[i]);
1040 err = __platform_driver_register(drivers[i], owner);
1042 pr_err("failed to register platform driver %ps: %d\n",
1052 pr_debug("unregistering platform driver %ps\n", drivers[i]);
1053 platform_driver_unregister(drivers[i]);
1058 EXPORT_SYMBOL_GPL(__platform_register_drivers);
1061 * platform_unregister_drivers - unregister an array of platform drivers
1062 * @drivers: an array of drivers to unregister
1063 * @count: the number of drivers to unregister
1065 * Unregisters platform drivers specified by an array. This is typically used
1066 * to complement an earlier call to platform_register_drivers(). Drivers are
1067 * unregistered in the reverse order in which they were registered.
1069 void platform_unregister_drivers(struct platform_driver * const *drivers,
1073 pr_debug("unregistering platform driver %ps\n", drivers[count]);
1074 platform_driver_unregister(drivers[count]);
1077 EXPORT_SYMBOL_GPL(platform_unregister_drivers);
1079 static const struct platform_device_id *platform_match_id(
1080 const struct platform_device_id *id,
1081 struct platform_device *pdev)
1083 while (id->name[0]) {
1084 if (strcmp(pdev->name, id->name) == 0) {
1085 pdev->id_entry = id;
1093 #ifdef CONFIG_PM_SLEEP
1095 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
1097 struct platform_driver *pdrv = to_platform_driver(dev->driver);
1098 struct platform_device *pdev = to_platform_device(dev);
1101 if (dev->driver && pdrv->suspend)
1102 ret = pdrv->suspend(pdev, mesg);
1107 static int platform_legacy_resume(struct device *dev)
1109 struct platform_driver *pdrv = to_platform_driver(dev->driver);
1110 struct platform_device *pdev = to_platform_device(dev);
1113 if (dev->driver && pdrv->resume)
1114 ret = pdrv->resume(pdev);
1119 #endif /* CONFIG_PM_SLEEP */
1121 #ifdef CONFIG_SUSPEND
1123 int platform_pm_suspend(struct device *dev)
1125 struct device_driver *drv = dev->driver;
1132 if (drv->pm->suspend)
1133 ret = drv->pm->suspend(dev);
1135 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
1141 int platform_pm_resume(struct device *dev)
1143 struct device_driver *drv = dev->driver;
1150 if (drv->pm->resume)
1151 ret = drv->pm->resume(dev);
1153 ret = platform_legacy_resume(dev);
1159 #endif /* CONFIG_SUSPEND */
1161 #ifdef CONFIG_HIBERNATE_CALLBACKS
1163 int platform_pm_freeze(struct device *dev)
1165 struct device_driver *drv = dev->driver;
1172 if (drv->pm->freeze)
1173 ret = drv->pm->freeze(dev);
1175 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
1181 int platform_pm_thaw(struct device *dev)
1183 struct device_driver *drv = dev->driver;
1191 ret = drv->pm->thaw(dev);
1193 ret = platform_legacy_resume(dev);
1199 int platform_pm_poweroff(struct device *dev)
1201 struct device_driver *drv = dev->driver;
1208 if (drv->pm->poweroff)
1209 ret = drv->pm->poweroff(dev);
1211 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
1217 int platform_pm_restore(struct device *dev)
1219 struct device_driver *drv = dev->driver;
1226 if (drv->pm->restore)
1227 ret = drv->pm->restore(dev);
1229 ret = platform_legacy_resume(dev);
1235 #endif /* CONFIG_HIBERNATE_CALLBACKS */
1237 /* modalias support enables more hands-off userspace setup:
1238 * (a) environment variable lets new-style hotplug events work once system is
1239 * fully running: "modprobe $MODALIAS"
1240 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
1241 * mishandled before system is fully running: "modprobe $(cat modalias)"
1243 static ssize_t modalias_show(struct device *dev,
1244 struct device_attribute *attr, char *buf)
1246 struct platform_device *pdev = to_platform_device(dev);
1249 len = of_device_modalias(dev, buf, PAGE_SIZE);
1253 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
1257 return sysfs_emit(buf, "platform:%s\n", pdev->name);
1259 static DEVICE_ATTR_RO(modalias);
1261 static ssize_t numa_node_show(struct device *dev,
1262 struct device_attribute *attr, char *buf)
1264 return sysfs_emit(buf, "%d\n", dev_to_node(dev));
1266 static DEVICE_ATTR_RO(numa_node);
1268 static ssize_t driver_override_show(struct device *dev,
1269 struct device_attribute *attr, char *buf)
1271 struct platform_device *pdev = to_platform_device(dev);
1275 len = sysfs_emit(buf, "%s\n", pdev->driver_override);
1281 static ssize_t driver_override_store(struct device *dev,
1282 struct device_attribute *attr,
1283 const char *buf, size_t count)
1285 struct platform_device *pdev = to_platform_device(dev);
1288 ret = driver_set_override(dev, &pdev->driver_override, buf, count);
1294 static DEVICE_ATTR_RW(driver_override);
1296 static struct attribute *platform_dev_attrs[] = {
1297 &dev_attr_modalias.attr,
1298 &dev_attr_numa_node.attr,
1299 &dev_attr_driver_override.attr,
1303 static umode_t platform_dev_attrs_visible(struct kobject *kobj, struct attribute *a,
1306 struct device *dev = container_of(kobj, typeof(*dev), kobj);
1308 if (a == &dev_attr_numa_node.attr &&
1309 dev_to_node(dev) == NUMA_NO_NODE)
1315 static const struct attribute_group platform_dev_group = {
1316 .attrs = platform_dev_attrs,
1317 .is_visible = platform_dev_attrs_visible,
1319 __ATTRIBUTE_GROUPS(platform_dev);
1323 * platform_match - bind platform device to platform driver.
1327 * Platform device IDs are assumed to be encoded like this:
1328 * "<name><instance>", where <name> is a short description of the type of
1329 * device, like "pci" or "floppy", and <instance> is the enumerated
1330 * instance of the device, like '0' or '42'. Driver IDs are simply
1331 * "<name>". So, extract the <name> from the platform_device structure,
1332 * and compare it against the name of the driver. Return whether they match
1335 static int platform_match(struct device *dev, struct device_driver *drv)
1337 struct platform_device *pdev = to_platform_device(dev);
1338 struct platform_driver *pdrv = to_platform_driver(drv);
1340 /* When driver_override is set, only bind to the matching driver */
1341 if (pdev->driver_override)
1342 return !strcmp(pdev->driver_override, drv->name);
1344 /* Attempt an OF style match first */
1345 if (of_driver_match_device(dev, drv))
1348 /* Then try ACPI style match */
1349 if (acpi_driver_match_device(dev, drv))
1352 /* Then try to match against the id table */
1354 return platform_match_id(pdrv->id_table, pdev) != NULL;
1356 /* fall-back to driver name match */
1357 return (strcmp(pdev->name, drv->name) == 0);
1360 static int platform_uevent(const struct device *dev, struct kobj_uevent_env *env)
1362 const struct platform_device *pdev = to_platform_device(dev);
1365 /* Some devices have extra OF data and an OF-style MODALIAS */
1366 rc = of_device_uevent_modalias(dev, env);
1370 rc = acpi_device_uevent_modalias(dev, env);
1374 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
1379 static int platform_probe(struct device *_dev)
1381 struct platform_driver *drv = to_platform_driver(_dev->driver);
1382 struct platform_device *dev = to_platform_device(_dev);
1386 * A driver registered using platform_driver_probe() cannot be bound
1387 * again later because the probe function usually lives in __init code
1388 * and so is gone. For these drivers .probe is set to
1389 * platform_probe_fail in __platform_driver_probe(). Don't even prepare
1390 * clocks and PM domains for these to match the traditional behaviour.
1392 if (unlikely(drv->probe == platform_probe_fail))
1395 ret = of_clk_set_defaults(_dev->of_node, false);
1399 ret = dev_pm_domain_attach(_dev, true);
1404 ret = drv->probe(dev);
1406 dev_pm_domain_detach(_dev, true);
1410 if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
1411 dev_warn(_dev, "probe deferral not supported\n");
1418 static void platform_remove(struct device *_dev)
1420 struct platform_driver *drv = to_platform_driver(_dev->driver);
1421 struct platform_device *dev = to_platform_device(_dev);
1423 if (drv->remove_new) {
1424 drv->remove_new(dev);
1425 } else if (drv->remove) {
1426 int ret = drv->remove(dev);
1429 dev_warn(_dev, "remove callback returned a non-zero value. This will be ignored.\n");
1431 dev_pm_domain_detach(_dev, true);
1434 static void platform_shutdown(struct device *_dev)
1436 struct platform_device *dev = to_platform_device(_dev);
1437 struct platform_driver *drv;
1442 drv = to_platform_driver(_dev->driver);
1447 static int platform_dma_configure(struct device *dev)
1449 struct platform_driver *drv = to_platform_driver(dev->driver);
1450 enum dev_dma_attr attr;
1454 ret = of_dma_configure(dev, dev->of_node, true);
1455 } else if (has_acpi_companion(dev)) {
1456 attr = acpi_get_dma_attr(to_acpi_device_node(dev->fwnode));
1457 ret = acpi_dma_configure(dev, attr);
1460 if (!ret && !drv->driver_managed_dma) {
1461 ret = iommu_device_use_default_domain(dev);
1463 arch_teardown_dma_ops(dev);
1469 static void platform_dma_cleanup(struct device *dev)
1471 struct platform_driver *drv = to_platform_driver(dev->driver);
1473 if (!drv->driver_managed_dma)
1474 iommu_device_unuse_default_domain(dev);
1477 static const struct dev_pm_ops platform_dev_pm_ops = {
1478 SET_RUNTIME_PM_OPS(pm_generic_runtime_suspend, pm_generic_runtime_resume, NULL)
1479 USE_PLATFORM_PM_SLEEP_OPS
1482 struct bus_type platform_bus_type = {
1484 .dev_groups = platform_dev_groups,
1485 .match = platform_match,
1486 .uevent = platform_uevent,
1487 .probe = platform_probe,
1488 .remove = platform_remove,
1489 .shutdown = platform_shutdown,
1490 .dma_configure = platform_dma_configure,
1491 .dma_cleanup = platform_dma_cleanup,
1492 .pm = &platform_dev_pm_ops,
1494 EXPORT_SYMBOL_GPL(platform_bus_type);
1496 static inline int __platform_match(struct device *dev, const void *drv)
1498 return platform_match(dev, (struct device_driver *)drv);
1502 * platform_find_device_by_driver - Find a platform device with a given
1504 * @start: The device to start the search from.
1505 * @drv: The device driver to look for.
1507 struct device *platform_find_device_by_driver(struct device *start,
1508 const struct device_driver *drv)
1510 return bus_find_device(&platform_bus_type, start, drv,
1513 EXPORT_SYMBOL_GPL(platform_find_device_by_driver);
1515 void __weak __init early_platform_cleanup(void) { }
1517 int __init platform_bus_init(void)
1521 early_platform_cleanup();
1523 error = device_register(&platform_bus);
1525 put_device(&platform_bus);
1528 error = bus_register(&platform_bus_type);
1530 device_unregister(&platform_bus);