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