Mention branches and keyring.
[releases.git] / 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         char *driver_override, *old, *cp;
877
878         /* We need to keep extra room for a newline */
879         if (count >= (PAGE_SIZE - 1))
880                 return -EINVAL;
881
882         driver_override = kstrndup(buf, count, GFP_KERNEL);
883         if (!driver_override)
884                 return -ENOMEM;
885
886         cp = strchr(driver_override, '\n');
887         if (cp)
888                 *cp = '\0';
889
890         device_lock(dev);
891         old = pdev->driver_override;
892         if (strlen(driver_override)) {
893                 pdev->driver_override = driver_override;
894         } else {
895                 kfree(driver_override);
896                 pdev->driver_override = NULL;
897         }
898         device_unlock(dev);
899
900         kfree(old);
901
902         return count;
903 }
904
905 static ssize_t driver_override_show(struct device *dev,
906                                     struct device_attribute *attr, char *buf)
907 {
908         struct platform_device *pdev = to_platform_device(dev);
909         ssize_t len;
910
911         device_lock(dev);
912         len = sprintf(buf, "%s\n", pdev->driver_override);
913         device_unlock(dev);
914         return len;
915 }
916 static DEVICE_ATTR_RW(driver_override);
917
918
919 static struct attribute *platform_dev_attrs[] = {
920         &dev_attr_modalias.attr,
921         &dev_attr_driver_override.attr,
922         NULL,
923 };
924 ATTRIBUTE_GROUPS(platform_dev);
925
926 static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
927 {
928         struct platform_device  *pdev = to_platform_device(dev);
929         int rc;
930
931         /* Some devices have extra OF data and an OF-style MODALIAS */
932         rc = of_device_uevent_modalias(dev, env);
933         if (rc != -ENODEV)
934                 return rc;
935
936         rc = acpi_device_uevent_modalias(dev, env);
937         if (rc != -ENODEV)
938                 return rc;
939
940         add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
941                         pdev->name);
942         return 0;
943 }
944
945 static const struct platform_device_id *platform_match_id(
946                         const struct platform_device_id *id,
947                         struct platform_device *pdev)
948 {
949         while (id->name[0]) {
950                 if (strcmp(pdev->name, id->name) == 0) {
951                         pdev->id_entry = id;
952                         return id;
953                 }
954                 id++;
955         }
956         return NULL;
957 }
958
959 /**
960  * platform_match - bind platform device to platform driver.
961  * @dev: device.
962  * @drv: driver.
963  *
964  * Platform device IDs are assumed to be encoded like this:
965  * "<name><instance>", where <name> is a short description of the type of
966  * device, like "pci" or "floppy", and <instance> is the enumerated
967  * instance of the device, like '0' or '42'.  Driver IDs are simply
968  * "<name>".  So, extract the <name> from the platform_device structure,
969  * and compare it against the name of the driver. Return whether they match
970  * or not.
971  */
972 static int platform_match(struct device *dev, struct device_driver *drv)
973 {
974         struct platform_device *pdev = to_platform_device(dev);
975         struct platform_driver *pdrv = to_platform_driver(drv);
976
977         /* When driver_override is set, only bind to the matching driver */
978         if (pdev->driver_override)
979                 return !strcmp(pdev->driver_override, drv->name);
980
981         /* Attempt an OF style match first */
982         if (of_driver_match_device(dev, drv))
983                 return 1;
984
985         /* Then try ACPI style match */
986         if (acpi_driver_match_device(dev, drv))
987                 return 1;
988
989         /* Then try to match against the id table */
990         if (pdrv->id_table)
991                 return platform_match_id(pdrv->id_table, pdev) != NULL;
992
993         /* fall-back to driver name match */
994         return (strcmp(pdev->name, drv->name) == 0);
995 }
996
997 #ifdef CONFIG_PM_SLEEP
998
999 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
1000 {
1001         struct platform_driver *pdrv = to_platform_driver(dev->driver);
1002         struct platform_device *pdev = to_platform_device(dev);
1003         int ret = 0;
1004
1005         if (dev->driver && pdrv->suspend)
1006                 ret = pdrv->suspend(pdev, mesg);
1007
1008         return ret;
1009 }
1010
1011 static int platform_legacy_resume(struct device *dev)
1012 {
1013         struct platform_driver *pdrv = to_platform_driver(dev->driver);
1014         struct platform_device *pdev = to_platform_device(dev);
1015         int ret = 0;
1016
1017         if (dev->driver && pdrv->resume)
1018                 ret = pdrv->resume(pdev);
1019
1020         return ret;
1021 }
1022
1023 #endif /* CONFIG_PM_SLEEP */
1024
1025 #ifdef CONFIG_SUSPEND
1026
1027 int platform_pm_suspend(struct device *dev)
1028 {
1029         struct device_driver *drv = dev->driver;
1030         int ret = 0;
1031
1032         if (!drv)
1033                 return 0;
1034
1035         if (drv->pm) {
1036                 if (drv->pm->suspend)
1037                         ret = drv->pm->suspend(dev);
1038         } else {
1039                 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
1040         }
1041
1042         return ret;
1043 }
1044
1045 int platform_pm_resume(struct device *dev)
1046 {
1047         struct device_driver *drv = dev->driver;
1048         int ret = 0;
1049
1050         if (!drv)
1051                 return 0;
1052
1053         if (drv->pm) {
1054                 if (drv->pm->resume)
1055                         ret = drv->pm->resume(dev);
1056         } else {
1057                 ret = platform_legacy_resume(dev);
1058         }
1059
1060         return ret;
1061 }
1062
1063 #endif /* CONFIG_SUSPEND */
1064
1065 #ifdef CONFIG_HIBERNATE_CALLBACKS
1066
1067 int platform_pm_freeze(struct device *dev)
1068 {
1069         struct device_driver *drv = dev->driver;
1070         int ret = 0;
1071
1072         if (!drv)
1073                 return 0;
1074
1075         if (drv->pm) {
1076                 if (drv->pm->freeze)
1077                         ret = drv->pm->freeze(dev);
1078         } else {
1079                 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
1080         }
1081
1082         return ret;
1083 }
1084
1085 int platform_pm_thaw(struct device *dev)
1086 {
1087         struct device_driver *drv = dev->driver;
1088         int ret = 0;
1089
1090         if (!drv)
1091                 return 0;
1092
1093         if (drv->pm) {
1094                 if (drv->pm->thaw)
1095                         ret = drv->pm->thaw(dev);
1096         } else {
1097                 ret = platform_legacy_resume(dev);
1098         }
1099
1100         return ret;
1101 }
1102
1103 int platform_pm_poweroff(struct device *dev)
1104 {
1105         struct device_driver *drv = dev->driver;
1106         int ret = 0;
1107
1108         if (!drv)
1109                 return 0;
1110
1111         if (drv->pm) {
1112                 if (drv->pm->poweroff)
1113                         ret = drv->pm->poweroff(dev);
1114         } else {
1115                 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
1116         }
1117
1118         return ret;
1119 }
1120
1121 int platform_pm_restore(struct device *dev)
1122 {
1123         struct device_driver *drv = dev->driver;
1124         int ret = 0;
1125
1126         if (!drv)
1127                 return 0;
1128
1129         if (drv->pm) {
1130                 if (drv->pm->restore)
1131                         ret = drv->pm->restore(dev);
1132         } else {
1133                 ret = platform_legacy_resume(dev);
1134         }
1135
1136         return ret;
1137 }
1138
1139 #endif /* CONFIG_HIBERNATE_CALLBACKS */
1140
1141 static const struct dev_pm_ops platform_dev_pm_ops = {
1142         .runtime_suspend = pm_generic_runtime_suspend,
1143         .runtime_resume = pm_generic_runtime_resume,
1144         USE_PLATFORM_PM_SLEEP_OPS
1145 };
1146
1147 struct bus_type platform_bus_type = {
1148         .name           = "platform",
1149         .dev_groups     = platform_dev_groups,
1150         .match          = platform_match,
1151         .uevent         = platform_uevent,
1152         .pm             = &platform_dev_pm_ops,
1153 };
1154 EXPORT_SYMBOL_GPL(platform_bus_type);
1155
1156 int __init platform_bus_init(void)
1157 {
1158         int error;
1159
1160         early_platform_cleanup();
1161
1162         error = device_register(&platform_bus);
1163         if (error)
1164                 return error;
1165         error =  bus_register(&platform_bus_type);
1166         if (error)
1167                 device_unregister(&platform_bus);
1168         of_platform_register_reconfig_notifier();
1169         return error;
1170 }
1171
1172 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
1173 u64 dma_get_required_mask(struct device *dev)
1174 {
1175         u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
1176         u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
1177         u64 mask;
1178
1179         if (!high_totalram) {
1180                 /* convert to mask just covering totalram */
1181                 low_totalram = (1 << (fls(low_totalram) - 1));
1182                 low_totalram += low_totalram - 1;
1183                 mask = low_totalram;
1184         } else {
1185                 high_totalram = (1 << (fls(high_totalram) - 1));
1186                 high_totalram += high_totalram - 1;
1187                 mask = (((u64)high_totalram) << 32) + 0xffffffff;
1188         }
1189         return mask;
1190 }
1191 EXPORT_SYMBOL_GPL(dma_get_required_mask);
1192 #endif
1193
1194 static __initdata LIST_HEAD(early_platform_driver_list);
1195 static __initdata LIST_HEAD(early_platform_device_list);
1196
1197 /**
1198  * early_platform_driver_register - register early platform driver
1199  * @epdrv: early_platform driver structure
1200  * @buf: string passed from early_param()
1201  *
1202  * Helper function for early_platform_init() / early_platform_init_buffer()
1203  */
1204 int __init early_platform_driver_register(struct early_platform_driver *epdrv,
1205                                           char *buf)
1206 {
1207         char *tmp;
1208         int n;
1209
1210         /* Simply add the driver to the end of the global list.
1211          * Drivers will by default be put on the list in compiled-in order.
1212          */
1213         if (!epdrv->list.next) {
1214                 INIT_LIST_HEAD(&epdrv->list);
1215                 list_add_tail(&epdrv->list, &early_platform_driver_list);
1216         }
1217
1218         /* If the user has specified device then make sure the driver
1219          * gets prioritized. The driver of the last device specified on
1220          * command line will be put first on the list.
1221          */
1222         n = strlen(epdrv->pdrv->driver.name);
1223         if (buf && !strncmp(buf, epdrv->pdrv->driver.name, n)) {
1224                 list_move(&epdrv->list, &early_platform_driver_list);
1225
1226                 /* Allow passing parameters after device name */
1227                 if (buf[n] == '\0' || buf[n] == ',')
1228                         epdrv->requested_id = -1;
1229                 else {
1230                         epdrv->requested_id = simple_strtoul(&buf[n + 1],
1231                                                              &tmp, 10);
1232
1233                         if (buf[n] != '.' || (tmp == &buf[n + 1])) {
1234                                 epdrv->requested_id = EARLY_PLATFORM_ID_ERROR;
1235                                 n = 0;
1236                         } else
1237                                 n += strcspn(&buf[n + 1], ",") + 1;
1238                 }
1239
1240                 if (buf[n] == ',')
1241                         n++;
1242
1243                 if (epdrv->bufsize) {
1244                         memcpy(epdrv->buffer, &buf[n],
1245                                min_t(int, epdrv->bufsize, strlen(&buf[n]) + 1));
1246                         epdrv->buffer[epdrv->bufsize - 1] = '\0';
1247                 }
1248         }
1249
1250         return 0;
1251 }
1252
1253 /**
1254  * early_platform_add_devices - adds a number of early platform devices
1255  * @devs: array of early platform devices to add
1256  * @num: number of early platform devices in array
1257  *
1258  * Used by early architecture code to register early platform devices and
1259  * their platform data.
1260  */
1261 void __init early_platform_add_devices(struct platform_device **devs, int num)
1262 {
1263         struct device *dev;
1264         int i;
1265
1266         /* simply add the devices to list */
1267         for (i = 0; i < num; i++) {
1268                 dev = &devs[i]->dev;
1269
1270                 if (!dev->devres_head.next) {
1271                         pm_runtime_early_init(dev);
1272                         INIT_LIST_HEAD(&dev->devres_head);
1273                         list_add_tail(&dev->devres_head,
1274                                       &early_platform_device_list);
1275                 }
1276         }
1277 }
1278
1279 /**
1280  * early_platform_driver_register_all - register early platform drivers
1281  * @class_str: string to identify early platform driver class
1282  *
1283  * Used by architecture code to register all early platform drivers
1284  * for a certain class. If omitted then only early platform drivers
1285  * with matching kernel command line class parameters will be registered.
1286  */
1287 void __init early_platform_driver_register_all(char *class_str)
1288 {
1289         /* The "class_str" parameter may or may not be present on the kernel
1290          * command line. If it is present then there may be more than one
1291          * matching parameter.
1292          *
1293          * Since we register our early platform drivers using early_param()
1294          * we need to make sure that they also get registered in the case
1295          * when the parameter is missing from the kernel command line.
1296          *
1297          * We use parse_early_options() to make sure the early_param() gets
1298          * called at least once. The early_param() may be called more than
1299          * once since the name of the preferred device may be specified on
1300          * the kernel command line. early_platform_driver_register() handles
1301          * this case for us.
1302          */
1303         parse_early_options(class_str);
1304 }
1305
1306 /**
1307  * early_platform_match - find early platform device matching driver
1308  * @epdrv: early platform driver structure
1309  * @id: id to match against
1310  */
1311 static struct platform_device * __init
1312 early_platform_match(struct early_platform_driver *epdrv, int id)
1313 {
1314         struct platform_device *pd;
1315
1316         list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1317                 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1318                         if (pd->id == id)
1319                                 return pd;
1320
1321         return NULL;
1322 }
1323
1324 /**
1325  * early_platform_left - check if early platform driver has matching devices
1326  * @epdrv: early platform driver structure
1327  * @id: return true if id or above exists
1328  */
1329 static int __init early_platform_left(struct early_platform_driver *epdrv,
1330                                        int id)
1331 {
1332         struct platform_device *pd;
1333
1334         list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1335                 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1336                         if (pd->id >= id)
1337                                 return 1;
1338
1339         return 0;
1340 }
1341
1342 /**
1343  * early_platform_driver_probe_id - probe drivers matching class_str and id
1344  * @class_str: string to identify early platform driver class
1345  * @id: id to match against
1346  * @nr_probe: number of platform devices to successfully probe before exiting
1347  */
1348 static int __init early_platform_driver_probe_id(char *class_str,
1349                                                  int id,
1350                                                  int nr_probe)
1351 {
1352         struct early_platform_driver *epdrv;
1353         struct platform_device *match;
1354         int match_id;
1355         int n = 0;
1356         int left = 0;
1357
1358         list_for_each_entry(epdrv, &early_platform_driver_list, list) {
1359                 /* only use drivers matching our class_str */
1360                 if (strcmp(class_str, epdrv->class_str))
1361                         continue;
1362
1363                 if (id == -2) {
1364                         match_id = epdrv->requested_id;
1365                         left = 1;
1366
1367                 } else {
1368                         match_id = id;
1369                         left += early_platform_left(epdrv, id);
1370
1371                         /* skip requested id */
1372                         switch (epdrv->requested_id) {
1373                         case EARLY_PLATFORM_ID_ERROR:
1374                         case EARLY_PLATFORM_ID_UNSET:
1375                                 break;
1376                         default:
1377                                 if (epdrv->requested_id == id)
1378                                         match_id = EARLY_PLATFORM_ID_UNSET;
1379                         }
1380                 }
1381
1382                 switch (match_id) {
1383                 case EARLY_PLATFORM_ID_ERROR:
1384                         pr_warn("%s: unable to parse %s parameter\n",
1385                                 class_str, epdrv->pdrv->driver.name);
1386                         /* fall-through */
1387                 case EARLY_PLATFORM_ID_UNSET:
1388                         match = NULL;
1389                         break;
1390                 default:
1391                         match = early_platform_match(epdrv, match_id);
1392                 }
1393
1394                 if (match) {
1395                         /*
1396                          * Set up a sensible init_name to enable
1397                          * dev_name() and others to be used before the
1398                          * rest of the driver core is initialized.
1399                          */
1400                         if (!match->dev.init_name && slab_is_available()) {
1401                                 if (match->id != -1)
1402                                         match->dev.init_name =
1403                                                 kasprintf(GFP_KERNEL, "%s.%d",
1404                                                           match->name,
1405                                                           match->id);
1406                                 else
1407                                         match->dev.init_name =
1408                                                 kasprintf(GFP_KERNEL, "%s",
1409                                                           match->name);
1410
1411                                 if (!match->dev.init_name)
1412                                         return -ENOMEM;
1413                         }
1414
1415                         if (epdrv->pdrv->probe(match))
1416                                 pr_warn("%s: unable to probe %s early.\n",
1417                                         class_str, match->name);
1418                         else
1419                                 n++;
1420                 }
1421
1422                 if (n >= nr_probe)
1423                         break;
1424         }
1425
1426         if (left)
1427                 return n;
1428         else
1429                 return -ENODEV;
1430 }
1431
1432 /**
1433  * early_platform_driver_probe - probe a class of registered drivers
1434  * @class_str: string to identify early platform driver class
1435  * @nr_probe: number of platform devices to successfully probe before exiting
1436  * @user_only: only probe user specified early platform devices
1437  *
1438  * Used by architecture code to probe registered early platform drivers
1439  * within a certain class. For probe to happen a registered early platform
1440  * device matching a registered early platform driver is needed.
1441  */
1442 int __init early_platform_driver_probe(char *class_str,
1443                                        int nr_probe,
1444                                        int user_only)
1445 {
1446         int k, n, i;
1447
1448         n = 0;
1449         for (i = -2; n < nr_probe; i++) {
1450                 k = early_platform_driver_probe_id(class_str, i, nr_probe - n);
1451
1452                 if (k < 0)
1453                         break;
1454
1455                 n += k;
1456
1457                 if (user_only)
1458                         break;
1459         }
1460
1461         return n;
1462 }
1463
1464 /**
1465  * early_platform_cleanup - clean up early platform code
1466  */
1467 void __init early_platform_cleanup(void)
1468 {
1469         struct platform_device *pd, *pd2;
1470
1471         /* clean up the devres list used to chain devices */
1472         list_for_each_entry_safe(pd, pd2, &early_platform_device_list,
1473                                  dev.devres_head) {
1474                 list_del(&pd->dev.devres_head);
1475                 memset(&pd->dev.devres_head, 0, sizeof(pd->dev.devres_head));
1476         }
1477 }
1478