blob: 66b710c2881223dac67a102bb227df0e63e2cec2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Russell Kingd052d1b2005-10-29 19:07:23 +010013#include <linux/platform_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#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>
Tim Schmielau4e57b682005-10-30 15:03:48 -080019#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Ben Dooksa1bdc7a2005-10-13 17:54:41 +010021#include "base.h"
22
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080023#define to_platform_driver(drv) (container_of((drv), struct platform_driver, \
24 driver))
Russell King00d3dcd2005-11-09 17:23:39 +000025
Linus Torvalds1da177e2005-04-16 15:20:36 -070026struct device platform_bus = {
27 .bus_id = "platform",
28};
Dmitry Torokhova96b2042005-12-10 01:36:28 -050029EXPORT_SYMBOL_GPL(platform_bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080032 * platform_get_resource - get a resource for a device
33 * @dev: platform device
34 * @type: resource type
35 * @num: resource index
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080037struct resource *platform_get_resource(struct platform_device *dev,
38 unsigned int type, unsigned int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039{
40 int i;
41
42 for (i = 0; i < dev->num_resources; i++) {
43 struct resource *r = &dev->resource[i];
44
Magnus Dammc9f66162008-10-15 22:05:15 -070045 if (type == resource_type(r) && num-- == 0)
46 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 }
48 return NULL;
49}
Dmitry Torokhova96b2042005-12-10 01:36:28 -050050EXPORT_SYMBOL_GPL(platform_get_resource);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080053 * platform_get_irq - get an IRQ for a device
54 * @dev: platform device
55 * @num: IRQ number index
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 */
57int platform_get_irq(struct platform_device *dev, unsigned int num)
58{
59 struct resource *r = platform_get_resource(dev, IORESOURCE_IRQ, num);
60
David Vrabel305b3222006-01-19 17:52:27 +000061 return r ? r->start : -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062}
Dmitry Torokhova96b2042005-12-10 01:36:28 -050063EXPORT_SYMBOL_GPL(platform_get_irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080066 * platform_get_resource_byname - get a resource for a device by name
67 * @dev: platform device
68 * @type: resource type
69 * @name: resource name
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080071struct resource *platform_get_resource_byname(struct platform_device *dev,
72 unsigned int type, char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073{
74 int i;
75
76 for (i = 0; i < dev->num_resources; i++) {
77 struct resource *r = &dev->resource[i];
78
Magnus Dammc9f66162008-10-15 22:05:15 -070079 if (type == resource_type(r) && !strcmp(r->name, name))
80 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 }
82 return NULL;
83}
Dmitry Torokhova96b2042005-12-10 01:36:28 -050084EXPORT_SYMBOL_GPL(platform_get_resource_byname);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080087 * platform_get_irq - get an IRQ for a device
88 * @dev: platform device
89 * @name: IRQ name
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 */
91int platform_get_irq_byname(struct platform_device *dev, char *name)
92{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080093 struct resource *r = platform_get_resource_byname(dev, IORESOURCE_IRQ,
94 name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
David Vrabel305b3222006-01-19 17:52:27 +000096 return r ? r->start : -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097}
Dmitry Torokhova96b2042005-12-10 01:36:28 -050098EXPORT_SYMBOL_GPL(platform_get_irq_byname);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
100/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800101 * platform_add_devices - add a numbers of platform devices
102 * @devs: array of platform devices to add
103 * @num: number of platform devices in array
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 */
105int platform_add_devices(struct platform_device **devs, int num)
106{
107 int i, ret = 0;
108
109 for (i = 0; i < num; i++) {
110 ret = platform_device_register(devs[i]);
111 if (ret) {
112 while (--i >= 0)
113 platform_device_unregister(devs[i]);
114 break;
115 }
116 }
117
118 return ret;
119}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500120EXPORT_SYMBOL_GPL(platform_add_devices);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Russell King37c12e72005-11-05 21:19:33 +0000122struct platform_object {
123 struct platform_device pdev;
124 char name[1];
125};
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800128 * platform_device_put
129 * @pdev: platform device to free
Russell King37c12e72005-11-05 21:19:33 +0000130 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800131 * Free all memory associated with a platform device. This function must
132 * _only_ be externally called in error cases. All other usage is a bug.
Russell King37c12e72005-11-05 21:19:33 +0000133 */
134void platform_device_put(struct platform_device *pdev)
135{
136 if (pdev)
137 put_device(&pdev->dev);
138}
139EXPORT_SYMBOL_GPL(platform_device_put);
140
141static void platform_device_release(struct device *dev)
142{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800143 struct platform_object *pa = container_of(dev, struct platform_object,
144 pdev.dev);
Russell King37c12e72005-11-05 21:19:33 +0000145
146 kfree(pa->pdev.dev.platform_data);
147 kfree(pa->pdev.resource);
148 kfree(pa);
149}
150
151/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800152 * platform_device_alloc
153 * @name: base name of the device we're adding
154 * @id: instance id
Russell King37c12e72005-11-05 21:19:33 +0000155 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800156 * Create a platform device object which can have other objects attached
157 * to it, and which will have attached objects freed when it is released.
Russell King37c12e72005-11-05 21:19:33 +0000158 */
Jean Delvare13595552007-09-09 12:54:16 +0200159struct platform_device *platform_device_alloc(const char *name, int id)
Russell King37c12e72005-11-05 21:19:33 +0000160{
161 struct platform_object *pa;
162
163 pa = kzalloc(sizeof(struct platform_object) + strlen(name), GFP_KERNEL);
164 if (pa) {
165 strcpy(pa->name, name);
166 pa->pdev.name = pa->name;
167 pa->pdev.id = id;
168 device_initialize(&pa->pdev.dev);
169 pa->pdev.dev.release = platform_device_release;
170 }
171
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500172 return pa ? &pa->pdev : NULL;
Russell King37c12e72005-11-05 21:19:33 +0000173}
174EXPORT_SYMBOL_GPL(platform_device_alloc);
175
176/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800177 * platform_device_add_resources
178 * @pdev: platform device allocated by platform_device_alloc to add resources to
179 * @res: set of resources that needs to be allocated for the device
180 * @num: number of resources
Russell King37c12e72005-11-05 21:19:33 +0000181 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800182 * Add a copy of the resources to the platform device. The memory
183 * associated with the resources will be freed when the platform device is
184 * released.
Russell King37c12e72005-11-05 21:19:33 +0000185 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800186int platform_device_add_resources(struct platform_device *pdev,
187 struct resource *res, unsigned int num)
Russell King37c12e72005-11-05 21:19:33 +0000188{
189 struct resource *r;
190
191 r = kmalloc(sizeof(struct resource) * num, GFP_KERNEL);
192 if (r) {
193 memcpy(r, res, sizeof(struct resource) * num);
194 pdev->resource = r;
195 pdev->num_resources = num;
196 }
197 return r ? 0 : -ENOMEM;
198}
199EXPORT_SYMBOL_GPL(platform_device_add_resources);
200
201/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800202 * platform_device_add_data
203 * @pdev: platform device allocated by platform_device_alloc to add resources to
204 * @data: platform specific data for this platform device
205 * @size: size of platform specific data
Russell King37c12e72005-11-05 21:19:33 +0000206 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800207 * Add a copy of platform specific data to the platform device's
208 * platform_data pointer. The memory associated with the platform data
209 * will be freed when the platform device is released.
Russell King37c12e72005-11-05 21:19:33 +0000210 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800211int platform_device_add_data(struct platform_device *pdev, const void *data,
212 size_t size)
Russell King37c12e72005-11-05 21:19:33 +0000213{
214 void *d;
215
216 d = kmalloc(size, GFP_KERNEL);
217 if (d) {
218 memcpy(d, data, size);
219 pdev->dev.platform_data = d;
220 }
221 return d ? 0 : -ENOMEM;
222}
223EXPORT_SYMBOL_GPL(platform_device_add_data);
224
225/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800226 * platform_device_add - add a platform device to device hierarchy
227 * @pdev: platform device we're adding
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800229 * This is part 2 of platform_device_register(), though may be called
230 * separately _iff_ pdev was allocated by platform_device_alloc().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 */
Russell King37c12e72005-11-05 21:19:33 +0000232int platform_device_add(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233{
234 int i, ret = 0;
235
236 if (!pdev)
237 return -EINVAL;
238
239 if (!pdev->dev.parent)
240 pdev->dev.parent = &platform_bus;
241
242 pdev->dev.bus = &platform_bus_type;
243
244 if (pdev->id != -1)
Jean Delvare13595552007-09-09 12:54:16 +0200245 snprintf(pdev->dev.bus_id, BUS_ID_SIZE, "%s.%d", pdev->name,
246 pdev->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 else
248 strlcpy(pdev->dev.bus_id, pdev->name, BUS_ID_SIZE);
249
250 for (i = 0; i < pdev->num_resources; i++) {
251 struct resource *p, *r = &pdev->resource[i];
252
253 if (r->name == NULL)
254 r->name = pdev->dev.bus_id;
255
256 p = r->parent;
257 if (!p) {
Magnus Dammc9f66162008-10-15 22:05:15 -0700258 if (resource_type(r) == IORESOURCE_MEM)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 p = &iomem_resource;
Magnus Dammc9f66162008-10-15 22:05:15 -0700260 else if (resource_type(r) == IORESOURCE_IO)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 p = &ioport_resource;
262 }
263
Kumar Galad960bb42005-11-28 10:15:39 -0600264 if (p && insert_resource(p, r)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 printk(KERN_ERR
266 "%s: failed to claim resource %d\n",
267 pdev->dev.bus_id, i);
268 ret = -EBUSY;
269 goto failed;
270 }
271 }
272
273 pr_debug("Registering platform device '%s'. Parent at %s\n",
274 pdev->dev.bus_id, pdev->dev.parent->bus_id);
275
Russell Kinge3915532006-05-06 08:15:26 +0100276 ret = device_add(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 if (ret == 0)
278 return ret;
279
280 failed:
Magnus Dammc9f66162008-10-15 22:05:15 -0700281 while (--i >= 0) {
282 struct resource *r = &pdev->resource[i];
283 unsigned long type = resource_type(r);
284
285 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
286 release_resource(r);
287 }
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 return ret;
290}
Russell King37c12e72005-11-05 21:19:33 +0000291EXPORT_SYMBOL_GPL(platform_device_add);
292
293/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800294 * platform_device_del - remove a platform-level device
295 * @pdev: platform device we're removing
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500296 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800297 * Note that this function will also release all memory- and port-based
298 * resources owned by the device (@dev->resource). This function must
299 * _only_ be externally called in error cases. All other usage is a bug.
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500300 */
301void platform_device_del(struct platform_device *pdev)
302{
303 int i;
304
305 if (pdev) {
Jean Delvaredc4c15d2007-05-02 20:55:54 +0200306 device_del(&pdev->dev);
307
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500308 for (i = 0; i < pdev->num_resources; i++) {
309 struct resource *r = &pdev->resource[i];
Magnus Dammc9f66162008-10-15 22:05:15 -0700310 unsigned long type = resource_type(r);
311
312 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500313 release_resource(r);
314 }
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500315 }
316}
317EXPORT_SYMBOL_GPL(platform_device_del);
318
319/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800320 * platform_device_register - add a platform-level device
321 * @pdev: platform device we're adding
Russell King37c12e72005-11-05 21:19:33 +0000322 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800323int platform_device_register(struct platform_device *pdev)
Russell King37c12e72005-11-05 21:19:33 +0000324{
325 device_initialize(&pdev->dev);
326 return platform_device_add(pdev);
327}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500328EXPORT_SYMBOL_GPL(platform_device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800331 * platform_device_unregister - unregister a platform-level device
332 * @pdev: platform device we're unregistering
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800334 * Unregistration is done in 2 steps. First we release all resources
335 * and remove it from the subsystem, then we drop reference count by
336 * calling platform_device_put().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800338void platform_device_unregister(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339{
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500340 platform_device_del(pdev);
341 platform_device_put(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500343EXPORT_SYMBOL_GPL(platform_device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800346 * platform_device_register_simple
347 * @name: base name of the device we're adding
348 * @id: instance id
349 * @res: set of resources that needs to be allocated for the device
350 * @num: number of resources
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800352 * This function creates a simple platform device that requires minimal
353 * resource and memory management. Canned release function freeing memory
354 * allocated for the device allows drivers using such devices to be
355 * unloaded without waiting for the last reference to the device to be
356 * dropped.
David Brownell49a4ec12007-05-08 00:29:39 -0700357 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800358 * This interface is primarily intended for use with legacy drivers which
359 * probe hardware directly. Because such drivers create sysfs device nodes
360 * themselves, rather than letting system infrastructure handle such device
361 * enumeration tasks, they don't fully conform to the Linux driver model.
362 * In particular, when such drivers are built as modules, they can't be
363 * "hotplugged".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800365struct platform_device *platform_device_register_simple(const char *name,
366 int id,
367 struct resource *res,
368 unsigned int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369{
Russell King37c12e72005-11-05 21:19:33 +0000370 struct platform_device *pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 int retval;
372
Russell King37c12e72005-11-05 21:19:33 +0000373 pdev = platform_device_alloc(name, id);
374 if (!pdev) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 retval = -ENOMEM;
376 goto error;
377 }
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 if (num) {
Russell King37c12e72005-11-05 21:19:33 +0000380 retval = platform_device_add_resources(pdev, res, num);
381 if (retval)
382 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 }
384
Russell King37c12e72005-11-05 21:19:33 +0000385 retval = platform_device_add(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 if (retval)
387 goto error;
388
Russell King37c12e72005-11-05 21:19:33 +0000389 return pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391error:
Russell King37c12e72005-11-05 21:19:33 +0000392 platform_device_put(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 return ERR_PTR(retval);
394}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500395EXPORT_SYMBOL_GPL(platform_device_register_simple);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Russell King00d3dcd2005-11-09 17:23:39 +0000397static int platform_drv_probe(struct device *_dev)
398{
399 struct platform_driver *drv = to_platform_driver(_dev->driver);
400 struct platform_device *dev = to_platform_device(_dev);
401
402 return drv->probe(dev);
403}
404
David Brownellc67334f2006-11-16 23:28:47 -0800405static int platform_drv_probe_fail(struct device *_dev)
406{
407 return -ENXIO;
408}
409
Russell King00d3dcd2005-11-09 17:23:39 +0000410static int platform_drv_remove(struct device *_dev)
411{
412 struct platform_driver *drv = to_platform_driver(_dev->driver);
413 struct platform_device *dev = to_platform_device(_dev);
414
415 return drv->remove(dev);
416}
417
418static void platform_drv_shutdown(struct device *_dev)
419{
420 struct platform_driver *drv = to_platform_driver(_dev->driver);
421 struct platform_device *dev = to_platform_device(_dev);
422
423 drv->shutdown(dev);
424}
425
426static int platform_drv_suspend(struct device *_dev, pm_message_t state)
427{
428 struct platform_driver *drv = to_platform_driver(_dev->driver);
429 struct platform_device *dev = to_platform_device(_dev);
430
431 return drv->suspend(dev, state);
432}
433
434static int platform_drv_resume(struct device *_dev)
435{
436 struct platform_driver *drv = to_platform_driver(_dev->driver);
437 struct platform_device *dev = to_platform_device(_dev);
438
439 return drv->resume(dev);
440}
441
442/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800443 * platform_driver_register
444 * @drv: platform driver structure
Russell King00d3dcd2005-11-09 17:23:39 +0000445 */
446int platform_driver_register(struct platform_driver *drv)
447{
448 drv->driver.bus = &platform_bus_type;
449 if (drv->probe)
450 drv->driver.probe = platform_drv_probe;
451 if (drv->remove)
452 drv->driver.remove = platform_drv_remove;
453 if (drv->shutdown)
454 drv->driver.shutdown = platform_drv_shutdown;
455 if (drv->suspend)
456 drv->driver.suspend = platform_drv_suspend;
457 if (drv->resume)
458 drv->driver.resume = platform_drv_resume;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200459 if (drv->pm)
460 drv->driver.pm = &drv->pm->base;
Russell King00d3dcd2005-11-09 17:23:39 +0000461 return driver_register(&drv->driver);
462}
463EXPORT_SYMBOL_GPL(platform_driver_register);
464
465/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800466 * platform_driver_unregister
467 * @drv: platform driver structure
Russell King00d3dcd2005-11-09 17:23:39 +0000468 */
469void platform_driver_unregister(struct platform_driver *drv)
470{
471 driver_unregister(&drv->driver);
472}
473EXPORT_SYMBOL_GPL(platform_driver_unregister);
474
David Brownellc67334f2006-11-16 23:28:47 -0800475/**
476 * platform_driver_probe - register driver for non-hotpluggable device
477 * @drv: platform driver structure
478 * @probe: the driver probe routine, probably from an __init section
479 *
480 * Use this instead of platform_driver_register() when you know the device
481 * is not hotpluggable and has already been registered, and you want to
482 * remove its run-once probe() infrastructure from memory after the driver
483 * has bound to the device.
484 *
485 * One typical use for this would be with drivers for controllers integrated
486 * into system-on-chip processors, where the controller devices have been
487 * configured as part of board setup.
488 *
489 * Returns zero if the driver registered and bound to a device, else returns
490 * a negative error code and with the driver not registered.
491 */
Andrew Mortonc63e0782006-12-04 14:56:36 -0800492int __init_or_module platform_driver_probe(struct platform_driver *drv,
David Brownellc67334f2006-11-16 23:28:47 -0800493 int (*probe)(struct platform_device *))
494{
495 int retval, code;
496
497 /* temporary section violation during probe() */
498 drv->probe = probe;
499 retval = code = platform_driver_register(drv);
500
501 /* Fixup that section violation, being paranoid about code scanning
502 * the list of drivers in order to probe new devices. Check to see
503 * if the probe was successful, and make sure any forced probes of
504 * new devices fail.
505 */
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700506 spin_lock(&platform_bus_type.p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800507 drv->probe = NULL;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800508 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
David Brownellc67334f2006-11-16 23:28:47 -0800509 retval = -ENODEV;
510 drv->driver.probe = platform_drv_probe_fail;
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700511 spin_unlock(&platform_bus_type.p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800512
513 if (code != retval)
514 platform_driver_unregister(drv);
515 return retval;
516}
517EXPORT_SYMBOL_GPL(platform_driver_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
David Brownella0245f72006-05-29 10:37:33 -0700519/* modalias support enables more hands-off userspace setup:
520 * (a) environment variable lets new-style hotplug events work once system is
521 * fully running: "modprobe $MODALIAS"
522 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
523 * mishandled before system is fully running: "modprobe $(cat modalias)"
524 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800525static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
526 char *buf)
David Brownella0245f72006-05-29 10:37:33 -0700527{
528 struct platform_device *pdev = to_platform_device(dev);
Kay Sievers43cc71e2007-08-18 04:40:39 +0200529 int len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700530
531 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
532}
533
534static struct device_attribute platform_dev_attrs[] = {
535 __ATTR_RO(modalias),
536 __ATTR_NULL,
537};
538
Kay Sievers7eff2e72007-08-14 15:15:12 +0200539static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownella0245f72006-05-29 10:37:33 -0700540{
541 struct platform_device *pdev = to_platform_device(dev);
542
Kay Sievers7eff2e72007-08-14 15:15:12 +0200543 add_uevent_var(env, "MODALIAS=platform:%s", pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700544 return 0;
545}
546
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800548 * platform_match - bind platform device to platform driver.
549 * @dev: device.
550 * @drv: driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800552 * Platform device IDs are assumed to be encoded like this:
553 * "<name><instance>", where <name> is a short description of the type of
554 * device, like "pci" or "floppy", and <instance> is the enumerated
555 * instance of the device, like '0' or '42'. Driver IDs are simply
556 * "<name>". So, extract the <name> from the platform_device structure,
557 * and compare it against the name of the driver. Return whether they match
558 * or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800560static int platform_match(struct device *dev, struct device_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800562 struct platform_device *pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800564 pdev = container_of(dev, struct platform_device, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 return (strncmp(pdev->name, drv->name, BUS_ID_SIZE) == 0);
566}
567
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200568#ifdef CONFIG_PM_SLEEP
569
570static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571{
572 int ret = 0;
573
Russell King9480e302005-10-28 09:52:56 -0700574 if (dev->driver && dev->driver->suspend)
David Brownell386415d2006-09-03 13:16:45 -0700575 ret = dev->driver->suspend(dev, mesg);
576
577 return ret;
578}
579
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200580static int platform_legacy_suspend_late(struct device *dev, pm_message_t mesg)
David Brownell386415d2006-09-03 13:16:45 -0700581{
582 struct platform_driver *drv = to_platform_driver(dev->driver);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800583 struct platform_device *pdev;
David Brownell386415d2006-09-03 13:16:45 -0700584 int ret = 0;
585
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800586 pdev = container_of(dev, struct platform_device, dev);
David Brownell386415d2006-09-03 13:16:45 -0700587 if (dev->driver && drv->suspend_late)
588 ret = drv->suspend_late(pdev, mesg);
589
590 return ret;
591}
592
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200593static int platform_legacy_resume_early(struct device *dev)
David Brownell386415d2006-09-03 13:16:45 -0700594{
595 struct platform_driver *drv = to_platform_driver(dev->driver);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800596 struct platform_device *pdev;
David Brownell386415d2006-09-03 13:16:45 -0700597 int ret = 0;
598
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800599 pdev = container_of(dev, struct platform_device, dev);
David Brownell386415d2006-09-03 13:16:45 -0700600 if (dev->driver && drv->resume_early)
601 ret = drv->resume_early(pdev);
Russell King9480e302005-10-28 09:52:56 -0700602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 return ret;
604}
605
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200606static int platform_legacy_resume(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
608 int ret = 0;
609
Russell King9480e302005-10-28 09:52:56 -0700610 if (dev->driver && dev->driver->resume)
611 ret = dev->driver->resume(dev);
612
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 return ret;
614}
615
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200616static int platform_pm_prepare(struct device *dev)
617{
618 struct device_driver *drv = dev->driver;
619 int ret = 0;
620
621 if (drv && drv->pm && drv->pm->prepare)
622 ret = drv->pm->prepare(dev);
623
624 return ret;
625}
626
627static void platform_pm_complete(struct device *dev)
628{
629 struct device_driver *drv = dev->driver;
630
631 if (drv && drv->pm && drv->pm->complete)
632 drv->pm->complete(dev);
633}
634
635#ifdef CONFIG_SUSPEND
636
637static int platform_pm_suspend(struct device *dev)
638{
639 struct device_driver *drv = dev->driver;
640 int ret = 0;
641
642 if (drv && drv->pm) {
643 if (drv->pm->suspend)
644 ret = drv->pm->suspend(dev);
645 } else {
646 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
647 }
648
649 return ret;
650}
651
652static int platform_pm_suspend_noirq(struct device *dev)
653{
654 struct platform_driver *pdrv;
655 int ret = 0;
656
657 if (!dev->driver)
658 return 0;
659
660 pdrv = to_platform_driver(dev->driver);
661 if (pdrv->pm) {
662 if (pdrv->pm->suspend_noirq)
663 ret = pdrv->pm->suspend_noirq(dev);
664 } else {
665 ret = platform_legacy_suspend_late(dev, PMSG_SUSPEND);
666 }
667
668 return ret;
669}
670
671static int platform_pm_resume(struct device *dev)
672{
673 struct device_driver *drv = dev->driver;
674 int ret = 0;
675
676 if (drv && drv->pm) {
677 if (drv->pm->resume)
678 ret = drv->pm->resume(dev);
679 } else {
680 ret = platform_legacy_resume(dev);
681 }
682
683 return ret;
684}
685
686static int platform_pm_resume_noirq(struct device *dev)
687{
688 struct platform_driver *pdrv;
689 int ret = 0;
690
691 if (!dev->driver)
692 return 0;
693
694 pdrv = to_platform_driver(dev->driver);
695 if (pdrv->pm) {
696 if (pdrv->pm->resume_noirq)
697 ret = pdrv->pm->resume_noirq(dev);
698 } else {
699 ret = platform_legacy_resume_early(dev);
700 }
701
702 return ret;
703}
704
705#else /* !CONFIG_SUSPEND */
706
707#define platform_pm_suspend NULL
708#define platform_pm_resume NULL
709#define platform_pm_suspend_noirq NULL
710#define platform_pm_resume_noirq NULL
711
712#endif /* !CONFIG_SUSPEND */
713
714#ifdef CONFIG_HIBERNATION
715
716static int platform_pm_freeze(struct device *dev)
717{
718 struct device_driver *drv = dev->driver;
719 int ret = 0;
720
721 if (!drv)
722 return 0;
723
724 if (drv->pm) {
725 if (drv->pm->freeze)
726 ret = drv->pm->freeze(dev);
727 } else {
728 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
729 }
730
731 return ret;
732}
733
734static int platform_pm_freeze_noirq(struct device *dev)
735{
736 struct platform_driver *pdrv;
737 int ret = 0;
738
739 if (!dev->driver)
740 return 0;
741
742 pdrv = to_platform_driver(dev->driver);
743 if (pdrv->pm) {
744 if (pdrv->pm->freeze_noirq)
745 ret = pdrv->pm->freeze_noirq(dev);
746 } else {
747 ret = platform_legacy_suspend_late(dev, PMSG_FREEZE);
748 }
749
750 return ret;
751}
752
753static int platform_pm_thaw(struct device *dev)
754{
755 struct device_driver *drv = dev->driver;
756 int ret = 0;
757
758 if (drv && drv->pm) {
759 if (drv->pm->thaw)
760 ret = drv->pm->thaw(dev);
761 } else {
762 ret = platform_legacy_resume(dev);
763 }
764
765 return ret;
766}
767
768static int platform_pm_thaw_noirq(struct device *dev)
769{
770 struct platform_driver *pdrv;
771 int ret = 0;
772
773 if (!dev->driver)
774 return 0;
775
776 pdrv = to_platform_driver(dev->driver);
777 if (pdrv->pm) {
778 if (pdrv->pm->thaw_noirq)
779 ret = pdrv->pm->thaw_noirq(dev);
780 } else {
781 ret = platform_legacy_resume_early(dev);
782 }
783
784 return ret;
785}
786
787static int platform_pm_poweroff(struct device *dev)
788{
789 struct device_driver *drv = dev->driver;
790 int ret = 0;
791
792 if (drv && drv->pm) {
793 if (drv->pm->poweroff)
794 ret = drv->pm->poweroff(dev);
795 } else {
796 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
797 }
798
799 return ret;
800}
801
802static int platform_pm_poweroff_noirq(struct device *dev)
803{
804 struct platform_driver *pdrv;
805 int ret = 0;
806
807 if (!dev->driver)
808 return 0;
809
810 pdrv = to_platform_driver(dev->driver);
811 if (pdrv->pm) {
812 if (pdrv->pm->poweroff_noirq)
813 ret = pdrv->pm->poweroff_noirq(dev);
814 } else {
815 ret = platform_legacy_suspend_late(dev, PMSG_HIBERNATE);
816 }
817
818 return ret;
819}
820
821static int platform_pm_restore(struct device *dev)
822{
823 struct device_driver *drv = dev->driver;
824 int ret = 0;
825
826 if (drv && drv->pm) {
827 if (drv->pm->restore)
828 ret = drv->pm->restore(dev);
829 } else {
830 ret = platform_legacy_resume(dev);
831 }
832
833 return ret;
834}
835
836static int platform_pm_restore_noirq(struct device *dev)
837{
838 struct platform_driver *pdrv;
839 int ret = 0;
840
841 if (!dev->driver)
842 return 0;
843
844 pdrv = to_platform_driver(dev->driver);
845 if (pdrv->pm) {
846 if (pdrv->pm->restore_noirq)
847 ret = pdrv->pm->restore_noirq(dev);
848 } else {
849 ret = platform_legacy_resume_early(dev);
850 }
851
852 return ret;
853}
854
855#else /* !CONFIG_HIBERNATION */
856
857#define platform_pm_freeze NULL
858#define platform_pm_thaw NULL
859#define platform_pm_poweroff NULL
860#define platform_pm_restore NULL
861#define platform_pm_freeze_noirq NULL
862#define platform_pm_thaw_noirq NULL
863#define platform_pm_poweroff_noirq NULL
864#define platform_pm_restore_noirq NULL
865
866#endif /* !CONFIG_HIBERNATION */
867
868struct pm_ext_ops platform_pm_ops = {
869 .base = {
870 .prepare = platform_pm_prepare,
871 .complete = platform_pm_complete,
872 .suspend = platform_pm_suspend,
873 .resume = platform_pm_resume,
874 .freeze = platform_pm_freeze,
875 .thaw = platform_pm_thaw,
876 .poweroff = platform_pm_poweroff,
877 .restore = platform_pm_restore,
878 },
879 .suspend_noirq = platform_pm_suspend_noirq,
880 .resume_noirq = platform_pm_resume_noirq,
881 .freeze_noirq = platform_pm_freeze_noirq,
882 .thaw_noirq = platform_pm_thaw_noirq,
883 .poweroff_noirq = platform_pm_poweroff_noirq,
884 .restore_noirq = platform_pm_restore_noirq,
885};
886
887#define PLATFORM_PM_OPS_PTR &platform_pm_ops
888
889#else /* !CONFIG_PM_SLEEP */
890
891#define PLATFORM_PM_OPS_PTR NULL
892
893#endif /* !CONFIG_PM_SLEEP */
894
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895struct bus_type platform_bus_type = {
896 .name = "platform",
David Brownella0245f72006-05-29 10:37:33 -0700897 .dev_attrs = platform_dev_attrs,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 .match = platform_match,
David Brownella0245f72006-05-29 10:37:33 -0700899 .uevent = platform_uevent,
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200900 .pm = PLATFORM_PM_OPS_PTR,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901};
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500902EXPORT_SYMBOL_GPL(platform_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
904int __init platform_bus_init(void)
905{
Cornelia Huckfbfb1442006-11-27 10:35:08 +0100906 int error;
907
908 error = device_register(&platform_bus);
909 if (error)
910 return error;
911 error = bus_register(&platform_bus_type);
912 if (error)
913 device_unregister(&platform_bus);
914 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915}
916
917#ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
918u64 dma_get_required_mask(struct device *dev)
919{
920 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
921 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
922 u64 mask;
923
924 if (!high_totalram) {
925 /* convert to mask just covering totalram */
926 low_totalram = (1 << (fls(low_totalram) - 1));
927 low_totalram += low_totalram - 1;
928 mask = low_totalram;
929 } else {
930 high_totalram = (1 << (fls(high_totalram) - 1));
931 high_totalram += high_totalram - 1;
932 mask = (((u64)high_totalram) << 32) + 0xffffffff;
933 }
James Bottomleye88a0c22008-03-09 11:57:56 -0500934 return mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935}
936EXPORT_SYMBOL_GPL(dma_get_required_mask);
937#endif