Loading...
1/*
2 * platform.c - platform 'pseudo' bus for legacy devices
3 *
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 *
7 * This file is released under the GPLv2
8 *
9 * Please see Documentation/driver-model/platform.txt for more
10 * information.
11 */
12
13#include <linux/string.h>
14#include <linux/platform_device.h>
15#include <linux/of_device.h>
16#include <linux/of_irq.h>
17#include <linux/module.h>
18#include <linux/init.h>
19#include <linux/dma-mapping.h>
20#include <linux/bootmem.h>
21#include <linux/err.h>
22#include <linux/slab.h>
23#include <linux/pm_runtime.h>
24#include <linux/idr.h>
25#include <linux/acpi.h>
26
27#include "base.h"
28#include "power/power.h"
29
30/* For automatically allocated device IDs */
31static DEFINE_IDA(platform_devid_ida);
32
33struct device platform_bus = {
34 .init_name = "platform",
35};
36EXPORT_SYMBOL_GPL(platform_bus);
37
38/**
39 * arch_setup_pdev_archdata - Allow manipulation of archdata before its used
40 * @pdev: platform device
41 *
42 * This is called before platform_device_add() such that any pdev_archdata may
43 * be setup before the platform_notifier is called. So if a user needs to
44 * manipulate any relevant information in the pdev_archdata they can do:
45 *
46 * platform_device_alloc()
47 * ... manipulate ...
48 * platform_device_add()
49 *
50 * And if they don't care they can just call platform_device_register() and
51 * everything will just work out.
52 */
53void __weak arch_setup_pdev_archdata(struct platform_device *pdev)
54{
55}
56
57/**
58 * platform_get_resource - get a resource for a device
59 * @dev: platform device
60 * @type: resource type
61 * @num: resource index
62 */
63struct resource *platform_get_resource(struct platform_device *dev,
64 unsigned int type, unsigned int num)
65{
66 int i;
67
68 for (i = 0; i < dev->num_resources; i++) {
69 struct resource *r = &dev->resource[i];
70
71 if (type == resource_type(r) && num-- == 0)
72 return r;
73 }
74 return NULL;
75}
76EXPORT_SYMBOL_GPL(platform_get_resource);
77
78/**
79 * platform_get_irq - get an IRQ for a device
80 * @dev: platform device
81 * @num: IRQ number index
82 */
83int platform_get_irq(struct platform_device *dev, unsigned int num)
84{
85#ifdef CONFIG_SPARC
86 /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
87 if (!dev || num >= dev->archdata.num_irqs)
88 return -ENXIO;
89 return dev->archdata.irqs[num];
90#else
91 struct resource *r;
92 if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node)
93 return of_irq_get(dev->dev.of_node, num);
94
95 r = platform_get_resource(dev, IORESOURCE_IRQ, num);
96
97 return r ? r->start : -ENXIO;
98#endif
99}
100EXPORT_SYMBOL_GPL(platform_get_irq);
101
102/**
103 * platform_get_resource_byname - get a resource for a device by name
104 * @dev: platform device
105 * @type: resource type
106 * @name: resource name
107 */
108struct resource *platform_get_resource_byname(struct platform_device *dev,
109 unsigned int type,
110 const char *name)
111{
112 int i;
113
114 for (i = 0; i < dev->num_resources; i++) {
115 struct resource *r = &dev->resource[i];
116
117 if (unlikely(!r->name))
118 continue;
119
120 if (type == resource_type(r) && !strcmp(r->name, name))
121 return r;
122 }
123 return NULL;
124}
125EXPORT_SYMBOL_GPL(platform_get_resource_byname);
126
127/**
128 * platform_get_irq_byname - get an IRQ for a device by name
129 * @dev: platform device
130 * @name: IRQ name
131 */
132int platform_get_irq_byname(struct platform_device *dev, const char *name)
133{
134 struct resource *r = platform_get_resource_byname(dev, IORESOURCE_IRQ,
135 name);
136
137 return r ? r->start : -ENXIO;
138}
139EXPORT_SYMBOL_GPL(platform_get_irq_byname);
140
141/**
142 * platform_add_devices - add a numbers of platform devices
143 * @devs: array of platform devices to add
144 * @num: number of platform devices in array
145 */
146int platform_add_devices(struct platform_device **devs, int num)
147{
148 int i, ret = 0;
149
150 for (i = 0; i < num; i++) {
151 ret = platform_device_register(devs[i]);
152 if (ret) {
153 while (--i >= 0)
154 platform_device_unregister(devs[i]);
155 break;
156 }
157 }
158
159 return ret;
160}
161EXPORT_SYMBOL_GPL(platform_add_devices);
162
163struct platform_object {
164 struct platform_device pdev;
165 char name[1];
166};
167
168/**
169 * platform_device_put - destroy a platform device
170 * @pdev: platform device to free
171 *
172 * Free all memory associated with a platform device. This function must
173 * _only_ be externally called in error cases. All other usage is a bug.
174 */
175void platform_device_put(struct platform_device *pdev)
176{
177 if (pdev)
178 put_device(&pdev->dev);
179}
180EXPORT_SYMBOL_GPL(platform_device_put);
181
182static void platform_device_release(struct device *dev)
183{
184 struct platform_object *pa = container_of(dev, struct platform_object,
185 pdev.dev);
186
187 of_device_node_put(&pa->pdev.dev);
188 kfree(pa->pdev.dev.platform_data);
189 kfree(pa->pdev.mfd_cell);
190 kfree(pa->pdev.resource);
191 kfree(pa);
192}
193
194/**
195 * platform_device_alloc - create a platform device
196 * @name: base name of the device we're adding
197 * @id: instance id
198 *
199 * Create a platform device object which can have other objects attached
200 * to it, and which will have attached objects freed when it is released.
201 */
202struct platform_device *platform_device_alloc(const char *name, int id)
203{
204 struct platform_object *pa;
205
206 pa = kzalloc(sizeof(struct platform_object) + strlen(name), GFP_KERNEL);
207 if (pa) {
208 strcpy(pa->name, name);
209 pa->pdev.name = pa->name;
210 pa->pdev.id = id;
211 device_initialize(&pa->pdev.dev);
212 pa->pdev.dev.release = platform_device_release;
213 arch_setup_pdev_archdata(&pa->pdev);
214 }
215
216 return pa ? &pa->pdev : NULL;
217}
218EXPORT_SYMBOL_GPL(platform_device_alloc);
219
220/**
221 * platform_device_add_resources - add resources to a platform device
222 * @pdev: platform device allocated by platform_device_alloc to add resources to
223 * @res: set of resources that needs to be allocated for the device
224 * @num: number of resources
225 *
226 * Add a copy of the resources to the platform device. The memory
227 * associated with the resources will be freed when the platform device is
228 * released.
229 */
230int platform_device_add_resources(struct platform_device *pdev,
231 const struct resource *res, unsigned int num)
232{
233 struct resource *r = NULL;
234
235 if (res) {
236 r = kmemdup(res, sizeof(struct resource) * num, GFP_KERNEL);
237 if (!r)
238 return -ENOMEM;
239 }
240
241 kfree(pdev->resource);
242 pdev->resource = r;
243 pdev->num_resources = num;
244 return 0;
245}
246EXPORT_SYMBOL_GPL(platform_device_add_resources);
247
248/**
249 * platform_device_add_data - add platform-specific data to a platform device
250 * @pdev: platform device allocated by platform_device_alloc to add resources to
251 * @data: platform specific data for this platform device
252 * @size: size of platform specific data
253 *
254 * Add a copy of platform specific data to the platform device's
255 * platform_data pointer. The memory associated with the platform data
256 * will be freed when the platform device is released.
257 */
258int platform_device_add_data(struct platform_device *pdev, const void *data,
259 size_t size)
260{
261 void *d = NULL;
262
263 if (data) {
264 d = kmemdup(data, size, GFP_KERNEL);
265 if (!d)
266 return -ENOMEM;
267 }
268
269 kfree(pdev->dev.platform_data);
270 pdev->dev.platform_data = d;
271 return 0;
272}
273EXPORT_SYMBOL_GPL(platform_device_add_data);
274
275/**
276 * platform_device_add - add a platform device to device hierarchy
277 * @pdev: platform device we're adding
278 *
279 * This is part 2 of platform_device_register(), though may be called
280 * separately _iff_ pdev was allocated by platform_device_alloc().
281 */
282int platform_device_add(struct platform_device *pdev)
283{
284 int i, ret;
285
286 if (!pdev)
287 return -EINVAL;
288
289 if (!pdev->dev.parent)
290 pdev->dev.parent = &platform_bus;
291
292 pdev->dev.bus = &platform_bus_type;
293
294 switch (pdev->id) {
295 default:
296 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
297 break;
298 case PLATFORM_DEVID_NONE:
299 dev_set_name(&pdev->dev, "%s", pdev->name);
300 break;
301 case PLATFORM_DEVID_AUTO:
302 /*
303 * Automatically allocated device ID. We mark it as such so
304 * that we remember it must be freed, and we append a suffix
305 * to avoid namespace collision with explicit IDs.
306 */
307 ret = ida_simple_get(&platform_devid_ida, 0, 0, GFP_KERNEL);
308 if (ret < 0)
309 goto err_out;
310 pdev->id = ret;
311 pdev->id_auto = true;
312 dev_set_name(&pdev->dev, "%s.%d.auto", pdev->name, pdev->id);
313 break;
314 }
315
316 for (i = 0; i < pdev->num_resources; i++) {
317 struct resource *p, *r = &pdev->resource[i];
318
319 if (r->name == NULL)
320 r->name = dev_name(&pdev->dev);
321
322 p = r->parent;
323 if (!p) {
324 if (resource_type(r) == IORESOURCE_MEM)
325 p = &iomem_resource;
326 else if (resource_type(r) == IORESOURCE_IO)
327 p = &ioport_resource;
328 }
329
330 if (p && insert_resource(p, r)) {
331 dev_err(&pdev->dev, "failed to claim resource %d\n", i);
332 ret = -EBUSY;
333 goto failed;
334 }
335 }
336
337 pr_debug("Registering platform device '%s'. Parent at %s\n",
338 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
339
340 ret = device_add(&pdev->dev);
341 if (ret == 0)
342 return ret;
343
344 failed:
345 if (pdev->id_auto) {
346 ida_simple_remove(&platform_devid_ida, pdev->id);
347 pdev->id = PLATFORM_DEVID_AUTO;
348 }
349
350 while (--i >= 0) {
351 struct resource *r = &pdev->resource[i];
352 unsigned long type = resource_type(r);
353
354 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
355 release_resource(r);
356 }
357
358 err_out:
359 return ret;
360}
361EXPORT_SYMBOL_GPL(platform_device_add);
362
363/**
364 * platform_device_del - remove a platform-level device
365 * @pdev: platform device we're removing
366 *
367 * Note that this function will also release all memory- and port-based
368 * resources owned by the device (@dev->resource). This function must
369 * _only_ be externally called in error cases. All other usage is a bug.
370 */
371void platform_device_del(struct platform_device *pdev)
372{
373 int i;
374
375 if (pdev) {
376 device_del(&pdev->dev);
377
378 if (pdev->id_auto) {
379 ida_simple_remove(&platform_devid_ida, pdev->id);
380 pdev->id = PLATFORM_DEVID_AUTO;
381 }
382
383 for (i = 0; i < pdev->num_resources; i++) {
384 struct resource *r = &pdev->resource[i];
385 unsigned long type = resource_type(r);
386
387 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
388 release_resource(r);
389 }
390 }
391}
392EXPORT_SYMBOL_GPL(platform_device_del);
393
394/**
395 * platform_device_register - add a platform-level device
396 * @pdev: platform device we're adding
397 */
398int platform_device_register(struct platform_device *pdev)
399{
400 device_initialize(&pdev->dev);
401 arch_setup_pdev_archdata(pdev);
402 return platform_device_add(pdev);
403}
404EXPORT_SYMBOL_GPL(platform_device_register);
405
406/**
407 * platform_device_unregister - unregister a platform-level device
408 * @pdev: platform device we're unregistering
409 *
410 * Unregistration is done in 2 steps. First we release all resources
411 * and remove it from the subsystem, then we drop reference count by
412 * calling platform_device_put().
413 */
414void platform_device_unregister(struct platform_device *pdev)
415{
416 platform_device_del(pdev);
417 platform_device_put(pdev);
418}
419EXPORT_SYMBOL_GPL(platform_device_unregister);
420
421/**
422 * platform_device_register_full - add a platform-level device with
423 * resources and platform-specific data
424 *
425 * @pdevinfo: data used to create device
426 *
427 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
428 */
429struct platform_device *platform_device_register_full(
430 const struct platform_device_info *pdevinfo)
431{
432 int ret = -ENOMEM;
433 struct platform_device *pdev;
434
435 pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
436 if (!pdev)
437 goto err_alloc;
438
439 pdev->dev.parent = pdevinfo->parent;
440 ACPI_COMPANION_SET(&pdev->dev, pdevinfo->acpi_node.companion);
441
442 if (pdevinfo->dma_mask) {
443 /*
444 * This memory isn't freed when the device is put,
445 * I don't have a nice idea for that though. Conceptually
446 * dma_mask in struct device should not be a pointer.
447 * See http://thread.gmane.org/gmane.linux.kernel.pci/9081
448 */
449 pdev->dev.dma_mask =
450 kmalloc(sizeof(*pdev->dev.dma_mask), GFP_KERNEL);
451 if (!pdev->dev.dma_mask)
452 goto err;
453
454 *pdev->dev.dma_mask = pdevinfo->dma_mask;
455 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
456 }
457
458 ret = platform_device_add_resources(pdev,
459 pdevinfo->res, pdevinfo->num_res);
460 if (ret)
461 goto err;
462
463 ret = platform_device_add_data(pdev,
464 pdevinfo->data, pdevinfo->size_data);
465 if (ret)
466 goto err;
467
468 ret = platform_device_add(pdev);
469 if (ret) {
470err:
471 ACPI_COMPANION_SET(&pdev->dev, NULL);
472 kfree(pdev->dev.dma_mask);
473
474err_alloc:
475 platform_device_put(pdev);
476 return ERR_PTR(ret);
477 }
478
479 return pdev;
480}
481EXPORT_SYMBOL_GPL(platform_device_register_full);
482
483static int platform_drv_probe(struct device *_dev)
484{
485 struct platform_driver *drv = to_platform_driver(_dev->driver);
486 struct platform_device *dev = to_platform_device(_dev);
487 int ret;
488
489 acpi_dev_pm_attach(_dev, true);
490
491 ret = drv->probe(dev);
492 if (ret)
493 acpi_dev_pm_detach(_dev, true);
494
495 if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
496 dev_warn(_dev, "probe deferral not supported\n");
497 ret = -ENXIO;
498 }
499
500 return ret;
501}
502
503static int platform_drv_probe_fail(struct device *_dev)
504{
505 return -ENXIO;
506}
507
508static int platform_drv_remove(struct device *_dev)
509{
510 struct platform_driver *drv = to_platform_driver(_dev->driver);
511 struct platform_device *dev = to_platform_device(_dev);
512 int ret;
513
514 ret = drv->remove(dev);
515 acpi_dev_pm_detach(_dev, true);
516
517 return ret;
518}
519
520static void platform_drv_shutdown(struct device *_dev)
521{
522 struct platform_driver *drv = to_platform_driver(_dev->driver);
523 struct platform_device *dev = to_platform_device(_dev);
524
525 drv->shutdown(dev);
526 acpi_dev_pm_detach(_dev, true);
527}
528
529/**
530 * __platform_driver_register - register a driver for platform-level devices
531 * @drv: platform driver structure
532 * @owner: owning module/driver
533 */
534int __platform_driver_register(struct platform_driver *drv,
535 struct module *owner)
536{
537 drv->driver.owner = owner;
538 drv->driver.bus = &platform_bus_type;
539 if (drv->probe)
540 drv->driver.probe = platform_drv_probe;
541 if (drv->remove)
542 drv->driver.remove = platform_drv_remove;
543 if (drv->shutdown)
544 drv->driver.shutdown = platform_drv_shutdown;
545
546 return driver_register(&drv->driver);
547}
548EXPORT_SYMBOL_GPL(__platform_driver_register);
549
550/**
551 * platform_driver_unregister - unregister a driver for platform-level devices
552 * @drv: platform driver structure
553 */
554void platform_driver_unregister(struct platform_driver *drv)
555{
556 driver_unregister(&drv->driver);
557}
558EXPORT_SYMBOL_GPL(platform_driver_unregister);
559
560/**
561 * platform_driver_probe - register driver for non-hotpluggable device
562 * @drv: platform driver structure
563 * @probe: the driver probe routine, probably from an __init section
564 *
565 * Use this instead of platform_driver_register() when you know the device
566 * is not hotpluggable and has already been registered, and you want to
567 * remove its run-once probe() infrastructure from memory after the driver
568 * has bound to the device.
569 *
570 * One typical use for this would be with drivers for controllers integrated
571 * into system-on-chip processors, where the controller devices have been
572 * configured as part of board setup.
573 *
574 * Note that this is incompatible with deferred probing.
575 *
576 * Returns zero if the driver registered and bound to a device, else returns
577 * a negative error code and with the driver not registered.
578 */
579int __init_or_module platform_driver_probe(struct platform_driver *drv,
580 int (*probe)(struct platform_device *))
581{
582 int retval, code;
583
584 /*
585 * Prevent driver from requesting probe deferral to avoid further
586 * futile probe attempts.
587 */
588 drv->prevent_deferred_probe = true;
589
590 /* make sure driver won't have bind/unbind attributes */
591 drv->driver.suppress_bind_attrs = true;
592
593 /* temporary section violation during probe() */
594 drv->probe = probe;
595 retval = code = platform_driver_register(drv);
596
597 /*
598 * Fixup that section violation, being paranoid about code scanning
599 * the list of drivers in order to probe new devices. Check to see
600 * if the probe was successful, and make sure any forced probes of
601 * new devices fail.
602 */
603 spin_lock(&drv->driver.bus->p->klist_drivers.k_lock);
604 drv->probe = NULL;
605 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
606 retval = -ENODEV;
607 drv->driver.probe = platform_drv_probe_fail;
608 spin_unlock(&drv->driver.bus->p->klist_drivers.k_lock);
609
610 if (code != retval)
611 platform_driver_unregister(drv);
612 return retval;
613}
614EXPORT_SYMBOL_GPL(platform_driver_probe);
615
616/**
617 * platform_create_bundle - register driver and create corresponding device
618 * @driver: platform driver structure
619 * @probe: the driver probe routine, probably from an __init section
620 * @res: set of resources that needs to be allocated for the device
621 * @n_res: number of resources
622 * @data: platform specific data for this platform device
623 * @size: size of platform specific data
624 *
625 * Use this in legacy-style modules that probe hardware directly and
626 * register a single platform device and corresponding platform driver.
627 *
628 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
629 */
630struct platform_device * __init_or_module platform_create_bundle(
631 struct platform_driver *driver,
632 int (*probe)(struct platform_device *),
633 struct resource *res, unsigned int n_res,
634 const void *data, size_t size)
635{
636 struct platform_device *pdev;
637 int error;
638
639 pdev = platform_device_alloc(driver->driver.name, -1);
640 if (!pdev) {
641 error = -ENOMEM;
642 goto err_out;
643 }
644
645 error = platform_device_add_resources(pdev, res, n_res);
646 if (error)
647 goto err_pdev_put;
648
649 error = platform_device_add_data(pdev, data, size);
650 if (error)
651 goto err_pdev_put;
652
653 error = platform_device_add(pdev);
654 if (error)
655 goto err_pdev_put;
656
657 error = platform_driver_probe(driver, probe);
658 if (error)
659 goto err_pdev_del;
660
661 return pdev;
662
663err_pdev_del:
664 platform_device_del(pdev);
665err_pdev_put:
666 platform_device_put(pdev);
667err_out:
668 return ERR_PTR(error);
669}
670EXPORT_SYMBOL_GPL(platform_create_bundle);
671
672/* modalias support enables more hands-off userspace setup:
673 * (a) environment variable lets new-style hotplug events work once system is
674 * fully running: "modprobe $MODALIAS"
675 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
676 * mishandled before system is fully running: "modprobe $(cat modalias)"
677 */
678static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
679 char *buf)
680{
681 struct platform_device *pdev = to_platform_device(dev);
682 int len;
683
684 len = of_device_get_modalias(dev, buf, PAGE_SIZE -1);
685 if (len != -ENODEV)
686 return len;
687
688 len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
689 if (len != -ENODEV)
690 return len;
691
692 len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
693
694 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
695}
696static DEVICE_ATTR_RO(modalias);
697
698static struct attribute *platform_dev_attrs[] = {
699 &dev_attr_modalias.attr,
700 NULL,
701};
702ATTRIBUTE_GROUPS(platform_dev);
703
704static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
705{
706 struct platform_device *pdev = to_platform_device(dev);
707 int rc;
708
709 /* Some devices have extra OF data and an OF-style MODALIAS */
710 rc = of_device_uevent_modalias(dev, env);
711 if (rc != -ENODEV)
712 return rc;
713
714 rc = acpi_device_uevent_modalias(dev, env);
715 if (rc != -ENODEV)
716 return rc;
717
718 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
719 pdev->name);
720 return 0;
721}
722
723static const struct platform_device_id *platform_match_id(
724 const struct platform_device_id *id,
725 struct platform_device *pdev)
726{
727 while (id->name[0]) {
728 if (strcmp(pdev->name, id->name) == 0) {
729 pdev->id_entry = id;
730 return id;
731 }
732 id++;
733 }
734 return NULL;
735}
736
737/**
738 * platform_match - bind platform device to platform driver.
739 * @dev: device.
740 * @drv: driver.
741 *
742 * Platform device IDs are assumed to be encoded like this:
743 * "<name><instance>", where <name> is a short description of the type of
744 * device, like "pci" or "floppy", and <instance> is the enumerated
745 * instance of the device, like '0' or '42'. Driver IDs are simply
746 * "<name>". So, extract the <name> from the platform_device structure,
747 * and compare it against the name of the driver. Return whether they match
748 * or not.
749 */
750static int platform_match(struct device *dev, struct device_driver *drv)
751{
752 struct platform_device *pdev = to_platform_device(dev);
753 struct platform_driver *pdrv = to_platform_driver(drv);
754
755 /* Attempt an OF style match first */
756 if (of_driver_match_device(dev, drv))
757 return 1;
758
759 /* Then try ACPI style match */
760 if (acpi_driver_match_device(dev, drv))
761 return 1;
762
763 /* Then try to match against the id table */
764 if (pdrv->id_table)
765 return platform_match_id(pdrv->id_table, pdev) != NULL;
766
767 /* fall-back to driver name match */
768 return (strcmp(pdev->name, drv->name) == 0);
769}
770
771#ifdef CONFIG_PM_SLEEP
772
773static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
774{
775 struct platform_driver *pdrv = to_platform_driver(dev->driver);
776 struct platform_device *pdev = to_platform_device(dev);
777 int ret = 0;
778
779 if (dev->driver && pdrv->suspend)
780 ret = pdrv->suspend(pdev, mesg);
781
782 return ret;
783}
784
785static int platform_legacy_resume(struct device *dev)
786{
787 struct platform_driver *pdrv = to_platform_driver(dev->driver);
788 struct platform_device *pdev = to_platform_device(dev);
789 int ret = 0;
790
791 if (dev->driver && pdrv->resume)
792 ret = pdrv->resume(pdev);
793
794 return ret;
795}
796
797#endif /* CONFIG_PM_SLEEP */
798
799#ifdef CONFIG_SUSPEND
800
801int platform_pm_suspend(struct device *dev)
802{
803 struct device_driver *drv = dev->driver;
804 int ret = 0;
805
806 if (!drv)
807 return 0;
808
809 if (drv->pm) {
810 if (drv->pm->suspend)
811 ret = drv->pm->suspend(dev);
812 } else {
813 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
814 }
815
816 return ret;
817}
818
819int platform_pm_resume(struct device *dev)
820{
821 struct device_driver *drv = dev->driver;
822 int ret = 0;
823
824 if (!drv)
825 return 0;
826
827 if (drv->pm) {
828 if (drv->pm->resume)
829 ret = drv->pm->resume(dev);
830 } else {
831 ret = platform_legacy_resume(dev);
832 }
833
834 return ret;
835}
836
837#endif /* CONFIG_SUSPEND */
838
839#ifdef CONFIG_HIBERNATE_CALLBACKS
840
841int platform_pm_freeze(struct device *dev)
842{
843 struct device_driver *drv = dev->driver;
844 int ret = 0;
845
846 if (!drv)
847 return 0;
848
849 if (drv->pm) {
850 if (drv->pm->freeze)
851 ret = drv->pm->freeze(dev);
852 } else {
853 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
854 }
855
856 return ret;
857}
858
859int platform_pm_thaw(struct device *dev)
860{
861 struct device_driver *drv = dev->driver;
862 int ret = 0;
863
864 if (!drv)
865 return 0;
866
867 if (drv->pm) {
868 if (drv->pm->thaw)
869 ret = drv->pm->thaw(dev);
870 } else {
871 ret = platform_legacy_resume(dev);
872 }
873
874 return ret;
875}
876
877int platform_pm_poweroff(struct device *dev)
878{
879 struct device_driver *drv = dev->driver;
880 int ret = 0;
881
882 if (!drv)
883 return 0;
884
885 if (drv->pm) {
886 if (drv->pm->poweroff)
887 ret = drv->pm->poweroff(dev);
888 } else {
889 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
890 }
891
892 return ret;
893}
894
895int platform_pm_restore(struct device *dev)
896{
897 struct device_driver *drv = dev->driver;
898 int ret = 0;
899
900 if (!drv)
901 return 0;
902
903 if (drv->pm) {
904 if (drv->pm->restore)
905 ret = drv->pm->restore(dev);
906 } else {
907 ret = platform_legacy_resume(dev);
908 }
909
910 return ret;
911}
912
913#endif /* CONFIG_HIBERNATE_CALLBACKS */
914
915static const struct dev_pm_ops platform_dev_pm_ops = {
916 .runtime_suspend = pm_generic_runtime_suspend,
917 .runtime_resume = pm_generic_runtime_resume,
918 USE_PLATFORM_PM_SLEEP_OPS
919};
920
921struct bus_type platform_bus_type = {
922 .name = "platform",
923 .dev_groups = platform_dev_groups,
924 .match = platform_match,
925 .uevent = platform_uevent,
926 .pm = &platform_dev_pm_ops,
927};
928EXPORT_SYMBOL_GPL(platform_bus_type);
929
930int __init platform_bus_init(void)
931{
932 int error;
933
934 early_platform_cleanup();
935
936 error = device_register(&platform_bus);
937 if (error)
938 return error;
939 error = bus_register(&platform_bus_type);
940 if (error)
941 device_unregister(&platform_bus);
942 return error;
943}
944
945#ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
946u64 dma_get_required_mask(struct device *dev)
947{
948 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
949 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
950 u64 mask;
951
952 if (!high_totalram) {
953 /* convert to mask just covering totalram */
954 low_totalram = (1 << (fls(low_totalram) - 1));
955 low_totalram += low_totalram - 1;
956 mask = low_totalram;
957 } else {
958 high_totalram = (1 << (fls(high_totalram) - 1));
959 high_totalram += high_totalram - 1;
960 mask = (((u64)high_totalram) << 32) + 0xffffffff;
961 }
962 return mask;
963}
964EXPORT_SYMBOL_GPL(dma_get_required_mask);
965#endif
966
967static __initdata LIST_HEAD(early_platform_driver_list);
968static __initdata LIST_HEAD(early_platform_device_list);
969
970/**
971 * early_platform_driver_register - register early platform driver
972 * @epdrv: early_platform driver structure
973 * @buf: string passed from early_param()
974 *
975 * Helper function for early_platform_init() / early_platform_init_buffer()
976 */
977int __init early_platform_driver_register(struct early_platform_driver *epdrv,
978 char *buf)
979{
980 char *tmp;
981 int n;
982
983 /* Simply add the driver to the end of the global list.
984 * Drivers will by default be put on the list in compiled-in order.
985 */
986 if (!epdrv->list.next) {
987 INIT_LIST_HEAD(&epdrv->list);
988 list_add_tail(&epdrv->list, &early_platform_driver_list);
989 }
990
991 /* If the user has specified device then make sure the driver
992 * gets prioritized. The driver of the last device specified on
993 * command line will be put first on the list.
994 */
995 n = strlen(epdrv->pdrv->driver.name);
996 if (buf && !strncmp(buf, epdrv->pdrv->driver.name, n)) {
997 list_move(&epdrv->list, &early_platform_driver_list);
998
999 /* Allow passing parameters after device name */
1000 if (buf[n] == '\0' || buf[n] == ',')
1001 epdrv->requested_id = -1;
1002 else {
1003 epdrv->requested_id = simple_strtoul(&buf[n + 1],
1004 &tmp, 10);
1005
1006 if (buf[n] != '.' || (tmp == &buf[n + 1])) {
1007 epdrv->requested_id = EARLY_PLATFORM_ID_ERROR;
1008 n = 0;
1009 } else
1010 n += strcspn(&buf[n + 1], ",") + 1;
1011 }
1012
1013 if (buf[n] == ',')
1014 n++;
1015
1016 if (epdrv->bufsize) {
1017 memcpy(epdrv->buffer, &buf[n],
1018 min_t(int, epdrv->bufsize, strlen(&buf[n]) + 1));
1019 epdrv->buffer[epdrv->bufsize - 1] = '\0';
1020 }
1021 }
1022
1023 return 0;
1024}
1025
1026/**
1027 * early_platform_add_devices - adds a number of early platform devices
1028 * @devs: array of early platform devices to add
1029 * @num: number of early platform devices in array
1030 *
1031 * Used by early architecture code to register early platform devices and
1032 * their platform data.
1033 */
1034void __init early_platform_add_devices(struct platform_device **devs, int num)
1035{
1036 struct device *dev;
1037 int i;
1038
1039 /* simply add the devices to list */
1040 for (i = 0; i < num; i++) {
1041 dev = &devs[i]->dev;
1042
1043 if (!dev->devres_head.next) {
1044 pm_runtime_early_init(dev);
1045 INIT_LIST_HEAD(&dev->devres_head);
1046 list_add_tail(&dev->devres_head,
1047 &early_platform_device_list);
1048 }
1049 }
1050}
1051
1052/**
1053 * early_platform_driver_register_all - register early platform drivers
1054 * @class_str: string to identify early platform driver class
1055 *
1056 * Used by architecture code to register all early platform drivers
1057 * for a certain class. If omitted then only early platform drivers
1058 * with matching kernel command line class parameters will be registered.
1059 */
1060void __init early_platform_driver_register_all(char *class_str)
1061{
1062 /* The "class_str" parameter may or may not be present on the kernel
1063 * command line. If it is present then there may be more than one
1064 * matching parameter.
1065 *
1066 * Since we register our early platform drivers using early_param()
1067 * we need to make sure that they also get registered in the case
1068 * when the parameter is missing from the kernel command line.
1069 *
1070 * We use parse_early_options() to make sure the early_param() gets
1071 * called at least once. The early_param() may be called more than
1072 * once since the name of the preferred device may be specified on
1073 * the kernel command line. early_platform_driver_register() handles
1074 * this case for us.
1075 */
1076 parse_early_options(class_str);
1077}
1078
1079/**
1080 * early_platform_match - find early platform device matching driver
1081 * @epdrv: early platform driver structure
1082 * @id: id to match against
1083 */
1084static struct platform_device * __init
1085early_platform_match(struct early_platform_driver *epdrv, int id)
1086{
1087 struct platform_device *pd;
1088
1089 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1090 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1091 if (pd->id == id)
1092 return pd;
1093
1094 return NULL;
1095}
1096
1097/**
1098 * early_platform_left - check if early platform driver has matching devices
1099 * @epdrv: early platform driver structure
1100 * @id: return true if id or above exists
1101 */
1102static int __init early_platform_left(struct early_platform_driver *epdrv,
1103 int id)
1104{
1105 struct platform_device *pd;
1106
1107 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1108 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1109 if (pd->id >= id)
1110 return 1;
1111
1112 return 0;
1113}
1114
1115/**
1116 * early_platform_driver_probe_id - probe drivers matching class_str and id
1117 * @class_str: string to identify early platform driver class
1118 * @id: id to match against
1119 * @nr_probe: number of platform devices to successfully probe before exiting
1120 */
1121static int __init early_platform_driver_probe_id(char *class_str,
1122 int id,
1123 int nr_probe)
1124{
1125 struct early_platform_driver *epdrv;
1126 struct platform_device *match;
1127 int match_id;
1128 int n = 0;
1129 int left = 0;
1130
1131 list_for_each_entry(epdrv, &early_platform_driver_list, list) {
1132 /* only use drivers matching our class_str */
1133 if (strcmp(class_str, epdrv->class_str))
1134 continue;
1135
1136 if (id == -2) {
1137 match_id = epdrv->requested_id;
1138 left = 1;
1139
1140 } else {
1141 match_id = id;
1142 left += early_platform_left(epdrv, id);
1143
1144 /* skip requested id */
1145 switch (epdrv->requested_id) {
1146 case EARLY_PLATFORM_ID_ERROR:
1147 case EARLY_PLATFORM_ID_UNSET:
1148 break;
1149 default:
1150 if (epdrv->requested_id == id)
1151 match_id = EARLY_PLATFORM_ID_UNSET;
1152 }
1153 }
1154
1155 switch (match_id) {
1156 case EARLY_PLATFORM_ID_ERROR:
1157 pr_warn("%s: unable to parse %s parameter\n",
1158 class_str, epdrv->pdrv->driver.name);
1159 /* fall-through */
1160 case EARLY_PLATFORM_ID_UNSET:
1161 match = NULL;
1162 break;
1163 default:
1164 match = early_platform_match(epdrv, match_id);
1165 }
1166
1167 if (match) {
1168 /*
1169 * Set up a sensible init_name to enable
1170 * dev_name() and others to be used before the
1171 * rest of the driver core is initialized.
1172 */
1173 if (!match->dev.init_name && slab_is_available()) {
1174 if (match->id != -1)
1175 match->dev.init_name =
1176 kasprintf(GFP_KERNEL, "%s.%d",
1177 match->name,
1178 match->id);
1179 else
1180 match->dev.init_name =
1181 kasprintf(GFP_KERNEL, "%s",
1182 match->name);
1183
1184 if (!match->dev.init_name)
1185 return -ENOMEM;
1186 }
1187
1188 if (epdrv->pdrv->probe(match))
1189 pr_warn("%s: unable to probe %s early.\n",
1190 class_str, match->name);
1191 else
1192 n++;
1193 }
1194
1195 if (n >= nr_probe)
1196 break;
1197 }
1198
1199 if (left)
1200 return n;
1201 else
1202 return -ENODEV;
1203}
1204
1205/**
1206 * early_platform_driver_probe - probe a class of registered drivers
1207 * @class_str: string to identify early platform driver class
1208 * @nr_probe: number of platform devices to successfully probe before exiting
1209 * @user_only: only probe user specified early platform devices
1210 *
1211 * Used by architecture code to probe registered early platform drivers
1212 * within a certain class. For probe to happen a registered early platform
1213 * device matching a registered early platform driver is needed.
1214 */
1215int __init early_platform_driver_probe(char *class_str,
1216 int nr_probe,
1217 int user_only)
1218{
1219 int k, n, i;
1220
1221 n = 0;
1222 for (i = -2; n < nr_probe; i++) {
1223 k = early_platform_driver_probe_id(class_str, i, nr_probe - n);
1224
1225 if (k < 0)
1226 break;
1227
1228 n += k;
1229
1230 if (user_only)
1231 break;
1232 }
1233
1234 return n;
1235}
1236
1237/**
1238 * early_platform_cleanup - clean up early platform code
1239 */
1240void __init early_platform_cleanup(void)
1241{
1242 struct platform_device *pd, *pd2;
1243
1244 /* clean up the devres list used to chain devices */
1245 list_for_each_entry_safe(pd, pd2, &early_platform_device_list,
1246 dev.devres_head) {
1247 list_del(&pd->dev.devres_head);
1248 memset(&pd->dev.devres_head, 0, sizeof(pd->dev.devres_head));
1249 }
1250}
1251
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * platform.c - platform 'pseudo' bus for legacy devices
4 *
5 * Copyright (c) 2002-3 Patrick Mochel
6 * Copyright (c) 2002-3 Open Source Development Labs
7 *
8 * Please see Documentation/driver-api/driver-model/platform.rst for more
9 * information.
10 */
11
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>
35
36#include "base.h"
37#include "power/power.h"
38
39/* For automatically allocated device IDs */
40static DEFINE_IDA(platform_devid_ida);
41
42struct device platform_bus = {
43 .init_name = "platform",
44};
45EXPORT_SYMBOL_GPL(platform_bus);
46
47/**
48 * platform_get_resource - get a resource for a device
49 * @dev: platform device
50 * @type: resource type
51 * @num: resource index
52 *
53 * Return: a pointer to the resource or NULL on failure.
54 */
55struct resource *platform_get_resource(struct platform_device *dev,
56 unsigned int type, unsigned int num)
57{
58 u32 i;
59
60 for (i = 0; i < dev->num_resources; i++) {
61 struct resource *r = &dev->resource[i];
62
63 if (type == resource_type(r) && num-- == 0)
64 return r;
65 }
66 return NULL;
67}
68EXPORT_SYMBOL_GPL(platform_get_resource);
69
70struct resource *platform_get_mem_or_io(struct platform_device *dev,
71 unsigned int num)
72{
73 u32 i;
74
75 for (i = 0; i < dev->num_resources; i++) {
76 struct resource *r = &dev->resource[i];
77
78 if ((resource_type(r) & (IORESOURCE_MEM|IORESOURCE_IO)) && num-- == 0)
79 return r;
80 }
81 return NULL;
82}
83EXPORT_SYMBOL_GPL(platform_get_mem_or_io);
84
85#ifdef CONFIG_HAS_IOMEM
86/**
87 * devm_platform_get_and_ioremap_resource - call devm_ioremap_resource() for a
88 * platform device and get resource
89 *
90 * @pdev: platform device to use both for memory resource lookup as well as
91 * resource management
92 * @index: resource index
93 * @res: optional output parameter to store a pointer to the obtained resource.
94 *
95 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
96 * on failure.
97 */
98void __iomem *
99devm_platform_get_and_ioremap_resource(struct platform_device *pdev,
100 unsigned int index, struct resource **res)
101{
102 struct resource *r;
103
104 r = platform_get_resource(pdev, IORESOURCE_MEM, index);
105 if (res)
106 *res = r;
107 return devm_ioremap_resource(&pdev->dev, r);
108}
109EXPORT_SYMBOL_GPL(devm_platform_get_and_ioremap_resource);
110
111/**
112 * devm_platform_ioremap_resource - call devm_ioremap_resource() for a platform
113 * device
114 *
115 * @pdev: platform device to use both for memory resource lookup as well as
116 * resource management
117 * @index: resource index
118 *
119 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
120 * on failure.
121 */
122void __iomem *devm_platform_ioremap_resource(struct platform_device *pdev,
123 unsigned int index)
124{
125 return devm_platform_get_and_ioremap_resource(pdev, index, NULL);
126}
127EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource);
128
129/**
130 * devm_platform_ioremap_resource_byname - call devm_ioremap_resource for
131 * a platform device, retrieve the
132 * resource by name
133 *
134 * @pdev: platform device to use both for memory resource lookup as well as
135 * resource management
136 * @name: name of the resource
137 *
138 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
139 * on failure.
140 */
141void __iomem *
142devm_platform_ioremap_resource_byname(struct platform_device *pdev,
143 const char *name)
144{
145 struct resource *res;
146
147 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
148 return devm_ioremap_resource(&pdev->dev, res);
149}
150EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource_byname);
151#endif /* CONFIG_HAS_IOMEM */
152
153/**
154 * platform_get_irq_optional - get an optional IRQ for a device
155 * @dev: platform device
156 * @num: IRQ number index
157 *
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.
162 *
163 * For example::
164 *
165 * int irq = platform_get_irq_optional(pdev, 0);
166 * if (irq < 0)
167 * return irq;
168 *
169 * Return: non-zero IRQ number on success, negative error number on failure.
170 */
171int platform_get_irq_optional(struct platform_device *dev, unsigned int num)
172{
173 int ret;
174#ifdef CONFIG_SPARC
175 /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
176 if (!dev || num >= dev->archdata.num_irqs)
177 goto out_not_found;
178 ret = dev->archdata.irqs[num];
179 goto out;
180#else
181 struct fwnode_handle *fwnode = dev_fwnode(&dev->dev);
182 struct resource *r;
183
184 if (is_of_node(fwnode)) {
185 ret = of_irq_get(to_of_node(fwnode), num);
186 if (ret > 0 || ret == -EPROBE_DEFER)
187 goto out;
188 }
189
190 r = platform_get_resource(dev, IORESOURCE_IRQ, num);
191 if (is_acpi_device_node(fwnode)) {
192 if (r && r->flags & IORESOURCE_DISABLED) {
193 ret = acpi_irq_get(ACPI_HANDLE_FWNODE(fwnode), num, r);
194 if (ret)
195 goto out;
196 }
197 }
198
199 /*
200 * The resources may pass trigger flags to the irqs that need
201 * to be set up. It so happens that the trigger flags for
202 * IORESOURCE_BITS correspond 1-to-1 to the IRQF_TRIGGER*
203 * settings.
204 */
205 if (r && r->flags & IORESOURCE_BITS) {
206 struct irq_data *irqd;
207
208 irqd = irq_get_irq_data(r->start);
209 if (!irqd)
210 goto out_not_found;
211 irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS);
212 }
213
214 if (r) {
215 ret = r->start;
216 goto out;
217 }
218
219 /*
220 * For the index 0 interrupt, allow falling back to GpioInt
221 * resources. While a device could have both Interrupt and GpioInt
222 * resources, making this fallback ambiguous, in many common cases
223 * the device will only expose one IRQ, and this fallback
224 * allows a common code path across either kind of resource.
225 */
226 if (num == 0 && is_acpi_device_node(fwnode)) {
227 ret = acpi_dev_gpio_irq_get(to_acpi_device_node(fwnode), num);
228 /* Our callers expect -ENXIO for missing IRQs. */
229 if (ret >= 0 || ret == -EPROBE_DEFER)
230 goto out;
231 }
232
233#endif
234out_not_found:
235 ret = -ENXIO;
236out:
237 if (WARN(!ret, "0 is an invalid IRQ number\n"))
238 return -EINVAL;
239 return ret;
240}
241EXPORT_SYMBOL_GPL(platform_get_irq_optional);
242
243/**
244 * platform_get_irq - get an IRQ for a device
245 * @dev: platform device
246 * @num: IRQ number index
247 *
248 * Gets an IRQ for a platform device and prints an error message if finding the
249 * IRQ fails. Device drivers should check the return value for errors so as to
250 * not pass a negative integer value to the request_irq() APIs.
251 *
252 * For example::
253 *
254 * int irq = platform_get_irq(pdev, 0);
255 * if (irq < 0)
256 * return irq;
257 *
258 * Return: non-zero IRQ number on success, negative error number on failure.
259 */
260int platform_get_irq(struct platform_device *dev, unsigned int num)
261{
262 int ret;
263
264 ret = platform_get_irq_optional(dev, num);
265 if (ret < 0)
266 return dev_err_probe(&dev->dev, ret,
267 "IRQ index %u not found\n", num);
268
269 return ret;
270}
271EXPORT_SYMBOL_GPL(platform_get_irq);
272
273/**
274 * platform_irq_count - Count the number of IRQs a platform device uses
275 * @dev: platform device
276 *
277 * Return: Number of IRQs a platform device uses or EPROBE_DEFER
278 */
279int platform_irq_count(struct platform_device *dev)
280{
281 int ret, nr = 0;
282
283 while ((ret = platform_get_irq_optional(dev, nr)) >= 0)
284 nr++;
285
286 if (ret == -EPROBE_DEFER)
287 return ret;
288
289 return nr;
290}
291EXPORT_SYMBOL_GPL(platform_irq_count);
292
293struct irq_affinity_devres {
294 unsigned int count;
295 unsigned int irq[] __counted_by(count);
296};
297
298static void platform_disable_acpi_irq(struct platform_device *pdev, int index)
299{
300 struct resource *r;
301
302 r = platform_get_resource(pdev, IORESOURCE_IRQ, index);
303 if (r)
304 irqresource_disabled(r, 0);
305}
306
307static void devm_platform_get_irqs_affinity_release(struct device *dev,
308 void *res)
309{
310 struct irq_affinity_devres *ptr = res;
311 int i;
312
313 for (i = 0; i < ptr->count; i++) {
314 irq_dispose_mapping(ptr->irq[i]);
315
316 if (is_acpi_device_node(dev_fwnode(dev)))
317 platform_disable_acpi_irq(to_platform_device(dev), i);
318 }
319}
320
321/**
322 * devm_platform_get_irqs_affinity - devm method to get a set of IRQs for a
323 * device using an interrupt affinity descriptor
324 * @dev: platform device pointer
325 * @affd: affinity descriptor
326 * @minvec: minimum count of interrupt vectors
327 * @maxvec: maximum count of interrupt vectors
328 * @irqs: pointer holder for IRQ numbers
329 *
330 * Gets a set of IRQs for a platform device, and updates IRQ afffinty according
331 * to the passed affinity descriptor
332 *
333 * Return: Number of vectors on success, negative error number on failure.
334 */
335int devm_platform_get_irqs_affinity(struct platform_device *dev,
336 struct irq_affinity *affd,
337 unsigned int minvec,
338 unsigned int maxvec,
339 int **irqs)
340{
341 struct irq_affinity_devres *ptr;
342 struct irq_affinity_desc *desc;
343 size_t size;
344 int i, ret, nvec;
345
346 if (!affd)
347 return -EPERM;
348
349 if (maxvec < minvec)
350 return -ERANGE;
351
352 nvec = platform_irq_count(dev);
353 if (nvec < 0)
354 return nvec;
355
356 if (nvec < minvec)
357 return -ENOSPC;
358
359 nvec = irq_calc_affinity_vectors(minvec, nvec, affd);
360 if (nvec < minvec)
361 return -ENOSPC;
362
363 if (nvec > maxvec)
364 nvec = maxvec;
365
366 size = sizeof(*ptr) + sizeof(unsigned int) * nvec;
367 ptr = devres_alloc(devm_platform_get_irqs_affinity_release, size,
368 GFP_KERNEL);
369 if (!ptr)
370 return -ENOMEM;
371
372 ptr->count = nvec;
373
374 for (i = 0; i < nvec; i++) {
375 int irq = platform_get_irq(dev, i);
376 if (irq < 0) {
377 ret = irq;
378 goto err_free_devres;
379 }
380 ptr->irq[i] = irq;
381 }
382
383 desc = irq_create_affinity_masks(nvec, affd);
384 if (!desc) {
385 ret = -ENOMEM;
386 goto err_free_devres;
387 }
388
389 for (i = 0; i < nvec; i++) {
390 ret = irq_update_affinity_desc(ptr->irq[i], &desc[i]);
391 if (ret) {
392 dev_err(&dev->dev, "failed to update irq%d affinity descriptor (%d)\n",
393 ptr->irq[i], ret);
394 goto err_free_desc;
395 }
396 }
397
398 devres_add(&dev->dev, ptr);
399
400 kfree(desc);
401
402 *irqs = ptr->irq;
403
404 return nvec;
405
406err_free_desc:
407 kfree(desc);
408err_free_devres:
409 devres_free(ptr);
410 return ret;
411}
412EXPORT_SYMBOL_GPL(devm_platform_get_irqs_affinity);
413
414/**
415 * platform_get_resource_byname - get a resource for a device by name
416 * @dev: platform device
417 * @type: resource type
418 * @name: resource name
419 */
420struct resource *platform_get_resource_byname(struct platform_device *dev,
421 unsigned int type,
422 const char *name)
423{
424 u32 i;
425
426 for (i = 0; i < dev->num_resources; i++) {
427 struct resource *r = &dev->resource[i];
428
429 if (unlikely(!r->name))
430 continue;
431
432 if (type == resource_type(r) && !strcmp(r->name, name))
433 return r;
434 }
435 return NULL;
436}
437EXPORT_SYMBOL_GPL(platform_get_resource_byname);
438
439static int __platform_get_irq_byname(struct platform_device *dev,
440 const char *name)
441{
442 struct resource *r;
443 int ret;
444
445 ret = fwnode_irq_get_byname(dev_fwnode(&dev->dev), name);
446 if (ret > 0 || ret == -EPROBE_DEFER)
447 return ret;
448
449 r = platform_get_resource_byname(dev, IORESOURCE_IRQ, name);
450 if (r) {
451 if (WARN(!r->start, "0 is an invalid IRQ number\n"))
452 return -EINVAL;
453 return r->start;
454 }
455
456 return -ENXIO;
457}
458
459/**
460 * platform_get_irq_byname - get an IRQ for a device by name
461 * @dev: platform device
462 * @name: IRQ name
463 *
464 * Get an IRQ like platform_get_irq(), but then by name rather then by index.
465 *
466 * Return: non-zero IRQ number on success, negative error number on failure.
467 */
468int platform_get_irq_byname(struct platform_device *dev, const char *name)
469{
470 int ret;
471
472 ret = __platform_get_irq_byname(dev, name);
473 if (ret < 0)
474 return dev_err_probe(&dev->dev, ret, "IRQ %s not found\n",
475 name);
476 return ret;
477}
478EXPORT_SYMBOL_GPL(platform_get_irq_byname);
479
480/**
481 * platform_get_irq_byname_optional - get an optional IRQ for a device by name
482 * @dev: platform device
483 * @name: IRQ name
484 *
485 * Get an optional IRQ by name like platform_get_irq_byname(). Except that it
486 * does not print an error message if an IRQ can not be obtained.
487 *
488 * Return: non-zero IRQ number on success, negative error number on failure.
489 */
490int platform_get_irq_byname_optional(struct platform_device *dev,
491 const char *name)
492{
493 return __platform_get_irq_byname(dev, name);
494}
495EXPORT_SYMBOL_GPL(platform_get_irq_byname_optional);
496
497/**
498 * platform_add_devices - add a numbers of platform devices
499 * @devs: array of platform devices to add
500 * @num: number of platform devices in array
501 *
502 * Return: 0 on success, negative error number on failure.
503 */
504int platform_add_devices(struct platform_device **devs, int num)
505{
506 int i, ret = 0;
507
508 for (i = 0; i < num; i++) {
509 ret = platform_device_register(devs[i]);
510 if (ret) {
511 while (--i >= 0)
512 platform_device_unregister(devs[i]);
513 break;
514 }
515 }
516
517 return ret;
518}
519EXPORT_SYMBOL_GPL(platform_add_devices);
520
521struct platform_object {
522 struct platform_device pdev;
523 char name[];
524};
525
526/*
527 * Set up default DMA mask for platform devices if the they weren't
528 * previously set by the architecture / DT.
529 */
530static void setup_pdev_dma_masks(struct platform_device *pdev)
531{
532 pdev->dev.dma_parms = &pdev->dma_parms;
533
534 if (!pdev->dev.coherent_dma_mask)
535 pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
536 if (!pdev->dev.dma_mask) {
537 pdev->platform_dma_mask = DMA_BIT_MASK(32);
538 pdev->dev.dma_mask = &pdev->platform_dma_mask;
539 }
540};
541
542/**
543 * platform_device_put - destroy a platform device
544 * @pdev: platform device to free
545 *
546 * Free all memory associated with a platform device. This function must
547 * _only_ be externally called in error cases. All other usage is a bug.
548 */
549void platform_device_put(struct platform_device *pdev)
550{
551 if (!IS_ERR_OR_NULL(pdev))
552 put_device(&pdev->dev);
553}
554EXPORT_SYMBOL_GPL(platform_device_put);
555
556static void platform_device_release(struct device *dev)
557{
558 struct platform_object *pa = container_of(dev, struct platform_object,
559 pdev.dev);
560
561 of_node_put(pa->pdev.dev.of_node);
562 kfree(pa->pdev.dev.platform_data);
563 kfree(pa->pdev.mfd_cell);
564 kfree(pa->pdev.resource);
565 kfree(pa->pdev.driver_override);
566 kfree(pa);
567}
568
569/**
570 * platform_device_alloc - create a platform device
571 * @name: base name of the device we're adding
572 * @id: instance id
573 *
574 * Create a platform device object which can have other objects attached
575 * to it, and which will have attached objects freed when it is released.
576 */
577struct platform_device *platform_device_alloc(const char *name, int id)
578{
579 struct platform_object *pa;
580
581 pa = kzalloc(sizeof(*pa) + strlen(name) + 1, GFP_KERNEL);
582 if (pa) {
583 strcpy(pa->name, name);
584 pa->pdev.name = pa->name;
585 pa->pdev.id = id;
586 device_initialize(&pa->pdev.dev);
587 pa->pdev.dev.release = platform_device_release;
588 setup_pdev_dma_masks(&pa->pdev);
589 }
590
591 return pa ? &pa->pdev : NULL;
592}
593EXPORT_SYMBOL_GPL(platform_device_alloc);
594
595/**
596 * platform_device_add_resources - add resources to a platform device
597 * @pdev: platform device allocated by platform_device_alloc to add resources to
598 * @res: set of resources that needs to be allocated for the device
599 * @num: number of resources
600 *
601 * Add a copy of the resources to the platform device. The memory
602 * associated with the resources will be freed when the platform device is
603 * released.
604 */
605int platform_device_add_resources(struct platform_device *pdev,
606 const struct resource *res, unsigned int num)
607{
608 struct resource *r = NULL;
609
610 if (res) {
611 r = kmemdup_array(res, num, sizeof(*r), GFP_KERNEL);
612 if (!r)
613 return -ENOMEM;
614 }
615
616 kfree(pdev->resource);
617 pdev->resource = r;
618 pdev->num_resources = num;
619 return 0;
620}
621EXPORT_SYMBOL_GPL(platform_device_add_resources);
622
623/**
624 * platform_device_add_data - add platform-specific data to a platform device
625 * @pdev: platform device allocated by platform_device_alloc to add resources to
626 * @data: platform specific data for this platform device
627 * @size: size of platform specific data
628 *
629 * Add a copy of platform specific data to the platform device's
630 * platform_data pointer. The memory associated with the platform data
631 * will be freed when the platform device is released.
632 */
633int platform_device_add_data(struct platform_device *pdev, const void *data,
634 size_t size)
635{
636 void *d = NULL;
637
638 if (data) {
639 d = kmemdup(data, size, GFP_KERNEL);
640 if (!d)
641 return -ENOMEM;
642 }
643
644 kfree(pdev->dev.platform_data);
645 pdev->dev.platform_data = d;
646 return 0;
647}
648EXPORT_SYMBOL_GPL(platform_device_add_data);
649
650/**
651 * platform_device_add - add a platform device to device hierarchy
652 * @pdev: platform device we're adding
653 *
654 * This is part 2 of platform_device_register(), though may be called
655 * separately _iff_ pdev was allocated by platform_device_alloc().
656 */
657int platform_device_add(struct platform_device *pdev)
658{
659 struct device *dev = &pdev->dev;
660 u32 i;
661 int ret;
662
663 if (!dev->parent)
664 dev->parent = &platform_bus;
665
666 dev->bus = &platform_bus_type;
667
668 switch (pdev->id) {
669 default:
670 dev_set_name(dev, "%s.%d", pdev->name, pdev->id);
671 break;
672 case PLATFORM_DEVID_NONE:
673 dev_set_name(dev, "%s", pdev->name);
674 break;
675 case PLATFORM_DEVID_AUTO:
676 /*
677 * Automatically allocated device ID. We mark it as such so
678 * that we remember it must be freed, and we append a suffix
679 * to avoid namespace collision with explicit IDs.
680 */
681 ret = ida_alloc(&platform_devid_ida, GFP_KERNEL);
682 if (ret < 0)
683 return ret;
684 pdev->id = ret;
685 pdev->id_auto = true;
686 dev_set_name(dev, "%s.%d.auto", pdev->name, pdev->id);
687 break;
688 }
689
690 for (i = 0; i < pdev->num_resources; i++) {
691 struct resource *p, *r = &pdev->resource[i];
692
693 if (r->name == NULL)
694 r->name = dev_name(dev);
695
696 p = r->parent;
697 if (!p) {
698 if (resource_type(r) == IORESOURCE_MEM)
699 p = &iomem_resource;
700 else if (resource_type(r) == IORESOURCE_IO)
701 p = &ioport_resource;
702 }
703
704 if (p) {
705 ret = insert_resource(p, r);
706 if (ret) {
707 dev_err(dev, "failed to claim resource %d: %pR\n", i, r);
708 goto failed;
709 }
710 }
711 }
712
713 pr_debug("Registering platform device '%s'. Parent at %s\n", dev_name(dev),
714 dev_name(dev->parent));
715
716 ret = device_add(dev);
717 if (ret)
718 goto failed;
719
720 return 0;
721
722 failed:
723 if (pdev->id_auto) {
724 ida_free(&platform_devid_ida, pdev->id);
725 pdev->id = PLATFORM_DEVID_AUTO;
726 }
727
728 while (i--) {
729 struct resource *r = &pdev->resource[i];
730 if (r->parent)
731 release_resource(r);
732 }
733
734 return ret;
735}
736EXPORT_SYMBOL_GPL(platform_device_add);
737
738/**
739 * platform_device_del - remove a platform-level device
740 * @pdev: platform device we're removing
741 *
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.
745 */
746void platform_device_del(struct platform_device *pdev)
747{
748 u32 i;
749
750 if (!IS_ERR_OR_NULL(pdev)) {
751 device_del(&pdev->dev);
752
753 if (pdev->id_auto) {
754 ida_free(&platform_devid_ida, pdev->id);
755 pdev->id = PLATFORM_DEVID_AUTO;
756 }
757
758 for (i = 0; i < pdev->num_resources; i++) {
759 struct resource *r = &pdev->resource[i];
760 if (r->parent)
761 release_resource(r);
762 }
763 }
764}
765EXPORT_SYMBOL_GPL(platform_device_del);
766
767/**
768 * platform_device_register - add a platform-level device
769 * @pdev: platform device we're adding
770 *
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.
774 */
775int platform_device_register(struct platform_device *pdev)
776{
777 device_initialize(&pdev->dev);
778 setup_pdev_dma_masks(pdev);
779 return platform_device_add(pdev);
780}
781EXPORT_SYMBOL_GPL(platform_device_register);
782
783/**
784 * platform_device_unregister - unregister a platform-level device
785 * @pdev: platform device we're unregistering
786 *
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().
790 */
791void platform_device_unregister(struct platform_device *pdev)
792{
793 platform_device_del(pdev);
794 platform_device_put(pdev);
795}
796EXPORT_SYMBOL_GPL(platform_device_unregister);
797
798/**
799 * platform_device_register_full - add a platform-level device with
800 * resources and platform-specific data
801 *
802 * @pdevinfo: data used to create device
803 *
804 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
805 */
806struct platform_device *platform_device_register_full(
807 const struct platform_device_info *pdevinfo)
808{
809 int ret;
810 struct platform_device *pdev;
811
812 pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
813 if (!pdev)
814 return ERR_PTR(-ENOMEM);
815
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;
820
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;
825 }
826
827 ret = platform_device_add_resources(pdev,
828 pdevinfo->res, pdevinfo->num_res);
829 if (ret)
830 goto err;
831
832 ret = platform_device_add_data(pdev,
833 pdevinfo->data, pdevinfo->size_data);
834 if (ret)
835 goto err;
836
837 if (pdevinfo->properties) {
838 ret = device_create_managed_software_node(&pdev->dev,
839 pdevinfo->properties, NULL);
840 if (ret)
841 goto err;
842 }
843
844 ret = platform_device_add(pdev);
845 if (ret) {
846err:
847 ACPI_COMPANION_SET(&pdev->dev, NULL);
848 platform_device_put(pdev);
849 return ERR_PTR(ret);
850 }
851
852 return pdev;
853}
854EXPORT_SYMBOL_GPL(platform_device_register_full);
855
856/**
857 * __platform_driver_register - register a driver for platform-level devices
858 * @drv: platform driver structure
859 * @owner: owning module/driver
860 */
861int __platform_driver_register(struct platform_driver *drv,
862 struct module *owner)
863{
864 drv->driver.owner = owner;
865 drv->driver.bus = &platform_bus_type;
866
867 return driver_register(&drv->driver);
868}
869EXPORT_SYMBOL_GPL(__platform_driver_register);
870
871/**
872 * platform_driver_unregister - unregister a driver for platform-level devices
873 * @drv: platform driver structure
874 */
875void platform_driver_unregister(struct platform_driver *drv)
876{
877 driver_unregister(&drv->driver);
878}
879EXPORT_SYMBOL_GPL(platform_driver_unregister);
880
881static int platform_probe_fail(struct platform_device *pdev)
882{
883 return -ENXIO;
884}
885
886static int is_bound_to_driver(struct device *dev, void *driver)
887{
888 if (dev->driver == driver)
889 return 1;
890 return 0;
891}
892
893/**
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
898 *
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.
903 *
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.
907 *
908 * Note that this is incompatible with deferred probing.
909 *
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.
912 */
913int __init_or_module __platform_driver_probe(struct platform_driver *drv,
914 int (*probe)(struct platform_device *), struct module *module)
915{
916 int retval;
917
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__);
921 return -EINVAL;
922 }
923
924 /*
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
927 * are any.
928 */
929 drv->driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
930
931 /*
932 * Prevent driver from requesting probe deferral to avoid further
933 * futile probe attempts.
934 */
935 drv->prevent_deferred_probe = true;
936
937 /* make sure driver won't have bind/unbind attributes */
938 drv->driver.suppress_bind_attrs = true;
939
940 /* temporary section violation during probe() */
941 drv->probe = probe;
942 retval = __platform_driver_register(drv, module);
943 if (retval)
944 return retval;
945
946 /* Force all new probes of this driver to fail */
947 drv->probe = platform_probe_fail;
948
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.
951 */
952 if (!bus_for_each_dev(&platform_bus_type, NULL, &drv->driver, is_bound_to_driver)) {
953 retval = -ENODEV;
954 platform_driver_unregister(drv);
955 }
956
957 return retval;
958}
959EXPORT_SYMBOL_GPL(__platform_driver_probe);
960
961/**
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
970 *
971 * Use this in legacy-style modules that probe hardware directly and
972 * register a single platform device and corresponding platform driver.
973 *
974 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
975 */
976struct 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)
981{
982 struct platform_device *pdev;
983 int error;
984
985 pdev = platform_device_alloc(driver->driver.name, -1);
986 if (!pdev) {
987 error = -ENOMEM;
988 goto err_out;
989 }
990
991 error = platform_device_add_resources(pdev, res, n_res);
992 if (error)
993 goto err_pdev_put;
994
995 error = platform_device_add_data(pdev, data, size);
996 if (error)
997 goto err_pdev_put;
998
999 error = platform_device_add(pdev);
1000 if (error)
1001 goto err_pdev_put;
1002
1003 error = __platform_driver_probe(driver, probe, module);
1004 if (error)
1005 goto err_pdev_del;
1006
1007 return pdev;
1008
1009err_pdev_del:
1010 platform_device_del(pdev);
1011err_pdev_put:
1012 platform_device_put(pdev);
1013err_out:
1014 return ERR_PTR(error);
1015}
1016EXPORT_SYMBOL_GPL(__platform_create_bundle);
1017
1018/**
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
1023 *
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.
1028 *
1029 * Returns: 0 on success or a negative error code on failure.
1030 */
1031int __platform_register_drivers(struct platform_driver * const *drivers,
1032 unsigned int count, struct module *owner)
1033{
1034 unsigned int i;
1035 int err;
1036
1037 for (i = 0; i < count; i++) {
1038 pr_debug("registering platform driver %ps\n", drivers[i]);
1039
1040 err = __platform_driver_register(drivers[i], owner);
1041 if (err < 0) {
1042 pr_err("failed to register platform driver %ps: %d\n",
1043 drivers[i], err);
1044 goto error;
1045 }
1046 }
1047
1048 return 0;
1049
1050error:
1051 while (i--) {
1052 pr_debug("unregistering platform driver %ps\n", drivers[i]);
1053 platform_driver_unregister(drivers[i]);
1054 }
1055
1056 return err;
1057}
1058EXPORT_SYMBOL_GPL(__platform_register_drivers);
1059
1060/**
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
1064 *
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.
1068 */
1069void platform_unregister_drivers(struct platform_driver * const *drivers,
1070 unsigned int count)
1071{
1072 while (count--) {
1073 pr_debug("unregistering platform driver %ps\n", drivers[count]);
1074 platform_driver_unregister(drivers[count]);
1075 }
1076}
1077EXPORT_SYMBOL_GPL(platform_unregister_drivers);
1078
1079static const struct platform_device_id *platform_match_id(
1080 const struct platform_device_id *id,
1081 struct platform_device *pdev)
1082{
1083 while (id->name[0]) {
1084 if (strcmp(pdev->name, id->name) == 0) {
1085 pdev->id_entry = id;
1086 return id;
1087 }
1088 id++;
1089 }
1090 return NULL;
1091}
1092
1093#ifdef CONFIG_PM_SLEEP
1094
1095static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
1096{
1097 struct platform_driver *pdrv = to_platform_driver(dev->driver);
1098 struct platform_device *pdev = to_platform_device(dev);
1099 int ret = 0;
1100
1101 if (dev->driver && pdrv->suspend)
1102 ret = pdrv->suspend(pdev, mesg);
1103
1104 return ret;
1105}
1106
1107static int platform_legacy_resume(struct device *dev)
1108{
1109 struct platform_driver *pdrv = to_platform_driver(dev->driver);
1110 struct platform_device *pdev = to_platform_device(dev);
1111 int ret = 0;
1112
1113 if (dev->driver && pdrv->resume)
1114 ret = pdrv->resume(pdev);
1115
1116 return ret;
1117}
1118
1119#endif /* CONFIG_PM_SLEEP */
1120
1121#ifdef CONFIG_SUSPEND
1122
1123int platform_pm_suspend(struct device *dev)
1124{
1125 const struct device_driver *drv = dev->driver;
1126 int ret = 0;
1127
1128 if (!drv)
1129 return 0;
1130
1131 if (drv->pm) {
1132 if (drv->pm->suspend)
1133 ret = drv->pm->suspend(dev);
1134 } else {
1135 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
1136 }
1137
1138 return ret;
1139}
1140
1141int platform_pm_resume(struct device *dev)
1142{
1143 const struct device_driver *drv = dev->driver;
1144 int ret = 0;
1145
1146 if (!drv)
1147 return 0;
1148
1149 if (drv->pm) {
1150 if (drv->pm->resume)
1151 ret = drv->pm->resume(dev);
1152 } else {
1153 ret = platform_legacy_resume(dev);
1154 }
1155
1156 return ret;
1157}
1158
1159#endif /* CONFIG_SUSPEND */
1160
1161#ifdef CONFIG_HIBERNATE_CALLBACKS
1162
1163int platform_pm_freeze(struct device *dev)
1164{
1165 const struct device_driver *drv = dev->driver;
1166 int ret = 0;
1167
1168 if (!drv)
1169 return 0;
1170
1171 if (drv->pm) {
1172 if (drv->pm->freeze)
1173 ret = drv->pm->freeze(dev);
1174 } else {
1175 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
1176 }
1177
1178 return ret;
1179}
1180
1181int platform_pm_thaw(struct device *dev)
1182{
1183 const struct device_driver *drv = dev->driver;
1184 int ret = 0;
1185
1186 if (!drv)
1187 return 0;
1188
1189 if (drv->pm) {
1190 if (drv->pm->thaw)
1191 ret = drv->pm->thaw(dev);
1192 } else {
1193 ret = platform_legacy_resume(dev);
1194 }
1195
1196 return ret;
1197}
1198
1199int platform_pm_poweroff(struct device *dev)
1200{
1201 const struct device_driver *drv = dev->driver;
1202 int ret = 0;
1203
1204 if (!drv)
1205 return 0;
1206
1207 if (drv->pm) {
1208 if (drv->pm->poweroff)
1209 ret = drv->pm->poweroff(dev);
1210 } else {
1211 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
1212 }
1213
1214 return ret;
1215}
1216
1217int platform_pm_restore(struct device *dev)
1218{
1219 const struct device_driver *drv = dev->driver;
1220 int ret = 0;
1221
1222 if (!drv)
1223 return 0;
1224
1225 if (drv->pm) {
1226 if (drv->pm->restore)
1227 ret = drv->pm->restore(dev);
1228 } else {
1229 ret = platform_legacy_resume(dev);
1230 }
1231
1232 return ret;
1233}
1234
1235#endif /* CONFIG_HIBERNATE_CALLBACKS */
1236
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)"
1242 */
1243static ssize_t modalias_show(struct device *dev,
1244 struct device_attribute *attr, char *buf)
1245{
1246 struct platform_device *pdev = to_platform_device(dev);
1247 int len;
1248
1249 len = of_device_modalias(dev, buf, PAGE_SIZE);
1250 if (len != -ENODEV)
1251 return len;
1252
1253 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
1254 if (len != -ENODEV)
1255 return len;
1256
1257 return sysfs_emit(buf, "platform:%s\n", pdev->name);
1258}
1259static DEVICE_ATTR_RO(modalias);
1260
1261static ssize_t numa_node_show(struct device *dev,
1262 struct device_attribute *attr, char *buf)
1263{
1264 return sysfs_emit(buf, "%d\n", dev_to_node(dev));
1265}
1266static DEVICE_ATTR_RO(numa_node);
1267
1268static ssize_t driver_override_show(struct device *dev,
1269 struct device_attribute *attr, char *buf)
1270{
1271 struct platform_device *pdev = to_platform_device(dev);
1272 ssize_t len;
1273
1274 device_lock(dev);
1275 len = sysfs_emit(buf, "%s\n", pdev->driver_override);
1276 device_unlock(dev);
1277
1278 return len;
1279}
1280
1281static ssize_t driver_override_store(struct device *dev,
1282 struct device_attribute *attr,
1283 const char *buf, size_t count)
1284{
1285 struct platform_device *pdev = to_platform_device(dev);
1286 int ret;
1287
1288 ret = driver_set_override(dev, &pdev->driver_override, buf, count);
1289 if (ret)
1290 return ret;
1291
1292 return count;
1293}
1294static DEVICE_ATTR_RW(driver_override);
1295
1296static struct attribute *platform_dev_attrs[] = {
1297 &dev_attr_modalias.attr,
1298 &dev_attr_numa_node.attr,
1299 &dev_attr_driver_override.attr,
1300 NULL,
1301};
1302
1303static umode_t platform_dev_attrs_visible(struct kobject *kobj, struct attribute *a,
1304 int n)
1305{
1306 struct device *dev = container_of(kobj, typeof(*dev), kobj);
1307
1308 if (a == &dev_attr_numa_node.attr &&
1309 dev_to_node(dev) == NUMA_NO_NODE)
1310 return 0;
1311
1312 return a->mode;
1313}
1314
1315static const struct attribute_group platform_dev_group = {
1316 .attrs = platform_dev_attrs,
1317 .is_visible = platform_dev_attrs_visible,
1318};
1319__ATTRIBUTE_GROUPS(platform_dev);
1320
1321
1322/**
1323 * platform_match - bind platform device to platform driver.
1324 * @dev: device.
1325 * @drv: driver.
1326 *
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
1333 * or not.
1334 */
1335static int platform_match(struct device *dev, const struct device_driver *drv)
1336{
1337 struct platform_device *pdev = to_platform_device(dev);
1338 struct platform_driver *pdrv = to_platform_driver(drv);
1339
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);
1343
1344 /* Attempt an OF style match first */
1345 if (of_driver_match_device(dev, drv))
1346 return 1;
1347
1348 /* Then try ACPI style match */
1349 if (acpi_driver_match_device(dev, drv))
1350 return 1;
1351
1352 /* Then try to match against the id table */
1353 if (pdrv->id_table)
1354 return platform_match_id(pdrv->id_table, pdev) != NULL;
1355
1356 /* fall-back to driver name match */
1357 return (strcmp(pdev->name, drv->name) == 0);
1358}
1359
1360static int platform_uevent(const struct device *dev, struct kobj_uevent_env *env)
1361{
1362 const struct platform_device *pdev = to_platform_device(dev);
1363 int rc;
1364
1365 /* Some devices have extra OF data and an OF-style MODALIAS */
1366 rc = of_device_uevent_modalias(dev, env);
1367 if (rc != -ENODEV)
1368 return rc;
1369
1370 rc = acpi_device_uevent_modalias(dev, env);
1371 if (rc != -ENODEV)
1372 return rc;
1373
1374 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
1375 pdev->name);
1376 return 0;
1377}
1378
1379static int platform_probe(struct device *_dev)
1380{
1381 struct platform_driver *drv = to_platform_driver(_dev->driver);
1382 struct platform_device *dev = to_platform_device(_dev);
1383 int ret;
1384
1385 /*
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.
1391 */
1392 if (unlikely(drv->probe == platform_probe_fail))
1393 return -ENXIO;
1394
1395 ret = of_clk_set_defaults(_dev->of_node, false);
1396 if (ret < 0)
1397 return ret;
1398
1399 ret = dev_pm_domain_attach(_dev, true);
1400 if (ret)
1401 goto out;
1402
1403 if (drv->probe) {
1404 ret = drv->probe(dev);
1405 if (ret)
1406 dev_pm_domain_detach(_dev, true);
1407 }
1408
1409out:
1410 if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
1411 dev_warn(_dev, "probe deferral not supported\n");
1412 ret = -ENXIO;
1413 }
1414
1415 return ret;
1416}
1417
1418static void platform_remove(struct device *_dev)
1419{
1420 struct platform_driver *drv = to_platform_driver(_dev->driver);
1421 struct platform_device *dev = to_platform_device(_dev);
1422
1423 if (drv->remove)
1424 drv->remove(dev);
1425 dev_pm_domain_detach(_dev, true);
1426}
1427
1428static void platform_shutdown(struct device *_dev)
1429{
1430 struct platform_device *dev = to_platform_device(_dev);
1431 struct platform_driver *drv;
1432
1433 if (!_dev->driver)
1434 return;
1435
1436 drv = to_platform_driver(_dev->driver);
1437 if (drv->shutdown)
1438 drv->shutdown(dev);
1439}
1440
1441static int platform_dma_configure(struct device *dev)
1442{
1443 struct platform_driver *drv = to_platform_driver(dev->driver);
1444 struct fwnode_handle *fwnode = dev_fwnode(dev);
1445 enum dev_dma_attr attr;
1446 int ret = 0;
1447
1448 if (is_of_node(fwnode)) {
1449 ret = of_dma_configure(dev, to_of_node(fwnode), true);
1450 } else if (is_acpi_device_node(fwnode)) {
1451 attr = acpi_get_dma_attr(to_acpi_device_node(fwnode));
1452 ret = acpi_dma_configure(dev, attr);
1453 }
1454 if (ret || drv->driver_managed_dma)
1455 return ret;
1456
1457 ret = iommu_device_use_default_domain(dev);
1458 if (ret)
1459 arch_teardown_dma_ops(dev);
1460
1461 return ret;
1462}
1463
1464static void platform_dma_cleanup(struct device *dev)
1465{
1466 struct platform_driver *drv = to_platform_driver(dev->driver);
1467
1468 if (!drv->driver_managed_dma)
1469 iommu_device_unuse_default_domain(dev);
1470}
1471
1472static const struct dev_pm_ops platform_dev_pm_ops = {
1473 SET_RUNTIME_PM_OPS(pm_generic_runtime_suspend, pm_generic_runtime_resume, NULL)
1474 USE_PLATFORM_PM_SLEEP_OPS
1475};
1476
1477const struct bus_type platform_bus_type = {
1478 .name = "platform",
1479 .dev_groups = platform_dev_groups,
1480 .match = platform_match,
1481 .uevent = platform_uevent,
1482 .probe = platform_probe,
1483 .remove = platform_remove,
1484 .shutdown = platform_shutdown,
1485 .dma_configure = platform_dma_configure,
1486 .dma_cleanup = platform_dma_cleanup,
1487 .pm = &platform_dev_pm_ops,
1488};
1489EXPORT_SYMBOL_GPL(platform_bus_type);
1490
1491static inline int __platform_match(struct device *dev, const void *drv)
1492{
1493 return platform_match(dev, (struct device_driver *)drv);
1494}
1495
1496/**
1497 * platform_find_device_by_driver - Find a platform device with a given
1498 * driver.
1499 * @start: The device to start the search from.
1500 * @drv: The device driver to look for.
1501 */
1502struct device *platform_find_device_by_driver(struct device *start,
1503 const struct device_driver *drv)
1504{
1505 return bus_find_device(&platform_bus_type, start, drv,
1506 __platform_match);
1507}
1508EXPORT_SYMBOL_GPL(platform_find_device_by_driver);
1509
1510void __weak __init early_platform_cleanup(void) { }
1511
1512int __init platform_bus_init(void)
1513{
1514 int error;
1515
1516 early_platform_cleanup();
1517
1518 error = device_register(&platform_bus);
1519 if (error) {
1520 put_device(&platform_bus);
1521 return error;
1522 }
1523 error = bus_register(&platform_bus_type);
1524 if (error)
1525 device_unregister(&platform_bus);
1526
1527 return error;
1528}