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