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