sysdev: remove global sysdev drivers list
[deliverable/linux.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
d052d1be 13#include <linux/platform_device.h>
1da177e4
LT
14#include <linux/module.h>
15#include <linux/init.h>
16#include <linux/dma-mapping.h>
17#include <linux/bootmem.h>
18#include <linux/err.h>
4e57b681 19#include <linux/slab.h>
1da177e4 20
a1bdc7aa
BD
21#include "base.h"
22
00d3dcdd
RK
23#define to_platform_driver(drv) (container_of((drv), struct platform_driver, driver))
24
1da177e4
LT
25struct device platform_bus = {
26 .bus_id = "platform",
27};
a96b2042 28EXPORT_SYMBOL_GPL(platform_bus);
1da177e4
LT
29
30/**
31 * platform_get_resource - get a resource for a device
32 * @dev: platform device
33 * @type: resource type
34 * @num: resource index
35 */
36struct resource *
37platform_get_resource(struct platform_device *dev, unsigned int type,
38 unsigned int num)
39{
40 int i;
41
42 for (i = 0; i < dev->num_resources; i++) {
43 struct resource *r = &dev->resource[i];
44
45 if ((r->flags & (IORESOURCE_IO|IORESOURCE_MEM|
46 IORESOURCE_IRQ|IORESOURCE_DMA))
47 == type)
48 if (num-- == 0)
49 return r;
50 }
51 return NULL;
52}
a96b2042 53EXPORT_SYMBOL_GPL(platform_get_resource);
1da177e4
LT
54
55/**
56 * platform_get_irq - get an IRQ for a device
57 * @dev: platform device
58 * @num: IRQ number index
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/**
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
73 */
74struct resource *
75platform_get_resource_byname(struct platform_device *dev, unsigned int type,
76 char *name)
77{
78 int i;
79
80 for (i = 0; i < dev->num_resources; i++) {
81 struct resource *r = &dev->resource[i];
82
83 if ((r->flags & (IORESOURCE_IO|IORESOURCE_MEM|
84 IORESOURCE_IRQ|IORESOURCE_DMA)) == type)
85 if (!strcmp(r->name, name))
86 return r;
87 }
88 return NULL;
89}
a96b2042 90EXPORT_SYMBOL_GPL(platform_get_resource_byname);
1da177e4
LT
91
92/**
93 * platform_get_irq - get an IRQ for a device
94 * @dev: platform device
95 * @name: IRQ name
96 */
97int platform_get_irq_byname(struct platform_device *dev, char *name)
98{
99 struct resource *r = platform_get_resource_byname(dev, IORESOURCE_IRQ, name);
100
305b3228 101 return r ? r->start : -ENXIO;
1da177e4 102}
a96b2042 103EXPORT_SYMBOL_GPL(platform_get_irq_byname);
1da177e4
LT
104
105/**
106 * platform_add_devices - add a numbers of platform devices
107 * @devs: array of platform devices to add
108 * @num: number of platform devices in array
109 */
110int platform_add_devices(struct platform_device **devs, int num)
111{
112 int i, ret = 0;
113
114 for (i = 0; i < num; i++) {
115 ret = platform_device_register(devs[i]);
116 if (ret) {
117 while (--i >= 0)
118 platform_device_unregister(devs[i]);
119 break;
120 }
121 }
122
123 return ret;
124}
a96b2042 125EXPORT_SYMBOL_GPL(platform_add_devices);
1da177e4 126
37c12e74
RK
127struct platform_object {
128 struct platform_device pdev;
129 char name[1];
130};
131
1da177e4 132/**
37c12e74
RK
133 * platform_device_put
134 * @pdev: platform device to free
135 *
136 * Free all memory associated with a platform device. This function
137 * must _only_ be externally called in error cases. All other usage
138 * is a bug.
139 */
140void platform_device_put(struct platform_device *pdev)
141{
142 if (pdev)
143 put_device(&pdev->dev);
144}
145EXPORT_SYMBOL_GPL(platform_device_put);
146
147static void platform_device_release(struct device *dev)
148{
149 struct platform_object *pa = container_of(dev, struct platform_object, pdev.dev);
150
151 kfree(pa->pdev.dev.platform_data);
152 kfree(pa->pdev.resource);
153 kfree(pa);
154}
155
156/**
157 * platform_device_alloc
158 * @name: base name of the device we're adding
159 * @id: instance id
160 *
161 * Create a platform device object which can have other objects attached
162 * to it, and which will have attached objects freed when it is released.
163 */
164struct platform_device *platform_device_alloc(const char *name, unsigned int id)
165{
166 struct platform_object *pa;
167
168 pa = kzalloc(sizeof(struct platform_object) + strlen(name), GFP_KERNEL);
169 if (pa) {
170 strcpy(pa->name, name);
171 pa->pdev.name = pa->name;
172 pa->pdev.id = id;
173 device_initialize(&pa->pdev.dev);
174 pa->pdev.dev.release = platform_device_release;
175 }
176
93ce3061 177 return pa ? &pa->pdev : NULL;
37c12e74
RK
178}
179EXPORT_SYMBOL_GPL(platform_device_alloc);
180
181/**
182 * platform_device_add_resources
183 * @pdev: platform device allocated by platform_device_alloc to add resources to
184 * @res: set of resources that needs to be allocated for the device
185 * @num: number of resources
186 *
187 * Add a copy of the resources to the platform device. The memory
188 * associated with the resources will be freed when the platform
189 * device is released.
190 */
191int platform_device_add_resources(struct platform_device *pdev, struct resource *res, unsigned int num)
192{
193 struct resource *r;
194
195 r = kmalloc(sizeof(struct resource) * num, GFP_KERNEL);
196 if (r) {
197 memcpy(r, res, sizeof(struct resource) * num);
198 pdev->resource = r;
199 pdev->num_resources = num;
200 }
201 return r ? 0 : -ENOMEM;
202}
203EXPORT_SYMBOL_GPL(platform_device_add_resources);
204
205/**
206 * platform_device_add_data
207 * @pdev: platform device allocated by platform_device_alloc to add resources to
208 * @data: platform specific data for this platform device
209 * @size: size of platform specific data
210 *
211 * Add a copy of platform specific data to the platform device's platform_data
212 * pointer. The memory associated with the platform data will be freed
213 * when the platform device is released.
214 */
6eefd34f 215int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size)
37c12e74
RK
216{
217 void *d;
218
219 d = kmalloc(size, GFP_KERNEL);
220 if (d) {
221 memcpy(d, data, size);
222 pdev->dev.platform_data = d;
223 }
224 return d ? 0 : -ENOMEM;
225}
226EXPORT_SYMBOL_GPL(platform_device_add_data);
227
228/**
229 * platform_device_add - add a platform device to device hierarchy
67be2dd1 230 * @pdev: platform device we're adding
1da177e4 231 *
37c12e74
RK
232 * This is part 2 of platform_device_register(), though may be called
233 * separately _iff_ pdev was allocated by platform_device_alloc().
1da177e4 234 */
37c12e74 235int platform_device_add(struct platform_device *pdev)
1da177e4
LT
236{
237 int i, ret = 0;
238
239 if (!pdev)
240 return -EINVAL;
241
242 if (!pdev->dev.parent)
243 pdev->dev.parent = &platform_bus;
244
245 pdev->dev.bus = &platform_bus_type;
246
247 if (pdev->id != -1)
248 snprintf(pdev->dev.bus_id, BUS_ID_SIZE, "%s.%u", pdev->name, pdev->id);
249 else
250 strlcpy(pdev->dev.bus_id, pdev->name, BUS_ID_SIZE);
251
252 for (i = 0; i < pdev->num_resources; i++) {
253 struct resource *p, *r = &pdev->resource[i];
254
255 if (r->name == NULL)
256 r->name = pdev->dev.bus_id;
257
258 p = r->parent;
259 if (!p) {
260 if (r->flags & IORESOURCE_MEM)
261 p = &iomem_resource;
262 else if (r->flags & IORESOURCE_IO)
263 p = &ioport_resource;
264 }
265
d960bb4d 266 if (p && insert_resource(p, r)) {
1da177e4
LT
267 printk(KERN_ERR
268 "%s: failed to claim resource %d\n",
269 pdev->dev.bus_id, i);
270 ret = -EBUSY;
271 goto failed;
272 }
273 }
274
275 pr_debug("Registering platform device '%s'. Parent at %s\n",
276 pdev->dev.bus_id, pdev->dev.parent->bus_id);
277
e3915532 278 ret = device_add(&pdev->dev);
1da177e4
LT
279 if (ret == 0)
280 return ret;
281
282 failed:
283 while (--i >= 0)
284 if (pdev->resource[i].flags & (IORESOURCE_MEM|IORESOURCE_IO))
285 release_resource(&pdev->resource[i]);
286 return ret;
287}
37c12e74
RK
288EXPORT_SYMBOL_GPL(platform_device_add);
289
290/**
93ce3061 291 * platform_device_del - remove a platform-level device
67be2dd1 292 * @pdev: platform device we're removing
1da177e4
LT
293 *
294 * Note that this function will also release all memory- and port-based
dc4c15d4
JD
295 * resources owned by the device (@dev->resource). This function
296 * must _only_ be externally called in error cases. All other usage
297 * is a bug.
1da177e4 298 */
93ce3061 299void platform_device_del(struct platform_device *pdev)
1da177e4
LT
300{
301 int i;
302
303 if (pdev) {
dc4c15d4
JD
304 device_del(&pdev->dev);
305
1da177e4
LT
306 for (i = 0; i < pdev->num_resources; i++) {
307 struct resource *r = &pdev->resource[i];
308 if (r->flags & (IORESOURCE_MEM|IORESOURCE_IO))
309 release_resource(r);
310 }
1da177e4
LT
311 }
312}
93ce3061
DT
313EXPORT_SYMBOL_GPL(platform_device_del);
314
315/**
316 * platform_device_register - add a platform-level device
317 * @pdev: platform device we're adding
318 *
319 */
320int platform_device_register(struct platform_device * pdev)
321{
322 device_initialize(&pdev->dev);
323 return platform_device_add(pdev);
324}
a96b2042 325EXPORT_SYMBOL_GPL(platform_device_register);
93ce3061
DT
326
327/**
328 * platform_device_unregister - unregister a platform-level device
329 * @pdev: platform device we're unregistering
330 *
80682fa9 331 * Unregistration is done in 2 steps. First we release all resources
2d7b5a70 332 * and remove it from the subsystem, then we drop reference count by
93ce3061
DT
333 * calling platform_device_put().
334 */
335void platform_device_unregister(struct platform_device * pdev)
336{
337 platform_device_del(pdev);
338 platform_device_put(pdev);
339}
a96b2042 340EXPORT_SYMBOL_GPL(platform_device_unregister);
1da177e4 341
1da177e4
LT
342/**
343 * platform_device_register_simple
344 * @name: base name of the device we're adding
345 * @id: instance id
346 * @res: set of resources that needs to be allocated for the device
347 * @num: number of resources
348 *
349 * This function creates a simple platform device that requires minimal
350 * resource and memory management. Canned release function freeing
351 * memory allocated for the device allows drivers using such devices
01afd806 352 * to be unloaded without waiting for the last reference to the device
1da177e4 353 * to be dropped.
49a4ec18
DB
354 *
355 * This interface is primarily intended for use with legacy drivers
356 * which probe hardware directly. Because such drivers create sysfs
357 * device nodes themselves, rather than letting system infrastructure
358 * handle such device enumeration tasks, they don't fully conform to
359 * the Linux driver model. In particular, when such drivers are built
360 * as modules, they can't be "hotplugged".
1da177e4
LT
361 */
362struct platform_device *platform_device_register_simple(char *name, unsigned int id,
363 struct resource *res, unsigned int num)
364{
37c12e74 365 struct platform_device *pdev;
1da177e4
LT
366 int retval;
367
37c12e74
RK
368 pdev = platform_device_alloc(name, id);
369 if (!pdev) {
1da177e4
LT
370 retval = -ENOMEM;
371 goto error;
372 }
373
1da177e4 374 if (num) {
37c12e74
RK
375 retval = platform_device_add_resources(pdev, res, num);
376 if (retval)
377 goto error;
1da177e4
LT
378 }
379
37c12e74 380 retval = platform_device_add(pdev);
1da177e4
LT
381 if (retval)
382 goto error;
383
37c12e74 384 return pdev;
1da177e4
LT
385
386error:
37c12e74 387 platform_device_put(pdev);
1da177e4
LT
388 return ERR_PTR(retval);
389}
a96b2042 390EXPORT_SYMBOL_GPL(platform_device_register_simple);
1da177e4 391
00d3dcdd
RK
392static int platform_drv_probe(struct device *_dev)
393{
394 struct platform_driver *drv = to_platform_driver(_dev->driver);
395 struct platform_device *dev = to_platform_device(_dev);
396
397 return drv->probe(dev);
398}
399
c67334fb
DB
400static int platform_drv_probe_fail(struct device *_dev)
401{
402 return -ENXIO;
403}
404
00d3dcdd
RK
405static int platform_drv_remove(struct device *_dev)
406{
407 struct platform_driver *drv = to_platform_driver(_dev->driver);
408 struct platform_device *dev = to_platform_device(_dev);
409
410 return drv->remove(dev);
411}
412
413static void platform_drv_shutdown(struct device *_dev)
414{
415 struct platform_driver *drv = to_platform_driver(_dev->driver);
416 struct platform_device *dev = to_platform_device(_dev);
417
418 drv->shutdown(dev);
419}
420
421static int platform_drv_suspend(struct device *_dev, pm_message_t state)
422{
423 struct platform_driver *drv = to_platform_driver(_dev->driver);
424 struct platform_device *dev = to_platform_device(_dev);
425
426 return drv->suspend(dev, state);
427}
428
429static int platform_drv_resume(struct device *_dev)
430{
431 struct platform_driver *drv = to_platform_driver(_dev->driver);
432 struct platform_device *dev = to_platform_device(_dev);
433
434 return drv->resume(dev);
435}
436
437/**
438 * platform_driver_register
439 * @drv: platform driver structure
440 */
441int platform_driver_register(struct platform_driver *drv)
442{
443 drv->driver.bus = &platform_bus_type;
444 if (drv->probe)
445 drv->driver.probe = platform_drv_probe;
446 if (drv->remove)
447 drv->driver.remove = platform_drv_remove;
448 if (drv->shutdown)
449 drv->driver.shutdown = platform_drv_shutdown;
450 if (drv->suspend)
451 drv->driver.suspend = platform_drv_suspend;
452 if (drv->resume)
453 drv->driver.resume = platform_drv_resume;
454 return driver_register(&drv->driver);
455}
456EXPORT_SYMBOL_GPL(platform_driver_register);
457
458/**
459 * platform_driver_unregister
460 * @drv: platform driver structure
461 */
462void platform_driver_unregister(struct platform_driver *drv)
463{
464 driver_unregister(&drv->driver);
465}
466EXPORT_SYMBOL_GPL(platform_driver_unregister);
467
c67334fb
DB
468/**
469 * platform_driver_probe - register driver for non-hotpluggable device
470 * @drv: platform driver structure
471 * @probe: the driver probe routine, probably from an __init section
472 *
473 * Use this instead of platform_driver_register() when you know the device
474 * is not hotpluggable and has already been registered, and you want to
475 * remove its run-once probe() infrastructure from memory after the driver
476 * has bound to the device.
477 *
478 * One typical use for this would be with drivers for controllers integrated
479 * into system-on-chip processors, where the controller devices have been
480 * configured as part of board setup.
481 *
482 * Returns zero if the driver registered and bound to a device, else returns
483 * a negative error code and with the driver not registered.
484 */
c63e0783 485int __init_or_module platform_driver_probe(struct platform_driver *drv,
c67334fb
DB
486 int (*probe)(struct platform_device *))
487{
488 int retval, code;
489
490 /* temporary section violation during probe() */
491 drv->probe = probe;
492 retval = code = platform_driver_register(drv);
493
494 /* Fixup that section violation, being paranoid about code scanning
495 * the list of drivers in order to probe new devices. Check to see
496 * if the probe was successful, and make sure any forced probes of
497 * new devices fail.
498 */
499 spin_lock(&platform_bus_type.klist_drivers.k_lock);
500 drv->probe = NULL;
501 if (code == 0 && list_empty(&drv->driver.klist_devices.k_list))
502 retval = -ENODEV;
503 drv->driver.probe = platform_drv_probe_fail;
504 spin_unlock(&platform_bus_type.klist_drivers.k_lock);
505
506 if (code != retval)
507 platform_driver_unregister(drv);
508 return retval;
509}
510EXPORT_SYMBOL_GPL(platform_driver_probe);
1da177e4 511
a0245f7a
DB
512/* modalias support enables more hands-off userspace setup:
513 * (a) environment variable lets new-style hotplug events work once system is
514 * fully running: "modprobe $MODALIAS"
515 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
516 * mishandled before system is fully running: "modprobe $(cat modalias)"
517 */
518static ssize_t
519modalias_show(struct device *dev, struct device_attribute *a, char *buf)
520{
521 struct platform_device *pdev = to_platform_device(dev);
43cc71ee 522 int len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
a0245f7a
DB
523
524 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
525}
526
527static struct device_attribute platform_dev_attrs[] = {
528 __ATTR_RO(modalias),
529 __ATTR_NULL,
530};
531
7eff2e7a 532static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
a0245f7a
DB
533{
534 struct platform_device *pdev = to_platform_device(dev);
535
7eff2e7a 536 add_uevent_var(env, "MODALIAS=platform:%s", pdev->name);
a0245f7a
DB
537 return 0;
538}
539
540
1da177e4
LT
541/**
542 * platform_match - bind platform device to platform driver.
543 * @dev: device.
544 * @drv: driver.
545 *
546 * Platform device IDs are assumed to be encoded like this:
547 * "<name><instance>", where <name> is a short description of the
548 * type of device, like "pci" or "floppy", and <instance> is the
549 * enumerated instance of the device, like '0' or '42'.
550 * Driver IDs are simply "<name>".
551 * So, extract the <name> from the platform_device structure,
552 * and compare it against the name of the driver. Return whether
553 * they match or not.
554 */
555
556static int platform_match(struct device * dev, struct device_driver * drv)
557{
558 struct platform_device *pdev = container_of(dev, struct platform_device, dev);
559
560 return (strncmp(pdev->name, drv->name, BUS_ID_SIZE) == 0);
561}
562
386415d8 563static int platform_suspend(struct device *dev, pm_message_t mesg)
1da177e4
LT
564{
565 int ret = 0;
566
9480e307 567 if (dev->driver && dev->driver->suspend)
386415d8
DB
568 ret = dev->driver->suspend(dev, mesg);
569
570 return ret;
571}
572
573static int platform_suspend_late(struct device *dev, pm_message_t mesg)
574{
575 struct platform_driver *drv = to_platform_driver(dev->driver);
576 struct platform_device *pdev = container_of(dev, struct platform_device, dev);
577 int ret = 0;
578
579 if (dev->driver && drv->suspend_late)
580 ret = drv->suspend_late(pdev, mesg);
581
582 return ret;
583}
584
585static int platform_resume_early(struct device *dev)
586{
587 struct platform_driver *drv = to_platform_driver(dev->driver);
588 struct platform_device *pdev = container_of(dev, struct platform_device, dev);
589 int ret = 0;
590
591 if (dev->driver && drv->resume_early)
592 ret = drv->resume_early(pdev);
9480e307 593
1da177e4
LT
594 return ret;
595}
596
597static int platform_resume(struct device * dev)
598{
599 int ret = 0;
600
9480e307
RK
601 if (dev->driver && dev->driver->resume)
602 ret = dev->driver->resume(dev);
603
1da177e4
LT
604 return ret;
605}
606
607struct bus_type platform_bus_type = {
608 .name = "platform",
a0245f7a 609 .dev_attrs = platform_dev_attrs,
1da177e4 610 .match = platform_match,
a0245f7a 611 .uevent = platform_uevent,
1da177e4 612 .suspend = platform_suspend,
386415d8
DB
613 .suspend_late = platform_suspend_late,
614 .resume_early = platform_resume_early,
1da177e4
LT
615 .resume = platform_resume,
616};
a96b2042 617EXPORT_SYMBOL_GPL(platform_bus_type);
1da177e4
LT
618
619int __init platform_bus_init(void)
620{
fbfb1445
CH
621 int error;
622
623 error = device_register(&platform_bus);
624 if (error)
625 return error;
626 error = bus_register(&platform_bus_type);
627 if (error)
628 device_unregister(&platform_bus);
629 return error;
1da177e4
LT
630}
631
632#ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
633u64 dma_get_required_mask(struct device *dev)
634{
635 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
636 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
637 u64 mask;
638
639 if (!high_totalram) {
640 /* convert to mask just covering totalram */
641 low_totalram = (1 << (fls(low_totalram) - 1));
642 low_totalram += low_totalram - 1;
643 mask = low_totalram;
644 } else {
645 high_totalram = (1 << (fls(high_totalram) - 1));
646 high_totalram += high_totalram - 1;
647 mask = (((u64)high_totalram) << 32) + 0xffffffff;
648 }
649 return mask & *dev->dma_mask;
650}
651EXPORT_SYMBOL_GPL(dma_get_required_mask);
652#endif
This page took 0.307823 seconds and 5 git commands to generate.