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-model/platform.txt 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/dma-mapping.h>
19 #include <linux/bootmem.h>
20 #include <linux/err.h>
21 #include <linux/slab.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/pm_domain.h>
24 #include <linux/idr.h>
25 #include <linux/acpi.h>
26 #include <linux/clk/clk-conf.h>
27 #include <linux/limits.h>
28 #include <linux/property.h>
29 #include <linux/kmemleak.h>
30 #include <linux/types.h>
33 #include "power/power.h"
35 /* For automatically allocated device IDs */
36 static DEFINE_IDA(platform_devid_ida);
38 struct device platform_bus = {
39 .init_name = "platform",
41 EXPORT_SYMBOL_GPL(platform_bus);
44 * arch_setup_pdev_archdata - Allow manipulation of archdata before its used
45 * @pdev: platform device
47 * This is called before platform_device_add() such that any pdev_archdata may
48 * be setup before the platform_notifier is called. So if a user needs to
49 * manipulate any relevant information in the pdev_archdata they can do:
51 * platform_device_alloc()
53 * platform_device_add()
55 * And if they don't care they can just call platform_device_register() and
56 * everything will just work out.
58 void __weak arch_setup_pdev_archdata(struct platform_device *pdev)
63 * platform_get_resource - get a resource for a device
64 * @dev: platform device
65 * @type: resource type
66 * @num: resource index
68 struct resource *platform_get_resource(struct platform_device *dev,
69 unsigned int type, unsigned int num)
73 for (i = 0; i < dev->num_resources; i++) {
74 struct resource *r = &dev->resource[i];
76 if (type == resource_type(r) && num-- == 0)
81 EXPORT_SYMBOL_GPL(platform_get_resource);
84 * platform_get_irq - get an IRQ for a device
85 * @dev: platform device
86 * @num: IRQ number index
88 int platform_get_irq(struct platform_device *dev, unsigned int num)
91 /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
92 if (!dev || num >= dev->archdata.num_irqs)
94 return dev->archdata.irqs[num];
97 if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node) {
100 ret = of_irq_get(dev->dev.of_node, num);
101 if (ret > 0 || ret == -EPROBE_DEFER)
105 r = platform_get_resource(dev, IORESOURCE_IRQ, num);
106 if (has_acpi_companion(&dev->dev)) {
107 if (r && r->flags & IORESOURCE_DISABLED) {
110 ret = acpi_irq_get(ACPI_HANDLE(&dev->dev), num, r);
117 * The resources may pass trigger flags to the irqs that need
118 * to be set up. It so happens that the trigger flags for
119 * IORESOURCE_BITS correspond 1-to-1 to the IRQF_TRIGGER*
122 if (r && r->flags & IORESOURCE_BITS) {
123 struct irq_data *irqd;
125 irqd = irq_get_irq_data(r->start);
128 irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS);
131 return r ? r->start : -ENXIO;
134 EXPORT_SYMBOL_GPL(platform_get_irq);
137 * platform_irq_count - Count the number of IRQs a platform device uses
138 * @dev: platform device
140 * Return: Number of IRQs a platform device uses or EPROBE_DEFER
142 int platform_irq_count(struct platform_device *dev)
146 while ((ret = platform_get_irq(dev, nr)) >= 0)
149 if (ret == -EPROBE_DEFER)
154 EXPORT_SYMBOL_GPL(platform_irq_count);
157 * platform_get_resource_byname - get a resource for a device by name
158 * @dev: platform device
159 * @type: resource type
160 * @name: resource name
162 struct resource *platform_get_resource_byname(struct platform_device *dev,
168 for (i = 0; i < dev->num_resources; i++) {
169 struct resource *r = &dev->resource[i];
171 if (unlikely(!r->name))
174 if (type == resource_type(r) && !strcmp(r->name, name))
179 EXPORT_SYMBOL_GPL(platform_get_resource_byname);
182 * platform_get_irq_byname - get an IRQ for a device by name
183 * @dev: platform device
186 int platform_get_irq_byname(struct platform_device *dev, const char *name)
190 if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node) {
193 ret = of_irq_get_byname(dev->dev.of_node, name);
194 if (ret > 0 || ret == -EPROBE_DEFER)
198 r = platform_get_resource_byname(dev, IORESOURCE_IRQ, name);
199 return r ? r->start : -ENXIO;
201 EXPORT_SYMBOL_GPL(platform_get_irq_byname);
204 * platform_add_devices - add a numbers of platform devices
205 * @devs: array of platform devices to add
206 * @num: number of platform devices in array
208 int platform_add_devices(struct platform_device **devs, int num)
212 for (i = 0; i < num; i++) {
213 ret = platform_device_register(devs[i]);
216 platform_device_unregister(devs[i]);
223 EXPORT_SYMBOL_GPL(platform_add_devices);
225 struct platform_object {
226 struct platform_device pdev;
231 * platform_device_put - destroy a platform device
232 * @pdev: platform device to free
234 * Free all memory associated with a platform device. This function must
235 * _only_ be externally called in error cases. All other usage is a bug.
237 void platform_device_put(struct platform_device *pdev)
240 put_device(&pdev->dev);
242 EXPORT_SYMBOL_GPL(platform_device_put);
244 static void platform_device_release(struct device *dev)
246 struct platform_object *pa = container_of(dev, struct platform_object,
249 of_device_node_put(&pa->pdev.dev);
250 kfree(pa->pdev.dev.platform_data);
251 kfree(pa->pdev.mfd_cell);
252 kfree(pa->pdev.resource);
253 kfree(pa->pdev.driver_override);
258 * platform_device_alloc - create a platform device
259 * @name: base name of the device we're adding
262 * Create a platform device object which can have other objects attached
263 * to it, and which will have attached objects freed when it is released.
265 struct platform_device *platform_device_alloc(const char *name, int id)
267 struct platform_object *pa;
269 pa = kzalloc(sizeof(*pa) + strlen(name) + 1, GFP_KERNEL);
271 strcpy(pa->name, name);
272 pa->pdev.name = pa->name;
274 device_initialize(&pa->pdev.dev);
275 pa->pdev.dev.release = platform_device_release;
276 arch_setup_pdev_archdata(&pa->pdev);
279 return pa ? &pa->pdev : NULL;
281 EXPORT_SYMBOL_GPL(platform_device_alloc);
284 * platform_device_add_resources - add resources to a platform device
285 * @pdev: platform device allocated by platform_device_alloc to add resources to
286 * @res: set of resources that needs to be allocated for the device
287 * @num: number of resources
289 * Add a copy of the resources to the platform device. The memory
290 * associated with the resources will be freed when the platform device is
293 int platform_device_add_resources(struct platform_device *pdev,
294 const struct resource *res, unsigned int num)
296 struct resource *r = NULL;
299 r = kmemdup(res, sizeof(struct resource) * num, GFP_KERNEL);
304 kfree(pdev->resource);
306 pdev->num_resources = num;
309 EXPORT_SYMBOL_GPL(platform_device_add_resources);
312 * platform_device_add_data - add platform-specific data to a platform device
313 * @pdev: platform device allocated by platform_device_alloc to add resources to
314 * @data: platform specific data for this platform device
315 * @size: size of platform specific data
317 * Add a copy of platform specific data to the platform device's
318 * platform_data pointer. The memory associated with the platform data
319 * will be freed when the platform device is released.
321 int platform_device_add_data(struct platform_device *pdev, const void *data,
327 d = kmemdup(data, size, GFP_KERNEL);
332 kfree(pdev->dev.platform_data);
333 pdev->dev.platform_data = d;
336 EXPORT_SYMBOL_GPL(platform_device_add_data);
339 * platform_device_add_properties - add built-in properties to a platform device
340 * @pdev: platform device to add properties to
341 * @properties: null terminated array of properties to add
343 * The function will take deep copy of @properties and attach the copy to the
344 * platform device. The memory associated with properties will be freed when the
345 * platform device is released.
347 int platform_device_add_properties(struct platform_device *pdev,
348 const struct property_entry *properties)
350 return device_add_properties(&pdev->dev, properties);
352 EXPORT_SYMBOL_GPL(platform_device_add_properties);
355 * platform_device_add - add a platform device to device hierarchy
356 * @pdev: platform device we're adding
358 * This is part 2 of platform_device_register(), though may be called
359 * separately _iff_ pdev was allocated by platform_device_alloc().
361 int platform_device_add(struct platform_device *pdev)
369 if (!pdev->dev.parent)
370 pdev->dev.parent = &platform_bus;
372 pdev->dev.bus = &platform_bus_type;
376 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
378 case PLATFORM_DEVID_NONE:
379 dev_set_name(&pdev->dev, "%s", pdev->name);
381 case PLATFORM_DEVID_AUTO:
383 * Automatically allocated device ID. We mark it as such so
384 * that we remember it must be freed, and we append a suffix
385 * to avoid namespace collision with explicit IDs.
387 ret = ida_simple_get(&platform_devid_ida, 0, 0, GFP_KERNEL);
391 pdev->id_auto = true;
392 dev_set_name(&pdev->dev, "%s.%d.auto", pdev->name, pdev->id);
396 for (i = 0; i < pdev->num_resources; i++) {
397 struct resource *p, *r = &pdev->resource[i];
400 r->name = dev_name(&pdev->dev);
404 if (resource_type(r) == IORESOURCE_MEM)
406 else if (resource_type(r) == IORESOURCE_IO)
407 p = &ioport_resource;
410 if (p && insert_resource(p, r)) {
411 dev_err(&pdev->dev, "failed to claim resource %d: %pR\n", i, r);
417 pr_debug("Registering platform device '%s'. Parent at %s\n",
418 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
420 ret = device_add(&pdev->dev);
426 ida_simple_remove(&platform_devid_ida, pdev->id);
427 pdev->id = PLATFORM_DEVID_AUTO;
431 struct resource *r = &pdev->resource[i];
439 EXPORT_SYMBOL_GPL(platform_device_add);
442 * platform_device_del - remove a platform-level device
443 * @pdev: platform device we're removing
445 * Note that this function will also release all memory- and port-based
446 * resources owned by the device (@dev->resource). This function must
447 * _only_ be externally called in error cases. All other usage is a bug.
449 void platform_device_del(struct platform_device *pdev)
454 device_remove_properties(&pdev->dev);
455 device_del(&pdev->dev);
458 ida_simple_remove(&platform_devid_ida, pdev->id);
459 pdev->id = PLATFORM_DEVID_AUTO;
462 for (i = 0; i < pdev->num_resources; i++) {
463 struct resource *r = &pdev->resource[i];
469 EXPORT_SYMBOL_GPL(platform_device_del);
472 * platform_device_register - add a platform-level device
473 * @pdev: platform device we're adding
475 int platform_device_register(struct platform_device *pdev)
477 device_initialize(&pdev->dev);
478 arch_setup_pdev_archdata(pdev);
479 return platform_device_add(pdev);
481 EXPORT_SYMBOL_GPL(platform_device_register);
484 * platform_device_unregister - unregister a platform-level device
485 * @pdev: platform device we're unregistering
487 * Unregistration is done in 2 steps. First we release all resources
488 * and remove it from the subsystem, then we drop reference count by
489 * calling platform_device_put().
491 void platform_device_unregister(struct platform_device *pdev)
493 platform_device_del(pdev);
494 platform_device_put(pdev);
496 EXPORT_SYMBOL_GPL(platform_device_unregister);
499 * platform_device_register_full - add a platform-level device with
500 * resources and platform-specific data
502 * @pdevinfo: data used to create device
504 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
506 struct platform_device *platform_device_register_full(
507 const struct platform_device_info *pdevinfo)
510 struct platform_device *pdev;
512 pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
516 pdev->dev.parent = pdevinfo->parent;
517 pdev->dev.fwnode = pdevinfo->fwnode;
519 if (pdevinfo->dma_mask) {
521 * This memory isn't freed when the device is put,
522 * I don't have a nice idea for that though. Conceptually
523 * dma_mask in struct device should not be a pointer.
524 * See http://thread.gmane.org/gmane.linux.kernel.pci/9081
527 kmalloc(sizeof(*pdev->dev.dma_mask), GFP_KERNEL);
528 if (!pdev->dev.dma_mask)
531 kmemleak_ignore(pdev->dev.dma_mask);
533 *pdev->dev.dma_mask = pdevinfo->dma_mask;
534 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
537 ret = platform_device_add_resources(pdev,
538 pdevinfo->res, pdevinfo->num_res);
542 ret = platform_device_add_data(pdev,
543 pdevinfo->data, pdevinfo->size_data);
547 if (pdevinfo->properties) {
548 ret = platform_device_add_properties(pdev,
549 pdevinfo->properties);
554 ret = platform_device_add(pdev);
557 ACPI_COMPANION_SET(&pdev->dev, NULL);
558 kfree(pdev->dev.dma_mask);
561 platform_device_put(pdev);
567 EXPORT_SYMBOL_GPL(platform_device_register_full);
569 static int platform_drv_probe(struct device *_dev)
571 struct platform_driver *drv = to_platform_driver(_dev->driver);
572 struct platform_device *dev = to_platform_device(_dev);
575 ret = of_clk_set_defaults(_dev->of_node, false);
579 ret = dev_pm_domain_attach(_dev, true);
584 ret = drv->probe(dev);
586 dev_pm_domain_detach(_dev, true);
590 if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
591 dev_warn(_dev, "probe deferral not supported\n");
598 static int platform_drv_probe_fail(struct device *_dev)
603 static int platform_drv_remove(struct device *_dev)
605 struct platform_driver *drv = to_platform_driver(_dev->driver);
606 struct platform_device *dev = to_platform_device(_dev);
610 ret = drv->remove(dev);
611 dev_pm_domain_detach(_dev, true);
616 static void platform_drv_shutdown(struct device *_dev)
618 struct platform_driver *drv = to_platform_driver(_dev->driver);
619 struct platform_device *dev = to_platform_device(_dev);
626 * __platform_driver_register - register a driver for platform-level devices
627 * @drv: platform driver structure
628 * @owner: owning module/driver
630 int __platform_driver_register(struct platform_driver *drv,
631 struct module *owner)
633 drv->driver.owner = owner;
634 drv->driver.bus = &platform_bus_type;
635 drv->driver.probe = platform_drv_probe;
636 drv->driver.remove = platform_drv_remove;
637 drv->driver.shutdown = platform_drv_shutdown;
639 return driver_register(&drv->driver);
641 EXPORT_SYMBOL_GPL(__platform_driver_register);
644 * platform_driver_unregister - unregister a driver for platform-level devices
645 * @drv: platform driver structure
647 void platform_driver_unregister(struct platform_driver *drv)
649 driver_unregister(&drv->driver);
651 EXPORT_SYMBOL_GPL(platform_driver_unregister);
654 * __platform_driver_probe - register driver for non-hotpluggable device
655 * @drv: platform driver structure
656 * @probe: the driver probe routine, probably from an __init section
657 * @module: module which will be the owner of the driver
659 * Use this instead of platform_driver_register() when you know the device
660 * is not hotpluggable and has already been registered, and you want to
661 * remove its run-once probe() infrastructure from memory after the driver
662 * has bound to the device.
664 * One typical use for this would be with drivers for controllers integrated
665 * into system-on-chip processors, where the controller devices have been
666 * configured as part of board setup.
668 * Note that this is incompatible with deferred probing.
670 * Returns zero if the driver registered and bound to a device, else returns
671 * a negative error code and with the driver not registered.
673 int __init_or_module __platform_driver_probe(struct platform_driver *drv,
674 int (*probe)(struct platform_device *), struct module *module)
678 if (drv->driver.probe_type == PROBE_PREFER_ASYNCHRONOUS) {
679 pr_err("%s: drivers registered with %s can not be probed asynchronously\n",
680 drv->driver.name, __func__);
685 * We have to run our probes synchronously because we check if
686 * we find any devices to bind to and exit with error if there
689 drv->driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
692 * Prevent driver from requesting probe deferral to avoid further
693 * futile probe attempts.
695 drv->prevent_deferred_probe = true;
697 /* make sure driver won't have bind/unbind attributes */
698 drv->driver.suppress_bind_attrs = true;
700 /* temporary section violation during probe() */
702 retval = code = __platform_driver_register(drv, module);
707 * Fixup that section violation, being paranoid about code scanning
708 * the list of drivers in order to probe new devices. Check to see
709 * if the probe was successful, and make sure any forced probes of
712 spin_lock(&drv->driver.bus->p->klist_drivers.k_lock);
714 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
716 drv->driver.probe = platform_drv_probe_fail;
717 spin_unlock(&drv->driver.bus->p->klist_drivers.k_lock);
720 platform_driver_unregister(drv);
723 EXPORT_SYMBOL_GPL(__platform_driver_probe);
726 * __platform_create_bundle - register driver and create corresponding device
727 * @driver: platform driver structure
728 * @probe: the driver probe routine, probably from an __init section
729 * @res: set of resources that needs to be allocated for the device
730 * @n_res: number of resources
731 * @data: platform specific data for this platform device
732 * @size: size of platform specific data
733 * @module: module which will be the owner of the driver
735 * Use this in legacy-style modules that probe hardware directly and
736 * register a single platform device and corresponding platform driver.
738 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
740 struct platform_device * __init_or_module __platform_create_bundle(
741 struct platform_driver *driver,
742 int (*probe)(struct platform_device *),
743 struct resource *res, unsigned int n_res,
744 const void *data, size_t size, struct module *module)
746 struct platform_device *pdev;
749 pdev = platform_device_alloc(driver->driver.name, -1);
755 error = platform_device_add_resources(pdev, res, n_res);
759 error = platform_device_add_data(pdev, data, size);
763 error = platform_device_add(pdev);
767 error = __platform_driver_probe(driver, probe, module);
774 platform_device_del(pdev);
776 platform_device_put(pdev);
778 return ERR_PTR(error);
780 EXPORT_SYMBOL_GPL(__platform_create_bundle);
783 * __platform_register_drivers - register an array of platform drivers
784 * @drivers: an array of drivers to register
785 * @count: the number of drivers to register
786 * @owner: module owning the drivers
788 * Registers platform drivers specified by an array. On failure to register a
789 * driver, all previously registered drivers will be unregistered. Callers of
790 * this API should use platform_unregister_drivers() to unregister drivers in
793 * Returns: 0 on success or a negative error code on failure.
795 int __platform_register_drivers(struct platform_driver * const *drivers,
796 unsigned int count, struct module *owner)
801 for (i = 0; i < count; i++) {
802 pr_debug("registering platform driver %ps\n", drivers[i]);
804 err = __platform_driver_register(drivers[i], owner);
806 pr_err("failed to register platform driver %ps: %d\n",
816 pr_debug("unregistering platform driver %ps\n", drivers[i]);
817 platform_driver_unregister(drivers[i]);
822 EXPORT_SYMBOL_GPL(__platform_register_drivers);
825 * platform_unregister_drivers - unregister an array of platform drivers
826 * @drivers: an array of drivers to unregister
827 * @count: the number of drivers to unregister
829 * Unegisters platform drivers specified by an array. This is typically used
830 * to complement an earlier call to platform_register_drivers(). Drivers are
831 * unregistered in the reverse order in which they were registered.
833 void platform_unregister_drivers(struct platform_driver * const *drivers,
837 pr_debug("unregistering platform driver %ps\n", drivers[count]);
838 platform_driver_unregister(drivers[count]);
841 EXPORT_SYMBOL_GPL(platform_unregister_drivers);
843 /* modalias support enables more hands-off userspace setup:
844 * (a) environment variable lets new-style hotplug events work once system is
845 * fully running: "modprobe $MODALIAS"
846 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
847 * mishandled before system is fully running: "modprobe $(cat modalias)"
849 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
852 struct platform_device *pdev = to_platform_device(dev);
855 len = of_device_modalias(dev, buf, PAGE_SIZE);
859 len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
863 len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
865 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
867 static DEVICE_ATTR_RO(modalias);
869 static ssize_t driver_override_store(struct device *dev,
870 struct device_attribute *attr,
871 const char *buf, size_t count)
873 struct platform_device *pdev = to_platform_device(dev);
874 char *driver_override, *old, *cp;
876 /* We need to keep extra room for a newline */
877 if (count >= (PAGE_SIZE - 1))
880 driver_override = kstrndup(buf, count, GFP_KERNEL);
881 if (!driver_override)
884 cp = strchr(driver_override, '\n');
889 old = pdev->driver_override;
890 if (strlen(driver_override)) {
891 pdev->driver_override = driver_override;
893 kfree(driver_override);
894 pdev->driver_override = NULL;
903 static ssize_t driver_override_show(struct device *dev,
904 struct device_attribute *attr, char *buf)
906 struct platform_device *pdev = to_platform_device(dev);
910 len = sprintf(buf, "%s\n", pdev->driver_override);
914 static DEVICE_ATTR_RW(driver_override);
917 static struct attribute *platform_dev_attrs[] = {
918 &dev_attr_modalias.attr,
919 &dev_attr_driver_override.attr,
922 ATTRIBUTE_GROUPS(platform_dev);
924 static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
926 struct platform_device *pdev = to_platform_device(dev);
929 /* Some devices have extra OF data and an OF-style MODALIAS */
930 rc = of_device_uevent_modalias(dev, env);
934 rc = acpi_device_uevent_modalias(dev, env);
938 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
943 static const struct platform_device_id *platform_match_id(
944 const struct platform_device_id *id,
945 struct platform_device *pdev)
947 while (id->name[0]) {
948 if (strcmp(pdev->name, id->name) == 0) {
958 * platform_match - bind platform device to platform driver.
962 * Platform device IDs are assumed to be encoded like this:
963 * "<name><instance>", where <name> is a short description of the type of
964 * device, like "pci" or "floppy", and <instance> is the enumerated
965 * instance of the device, like '0' or '42'. Driver IDs are simply
966 * "<name>". So, extract the <name> from the platform_device structure,
967 * and compare it against the name of the driver. Return whether they match
970 static int platform_match(struct device *dev, struct device_driver *drv)
972 struct platform_device *pdev = to_platform_device(dev);
973 struct platform_driver *pdrv = to_platform_driver(drv);
975 /* When driver_override is set, only bind to the matching driver */
976 if (pdev->driver_override)
977 return !strcmp(pdev->driver_override, drv->name);
979 /* Attempt an OF style match first */
980 if (of_driver_match_device(dev, drv))
983 /* Then try ACPI style match */
984 if (acpi_driver_match_device(dev, drv))
987 /* Then try to match against the id table */
989 return platform_match_id(pdrv->id_table, pdev) != NULL;
991 /* fall-back to driver name match */
992 return (strcmp(pdev->name, drv->name) == 0);
995 #ifdef CONFIG_PM_SLEEP
997 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
999 struct platform_driver *pdrv = to_platform_driver(dev->driver);
1000 struct platform_device *pdev = to_platform_device(dev);
1003 if (dev->driver && pdrv->suspend)
1004 ret = pdrv->suspend(pdev, mesg);
1009 static int platform_legacy_resume(struct device *dev)
1011 struct platform_driver *pdrv = to_platform_driver(dev->driver);
1012 struct platform_device *pdev = to_platform_device(dev);
1015 if (dev->driver && pdrv->resume)
1016 ret = pdrv->resume(pdev);
1021 #endif /* CONFIG_PM_SLEEP */
1023 #ifdef CONFIG_SUSPEND
1025 int platform_pm_suspend(struct device *dev)
1027 struct device_driver *drv = dev->driver;
1034 if (drv->pm->suspend)
1035 ret = drv->pm->suspend(dev);
1037 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
1043 int platform_pm_resume(struct device *dev)
1045 struct device_driver *drv = dev->driver;
1052 if (drv->pm->resume)
1053 ret = drv->pm->resume(dev);
1055 ret = platform_legacy_resume(dev);
1061 #endif /* CONFIG_SUSPEND */
1063 #ifdef CONFIG_HIBERNATE_CALLBACKS
1065 int platform_pm_freeze(struct device *dev)
1067 struct device_driver *drv = dev->driver;
1074 if (drv->pm->freeze)
1075 ret = drv->pm->freeze(dev);
1077 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
1083 int platform_pm_thaw(struct device *dev)
1085 struct device_driver *drv = dev->driver;
1093 ret = drv->pm->thaw(dev);
1095 ret = platform_legacy_resume(dev);
1101 int platform_pm_poweroff(struct device *dev)
1103 struct device_driver *drv = dev->driver;
1110 if (drv->pm->poweroff)
1111 ret = drv->pm->poweroff(dev);
1113 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
1119 int platform_pm_restore(struct device *dev)
1121 struct device_driver *drv = dev->driver;
1128 if (drv->pm->restore)
1129 ret = drv->pm->restore(dev);
1131 ret = platform_legacy_resume(dev);
1137 #endif /* CONFIG_HIBERNATE_CALLBACKS */
1139 int platform_dma_configure(struct device *dev)
1141 enum dev_dma_attr attr;
1145 ret = of_dma_configure(dev, dev->of_node, true);
1146 } else if (has_acpi_companion(dev)) {
1147 attr = acpi_get_dma_attr(to_acpi_device_node(dev->fwnode));
1148 if (attr != DEV_DMA_NOT_SUPPORTED)
1149 ret = acpi_dma_configure(dev, attr);
1155 static const struct dev_pm_ops platform_dev_pm_ops = {
1156 .runtime_suspend = pm_generic_runtime_suspend,
1157 .runtime_resume = pm_generic_runtime_resume,
1158 USE_PLATFORM_PM_SLEEP_OPS
1161 struct bus_type platform_bus_type = {
1163 .dev_groups = platform_dev_groups,
1164 .match = platform_match,
1165 .uevent = platform_uevent,
1166 .dma_configure = platform_dma_configure,
1167 .pm = &platform_dev_pm_ops,
1169 EXPORT_SYMBOL_GPL(platform_bus_type);
1171 int __init platform_bus_init(void)
1175 early_platform_cleanup();
1177 error = device_register(&platform_bus);
1179 put_device(&platform_bus);
1182 error = bus_register(&platform_bus_type);
1184 device_unregister(&platform_bus);
1185 of_platform_register_reconfig_notifier();
1189 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
1190 u64 dma_get_required_mask(struct device *dev)
1192 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
1193 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
1196 if (!high_totalram) {
1197 /* convert to mask just covering totalram */
1198 low_totalram = (1 << (fls(low_totalram) - 1));
1199 low_totalram += low_totalram - 1;
1200 mask = low_totalram;
1202 high_totalram = (1 << (fls(high_totalram) - 1));
1203 high_totalram += high_totalram - 1;
1204 mask = (((u64)high_totalram) << 32) + 0xffffffff;
1208 EXPORT_SYMBOL_GPL(dma_get_required_mask);
1211 static __initdata LIST_HEAD(early_platform_driver_list);
1212 static __initdata LIST_HEAD(early_platform_device_list);
1215 * early_platform_driver_register - register early platform driver
1216 * @epdrv: early_platform driver structure
1217 * @buf: string passed from early_param()
1219 * Helper function for early_platform_init() / early_platform_init_buffer()
1221 int __init early_platform_driver_register(struct early_platform_driver *epdrv,
1227 /* Simply add the driver to the end of the global list.
1228 * Drivers will by default be put on the list in compiled-in order.
1230 if (!epdrv->list.next) {
1231 INIT_LIST_HEAD(&epdrv->list);
1232 list_add_tail(&epdrv->list, &early_platform_driver_list);
1235 /* If the user has specified device then make sure the driver
1236 * gets prioritized. The driver of the last device specified on
1237 * command line will be put first on the list.
1239 n = strlen(epdrv->pdrv->driver.name);
1240 if (buf && !strncmp(buf, epdrv->pdrv->driver.name, n)) {
1241 list_move(&epdrv->list, &early_platform_driver_list);
1243 /* Allow passing parameters after device name */
1244 if (buf[n] == '\0' || buf[n] == ',')
1245 epdrv->requested_id = -1;
1247 epdrv->requested_id = simple_strtoul(&buf[n + 1],
1250 if (buf[n] != '.' || (tmp == &buf[n + 1])) {
1251 epdrv->requested_id = EARLY_PLATFORM_ID_ERROR;
1254 n += strcspn(&buf[n + 1], ",") + 1;
1260 if (epdrv->bufsize) {
1261 memcpy(epdrv->buffer, &buf[n],
1262 min_t(int, epdrv->bufsize, strlen(&buf[n]) + 1));
1263 epdrv->buffer[epdrv->bufsize - 1] = '\0';
1271 * early_platform_add_devices - adds a number of early platform devices
1272 * @devs: array of early platform devices to add
1273 * @num: number of early platform devices in array
1275 * Used by early architecture code to register early platform devices and
1276 * their platform data.
1278 void __init early_platform_add_devices(struct platform_device **devs, int num)
1283 /* simply add the devices to list */
1284 for (i = 0; i < num; i++) {
1285 dev = &devs[i]->dev;
1287 if (!dev->devres_head.next) {
1288 pm_runtime_early_init(dev);
1289 INIT_LIST_HEAD(&dev->devres_head);
1290 list_add_tail(&dev->devres_head,
1291 &early_platform_device_list);
1297 * early_platform_driver_register_all - register early platform drivers
1298 * @class_str: string to identify early platform driver class
1300 * Used by architecture code to register all early platform drivers
1301 * for a certain class. If omitted then only early platform drivers
1302 * with matching kernel command line class parameters will be registered.
1304 void __init early_platform_driver_register_all(char *class_str)
1306 /* The "class_str" parameter may or may not be present on the kernel
1307 * command line. If it is present then there may be more than one
1308 * matching parameter.
1310 * Since we register our early platform drivers using early_param()
1311 * we need to make sure that they also get registered in the case
1312 * when the parameter is missing from the kernel command line.
1314 * We use parse_early_options() to make sure the early_param() gets
1315 * called at least once. The early_param() may be called more than
1316 * once since the name of the preferred device may be specified on
1317 * the kernel command line. early_platform_driver_register() handles
1320 parse_early_options(class_str);
1324 * early_platform_match - find early platform device matching driver
1325 * @epdrv: early platform driver structure
1326 * @id: id to match against
1328 static struct platform_device * __init
1329 early_platform_match(struct early_platform_driver *epdrv, int id)
1331 struct platform_device *pd;
1333 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1334 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1342 * early_platform_left - check if early platform driver has matching devices
1343 * @epdrv: early platform driver structure
1344 * @id: return true if id or above exists
1346 static int __init early_platform_left(struct early_platform_driver *epdrv,
1349 struct platform_device *pd;
1351 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1352 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1360 * early_platform_driver_probe_id - probe drivers matching class_str and id
1361 * @class_str: string to identify early platform driver class
1362 * @id: id to match against
1363 * @nr_probe: number of platform devices to successfully probe before exiting
1365 static int __init early_platform_driver_probe_id(char *class_str,
1369 struct early_platform_driver *epdrv;
1370 struct platform_device *match;
1375 list_for_each_entry(epdrv, &early_platform_driver_list, list) {
1376 /* only use drivers matching our class_str */
1377 if (strcmp(class_str, epdrv->class_str))
1381 match_id = epdrv->requested_id;
1386 left += early_platform_left(epdrv, id);
1388 /* skip requested id */
1389 switch (epdrv->requested_id) {
1390 case EARLY_PLATFORM_ID_ERROR:
1391 case EARLY_PLATFORM_ID_UNSET:
1394 if (epdrv->requested_id == id)
1395 match_id = EARLY_PLATFORM_ID_UNSET;
1400 case EARLY_PLATFORM_ID_ERROR:
1401 pr_warn("%s: unable to parse %s parameter\n",
1402 class_str, epdrv->pdrv->driver.name);
1404 case EARLY_PLATFORM_ID_UNSET:
1408 match = early_platform_match(epdrv, match_id);
1413 * Set up a sensible init_name to enable
1414 * dev_name() and others to be used before the
1415 * rest of the driver core is initialized.
1417 if (!match->dev.init_name && slab_is_available()) {
1418 if (match->id != -1)
1419 match->dev.init_name =
1420 kasprintf(GFP_KERNEL, "%s.%d",
1424 match->dev.init_name =
1425 kasprintf(GFP_KERNEL, "%s",
1428 if (!match->dev.init_name)
1432 if (epdrv->pdrv->probe(match))
1433 pr_warn("%s: unable to probe %s early.\n",
1434 class_str, match->name);
1450 * early_platform_driver_probe - probe a class of registered drivers
1451 * @class_str: string to identify early platform driver class
1452 * @nr_probe: number of platform devices to successfully probe before exiting
1453 * @user_only: only probe user specified early platform devices
1455 * Used by architecture code to probe registered early platform drivers
1456 * within a certain class. For probe to happen a registered early platform
1457 * device matching a registered early platform driver is needed.
1459 int __init early_platform_driver_probe(char *class_str,
1466 for (i = -2; n < nr_probe; i++) {
1467 k = early_platform_driver_probe_id(class_str, i, nr_probe - n);
1482 * early_platform_cleanup - clean up early platform code
1484 void __init early_platform_cleanup(void)
1486 struct platform_device *pd, *pd2;
1488 /* clean up the devres list used to chain devices */
1489 list_for_each_entry_safe(pd, pd2, &early_platform_device_list,
1491 list_del(&pd->dev.devres_head);
1492 memset(&pd->dev.devres_head, 0, sizeof(pd->dev.devres_head));