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