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>
35 #include "power/power.h"
37 /* For automatically allocated device IDs */
38 static DEFINE_IDA(platform_devid_ida);
40 struct device platform_bus = {
41 .init_name = "platform",
43 EXPORT_SYMBOL_GPL(platform_bus);
46 * platform_get_resource - get a resource for a device
47 * @dev: platform device
48 * @type: resource type
49 * @num: resource index
51 * Return: a pointer to the resource or NULL on failure.
53 struct resource *platform_get_resource(struct platform_device *dev,
54 unsigned int type, unsigned int num)
58 for (i = 0; i < dev->num_resources; i++) {
59 struct resource *r = &dev->resource[i];
61 if (type == resource_type(r) && num-- == 0)
66 EXPORT_SYMBOL_GPL(platform_get_resource);
68 struct resource *platform_get_mem_or_io(struct platform_device *dev,
73 for (i = 0; i < dev->num_resources; i++) {
74 struct resource *r = &dev->resource[i];
76 if ((resource_type(r) & (IORESOURCE_MEM|IORESOURCE_IO)) && num-- == 0)
81 EXPORT_SYMBOL_GPL(platform_get_mem_or_io);
83 #ifdef CONFIG_HAS_IOMEM
85 * devm_platform_get_and_ioremap_resource - call devm_ioremap_resource() for a
86 * platform device and get resource
88 * @pdev: platform device to use both for memory resource lookup as well as
90 * @index: resource index
91 * @res: optional output parameter to store a pointer to the obtained resource.
93 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
97 devm_platform_get_and_ioremap_resource(struct platform_device *pdev,
98 unsigned int index, struct resource **res)
102 r = platform_get_resource(pdev, IORESOURCE_MEM, index);
105 return devm_ioremap_resource(&pdev->dev, r);
107 EXPORT_SYMBOL_GPL(devm_platform_get_and_ioremap_resource);
110 * devm_platform_ioremap_resource - call devm_ioremap_resource() for a platform
113 * @pdev: platform device to use both for memory resource lookup as well as
114 * resource management
115 * @index: resource index
117 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
120 void __iomem *devm_platform_ioremap_resource(struct platform_device *pdev,
123 return devm_platform_get_and_ioremap_resource(pdev, index, NULL);
125 EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource);
128 * devm_platform_ioremap_resource_byname - call devm_ioremap_resource for
129 * a platform device, retrieve the
132 * @pdev: platform device to use both for memory resource lookup as well as
133 * resource management
134 * @name: name of the resource
136 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
140 devm_platform_ioremap_resource_byname(struct platform_device *pdev,
143 struct resource *res;
145 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
146 return devm_ioremap_resource(&pdev->dev, res);
148 EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource_byname);
149 #endif /* CONFIG_HAS_IOMEM */
152 * platform_get_irq_optional - get an optional IRQ for a device
153 * @dev: platform device
154 * @num: IRQ number index
156 * Gets an IRQ for a platform device. Device drivers should check the return
157 * value for errors so as to not pass a negative integer value to the
158 * request_irq() APIs. This is the same as platform_get_irq(), except that it
159 * does not print an error message if an IRQ can not be obtained.
163 * int irq = platform_get_irq_optional(pdev, 0);
167 * Return: non-zero IRQ number on success, negative error number on failure.
169 int platform_get_irq_optional(struct platform_device *dev, unsigned int num)
173 /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
174 if (!dev || num >= dev->archdata.num_irqs)
176 ret = dev->archdata.irqs[num];
181 if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node) {
182 ret = of_irq_get(dev->dev.of_node, num);
183 if (ret > 0 || ret == -EPROBE_DEFER)
187 r = platform_get_resource(dev, IORESOURCE_IRQ, num);
188 if (has_acpi_companion(&dev->dev)) {
189 if (r && r->flags & IORESOURCE_DISABLED) {
190 ret = acpi_irq_get(ACPI_HANDLE(&dev->dev), num, r);
197 * The resources may pass trigger flags to the irqs that need
198 * to be set up. It so happens that the trigger flags for
199 * IORESOURCE_BITS correspond 1-to-1 to the IRQF_TRIGGER*
202 if (r && r->flags & IORESOURCE_BITS) {
203 struct irq_data *irqd;
205 irqd = irq_get_irq_data(r->start);
208 irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS);
217 * For the index 0 interrupt, allow falling back to GpioInt
218 * resources. While a device could have both Interrupt and GpioInt
219 * resources, making this fallback ambiguous, in many common cases
220 * the device will only expose one IRQ, and this fallback
221 * allows a common code path across either kind of resource.
223 if (num == 0 && has_acpi_companion(&dev->dev)) {
224 ret = acpi_dev_gpio_irq_get(ACPI_COMPANION(&dev->dev), num);
225 /* Our callers expect -ENXIO for missing IRQs. */
226 if (ret >= 0 || ret == -EPROBE_DEFER)
234 WARN(ret == 0, "0 is an invalid IRQ number\n");
237 EXPORT_SYMBOL_GPL(platform_get_irq_optional);
240 * platform_get_irq - get an IRQ for a device
241 * @dev: platform device
242 * @num: IRQ number index
244 * Gets an IRQ for a platform device and prints an error message if finding the
245 * IRQ fails. Device drivers should check the return value for errors so as to
246 * not pass a negative integer value to the request_irq() APIs.
250 * int irq = platform_get_irq(pdev, 0);
254 * Return: non-zero IRQ number on success, negative error number on failure.
256 int platform_get_irq(struct platform_device *dev, unsigned int num)
260 ret = platform_get_irq_optional(dev, num);
261 if (ret < 0 && ret != -EPROBE_DEFER)
262 dev_err(&dev->dev, "IRQ index %u not found\n", num);
266 EXPORT_SYMBOL_GPL(platform_get_irq);
269 * platform_irq_count - Count the number of IRQs a platform device uses
270 * @dev: platform device
272 * Return: Number of IRQs a platform device uses or EPROBE_DEFER
274 int platform_irq_count(struct platform_device *dev)
278 while ((ret = platform_get_irq_optional(dev, nr)) >= 0)
281 if (ret == -EPROBE_DEFER)
286 EXPORT_SYMBOL_GPL(platform_irq_count);
288 struct irq_affinity_devres {
293 static void platform_disable_acpi_irq(struct platform_device *pdev, int index)
297 r = platform_get_resource(pdev, IORESOURCE_IRQ, index);
299 irqresource_disabled(r, 0);
302 static void devm_platform_get_irqs_affinity_release(struct device *dev,
305 struct irq_affinity_devres *ptr = res;
308 for (i = 0; i < ptr->count; i++) {
309 irq_dispose_mapping(ptr->irq[i]);
311 if (has_acpi_companion(dev))
312 platform_disable_acpi_irq(to_platform_device(dev), i);
317 * devm_platform_get_irqs_affinity - devm method to get a set of IRQs for a
318 * device using an interrupt affinity descriptor
319 * @dev: platform device pointer
320 * @affd: affinity descriptor
321 * @minvec: minimum count of interrupt vectors
322 * @maxvec: maximum count of interrupt vectors
323 * @irqs: pointer holder for IRQ numbers
325 * Gets a set of IRQs for a platform device, and updates IRQ afffinty according
326 * to the passed affinity descriptor
328 * Return: Number of vectors on success, negative error number on failure.
330 int devm_platform_get_irqs_affinity(struct platform_device *dev,
331 struct irq_affinity *affd,
336 struct irq_affinity_devres *ptr;
337 struct irq_affinity_desc *desc;
347 nvec = platform_irq_count(dev);
354 nvec = irq_calc_affinity_vectors(minvec, nvec, affd);
361 size = sizeof(*ptr) + sizeof(unsigned int) * nvec;
362 ptr = devres_alloc(devm_platform_get_irqs_affinity_release, size,
369 for (i = 0; i < nvec; i++) {
370 int irq = platform_get_irq(dev, i);
373 goto err_free_devres;
378 desc = irq_create_affinity_masks(nvec, affd);
381 goto err_free_devres;
384 for (i = 0; i < nvec; i++) {
385 ret = irq_update_affinity_desc(ptr->irq[i], &desc[i]);
387 dev_err(&dev->dev, "failed to update irq%d affinity descriptor (%d)\n",
393 devres_add(&dev->dev, ptr);
407 EXPORT_SYMBOL_GPL(devm_platform_get_irqs_affinity);
410 * platform_get_resource_byname - get a resource for a device by name
411 * @dev: platform device
412 * @type: resource type
413 * @name: resource name
415 struct resource *platform_get_resource_byname(struct platform_device *dev,
421 for (i = 0; i < dev->num_resources; i++) {
422 struct resource *r = &dev->resource[i];
424 if (unlikely(!r->name))
427 if (type == resource_type(r) && !strcmp(r->name, name))
432 EXPORT_SYMBOL_GPL(platform_get_resource_byname);
434 static int __platform_get_irq_byname(struct platform_device *dev,
440 if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node) {
441 ret = of_irq_get_byname(dev->dev.of_node, name);
442 if (ret > 0 || ret == -EPROBE_DEFER)
446 r = platform_get_resource_byname(dev, IORESOURCE_IRQ, name);
448 WARN(r->start == 0, "0 is an invalid IRQ number\n");
456 * platform_get_irq_byname - get an IRQ for a device by name
457 * @dev: platform device
460 * Get an IRQ like platform_get_irq(), but then by name rather then by index.
462 * Return: non-zero IRQ number on success, negative error number on failure.
464 int platform_get_irq_byname(struct platform_device *dev, const char *name)
468 ret = __platform_get_irq_byname(dev, name);
469 if (ret < 0 && ret != -EPROBE_DEFER)
470 dev_err(&dev->dev, "IRQ %s not found\n", name);
474 EXPORT_SYMBOL_GPL(platform_get_irq_byname);
477 * platform_get_irq_byname_optional - get an optional IRQ for a device by name
478 * @dev: platform device
481 * Get an optional IRQ by name like platform_get_irq_byname(). Except that it
482 * does not print an error message if an IRQ can not be obtained.
484 * Return: non-zero IRQ number on success, negative error number on failure.
486 int platform_get_irq_byname_optional(struct platform_device *dev,
489 return __platform_get_irq_byname(dev, name);
491 EXPORT_SYMBOL_GPL(platform_get_irq_byname_optional);
494 * platform_add_devices - add a numbers of platform devices
495 * @devs: array of platform devices to add
496 * @num: number of platform devices in array
498 int platform_add_devices(struct platform_device **devs, int num)
502 for (i = 0; i < num; i++) {
503 ret = platform_device_register(devs[i]);
506 platform_device_unregister(devs[i]);
513 EXPORT_SYMBOL_GPL(platform_add_devices);
515 struct platform_object {
516 struct platform_device pdev;
521 * Set up default DMA mask for platform devices if the they weren't
522 * previously set by the architecture / DT.
524 static void setup_pdev_dma_masks(struct platform_device *pdev)
526 pdev->dev.dma_parms = &pdev->dma_parms;
528 if (!pdev->dev.coherent_dma_mask)
529 pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
530 if (!pdev->dev.dma_mask) {
531 pdev->platform_dma_mask = DMA_BIT_MASK(32);
532 pdev->dev.dma_mask = &pdev->platform_dma_mask;
537 * platform_device_put - destroy a platform device
538 * @pdev: platform device to free
540 * Free all memory associated with a platform device. This function must
541 * _only_ be externally called in error cases. All other usage is a bug.
543 void platform_device_put(struct platform_device *pdev)
545 if (!IS_ERR_OR_NULL(pdev))
546 put_device(&pdev->dev);
548 EXPORT_SYMBOL_GPL(platform_device_put);
550 static void platform_device_release(struct device *dev)
552 struct platform_object *pa = container_of(dev, struct platform_object,
555 of_node_put(pa->pdev.dev.of_node);
556 kfree(pa->pdev.dev.platform_data);
557 kfree(pa->pdev.mfd_cell);
558 kfree(pa->pdev.resource);
559 kfree(pa->pdev.driver_override);
564 * platform_device_alloc - create a platform device
565 * @name: base name of the device we're adding
568 * Create a platform device object which can have other objects attached
569 * to it, and which will have attached objects freed when it is released.
571 struct platform_device *platform_device_alloc(const char *name, int id)
573 struct platform_object *pa;
575 pa = kzalloc(sizeof(*pa) + strlen(name) + 1, GFP_KERNEL);
577 strcpy(pa->name, name);
578 pa->pdev.name = pa->name;
580 device_initialize(&pa->pdev.dev);
581 pa->pdev.dev.release = platform_device_release;
582 setup_pdev_dma_masks(&pa->pdev);
585 return pa ? &pa->pdev : NULL;
587 EXPORT_SYMBOL_GPL(platform_device_alloc);
590 * platform_device_add_resources - add resources to a platform device
591 * @pdev: platform device allocated by platform_device_alloc to add resources to
592 * @res: set of resources that needs to be allocated for the device
593 * @num: number of resources
595 * Add a copy of the resources to the platform device. The memory
596 * associated with the resources will be freed when the platform device is
599 int platform_device_add_resources(struct platform_device *pdev,
600 const struct resource *res, unsigned int num)
602 struct resource *r = NULL;
605 r = kmemdup(res, sizeof(struct resource) * num, GFP_KERNEL);
610 kfree(pdev->resource);
612 pdev->num_resources = num;
615 EXPORT_SYMBOL_GPL(platform_device_add_resources);
618 * platform_device_add_data - add platform-specific data to a platform device
619 * @pdev: platform device allocated by platform_device_alloc to add resources to
620 * @data: platform specific data for this platform device
621 * @size: size of platform specific data
623 * Add a copy of platform specific data to the platform device's
624 * platform_data pointer. The memory associated with the platform data
625 * will be freed when the platform device is released.
627 int platform_device_add_data(struct platform_device *pdev, const void *data,
633 d = kmemdup(data, size, GFP_KERNEL);
638 kfree(pdev->dev.platform_data);
639 pdev->dev.platform_data = d;
642 EXPORT_SYMBOL_GPL(platform_device_add_data);
645 * platform_device_add - add a platform device to device hierarchy
646 * @pdev: platform device we're adding
648 * This is part 2 of platform_device_register(), though may be called
649 * separately _iff_ pdev was allocated by platform_device_alloc().
651 int platform_device_add(struct platform_device *pdev)
659 if (!pdev->dev.parent)
660 pdev->dev.parent = &platform_bus;
662 pdev->dev.bus = &platform_bus_type;
666 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
668 case PLATFORM_DEVID_NONE:
669 dev_set_name(&pdev->dev, "%s", pdev->name);
671 case PLATFORM_DEVID_AUTO:
673 * Automatically allocated device ID. We mark it as such so
674 * that we remember it must be freed, and we append a suffix
675 * to avoid namespace collision with explicit IDs.
677 ret = ida_alloc(&platform_devid_ida, GFP_KERNEL);
681 pdev->id_auto = true;
682 dev_set_name(&pdev->dev, "%s.%d.auto", pdev->name, pdev->id);
686 for (i = 0; i < pdev->num_resources; i++) {
687 struct resource *p, *r = &pdev->resource[i];
690 r->name = dev_name(&pdev->dev);
694 if (resource_type(r) == IORESOURCE_MEM)
696 else if (resource_type(r) == IORESOURCE_IO)
697 p = &ioport_resource;
701 ret = insert_resource(p, r);
703 dev_err(&pdev->dev, "failed to claim resource %d: %pR\n", i, r);
709 pr_debug("Registering platform device '%s'. Parent at %s\n",
710 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
712 ret = device_add(&pdev->dev);
718 ida_free(&platform_devid_ida, pdev->id);
719 pdev->id = PLATFORM_DEVID_AUTO;
723 struct resource *r = &pdev->resource[i];
731 EXPORT_SYMBOL_GPL(platform_device_add);
734 * platform_device_del - remove a platform-level device
735 * @pdev: platform device we're removing
737 * Note that this function will also release all memory- and port-based
738 * resources owned by the device (@dev->resource). This function must
739 * _only_ be externally called in error cases. All other usage is a bug.
741 void platform_device_del(struct platform_device *pdev)
745 if (!IS_ERR_OR_NULL(pdev)) {
746 device_del(&pdev->dev);
749 ida_free(&platform_devid_ida, pdev->id);
750 pdev->id = PLATFORM_DEVID_AUTO;
753 for (i = 0; i < pdev->num_resources; i++) {
754 struct resource *r = &pdev->resource[i];
760 EXPORT_SYMBOL_GPL(platform_device_del);
763 * platform_device_register - add a platform-level device
764 * @pdev: platform device we're adding
766 int platform_device_register(struct platform_device *pdev)
768 device_initialize(&pdev->dev);
769 setup_pdev_dma_masks(pdev);
770 return platform_device_add(pdev);
772 EXPORT_SYMBOL_GPL(platform_device_register);
775 * platform_device_unregister - unregister a platform-level device
776 * @pdev: platform device we're unregistering
778 * Unregistration is done in 2 steps. First we release all resources
779 * and remove it from the subsystem, then we drop reference count by
780 * calling platform_device_put().
782 void platform_device_unregister(struct platform_device *pdev)
784 platform_device_del(pdev);
785 platform_device_put(pdev);
787 EXPORT_SYMBOL_GPL(platform_device_unregister);
790 * platform_device_register_full - add a platform-level device with
791 * resources and platform-specific data
793 * @pdevinfo: data used to create device
795 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
797 struct platform_device *platform_device_register_full(
798 const struct platform_device_info *pdevinfo)
801 struct platform_device *pdev;
803 pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
805 return ERR_PTR(-ENOMEM);
807 pdev->dev.parent = pdevinfo->parent;
808 pdev->dev.fwnode = pdevinfo->fwnode;
809 pdev->dev.of_node = of_node_get(to_of_node(pdev->dev.fwnode));
810 pdev->dev.of_node_reused = pdevinfo->of_node_reused;
812 if (pdevinfo->dma_mask) {
813 pdev->platform_dma_mask = pdevinfo->dma_mask;
814 pdev->dev.dma_mask = &pdev->platform_dma_mask;
815 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
818 ret = platform_device_add_resources(pdev,
819 pdevinfo->res, pdevinfo->num_res);
823 ret = platform_device_add_data(pdev,
824 pdevinfo->data, pdevinfo->size_data);
828 if (pdevinfo->properties) {
829 ret = device_create_managed_software_node(&pdev->dev,
830 pdevinfo->properties, NULL);
835 ret = platform_device_add(pdev);
838 ACPI_COMPANION_SET(&pdev->dev, NULL);
839 platform_device_put(pdev);
845 EXPORT_SYMBOL_GPL(platform_device_register_full);
848 * __platform_driver_register - register a driver for platform-level devices
849 * @drv: platform driver structure
850 * @owner: owning module/driver
852 int __platform_driver_register(struct platform_driver *drv,
853 struct module *owner)
855 drv->driver.owner = owner;
856 drv->driver.bus = &platform_bus_type;
858 return driver_register(&drv->driver);
860 EXPORT_SYMBOL_GPL(__platform_driver_register);
863 * platform_driver_unregister - unregister a driver for platform-level devices
864 * @drv: platform driver structure
866 void platform_driver_unregister(struct platform_driver *drv)
868 driver_unregister(&drv->driver);
870 EXPORT_SYMBOL_GPL(platform_driver_unregister);
872 static int platform_probe_fail(struct platform_device *pdev)
878 * __platform_driver_probe - register driver for non-hotpluggable device
879 * @drv: platform driver structure
880 * @probe: the driver probe routine, probably from an __init section
881 * @module: module which will be the owner of the driver
883 * Use this instead of platform_driver_register() when you know the device
884 * is not hotpluggable and has already been registered, and you want to
885 * remove its run-once probe() infrastructure from memory after the driver
886 * has bound to the device.
888 * One typical use for this would be with drivers for controllers integrated
889 * into system-on-chip processors, where the controller devices have been
890 * configured as part of board setup.
892 * Note that this is incompatible with deferred probing.
894 * Returns zero if the driver registered and bound to a device, else returns
895 * a negative error code and with the driver not registered.
897 int __init_or_module __platform_driver_probe(struct platform_driver *drv,
898 int (*probe)(struct platform_device *), struct module *module)
902 if (drv->driver.probe_type == PROBE_PREFER_ASYNCHRONOUS) {
903 pr_err("%s: drivers registered with %s can not be probed asynchronously\n",
904 drv->driver.name, __func__);
909 * We have to run our probes synchronously because we check if
910 * we find any devices to bind to and exit with error if there
913 drv->driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
916 * Prevent driver from requesting probe deferral to avoid further
917 * futile probe attempts.
919 drv->prevent_deferred_probe = true;
921 /* make sure driver won't have bind/unbind attributes */
922 drv->driver.suppress_bind_attrs = true;
924 /* temporary section violation during probe() */
926 retval = code = __platform_driver_register(drv, module);
931 * Fixup that section violation, being paranoid about code scanning
932 * the list of drivers in order to probe new devices. Check to see
933 * if the probe was successful, and make sure any forced probes of
936 spin_lock(&drv->driver.bus->p->klist_drivers.k_lock);
937 drv->probe = platform_probe_fail;
938 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
940 spin_unlock(&drv->driver.bus->p->klist_drivers.k_lock);
943 platform_driver_unregister(drv);
946 EXPORT_SYMBOL_GPL(__platform_driver_probe);
949 * __platform_create_bundle - register driver and create corresponding device
950 * @driver: platform driver structure
951 * @probe: the driver probe routine, probably from an __init section
952 * @res: set of resources that needs to be allocated for the device
953 * @n_res: number of resources
954 * @data: platform specific data for this platform device
955 * @size: size of platform specific data
956 * @module: module which will be the owner of the driver
958 * Use this in legacy-style modules that probe hardware directly and
959 * register a single platform device and corresponding platform driver.
961 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
963 struct platform_device * __init_or_module __platform_create_bundle(
964 struct platform_driver *driver,
965 int (*probe)(struct platform_device *),
966 struct resource *res, unsigned int n_res,
967 const void *data, size_t size, struct module *module)
969 struct platform_device *pdev;
972 pdev = platform_device_alloc(driver->driver.name, -1);
978 error = platform_device_add_resources(pdev, res, n_res);
982 error = platform_device_add_data(pdev, data, size);
986 error = platform_device_add(pdev);
990 error = __platform_driver_probe(driver, probe, module);
997 platform_device_del(pdev);
999 platform_device_put(pdev);
1001 return ERR_PTR(error);
1003 EXPORT_SYMBOL_GPL(__platform_create_bundle);
1006 * __platform_register_drivers - register an array of platform drivers
1007 * @drivers: an array of drivers to register
1008 * @count: the number of drivers to register
1009 * @owner: module owning the drivers
1011 * Registers platform drivers specified by an array. On failure to register a
1012 * driver, all previously registered drivers will be unregistered. Callers of
1013 * this API should use platform_unregister_drivers() to unregister drivers in
1014 * the reverse order.
1016 * Returns: 0 on success or a negative error code on failure.
1018 int __platform_register_drivers(struct platform_driver * const *drivers,
1019 unsigned int count, struct module *owner)
1024 for (i = 0; i < count; i++) {
1025 pr_debug("registering platform driver %ps\n", drivers[i]);
1027 err = __platform_driver_register(drivers[i], owner);
1029 pr_err("failed to register platform driver %ps: %d\n",
1039 pr_debug("unregistering platform driver %ps\n", drivers[i]);
1040 platform_driver_unregister(drivers[i]);
1045 EXPORT_SYMBOL_GPL(__platform_register_drivers);
1048 * platform_unregister_drivers - unregister an array of platform drivers
1049 * @drivers: an array of drivers to unregister
1050 * @count: the number of drivers to unregister
1052 * Unregisters platform drivers specified by an array. This is typically used
1053 * to complement an earlier call to platform_register_drivers(). Drivers are
1054 * unregistered in the reverse order in which they were registered.
1056 void platform_unregister_drivers(struct platform_driver * const *drivers,
1060 pr_debug("unregistering platform driver %ps\n", drivers[count]);
1061 platform_driver_unregister(drivers[count]);
1064 EXPORT_SYMBOL_GPL(platform_unregister_drivers);
1066 static const struct platform_device_id *platform_match_id(
1067 const struct platform_device_id *id,
1068 struct platform_device *pdev)
1070 while (id->name[0]) {
1071 if (strcmp(pdev->name, id->name) == 0) {
1072 pdev->id_entry = id;
1080 #ifdef CONFIG_PM_SLEEP
1082 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
1084 struct platform_driver *pdrv = to_platform_driver(dev->driver);
1085 struct platform_device *pdev = to_platform_device(dev);
1088 if (dev->driver && pdrv->suspend)
1089 ret = pdrv->suspend(pdev, mesg);
1094 static int platform_legacy_resume(struct device *dev)
1096 struct platform_driver *pdrv = to_platform_driver(dev->driver);
1097 struct platform_device *pdev = to_platform_device(dev);
1100 if (dev->driver && pdrv->resume)
1101 ret = pdrv->resume(pdev);
1106 #endif /* CONFIG_PM_SLEEP */
1108 #ifdef CONFIG_SUSPEND
1110 int platform_pm_suspend(struct device *dev)
1112 struct device_driver *drv = dev->driver;
1119 if (drv->pm->suspend)
1120 ret = drv->pm->suspend(dev);
1122 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
1128 int platform_pm_resume(struct device *dev)
1130 struct device_driver *drv = dev->driver;
1137 if (drv->pm->resume)
1138 ret = drv->pm->resume(dev);
1140 ret = platform_legacy_resume(dev);
1146 #endif /* CONFIG_SUSPEND */
1148 #ifdef CONFIG_HIBERNATE_CALLBACKS
1150 int platform_pm_freeze(struct device *dev)
1152 struct device_driver *drv = dev->driver;
1159 if (drv->pm->freeze)
1160 ret = drv->pm->freeze(dev);
1162 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
1168 int platform_pm_thaw(struct device *dev)
1170 struct device_driver *drv = dev->driver;
1178 ret = drv->pm->thaw(dev);
1180 ret = platform_legacy_resume(dev);
1186 int platform_pm_poweroff(struct device *dev)
1188 struct device_driver *drv = dev->driver;
1195 if (drv->pm->poweroff)
1196 ret = drv->pm->poweroff(dev);
1198 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
1204 int platform_pm_restore(struct device *dev)
1206 struct device_driver *drv = dev->driver;
1213 if (drv->pm->restore)
1214 ret = drv->pm->restore(dev);
1216 ret = platform_legacy_resume(dev);
1222 #endif /* CONFIG_HIBERNATE_CALLBACKS */
1224 /* modalias support enables more hands-off userspace setup:
1225 * (a) environment variable lets new-style hotplug events work once system is
1226 * fully running: "modprobe $MODALIAS"
1227 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
1228 * mishandled before system is fully running: "modprobe $(cat modalias)"
1230 static ssize_t modalias_show(struct device *dev,
1231 struct device_attribute *attr, char *buf)
1233 struct platform_device *pdev = to_platform_device(dev);
1236 len = of_device_modalias(dev, buf, PAGE_SIZE);
1240 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
1244 return sysfs_emit(buf, "platform:%s\n", pdev->name);
1246 static DEVICE_ATTR_RO(modalias);
1248 static ssize_t numa_node_show(struct device *dev,
1249 struct device_attribute *attr, char *buf)
1251 return sysfs_emit(buf, "%d\n", dev_to_node(dev));
1253 static DEVICE_ATTR_RO(numa_node);
1255 static ssize_t driver_override_show(struct device *dev,
1256 struct device_attribute *attr, char *buf)
1258 struct platform_device *pdev = to_platform_device(dev);
1262 len = sysfs_emit(buf, "%s\n", pdev->driver_override);
1268 static ssize_t driver_override_store(struct device *dev,
1269 struct device_attribute *attr,
1270 const char *buf, size_t count)
1272 struct platform_device *pdev = to_platform_device(dev);
1273 char *driver_override, *old, *cp;
1275 /* We need to keep extra room for a newline */
1276 if (count >= (PAGE_SIZE - 1))
1279 driver_override = kstrndup(buf, count, GFP_KERNEL);
1280 if (!driver_override)
1283 cp = strchr(driver_override, '\n');
1288 old = pdev->driver_override;
1289 if (strlen(driver_override)) {
1290 pdev->driver_override = driver_override;
1292 kfree(driver_override);
1293 pdev->driver_override = NULL;
1301 static DEVICE_ATTR_RW(driver_override);
1303 static struct attribute *platform_dev_attrs[] = {
1304 &dev_attr_modalias.attr,
1305 &dev_attr_numa_node.attr,
1306 &dev_attr_driver_override.attr,
1310 static umode_t platform_dev_attrs_visible(struct kobject *kobj, struct attribute *a,
1313 struct device *dev = container_of(kobj, typeof(*dev), kobj);
1315 if (a == &dev_attr_numa_node.attr &&
1316 dev_to_node(dev) == NUMA_NO_NODE)
1322 static const struct attribute_group platform_dev_group = {
1323 .attrs = platform_dev_attrs,
1324 .is_visible = platform_dev_attrs_visible,
1326 __ATTRIBUTE_GROUPS(platform_dev);
1330 * platform_match - bind platform device to platform driver.
1334 * Platform device IDs are assumed to be encoded like this:
1335 * "<name><instance>", where <name> is a short description of the type of
1336 * device, like "pci" or "floppy", and <instance> is the enumerated
1337 * instance of the device, like '0' or '42'. Driver IDs are simply
1338 * "<name>". So, extract the <name> from the platform_device structure,
1339 * and compare it against the name of the driver. Return whether they match
1342 static int platform_match(struct device *dev, struct device_driver *drv)
1344 struct platform_device *pdev = to_platform_device(dev);
1345 struct platform_driver *pdrv = to_platform_driver(drv);
1347 /* When driver_override is set, only bind to the matching driver */
1348 if (pdev->driver_override)
1349 return !strcmp(pdev->driver_override, drv->name);
1351 /* Attempt an OF style match first */
1352 if (of_driver_match_device(dev, drv))
1355 /* Then try ACPI style match */
1356 if (acpi_driver_match_device(dev, drv))
1359 /* Then try to match against the id table */
1361 return platform_match_id(pdrv->id_table, pdev) != NULL;
1363 /* fall-back to driver name match */
1364 return (strcmp(pdev->name, drv->name) == 0);
1367 static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
1369 struct platform_device *pdev = to_platform_device(dev);
1372 /* Some devices have extra OF data and an OF-style MODALIAS */
1373 rc = of_device_uevent_modalias(dev, env);
1377 rc = acpi_device_uevent_modalias(dev, env);
1381 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
1386 static int platform_probe(struct device *_dev)
1388 struct platform_driver *drv = to_platform_driver(_dev->driver);
1389 struct platform_device *dev = to_platform_device(_dev);
1393 * A driver registered using platform_driver_probe() cannot be bound
1394 * again later because the probe function usually lives in __init code
1395 * and so is gone. For these drivers .probe is set to
1396 * platform_probe_fail in __platform_driver_probe(). Don't even prepare
1397 * clocks and PM domains for these to match the traditional behaviour.
1399 if (unlikely(drv->probe == platform_probe_fail))
1402 ret = of_clk_set_defaults(_dev->of_node, false);
1406 ret = dev_pm_domain_attach(_dev, true);
1411 ret = drv->probe(dev);
1413 dev_pm_domain_detach(_dev, true);
1417 if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
1418 dev_warn(_dev, "probe deferral not supported\n");
1425 static void platform_remove(struct device *_dev)
1427 struct platform_driver *drv = to_platform_driver(_dev->driver);
1428 struct platform_device *dev = to_platform_device(_dev);
1431 int ret = drv->remove(dev);
1434 dev_warn(_dev, "remove callback returned a non-zero value. This will be ignored.\n");
1436 dev_pm_domain_detach(_dev, true);
1439 static void platform_shutdown(struct device *_dev)
1441 struct platform_device *dev = to_platform_device(_dev);
1442 struct platform_driver *drv;
1447 drv = to_platform_driver(_dev->driver);
1453 int platform_dma_configure(struct device *dev)
1455 enum dev_dma_attr attr;
1459 ret = of_dma_configure(dev, dev->of_node, true);
1460 } else if (has_acpi_companion(dev)) {
1461 attr = acpi_get_dma_attr(to_acpi_device_node(dev->fwnode));
1462 ret = acpi_dma_configure(dev, attr);
1468 static const struct dev_pm_ops platform_dev_pm_ops = {
1469 .runtime_suspend = pm_generic_runtime_suspend,
1470 .runtime_resume = pm_generic_runtime_resume,
1471 USE_PLATFORM_PM_SLEEP_OPS
1474 struct bus_type platform_bus_type = {
1476 .dev_groups = platform_dev_groups,
1477 .match = platform_match,
1478 .uevent = platform_uevent,
1479 .probe = platform_probe,
1480 .remove = platform_remove,
1481 .shutdown = platform_shutdown,
1482 .dma_configure = platform_dma_configure,
1483 .pm = &platform_dev_pm_ops,
1485 EXPORT_SYMBOL_GPL(platform_bus_type);
1487 static inline int __platform_match(struct device *dev, const void *drv)
1489 return platform_match(dev, (struct device_driver *)drv);
1493 * platform_find_device_by_driver - Find a platform device with a given
1495 * @start: The device to start the search from.
1496 * @drv: The device driver to look for.
1498 struct device *platform_find_device_by_driver(struct device *start,
1499 const struct device_driver *drv)
1501 return bus_find_device(&platform_bus_type, start, drv,
1504 EXPORT_SYMBOL_GPL(platform_find_device_by_driver);
1506 void __weak __init early_platform_cleanup(void) { }
1508 int __init platform_bus_init(void)
1512 early_platform_cleanup();
1514 error = device_register(&platform_bus);
1516 put_device(&platform_bus);
1519 error = bus_register(&platform_bus_type);
1521 device_unregister(&platform_bus);
1522 of_platform_register_reconfig_notifier();