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