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