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