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