Merge tag 'v3.10.89' into update
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / base / platform.c
CommitLineData
1da177e4
LT
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
daa41226 13#include <linux/string.h>
d052d1be 14#include <linux/platform_device.h>
05212157 15#include <linux/of_device.h>
1da177e4
LT
16#include <linux/module.h>
17#include <linux/init.h>
18#include <linux/dma-mapping.h>
19#include <linux/bootmem.h>
20#include <linux/err.h>
4e57b681 21#include <linux/slab.h>
9d730229 22#include <linux/pm_runtime.h>
689ae231 23#include <linux/idr.h>
91e56878 24#include <linux/acpi.h>
6fa3eb70 25#include <linux/time_log.h>
1da177e4 26
a1bdc7aa 27#include "base.h"
bed2b42d 28#include "power/power.h"
a1bdc7aa 29
689ae231
JD
30/* For automatically allocated device IDs */
31static DEFINE_IDA(platform_devid_ida);
32
4a3ad20c
GKH
33#define to_platform_driver(drv) (container_of((drv), struct platform_driver, \
34 driver))
00d3dcdd 35
1da177e4 36struct device platform_bus = {
1e0b2cf9 37 .init_name = "platform",
1da177e4 38};
a96b2042 39EXPORT_SYMBOL_GPL(platform_bus);
1da177e4 40
a77ce816
KG
41/**
42 * arch_setup_pdev_archdata - Allow manipulation of archdata before its used
7de636fa 43 * @pdev: platform device
a77ce816
KG
44 *
45 * This is called before platform_device_add() such that any pdev_archdata may
46 * be setup before the platform_notifier is called. So if a user needs to
47 * manipulate any relevant information in the pdev_archdata they can do:
48 *
b1d6d822 49 * platform_device_alloc()
0258e182
FP
50 * ... manipulate ...
51 * platform_device_add()
a77ce816
KG
52 *
53 * And if they don't care they can just call platform_device_register() and
54 * everything will just work out.
55 */
56void __weak arch_setup_pdev_archdata(struct platform_device *pdev)
57{
58}
59
1da177e4 60/**
4a3ad20c
GKH
61 * platform_get_resource - get a resource for a device
62 * @dev: platform device
63 * @type: resource type
64 * @num: resource index
1da177e4 65 */
4a3ad20c
GKH
66struct resource *platform_get_resource(struct platform_device *dev,
67 unsigned int type, unsigned int num)
1da177e4
LT
68{
69 int i;
70
71 for (i = 0; i < dev->num_resources; i++) {
72 struct resource *r = &dev->resource[i];
73
c9f66169
MD
74 if (type == resource_type(r) && num-- == 0)
75 return r;
1da177e4
LT
76 }
77 return NULL;
78}
a96b2042 79EXPORT_SYMBOL_GPL(platform_get_resource);
1da177e4
LT
80
81/**
4a3ad20c
GKH
82 * platform_get_irq - get an IRQ for a device
83 * @dev: platform device
84 * @num: IRQ number index
1da177e4
LT
85 */
86int platform_get_irq(struct platform_device *dev, unsigned int num)
87{
5cf8f7db
AL
88#ifdef CONFIG_SPARC
89 /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
90 if (!dev || num >= dev->archdata.num_irqs)
91 return -ENXIO;
92 return dev->archdata.irqs[num];
93#else
1da177e4
LT
94 struct resource *r = platform_get_resource(dev, IORESOURCE_IRQ, num);
95
305b3228 96 return r ? r->start : -ENXIO;
5cf8f7db 97#endif
1da177e4 98}
a96b2042 99EXPORT_SYMBOL_GPL(platform_get_irq);
1da177e4
LT
100
101/**
4a3ad20c
GKH
102 * platform_get_resource_byname - get a resource for a device by name
103 * @dev: platform device
104 * @type: resource type
105 * @name: resource name
1da177e4 106 */
4a3ad20c 107struct resource *platform_get_resource_byname(struct platform_device *dev,
c0afe7ba
LW
108 unsigned int type,
109 const char *name)
1da177e4
LT
110{
111 int i;
112
113 for (i = 0; i < dev->num_resources; i++) {
114 struct resource *r = &dev->resource[i];
115
1b8cb929
PU
116 if (unlikely(!r->name))
117 continue;
118
c9f66169
MD
119 if (type == resource_type(r) && !strcmp(r->name, name))
120 return r;
1da177e4
LT
121 }
122 return NULL;
123}
a96b2042 124EXPORT_SYMBOL_GPL(platform_get_resource_byname);
1da177e4
LT
125
126/**
d6ff8551 127 * platform_get_irq_byname - get an IRQ for a device by name
4a3ad20c
GKH
128 * @dev: platform device
129 * @name: IRQ name
1da177e4 130 */
c0afe7ba 131int platform_get_irq_byname(struct platform_device *dev, const char *name)
1da177e4 132{
4a3ad20c
GKH
133 struct resource *r = platform_get_resource_byname(dev, IORESOURCE_IRQ,
134 name);
1da177e4 135
305b3228 136 return r ? r->start : -ENXIO;
1da177e4 137}
a96b2042 138EXPORT_SYMBOL_GPL(platform_get_irq_byname);
1da177e4
LT
139
140/**
4a3ad20c
GKH
141 * platform_add_devices - add a numbers of platform devices
142 * @devs: array of platform devices to add
143 * @num: number of platform devices in array
1da177e4
LT
144 */
145int platform_add_devices(struct platform_device **devs, int num)
146{
147 int i, ret = 0;
148
149 for (i = 0; i < num; i++) {
150 ret = platform_device_register(devs[i]);
151 if (ret) {
152 while (--i >= 0)
153 platform_device_unregister(devs[i]);
154 break;
155 }
156 }
157
158 return ret;
159}
a96b2042 160EXPORT_SYMBOL_GPL(platform_add_devices);
1da177e4 161
37c12e74
RK
162struct platform_object {
163 struct platform_device pdev;
164 char name[1];
165};
166
1da177e4 167/**
3c31f07a 168 * platform_device_put - destroy a platform device
4a3ad20c 169 * @pdev: platform device to free
37c12e74 170 *
4a3ad20c
GKH
171 * Free all memory associated with a platform device. This function must
172 * _only_ be externally called in error cases. All other usage is a bug.
37c12e74
RK
173 */
174void platform_device_put(struct platform_device *pdev)
175{
176 if (pdev)
177 put_device(&pdev->dev);
178}
179EXPORT_SYMBOL_GPL(platform_device_put);
180
181static void platform_device_release(struct device *dev)
182{
4a3ad20c
GKH
183 struct platform_object *pa = container_of(dev, struct platform_object,
184 pdev.dev);
37c12e74 185
7096d042 186 of_device_node_put(&pa->pdev.dev);
37c12e74 187 kfree(pa->pdev.dev.platform_data);
e710d7d5 188 kfree(pa->pdev.mfd_cell);
37c12e74
RK
189 kfree(pa->pdev.resource);
190 kfree(pa);
191}
192
193/**
3c31f07a 194 * platform_device_alloc - create a platform device
4a3ad20c
GKH
195 * @name: base name of the device we're adding
196 * @id: instance id
37c12e74 197 *
4a3ad20c
GKH
198 * Create a platform device object which can have other objects attached
199 * to it, and which will have attached objects freed when it is released.
37c12e74 200 */
1359555e 201struct platform_device *platform_device_alloc(const char *name, int id)
37c12e74
RK
202{
203 struct platform_object *pa;
204
205 pa = kzalloc(sizeof(struct platform_object) + strlen(name), GFP_KERNEL);
206 if (pa) {
207 strcpy(pa->name, name);
208 pa->pdev.name = pa->name;
209 pa->pdev.id = id;
210 device_initialize(&pa->pdev.dev);
211 pa->pdev.dev.release = platform_device_release;
a77ce816 212 arch_setup_pdev_archdata(&pa->pdev);
37c12e74
RK
213 }
214
93ce3061 215 return pa ? &pa->pdev : NULL;
37c12e74
RK
216}
217EXPORT_SYMBOL_GPL(platform_device_alloc);
218
219/**
3c31f07a 220 * platform_device_add_resources - add resources to a platform device
4a3ad20c
GKH
221 * @pdev: platform device allocated by platform_device_alloc to add resources to
222 * @res: set of resources that needs to be allocated for the device
223 * @num: number of resources
37c12e74 224 *
4a3ad20c
GKH
225 * Add a copy of the resources to the platform device. The memory
226 * associated with the resources will be freed when the platform device is
227 * released.
37c12e74 228 */
4a3ad20c 229int platform_device_add_resources(struct platform_device *pdev,
0b7f1a7e 230 const struct resource *res, unsigned int num)
37c12e74 231{
cea89623 232 struct resource *r = NULL;
37c12e74 233
cea89623
UKK
234 if (res) {
235 r = kmemdup(res, sizeof(struct resource) * num, GFP_KERNEL);
236 if (!r)
237 return -ENOMEM;
37c12e74 238 }
cea89623 239
4a03d6f7 240 kfree(pdev->resource);
cea89623
UKK
241 pdev->resource = r;
242 pdev->num_resources = num;
243 return 0;
37c12e74
RK
244}
245EXPORT_SYMBOL_GPL(platform_device_add_resources);
246
247/**
3c31f07a 248 * platform_device_add_data - add platform-specific data to a platform device
4a3ad20c
GKH
249 * @pdev: platform device allocated by platform_device_alloc to add resources to
250 * @data: platform specific data for this platform device
251 * @size: size of platform specific data
37c12e74 252 *
4a3ad20c
GKH
253 * Add a copy of platform specific data to the platform device's
254 * platform_data pointer. The memory associated with the platform data
255 * will be freed when the platform device is released.
37c12e74 256 */
4a3ad20c
GKH
257int platform_device_add_data(struct platform_device *pdev, const void *data,
258 size_t size)
37c12e74 259{
27a33f9e 260 void *d = NULL;
5cfc64ce 261
27a33f9e
UKK
262 if (data) {
263 d = kmemdup(data, size, GFP_KERNEL);
264 if (!d)
265 return -ENOMEM;
37c12e74 266 }
27a33f9e 267
251e031d 268 kfree(pdev->dev.platform_data);
27a33f9e
UKK
269 pdev->dev.platform_data = d;
270 return 0;
37c12e74
RK
271}
272EXPORT_SYMBOL_GPL(platform_device_add_data);
273
274/**
4a3ad20c
GKH
275 * platform_device_add - add a platform device to device hierarchy
276 * @pdev: platform device we're adding
1da177e4 277 *
4a3ad20c
GKH
278 * This is part 2 of platform_device_register(), though may be called
279 * separately _iff_ pdev was allocated by platform_device_alloc().
1da177e4 280 */
37c12e74 281int platform_device_add(struct platform_device *pdev)
1da177e4 282{
689ae231 283 int i, ret;
1da177e4
LT
284
285 if (!pdev)
286 return -EINVAL;
287
288 if (!pdev->dev.parent)
289 pdev->dev.parent = &platform_bus;
290
291 pdev->dev.bus = &platform_bus_type;
292
689ae231
JD
293 switch (pdev->id) {
294 default:
1e0b2cf9 295 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
689ae231
JD
296 break;
297 case PLATFORM_DEVID_NONE:
acc0e90f 298 dev_set_name(&pdev->dev, "%s", pdev->name);
689ae231
JD
299 break;
300 case PLATFORM_DEVID_AUTO:
301 /*
302 * Automatically allocated device ID. We mark it as such so
303 * that we remember it must be freed, and we append a suffix
304 * to avoid namespace collision with explicit IDs.
305 */
306 ret = ida_simple_get(&platform_devid_ida, 0, 0, GFP_KERNEL);
307 if (ret < 0)
308 goto err_out;
309 pdev->id = ret;
310 pdev->id_auto = true;
311 dev_set_name(&pdev->dev, "%s.%d.auto", pdev->name, pdev->id);
312 break;
313 }
1da177e4
LT
314
315 for (i = 0; i < pdev->num_resources; i++) {
316 struct resource *p, *r = &pdev->resource[i];
317
318 if (r->name == NULL)
1e0b2cf9 319 r->name = dev_name(&pdev->dev);
1da177e4
LT
320
321 p = r->parent;
322 if (!p) {
c9f66169 323 if (resource_type(r) == IORESOURCE_MEM)
1da177e4 324 p = &iomem_resource;
c9f66169 325 else if (resource_type(r) == IORESOURCE_IO)
1da177e4
LT
326 p = &ioport_resource;
327 }
328
d960bb4d 329 if (p && insert_resource(p, r)) {
0258e182 330 dev_err(&pdev->dev, "failed to claim resource %d\n", i);
1da177e4
LT
331 ret = -EBUSY;
332 goto failed;
333 }
334 }
335
336 pr_debug("Registering platform device '%s'. Parent at %s\n",
1e0b2cf9 337 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
1da177e4 338
e3915532 339 ret = device_add(&pdev->dev);
1da177e4
LT
340 if (ret == 0)
341 return ret;
342
343 failed:
689ae231
JD
344 if (pdev->id_auto) {
345 ida_simple_remove(&platform_devid_ida, pdev->id);
346 pdev->id = PLATFORM_DEVID_AUTO;
347 }
348
c9f66169
MD
349 while (--i >= 0) {
350 struct resource *r = &pdev->resource[i];
6ae99d59 351 if (r->parent)
c9f66169
MD
352 release_resource(r);
353 }
354
689ae231 355 err_out:
1da177e4
LT
356 return ret;
357}
37c12e74
RK
358EXPORT_SYMBOL_GPL(platform_device_add);
359
360/**
4a3ad20c
GKH
361 * platform_device_del - remove a platform-level device
362 * @pdev: platform device we're removing
1da177e4 363 *
4a3ad20c
GKH
364 * Note that this function will also release all memory- and port-based
365 * resources owned by the device (@dev->resource). This function must
366 * _only_ be externally called in error cases. All other usage is a bug.
1da177e4 367 */
93ce3061 368void platform_device_del(struct platform_device *pdev)
1da177e4
LT
369{
370 int i;
371
372 if (pdev) {
dc4c15d4
JD
373 device_del(&pdev->dev);
374
689ae231
JD
375 if (pdev->id_auto) {
376 ida_simple_remove(&platform_devid_ida, pdev->id);
377 pdev->id = PLATFORM_DEVID_AUTO;
378 }
379
1da177e4
LT
380 for (i = 0; i < pdev->num_resources; i++) {
381 struct resource *r = &pdev->resource[i];
6ae99d59 382 if (r->parent)
1da177e4
LT
383 release_resource(r);
384 }
1da177e4
LT
385 }
386}
93ce3061
DT
387EXPORT_SYMBOL_GPL(platform_device_del);
388
389/**
4a3ad20c
GKH
390 * platform_device_register - add a platform-level device
391 * @pdev: platform device we're adding
93ce3061 392 */
4a3ad20c 393int platform_device_register(struct platform_device *pdev)
93ce3061 394{
6fa3eb70
S
395 int ret;
396 TIME_LOG_START();
93ce3061 397 device_initialize(&pdev->dev);
a77ce816 398 arch_setup_pdev_archdata(pdev);
6fa3eb70
S
399 ret = platform_device_add(pdev);
400 TIME_LOG_END("[pdev] %s\n", pdev->name);
401 return ret;
93ce3061 402}
a96b2042 403EXPORT_SYMBOL_GPL(platform_device_register);
93ce3061
DT
404
405/**
4a3ad20c
GKH
406 * platform_device_unregister - unregister a platform-level device
407 * @pdev: platform device we're unregistering
93ce3061 408 *
4a3ad20c
GKH
409 * Unregistration is done in 2 steps. First we release all resources
410 * and remove it from the subsystem, then we drop reference count by
411 * calling platform_device_put().
93ce3061 412 */
4a3ad20c 413void platform_device_unregister(struct platform_device *pdev)
93ce3061
DT
414{
415 platform_device_del(pdev);
416 platform_device_put(pdev);
417}
a96b2042 418EXPORT_SYMBOL_GPL(platform_device_unregister);
1da177e4 419
1da177e4 420/**
01dcc60a 421 * platform_device_register_full - add a platform-level device with
44f28bde 422 * resources and platform-specific data
49a4ec18 423 *
01dcc60a 424 * @pdevinfo: data used to create device
d8bf2540 425 *
f0eae0ed 426 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
d8bf2540 427 */
01dcc60a 428struct platform_device *platform_device_register_full(
5a3072be 429 const struct platform_device_info *pdevinfo)
d8bf2540 430{
44f28bde 431 int ret = -ENOMEM;
d8bf2540 432 struct platform_device *pdev;
d8bf2540 433
01dcc60a 434 pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
44f28bde 435 if (!pdev)
01dcc60a
UKK
436 goto err_alloc;
437
438 pdev->dev.parent = pdevinfo->parent;
863f9f30 439 ACPI_HANDLE_SET(&pdev->dev, pdevinfo->acpi_node.handle);
01dcc60a
UKK
440
441 if (pdevinfo->dma_mask) {
442 /*
443 * This memory isn't freed when the device is put,
444 * I don't have a nice idea for that though. Conceptually
445 * dma_mask in struct device should not be a pointer.
446 * See http://thread.gmane.org/gmane.linux.kernel.pci/9081
447 */
448 pdev->dev.dma_mask =
449 kmalloc(sizeof(*pdev->dev.dma_mask), GFP_KERNEL);
450 if (!pdev->dev.dma_mask)
451 goto err;
452
453 *pdev->dev.dma_mask = pdevinfo->dma_mask;
454 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
455 }
d8bf2540 456
01dcc60a
UKK
457 ret = platform_device_add_resources(pdev,
458 pdevinfo->res, pdevinfo->num_res);
807508c8
AV
459 if (ret)
460 goto err;
44f28bde 461
01dcc60a
UKK
462 ret = platform_device_add_data(pdev,
463 pdevinfo->data, pdevinfo->size_data);
807508c8
AV
464 if (ret)
465 goto err;
d8bf2540 466
44f28bde
UKK
467 ret = platform_device_add(pdev);
468 if (ret) {
469err:
863f9f30 470 ACPI_HANDLE_SET(&pdev->dev, NULL);
01dcc60a
UKK
471 kfree(pdev->dev.dma_mask);
472
473err_alloc:
44f28bde
UKK
474 platform_device_put(pdev);
475 return ERR_PTR(ret);
476 }
d8bf2540
DES
477
478 return pdev;
d8bf2540 479}
01dcc60a 480EXPORT_SYMBOL_GPL(platform_device_register_full);
d8bf2540 481
00d3dcdd
RK
482static int platform_drv_probe(struct device *_dev)
483{
484 struct platform_driver *drv = to_platform_driver(_dev->driver);
485 struct platform_device *dev = to_platform_device(_dev);
94d76d5d 486 int ret;
00d3dcdd 487
94d76d5d
RW
488 if (ACPI_HANDLE(_dev))
489 acpi_dev_pm_attach(_dev, true);
490
491 ret = drv->probe(dev);
492 if (ret && ACPI_HANDLE(_dev))
493 acpi_dev_pm_detach(_dev, true);
494
495 return ret;
00d3dcdd
RK
496}
497
c67334fb
DB
498static int platform_drv_probe_fail(struct device *_dev)
499{
500 return -ENXIO;
501}
502
00d3dcdd
RK
503static int platform_drv_remove(struct device *_dev)
504{
505 struct platform_driver *drv = to_platform_driver(_dev->driver);
506 struct platform_device *dev = to_platform_device(_dev);
94d76d5d 507 int ret;
00d3dcdd 508
94d76d5d
RW
509 ret = drv->remove(dev);
510 if (ACPI_HANDLE(_dev))
511 acpi_dev_pm_detach(_dev, true);
512
513 return ret;
00d3dcdd
RK
514}
515
516static void platform_drv_shutdown(struct device *_dev)
517{
518 struct platform_driver *drv = to_platform_driver(_dev->driver);
519 struct platform_device *dev = to_platform_device(_dev);
520
521 drv->shutdown(dev);
94d76d5d
RW
522 if (ACPI_HANDLE(_dev))
523 acpi_dev_pm_detach(_dev, true);
00d3dcdd
RK
524}
525
00d3dcdd 526/**
3c31f07a 527 * platform_driver_register - register a driver for platform-level devices
4a3ad20c 528 * @drv: platform driver structure
00d3dcdd
RK
529 */
530int platform_driver_register(struct platform_driver *drv)
531{
532 drv->driver.bus = &platform_bus_type;
533 if (drv->probe)
534 drv->driver.probe = platform_drv_probe;
535 if (drv->remove)
536 drv->driver.remove = platform_drv_remove;
537 if (drv->shutdown)
538 drv->driver.shutdown = platform_drv_shutdown;
783ea7d4 539
00d3dcdd
RK
540 return driver_register(&drv->driver);
541}
542EXPORT_SYMBOL_GPL(platform_driver_register);
543
544/**
3c31f07a 545 * platform_driver_unregister - unregister a driver for platform-level devices
4a3ad20c 546 * @drv: platform driver structure
00d3dcdd
RK
547 */
548void platform_driver_unregister(struct platform_driver *drv)
549{
550 driver_unregister(&drv->driver);
551}
552EXPORT_SYMBOL_GPL(platform_driver_unregister);
553
c67334fb
DB
554/**
555 * platform_driver_probe - register driver for non-hotpluggable device
556 * @drv: platform driver structure
647c86d0
FP
557 * @probe: the driver probe routine, probably from an __init section,
558 * must not return -EPROBE_DEFER.
c67334fb
DB
559 *
560 * Use this instead of platform_driver_register() when you know the device
561 * is not hotpluggable and has already been registered, and you want to
562 * remove its run-once probe() infrastructure from memory after the driver
563 * has bound to the device.
564 *
565 * One typical use for this would be with drivers for controllers integrated
566 * into system-on-chip processors, where the controller devices have been
567 * configured as part of board setup.
568 *
647c86d0
FP
569 * This is incompatible with deferred probing so probe() must not
570 * return -EPROBE_DEFER.
571 *
c67334fb
DB
572 * Returns zero if the driver registered and bound to a device, else returns
573 * a negative error code and with the driver not registered.
574 */
c63e0783 575int __init_or_module platform_driver_probe(struct platform_driver *drv,
c67334fb
DB
576 int (*probe)(struct platform_device *))
577{
578 int retval, code;
579
1a6f2a75
DT
580 /* make sure driver won't have bind/unbind attributes */
581 drv->driver.suppress_bind_attrs = true;
582
c67334fb
DB
583 /* temporary section violation during probe() */
584 drv->probe = probe;
585 retval = code = platform_driver_register(drv);
586
1a6f2a75
DT
587 /*
588 * Fixup that section violation, being paranoid about code scanning
c67334fb
DB
589 * the list of drivers in order to probe new devices. Check to see
590 * if the probe was successful, and make sure any forced probes of
591 * new devices fail.
592 */
d79d3244 593 spin_lock(&drv->driver.bus->p->klist_drivers.k_lock);
c67334fb 594 drv->probe = NULL;
e5dd1278 595 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
c67334fb
DB
596 retval = -ENODEV;
597 drv->driver.probe = platform_drv_probe_fail;
d79d3244 598 spin_unlock(&drv->driver.bus->p->klist_drivers.k_lock);
c67334fb
DB
599
600 if (code != retval)
601 platform_driver_unregister(drv);
602 return retval;
603}
604EXPORT_SYMBOL_GPL(platform_driver_probe);
1da177e4 605
ecdf6ceb
DT
606/**
607 * platform_create_bundle - register driver and create corresponding device
608 * @driver: platform driver structure
609 * @probe: the driver probe routine, probably from an __init section
610 * @res: set of resources that needs to be allocated for the device
611 * @n_res: number of resources
612 * @data: platform specific data for this platform device
613 * @size: size of platform specific data
614 *
615 * Use this in legacy-style modules that probe hardware directly and
616 * register a single platform device and corresponding platform driver.
f0eae0ed
JN
617 *
618 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
ecdf6ceb
DT
619 */
620struct platform_device * __init_or_module platform_create_bundle(
621 struct platform_driver *driver,
622 int (*probe)(struct platform_device *),
623 struct resource *res, unsigned int n_res,
624 const void *data, size_t size)
625{
626 struct platform_device *pdev;
627 int error;
628
629 pdev = platform_device_alloc(driver->driver.name, -1);
630 if (!pdev) {
631 error = -ENOMEM;
632 goto err_out;
633 }
634
807508c8
AV
635 error = platform_device_add_resources(pdev, res, n_res);
636 if (error)
637 goto err_pdev_put;
ecdf6ceb 638
807508c8
AV
639 error = platform_device_add_data(pdev, data, size);
640 if (error)
641 goto err_pdev_put;
ecdf6ceb
DT
642
643 error = platform_device_add(pdev);
644 if (error)
645 goto err_pdev_put;
646
647 error = platform_driver_probe(driver, probe);
648 if (error)
649 goto err_pdev_del;
650
651 return pdev;
652
653err_pdev_del:
654 platform_device_del(pdev);
655err_pdev_put:
656 platform_device_put(pdev);
657err_out:
658 return ERR_PTR(error);
659}
660EXPORT_SYMBOL_GPL(platform_create_bundle);
661
a0245f7a
DB
662/* modalias support enables more hands-off userspace setup:
663 * (a) environment variable lets new-style hotplug events work once system is
664 * fully running: "modprobe $MODALIAS"
665 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
666 * mishandled before system is fully running: "modprobe $(cat modalias)"
667 */
4a3ad20c
GKH
668static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
669 char *buf)
a0245f7a
DB
670{
671 struct platform_device *pdev = to_platform_device(dev);
43cc71ee 672 int len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
a0245f7a
DB
673
674 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
675}
676
677static struct device_attribute platform_dev_attrs[] = {
678 __ATTR_RO(modalias),
679 __ATTR_NULL,
680};
681
7eff2e7a 682static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
a0245f7a
DB
683{
684 struct platform_device *pdev = to_platform_device(dev);
eca39301
GL
685 int rc;
686
687 /* Some devices have extra OF data and an OF-style MODALIAS */
0258e182 688 rc = of_device_uevent_modalias(dev, env);
eca39301
GL
689 if (rc != -ENODEV)
690 return rc;
a0245f7a 691
57fee4a5 692 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
0a26813c 693 pdev->name);
a0245f7a
DB
694 return 0;
695}
696
57fee4a5 697static const struct platform_device_id *platform_match_id(
831fad2f 698 const struct platform_device_id *id,
57fee4a5
EM
699 struct platform_device *pdev)
700{
701 while (id->name[0]) {
702 if (strcmp(pdev->name, id->name) == 0) {
703 pdev->id_entry = id;
704 return id;
705 }
706 id++;
707 }
708 return NULL;
709}
710
1da177e4 711/**
4a3ad20c
GKH
712 * platform_match - bind platform device to platform driver.
713 * @dev: device.
714 * @drv: driver.
1da177e4 715 *
4a3ad20c
GKH
716 * Platform device IDs are assumed to be encoded like this:
717 * "<name><instance>", where <name> is a short description of the type of
718 * device, like "pci" or "floppy", and <instance> is the enumerated
719 * instance of the device, like '0' or '42'. Driver IDs are simply
720 * "<name>". So, extract the <name> from the platform_device structure,
721 * and compare it against the name of the driver. Return whether they match
722 * or not.
1da177e4 723 */
4a3ad20c 724static int platform_match(struct device *dev, struct device_driver *drv)
1da177e4 725{
71b3e0c1 726 struct platform_device *pdev = to_platform_device(dev);
57fee4a5
EM
727 struct platform_driver *pdrv = to_platform_driver(drv);
728
05212157
GL
729 /* Attempt an OF style match first */
730 if (of_driver_match_device(dev, drv))
731 return 1;
732
91e56878
MW
733 /* Then try ACPI style match */
734 if (acpi_driver_match_device(dev, drv))
735 return 1;
736
05212157 737 /* Then try to match against the id table */
57fee4a5
EM
738 if (pdrv->id_table)
739 return platform_match_id(pdrv->id_table, pdev) != NULL;
1da177e4 740
57fee4a5 741 /* fall-back to driver name match */
1e0b2cf9 742 return (strcmp(pdev->name, drv->name) == 0);
1da177e4
LT
743}
744
25e18499
RW
745#ifdef CONFIG_PM_SLEEP
746
747static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
1da177e4 748{
783ea7d4
MD
749 struct platform_driver *pdrv = to_platform_driver(dev->driver);
750 struct platform_device *pdev = to_platform_device(dev);
1da177e4
LT
751 int ret = 0;
752
783ea7d4
MD
753 if (dev->driver && pdrv->suspend)
754 ret = pdrv->suspend(pdev, mesg);
386415d8
DB
755
756 return ret;
757}
758
25e18499 759static int platform_legacy_resume(struct device *dev)
1da177e4 760{
783ea7d4
MD
761 struct platform_driver *pdrv = to_platform_driver(dev->driver);
762 struct platform_device *pdev = to_platform_device(dev);
1da177e4
LT
763 int ret = 0;
764
783ea7d4
MD
765 if (dev->driver && pdrv->resume)
766 ret = pdrv->resume(pdev);
9480e307 767
1da177e4
LT
768 return ret;
769}
770
69c9dd1e 771#endif /* CONFIG_PM_SLEEP */
9d730229 772
25e18499
RW
773#ifdef CONFIG_SUSPEND
774
69c9dd1e 775int platform_pm_suspend(struct device *dev)
25e18499
RW
776{
777 struct device_driver *drv = dev->driver;
778 int ret = 0;
779
adf09493
RW
780 if (!drv)
781 return 0;
782
783 if (drv->pm) {
25e18499
RW
784 if (drv->pm->suspend)
785 ret = drv->pm->suspend(dev);
786 } else {
787 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
788 }
789
790 return ret;
791}
792
69c9dd1e 793int platform_pm_resume(struct device *dev)
25e18499
RW
794{
795 struct device_driver *drv = dev->driver;
796 int ret = 0;
797
adf09493
RW
798 if (!drv)
799 return 0;
800
801 if (drv->pm) {
25e18499
RW
802 if (drv->pm->resume)
803 ret = drv->pm->resume(dev);
804 } else {
805 ret = platform_legacy_resume(dev);
806 }
807
808 return ret;
809}
810
69c9dd1e 811#endif /* CONFIG_SUSPEND */
25e18499 812
1f112cee 813#ifdef CONFIG_HIBERNATE_CALLBACKS
25e18499 814
69c9dd1e 815int platform_pm_freeze(struct device *dev)
25e18499
RW
816{
817 struct device_driver *drv = dev->driver;
818 int ret = 0;
819
820 if (!drv)
821 return 0;
822
823 if (drv->pm) {
824 if (drv->pm->freeze)
825 ret = drv->pm->freeze(dev);
826 } else {
827 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
828 }
829
830 return ret;
831}
832
69c9dd1e 833int platform_pm_thaw(struct device *dev)
25e18499
RW
834{
835 struct device_driver *drv = dev->driver;
836 int ret = 0;
837
adf09493
RW
838 if (!drv)
839 return 0;
840
841 if (drv->pm) {
25e18499
RW
842 if (drv->pm->thaw)
843 ret = drv->pm->thaw(dev);
844 } else {
845 ret = platform_legacy_resume(dev);
846 }
847
848 return ret;
849}
850
69c9dd1e 851int platform_pm_poweroff(struct device *dev)
25e18499
RW
852{
853 struct device_driver *drv = dev->driver;
854 int ret = 0;
855
adf09493
RW
856 if (!drv)
857 return 0;
858
859 if (drv->pm) {
25e18499
RW
860 if (drv->pm->poweroff)
861 ret = drv->pm->poweroff(dev);
862 } else {
863 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
864 }
865
866 return ret;
867}
868
69c9dd1e 869int platform_pm_restore(struct device *dev)
25e18499
RW
870{
871 struct device_driver *drv = dev->driver;
872 int ret = 0;
873
adf09493
RW
874 if (!drv)
875 return 0;
876
877 if (drv->pm) {
25e18499
RW
878 if (drv->pm->restore)
879 ret = drv->pm->restore(dev);
880 } else {
881 ret = platform_legacy_resume(dev);
882 }
883
884 return ret;
885}
886
69c9dd1e 887#endif /* CONFIG_HIBERNATE_CALLBACKS */
25e18499 888
d9ab7716 889static const struct dev_pm_ops platform_dev_pm_ops = {
8b313a38
RW
890 .runtime_suspend = pm_generic_runtime_suspend,
891 .runtime_resume = pm_generic_runtime_resume,
892 .runtime_idle = pm_generic_runtime_idle,
69c9dd1e 893 USE_PLATFORM_PM_SLEEP_OPS
25e18499
RW
894};
895
1da177e4
LT
896struct bus_type platform_bus_type = {
897 .name = "platform",
a0245f7a 898 .dev_attrs = platform_dev_attrs,
1da177e4 899 .match = platform_match,
a0245f7a 900 .uevent = platform_uevent,
9d730229 901 .pm = &platform_dev_pm_ops,
1da177e4 902};
a96b2042 903EXPORT_SYMBOL_GPL(platform_bus_type);
1da177e4
LT
904
905int __init platform_bus_init(void)
906{
fbfb1445
CH
907 int error;
908
13977091
MD
909 early_platform_cleanup();
910
fbfb1445
CH
911 error = device_register(&platform_bus);
912 if (error)
913 return error;
914 error = bus_register(&platform_bus_type);
915 if (error)
916 device_unregister(&platform_bus);
917 return error;
1da177e4
LT
918}
919
920#ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
921u64 dma_get_required_mask(struct device *dev)
922{
923 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
924 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
925 u64 mask;
926
927 if (!high_totalram) {
928 /* convert to mask just covering totalram */
929 low_totalram = (1 << (fls(low_totalram) - 1));
930 low_totalram += low_totalram - 1;
931 mask = low_totalram;
932 } else {
933 high_totalram = (1 << (fls(high_totalram) - 1));
934 high_totalram += high_totalram - 1;
935 mask = (((u64)high_totalram) << 32) + 0xffffffff;
936 }
e88a0c2c 937 return mask;
1da177e4
LT
938}
939EXPORT_SYMBOL_GPL(dma_get_required_mask);
940#endif
13977091
MD
941
942static __initdata LIST_HEAD(early_platform_driver_list);
943static __initdata LIST_HEAD(early_platform_device_list);
944
945/**
4d26e139 946 * early_platform_driver_register - register early platform driver
d86c1302 947 * @epdrv: early_platform driver structure
13977091 948 * @buf: string passed from early_param()
4d26e139
MD
949 *
950 * Helper function for early_platform_init() / early_platform_init_buffer()
13977091
MD
951 */
952int __init early_platform_driver_register(struct early_platform_driver *epdrv,
953 char *buf)
954{
c60e0504 955 char *tmp;
13977091
MD
956 int n;
957
958 /* Simply add the driver to the end of the global list.
959 * Drivers will by default be put on the list in compiled-in order.
960 */
961 if (!epdrv->list.next) {
962 INIT_LIST_HEAD(&epdrv->list);
963 list_add_tail(&epdrv->list, &early_platform_driver_list);
964 }
965
966 /* If the user has specified device then make sure the driver
967 * gets prioritized. The driver of the last device specified on
968 * command line will be put first on the list.
969 */
970 n = strlen(epdrv->pdrv->driver.name);
971 if (buf && !strncmp(buf, epdrv->pdrv->driver.name, n)) {
972 list_move(&epdrv->list, &early_platform_driver_list);
973
c60e0504
MD
974 /* Allow passing parameters after device name */
975 if (buf[n] == '\0' || buf[n] == ',')
13977091 976 epdrv->requested_id = -1;
c60e0504
MD
977 else {
978 epdrv->requested_id = simple_strtoul(&buf[n + 1],
979 &tmp, 10);
980
981 if (buf[n] != '.' || (tmp == &buf[n + 1])) {
982 epdrv->requested_id = EARLY_PLATFORM_ID_ERROR;
983 n = 0;
984 } else
985 n += strcspn(&buf[n + 1], ",") + 1;
986 }
987
988 if (buf[n] == ',')
989 n++;
990
991 if (epdrv->bufsize) {
992 memcpy(epdrv->buffer, &buf[n],
993 min_t(int, epdrv->bufsize, strlen(&buf[n]) + 1));
994 epdrv->buffer[epdrv->bufsize - 1] = '\0';
995 }
13977091
MD
996 }
997
998 return 0;
999}
1000
1001/**
4d26e139 1002 * early_platform_add_devices - adds a number of early platform devices
13977091
MD
1003 * @devs: array of early platform devices to add
1004 * @num: number of early platform devices in array
4d26e139
MD
1005 *
1006 * Used by early architecture code to register early platform devices and
1007 * their platform data.
13977091
MD
1008 */
1009void __init early_platform_add_devices(struct platform_device **devs, int num)
1010{
1011 struct device *dev;
1012 int i;
1013
1014 /* simply add the devices to list */
1015 for (i = 0; i < num; i++) {
1016 dev = &devs[i]->dev;
1017
1018 if (!dev->devres_head.next) {
bed2b42d 1019 pm_runtime_early_init(dev);
13977091
MD
1020 INIT_LIST_HEAD(&dev->devres_head);
1021 list_add_tail(&dev->devres_head,
1022 &early_platform_device_list);
1023 }
1024 }
1025}
1026
1027/**
4d26e139 1028 * early_platform_driver_register_all - register early platform drivers
13977091 1029 * @class_str: string to identify early platform driver class
4d26e139
MD
1030 *
1031 * Used by architecture code to register all early platform drivers
1032 * for a certain class. If omitted then only early platform drivers
1033 * with matching kernel command line class parameters will be registered.
13977091
MD
1034 */
1035void __init early_platform_driver_register_all(char *class_str)
1036{
1037 /* The "class_str" parameter may or may not be present on the kernel
1038 * command line. If it is present then there may be more than one
1039 * matching parameter.
1040 *
1041 * Since we register our early platform drivers using early_param()
1042 * we need to make sure that they also get registered in the case
1043 * when the parameter is missing from the kernel command line.
1044 *
1045 * We use parse_early_options() to make sure the early_param() gets
1046 * called at least once. The early_param() may be called more than
1047 * once since the name of the preferred device may be specified on
1048 * the kernel command line. early_platform_driver_register() handles
1049 * this case for us.
1050 */
1051 parse_early_options(class_str);
1052}
1053
1054/**
4d26e139 1055 * early_platform_match - find early platform device matching driver
d86c1302 1056 * @epdrv: early platform driver structure
13977091
MD
1057 * @id: id to match against
1058 */
1059static __init struct platform_device *
1060early_platform_match(struct early_platform_driver *epdrv, int id)
1061{
1062 struct platform_device *pd;
1063
1064 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1065 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1066 if (pd->id == id)
1067 return pd;
1068
1069 return NULL;
1070}
1071
1072/**
4d26e139 1073 * early_platform_left - check if early platform driver has matching devices
d86c1302 1074 * @epdrv: early platform driver structure
13977091
MD
1075 * @id: return true if id or above exists
1076 */
1077static __init int early_platform_left(struct early_platform_driver *epdrv,
1078 int id)
1079{
1080 struct platform_device *pd;
1081
1082 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1083 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1084 if (pd->id >= id)
1085 return 1;
1086
1087 return 0;
1088}
1089
1090/**
4d26e139 1091 * early_platform_driver_probe_id - probe drivers matching class_str and id
13977091
MD
1092 * @class_str: string to identify early platform driver class
1093 * @id: id to match against
1094 * @nr_probe: number of platform devices to successfully probe before exiting
1095 */
1096static int __init early_platform_driver_probe_id(char *class_str,
1097 int id,
1098 int nr_probe)
1099{
1100 struct early_platform_driver *epdrv;
1101 struct platform_device *match;
1102 int match_id;
1103 int n = 0;
1104 int left = 0;
1105
1106 list_for_each_entry(epdrv, &early_platform_driver_list, list) {
1107 /* only use drivers matching our class_str */
1108 if (strcmp(class_str, epdrv->class_str))
1109 continue;
1110
1111 if (id == -2) {
1112 match_id = epdrv->requested_id;
1113 left = 1;
1114
1115 } else {
1116 match_id = id;
1117 left += early_platform_left(epdrv, id);
1118
1119 /* skip requested id */
1120 switch (epdrv->requested_id) {
1121 case EARLY_PLATFORM_ID_ERROR:
1122 case EARLY_PLATFORM_ID_UNSET:
1123 break;
1124 default:
1125 if (epdrv->requested_id == id)
1126 match_id = EARLY_PLATFORM_ID_UNSET;
1127 }
1128 }
1129
1130 switch (match_id) {
1131 case EARLY_PLATFORM_ID_ERROR:
0258e182
FP
1132 pr_warn("%s: unable to parse %s parameter\n",
1133 class_str, epdrv->pdrv->driver.name);
13977091
MD
1134 /* fall-through */
1135 case EARLY_PLATFORM_ID_UNSET:
1136 match = NULL;
1137 break;
1138 default:
1139 match = early_platform_match(epdrv, match_id);
1140 }
1141
1142 if (match) {
a636ee7f
PM
1143 /*
1144 * Set up a sensible init_name to enable
1145 * dev_name() and others to be used before the
1146 * rest of the driver core is initialized.
1147 */
06fe53be 1148 if (!match->dev.init_name && slab_is_available()) {
a636ee7f 1149 if (match->id != -1)
bd05086b
PM
1150 match->dev.init_name =
1151 kasprintf(GFP_KERNEL, "%s.%d",
1152 match->name,
1153 match->id);
a636ee7f 1154 else
bd05086b
PM
1155 match->dev.init_name =
1156 kasprintf(GFP_KERNEL, "%s",
1157 match->name);
a636ee7f 1158
a636ee7f
PM
1159 if (!match->dev.init_name)
1160 return -ENOMEM;
1161 }
bd05086b 1162
13977091 1163 if (epdrv->pdrv->probe(match))
0258e182
FP
1164 pr_warn("%s: unable to probe %s early.\n",
1165 class_str, match->name);
13977091
MD
1166 else
1167 n++;
1168 }
1169
1170 if (n >= nr_probe)
1171 break;
1172 }
1173
1174 if (left)
1175 return n;
1176 else
1177 return -ENODEV;
1178}
1179
1180/**
4d26e139 1181 * early_platform_driver_probe - probe a class of registered drivers
13977091
MD
1182 * @class_str: string to identify early platform driver class
1183 * @nr_probe: number of platform devices to successfully probe before exiting
1184 * @user_only: only probe user specified early platform devices
4d26e139
MD
1185 *
1186 * Used by architecture code to probe registered early platform drivers
1187 * within a certain class. For probe to happen a registered early platform
1188 * device matching a registered early platform driver is needed.
13977091
MD
1189 */
1190int __init early_platform_driver_probe(char *class_str,
1191 int nr_probe,
1192 int user_only)
1193{
1194 int k, n, i;
1195
1196 n = 0;
1197 for (i = -2; n < nr_probe; i++) {
1198 k = early_platform_driver_probe_id(class_str, i, nr_probe - n);
1199
1200 if (k < 0)
1201 break;
1202
1203 n += k;
1204
1205 if (user_only)
1206 break;
1207 }
1208
1209 return n;
1210}
1211
1212/**
1213 * early_platform_cleanup - clean up early platform code
1214 */
1215void __init early_platform_cleanup(void)
1216{
1217 struct platform_device *pd, *pd2;
1218
1219 /* clean up the devres list used to chain devices */
1220 list_for_each_entry_safe(pd, pd2, &early_platform_device_list,
1221 dev.devres_head) {
1222 list_del(&pd->dev.devres_head);
1223 memset(&pd->dev.devres_head, 0, sizeof(pd->dev.devres_head));
1224 }
1225}
1226