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