blob: c5ac81d223039578631aaafaaa4062628e7c8472 [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 = {
Kay Sievers1e0b2cf2008-10-30 01:36:48 +010027 .init_name = "platform",
Linus Torvalds1da177e2005-04-16 15:20:36 -070028};
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 Delvare1359555e2007-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;
Ming Lei006f4572009-03-08 23:13:32 +0800220 pdev->platform_data = d;
Russell King37c12e72005-11-05 21:19:33 +0000221 }
222 return d ? 0 : -ENOMEM;
223}
224EXPORT_SYMBOL_GPL(platform_device_add_data);
225
226/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800227 * platform_device_add - add a platform device to device hierarchy
228 * @pdev: platform device we're adding
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800230 * This is part 2 of platform_device_register(), though may be called
231 * separately _iff_ pdev was allocated by platform_device_alloc().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 */
Russell King37c12e72005-11-05 21:19:33 +0000233int platform_device_add(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234{
235 int i, ret = 0;
236
237 if (!pdev)
238 return -EINVAL;
239
240 if (!pdev->dev.parent)
241 pdev->dev.parent = &platform_bus;
242
243 pdev->dev.bus = &platform_bus_type;
244
245 if (pdev->id != -1)
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100246 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 else
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100248 dev_set_name(&pdev->dev, pdev->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Ming Lei006f4572009-03-08 23:13:32 +0800250 pdev->platform_data = pdev->dev.platform_data;
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 for (i = 0; i < pdev->num_resources; i++) {
253 struct resource *p, *r = &pdev->resource[i];
254
255 if (r->name == NULL)
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100256 r->name = dev_name(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258 p = r->parent;
259 if (!p) {
Magnus Dammc9f66162008-10-15 22:05:15 -0700260 if (resource_type(r) == IORESOURCE_MEM)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 p = &iomem_resource;
Magnus Dammc9f66162008-10-15 22:05:15 -0700262 else if (resource_type(r) == IORESOURCE_IO)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 p = &ioport_resource;
264 }
265
Kumar Galad960bb42005-11-28 10:15:39 -0600266 if (p && insert_resource(p, r)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 printk(KERN_ERR
268 "%s: failed to claim resource %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100269 dev_name(&pdev->dev), i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 ret = -EBUSY;
271 goto failed;
272 }
273 }
274
275 pr_debug("Registering platform device '%s'. Parent at %s\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100276 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Russell Kinge3915532006-05-06 08:15:26 +0100278 ret = device_add(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 if (ret == 0)
280 return ret;
281
282 failed:
Magnus Dammc9f66162008-10-15 22:05:15 -0700283 while (--i >= 0) {
284 struct resource *r = &pdev->resource[i];
285 unsigned long type = resource_type(r);
286
287 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
288 release_resource(r);
289 }
290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 return ret;
292}
Russell King37c12e72005-11-05 21:19:33 +0000293EXPORT_SYMBOL_GPL(platform_device_add);
294
295/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800296 * platform_device_del - remove a platform-level device
297 * @pdev: platform device we're removing
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500298 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800299 * Note that this function will also release all memory- and port-based
300 * resources owned by the device (@dev->resource). This function must
301 * _only_ be externally called in error cases. All other usage is a bug.
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500302 */
303void platform_device_del(struct platform_device *pdev)
304{
305 int i;
306
307 if (pdev) {
Jean Delvaredc4c15d2007-05-02 20:55:54 +0200308 device_del(&pdev->dev);
309
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500310 for (i = 0; i < pdev->num_resources; i++) {
311 struct resource *r = &pdev->resource[i];
Magnus Dammc9f66162008-10-15 22:05:15 -0700312 unsigned long type = resource_type(r);
313
314 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500315 release_resource(r);
316 }
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500317 }
318}
319EXPORT_SYMBOL_GPL(platform_device_del);
320
321/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800322 * platform_device_register - add a platform-level device
323 * @pdev: platform device we're adding
Russell King37c12e72005-11-05 21:19:33 +0000324 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800325int platform_device_register(struct platform_device *pdev)
Russell King37c12e72005-11-05 21:19:33 +0000326{
327 device_initialize(&pdev->dev);
328 return platform_device_add(pdev);
329}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500330EXPORT_SYMBOL_GPL(platform_device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800333 * platform_device_unregister - unregister a platform-level device
334 * @pdev: platform device we're unregistering
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800336 * Unregistration is done in 2 steps. First we release all resources
337 * and remove it from the subsystem, then we drop reference count by
338 * calling platform_device_put().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800340void platform_device_unregister(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341{
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500342 platform_device_del(pdev);
343 platform_device_put(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500345EXPORT_SYMBOL_GPL(platform_device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800348 * platform_device_register_simple
349 * @name: base name of the device we're adding
350 * @id: instance id
351 * @res: set of resources that needs to be allocated for the device
352 * @num: number of resources
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800354 * This function creates a simple platform device that requires minimal
355 * resource and memory management. Canned release function freeing memory
356 * allocated for the device allows drivers using such devices to be
357 * unloaded without waiting for the last reference to the device to be
358 * dropped.
David Brownell49a4ec12007-05-08 00:29:39 -0700359 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800360 * This interface is primarily intended for use with legacy drivers which
361 * probe hardware directly. Because such drivers create sysfs device nodes
362 * themselves, rather than letting system infrastructure handle such device
363 * enumeration tasks, they don't fully conform to the Linux driver model.
364 * In particular, when such drivers are built as modules, they can't be
365 * "hotplugged".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800367struct platform_device *platform_device_register_simple(const char *name,
368 int id,
369 struct resource *res,
370 unsigned int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371{
Russell King37c12e72005-11-05 21:19:33 +0000372 struct platform_device *pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 int retval;
374
Russell King37c12e72005-11-05 21:19:33 +0000375 pdev = platform_device_alloc(name, id);
376 if (!pdev) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 retval = -ENOMEM;
378 goto error;
379 }
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 if (num) {
Russell King37c12e72005-11-05 21:19:33 +0000382 retval = platform_device_add_resources(pdev, res, num);
383 if (retval)
384 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 }
386
Russell King37c12e72005-11-05 21:19:33 +0000387 retval = platform_device_add(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 if (retval)
389 goto error;
390
Russell King37c12e72005-11-05 21:19:33 +0000391 return pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393error:
Russell King37c12e72005-11-05 21:19:33 +0000394 platform_device_put(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 return ERR_PTR(retval);
396}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500397EXPORT_SYMBOL_GPL(platform_device_register_simple);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700399/**
400 * platform_device_register_data
401 * @parent: parent device for the device we're adding
402 * @name: base name of the device we're adding
403 * @id: instance id
404 * @data: platform specific data for this platform device
405 * @size: size of platform specific data
406 *
407 * This function creates a simple platform device that requires minimal
408 * resource and memory management. Canned release function freeing memory
409 * allocated for the device allows drivers using such devices to be
410 * unloaded without waiting for the last reference to the device to be
411 * dropped.
412 */
413struct platform_device *platform_device_register_data(
414 struct device *parent,
415 const char *name, int id,
416 const void *data, size_t size)
417{
418 struct platform_device *pdev;
419 int retval;
420
421 pdev = platform_device_alloc(name, id);
422 if (!pdev) {
423 retval = -ENOMEM;
424 goto error;
425 }
426
427 pdev->dev.parent = parent;
428
429 if (size) {
430 retval = platform_device_add_data(pdev, data, size);
431 if (retval)
432 goto error;
433 }
434
435 retval = platform_device_add(pdev);
436 if (retval)
437 goto error;
438
439 return pdev;
440
441error:
442 platform_device_put(pdev);
443 return ERR_PTR(retval);
444}
445
Russell King00d3dcd2005-11-09 17:23:39 +0000446static int platform_drv_probe(struct device *_dev)
447{
448 struct platform_driver *drv = to_platform_driver(_dev->driver);
449 struct platform_device *dev = to_platform_device(_dev);
450
451 return drv->probe(dev);
452}
453
David Brownellc67334f2006-11-16 23:28:47 -0800454static int platform_drv_probe_fail(struct device *_dev)
455{
456 return -ENXIO;
457}
458
Russell King00d3dcd2005-11-09 17:23:39 +0000459static int platform_drv_remove(struct device *_dev)
460{
461 struct platform_driver *drv = to_platform_driver(_dev->driver);
462 struct platform_device *dev = to_platform_device(_dev);
463
464 return drv->remove(dev);
465}
466
467static void platform_drv_shutdown(struct device *_dev)
468{
469 struct platform_driver *drv = to_platform_driver(_dev->driver);
470 struct platform_device *dev = to_platform_device(_dev);
471
472 drv->shutdown(dev);
473}
474
475static int platform_drv_suspend(struct device *_dev, pm_message_t state)
476{
477 struct platform_driver *drv = to_platform_driver(_dev->driver);
478 struct platform_device *dev = to_platform_device(_dev);
479
480 return drv->suspend(dev, state);
481}
482
483static int platform_drv_resume(struct device *_dev)
484{
485 struct platform_driver *drv = to_platform_driver(_dev->driver);
486 struct platform_device *dev = to_platform_device(_dev);
487
488 return drv->resume(dev);
489}
490
491/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800492 * platform_driver_register
493 * @drv: platform driver structure
Russell King00d3dcd2005-11-09 17:23:39 +0000494 */
495int platform_driver_register(struct platform_driver *drv)
496{
497 drv->driver.bus = &platform_bus_type;
498 if (drv->probe)
499 drv->driver.probe = platform_drv_probe;
500 if (drv->remove)
501 drv->driver.remove = platform_drv_remove;
502 if (drv->shutdown)
503 drv->driver.shutdown = platform_drv_shutdown;
504 if (drv->suspend)
505 drv->driver.suspend = platform_drv_suspend;
506 if (drv->resume)
507 drv->driver.resume = platform_drv_resume;
508 return driver_register(&drv->driver);
509}
510EXPORT_SYMBOL_GPL(platform_driver_register);
511
512/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800513 * platform_driver_unregister
514 * @drv: platform driver structure
Russell King00d3dcd2005-11-09 17:23:39 +0000515 */
516void platform_driver_unregister(struct platform_driver *drv)
517{
518 driver_unregister(&drv->driver);
519}
520EXPORT_SYMBOL_GPL(platform_driver_unregister);
521
David Brownellc67334f2006-11-16 23:28:47 -0800522/**
523 * platform_driver_probe - register driver for non-hotpluggable device
524 * @drv: platform driver structure
525 * @probe: the driver probe routine, probably from an __init section
526 *
527 * Use this instead of platform_driver_register() when you know the device
528 * is not hotpluggable and has already been registered, and you want to
529 * remove its run-once probe() infrastructure from memory after the driver
530 * has bound to the device.
531 *
532 * One typical use for this would be with drivers for controllers integrated
533 * into system-on-chip processors, where the controller devices have been
534 * configured as part of board setup.
535 *
536 * Returns zero if the driver registered and bound to a device, else returns
537 * a negative error code and with the driver not registered.
538 */
Andrew Mortonc63e0782006-12-04 14:56:36 -0800539int __init_or_module platform_driver_probe(struct platform_driver *drv,
David Brownellc67334f2006-11-16 23:28:47 -0800540 int (*probe)(struct platform_device *))
541{
542 int retval, code;
543
544 /* temporary section violation during probe() */
545 drv->probe = probe;
546 retval = code = platform_driver_register(drv);
547
548 /* Fixup that section violation, being paranoid about code scanning
549 * the list of drivers in order to probe new devices. Check to see
550 * if the probe was successful, and make sure any forced probes of
551 * new devices fail.
552 */
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700553 spin_lock(&platform_bus_type.p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800554 drv->probe = NULL;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800555 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
David Brownellc67334f2006-11-16 23:28:47 -0800556 retval = -ENODEV;
557 drv->driver.probe = platform_drv_probe_fail;
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700558 spin_unlock(&platform_bus_type.p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800559
560 if (code != retval)
561 platform_driver_unregister(drv);
562 return retval;
563}
564EXPORT_SYMBOL_GPL(platform_driver_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
David Brownella0245f72006-05-29 10:37:33 -0700566/* modalias support enables more hands-off userspace setup:
567 * (a) environment variable lets new-style hotplug events work once system is
568 * fully running: "modprobe $MODALIAS"
569 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
570 * mishandled before system is fully running: "modprobe $(cat modalias)"
571 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800572static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
573 char *buf)
David Brownella0245f72006-05-29 10:37:33 -0700574{
575 struct platform_device *pdev = to_platform_device(dev);
Kay Sievers43cc71e2007-08-18 04:40:39 +0200576 int len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700577
578 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
579}
580
581static struct device_attribute platform_dev_attrs[] = {
582 __ATTR_RO(modalias),
583 __ATTR_NULL,
584};
585
Kay Sievers7eff2e72007-08-14 15:15:12 +0200586static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownella0245f72006-05-29 10:37:33 -0700587{
588 struct platform_device *pdev = to_platform_device(dev);
589
Eric Miao57fee4a2009-02-04 11:52:40 +0800590 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
591 (pdev->id_entry) ? pdev->id_entry->name : pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700592 return 0;
593}
594
Eric Miao57fee4a2009-02-04 11:52:40 +0800595static const struct platform_device_id *platform_match_id(
596 struct platform_device_id *id,
597 struct platform_device *pdev)
598{
599 while (id->name[0]) {
600 if (strcmp(pdev->name, id->name) == 0) {
601 pdev->id_entry = id;
602 return id;
603 }
604 id++;
605 }
606 return NULL;
607}
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800610 * platform_match - bind platform device to platform driver.
611 * @dev: device.
612 * @drv: driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800614 * Platform device IDs are assumed to be encoded like this:
615 * "<name><instance>", where <name> is a short description of the type of
616 * device, like "pci" or "floppy", and <instance> is the enumerated
617 * instance of the device, like '0' or '42'. Driver IDs are simply
618 * "<name>". So, extract the <name> from the platform_device structure,
619 * and compare it against the name of the driver. Return whether they match
620 * or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800622static int platform_match(struct device *dev, struct device_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623{
Eric Miao71b3e0c2009-01-31 22:47:44 +0800624 struct platform_device *pdev = to_platform_device(dev);
Eric Miao57fee4a2009-02-04 11:52:40 +0800625 struct platform_driver *pdrv = to_platform_driver(drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Eric Miao57fee4a2009-02-04 11:52:40 +0800627 /* match against the id table first */
628 if (pdrv->id_table)
629 return platform_match_id(pdrv->id_table, pdev) != NULL;
630
631 /* fall-back to driver name match */
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100632 return (strcmp(pdev->name, drv->name) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
634
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200635#ifdef CONFIG_PM_SLEEP
636
637static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
639 int ret = 0;
640
Russell King9480e302005-10-28 09:52:56 -0700641 if (dev->driver && dev->driver->suspend)
David Brownell386415d2006-09-03 13:16:45 -0700642 ret = dev->driver->suspend(dev, mesg);
643
644 return ret;
645}
646
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200647static int platform_legacy_suspend_late(struct device *dev, pm_message_t mesg)
David Brownell386415d2006-09-03 13:16:45 -0700648{
Eric Miao71b3e0c2009-01-31 22:47:44 +0800649 struct platform_driver *pdrv = to_platform_driver(dev->driver);
650 struct platform_device *pdev = to_platform_device(dev);
David Brownell386415d2006-09-03 13:16:45 -0700651 int ret = 0;
652
Eric Miao71b3e0c2009-01-31 22:47:44 +0800653 if (dev->driver && pdrv->suspend_late)
654 ret = pdrv->suspend_late(pdev, mesg);
David Brownell386415d2006-09-03 13:16:45 -0700655
656 return ret;
657}
658
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200659static int platform_legacy_resume_early(struct device *dev)
David Brownell386415d2006-09-03 13:16:45 -0700660{
Eric Miao71b3e0c2009-01-31 22:47:44 +0800661 struct platform_driver *pdrv = to_platform_driver(dev->driver);
662 struct platform_device *pdev = to_platform_device(dev);
David Brownell386415d2006-09-03 13:16:45 -0700663 int ret = 0;
664
Eric Miao71b3e0c2009-01-31 22:47:44 +0800665 if (dev->driver && pdrv->resume_early)
666 ret = pdrv->resume_early(pdev);
Russell King9480e302005-10-28 09:52:56 -0700667
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 return ret;
669}
670
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200671static int platform_legacy_resume(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672{
673 int ret = 0;
674
Russell King9480e302005-10-28 09:52:56 -0700675 if (dev->driver && dev->driver->resume)
676 ret = dev->driver->resume(dev);
677
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 return ret;
679}
680
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200681static int platform_pm_prepare(struct device *dev)
682{
683 struct device_driver *drv = dev->driver;
684 int ret = 0;
685
686 if (drv && drv->pm && drv->pm->prepare)
687 ret = drv->pm->prepare(dev);
688
689 return ret;
690}
691
692static void platform_pm_complete(struct device *dev)
693{
694 struct device_driver *drv = dev->driver;
695
696 if (drv && drv->pm && drv->pm->complete)
697 drv->pm->complete(dev);
698}
699
700#ifdef CONFIG_SUSPEND
701
702static int platform_pm_suspend(struct device *dev)
703{
704 struct device_driver *drv = dev->driver;
705 int ret = 0;
706
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200707 if (!drv)
708 return 0;
709
710 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200711 if (drv->pm->suspend)
712 ret = drv->pm->suspend(dev);
713 } else {
714 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
715 }
716
717 return ret;
718}
719
720static int platform_pm_suspend_noirq(struct device *dev)
721{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200722 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200723 int ret = 0;
724
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200725 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200726 return 0;
727
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200728 if (drv->pm) {
729 if (drv->pm->suspend_noirq)
730 ret = drv->pm->suspend_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200731 } else {
732 ret = platform_legacy_suspend_late(dev, PMSG_SUSPEND);
733 }
734
735 return ret;
736}
737
738static int platform_pm_resume(struct device *dev)
739{
740 struct device_driver *drv = dev->driver;
741 int ret = 0;
742
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200743 if (!drv)
744 return 0;
745
746 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200747 if (drv->pm->resume)
748 ret = drv->pm->resume(dev);
749 } else {
750 ret = platform_legacy_resume(dev);
751 }
752
753 return ret;
754}
755
756static int platform_pm_resume_noirq(struct device *dev)
757{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200758 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200759 int ret = 0;
760
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200761 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200762 return 0;
763
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200764 if (drv->pm) {
765 if (drv->pm->resume_noirq)
766 ret = drv->pm->resume_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200767 } else {
768 ret = platform_legacy_resume_early(dev);
769 }
770
771 return ret;
772}
773
774#else /* !CONFIG_SUSPEND */
775
776#define platform_pm_suspend NULL
777#define platform_pm_resume NULL
778#define platform_pm_suspend_noirq NULL
779#define platform_pm_resume_noirq NULL
780
781#endif /* !CONFIG_SUSPEND */
782
783#ifdef CONFIG_HIBERNATION
784
785static int platform_pm_freeze(struct device *dev)
786{
787 struct device_driver *drv = dev->driver;
788 int ret = 0;
789
790 if (!drv)
791 return 0;
792
793 if (drv->pm) {
794 if (drv->pm->freeze)
795 ret = drv->pm->freeze(dev);
796 } else {
797 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
798 }
799
800 return ret;
801}
802
803static int platform_pm_freeze_noirq(struct device *dev)
804{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200805 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200806 int ret = 0;
807
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200808 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200809 return 0;
810
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200811 if (drv->pm) {
812 if (drv->pm->freeze_noirq)
813 ret = drv->pm->freeze_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200814 } else {
815 ret = platform_legacy_suspend_late(dev, PMSG_FREEZE);
816 }
817
818 return ret;
819}
820
821static int platform_pm_thaw(struct device *dev)
822{
823 struct device_driver *drv = dev->driver;
824 int ret = 0;
825
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200826 if (!drv)
827 return 0;
828
829 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200830 if (drv->pm->thaw)
831 ret = drv->pm->thaw(dev);
832 } else {
833 ret = platform_legacy_resume(dev);
834 }
835
836 return ret;
837}
838
839static int platform_pm_thaw_noirq(struct device *dev)
840{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200841 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200842 int ret = 0;
843
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200844 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200845 return 0;
846
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200847 if (drv->pm) {
848 if (drv->pm->thaw_noirq)
849 ret = drv->pm->thaw_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200850 } else {
851 ret = platform_legacy_resume_early(dev);
852 }
853
854 return ret;
855}
856
857static int platform_pm_poweroff(struct device *dev)
858{
859 struct device_driver *drv = dev->driver;
860 int ret = 0;
861
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200862 if (!drv)
863 return 0;
864
865 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200866 if (drv->pm->poweroff)
867 ret = drv->pm->poweroff(dev);
868 } else {
869 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
870 }
871
872 return ret;
873}
874
875static int platform_pm_poweroff_noirq(struct device *dev)
876{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200877 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200878 int ret = 0;
879
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200880 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200881 return 0;
882
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200883 if (drv->pm) {
884 if (drv->pm->poweroff_noirq)
885 ret = drv->pm->poweroff_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200886 } else {
887 ret = platform_legacy_suspend_late(dev, PMSG_HIBERNATE);
888 }
889
890 return ret;
891}
892
893static int platform_pm_restore(struct device *dev)
894{
895 struct device_driver *drv = dev->driver;
896 int ret = 0;
897
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200898 if (!drv)
899 return 0;
900
901 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200902 if (drv->pm->restore)
903 ret = drv->pm->restore(dev);
904 } else {
905 ret = platform_legacy_resume(dev);
906 }
907
908 return ret;
909}
910
911static int platform_pm_restore_noirq(struct device *dev)
912{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200913 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200914 int ret = 0;
915
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200916 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200917 return 0;
918
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200919 if (drv->pm) {
920 if (drv->pm->restore_noirq)
921 ret = drv->pm->restore_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200922 } else {
923 ret = platform_legacy_resume_early(dev);
924 }
925
926 return ret;
927}
928
929#else /* !CONFIG_HIBERNATION */
930
931#define platform_pm_freeze NULL
932#define platform_pm_thaw NULL
933#define platform_pm_poweroff NULL
934#define platform_pm_restore NULL
935#define platform_pm_freeze_noirq NULL
936#define platform_pm_thaw_noirq NULL
937#define platform_pm_poweroff_noirq NULL
938#define platform_pm_restore_noirq NULL
939
940#endif /* !CONFIG_HIBERNATION */
941
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200942static struct dev_pm_ops platform_dev_pm_ops = {
943 .prepare = platform_pm_prepare,
944 .complete = platform_pm_complete,
945 .suspend = platform_pm_suspend,
946 .resume = platform_pm_resume,
947 .freeze = platform_pm_freeze,
948 .thaw = platform_pm_thaw,
949 .poweroff = platform_pm_poweroff,
950 .restore = platform_pm_restore,
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200951 .suspend_noirq = platform_pm_suspend_noirq,
952 .resume_noirq = platform_pm_resume_noirq,
953 .freeze_noirq = platform_pm_freeze_noirq,
954 .thaw_noirq = platform_pm_thaw_noirq,
955 .poweroff_noirq = platform_pm_poweroff_noirq,
956 .restore_noirq = platform_pm_restore_noirq,
957};
958
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200959#define PLATFORM_PM_OPS_PTR (&platform_dev_pm_ops)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200960
961#else /* !CONFIG_PM_SLEEP */
962
963#define PLATFORM_PM_OPS_PTR NULL
964
965#endif /* !CONFIG_PM_SLEEP */
966
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967struct bus_type platform_bus_type = {
968 .name = "platform",
David Brownella0245f72006-05-29 10:37:33 -0700969 .dev_attrs = platform_dev_attrs,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 .match = platform_match,
David Brownella0245f72006-05-29 10:37:33 -0700971 .uevent = platform_uevent,
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200972 .pm = PLATFORM_PM_OPS_PTR,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973};
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500974EXPORT_SYMBOL_GPL(platform_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
976int __init platform_bus_init(void)
977{
Cornelia Huckfbfb1442006-11-27 10:35:08 +0100978 int error;
979
980 error = device_register(&platform_bus);
981 if (error)
982 return error;
983 error = bus_register(&platform_bus_type);
984 if (error)
985 device_unregister(&platform_bus);
986 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987}
988
989#ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
990u64 dma_get_required_mask(struct device *dev)
991{
992 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
993 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
994 u64 mask;
995
996 if (!high_totalram) {
997 /* convert to mask just covering totalram */
998 low_totalram = (1 << (fls(low_totalram) - 1));
999 low_totalram += low_totalram - 1;
1000 mask = low_totalram;
1001 } else {
1002 high_totalram = (1 << (fls(high_totalram) - 1));
1003 high_totalram += high_totalram - 1;
1004 mask = (((u64)high_totalram) << 32) + 0xffffffff;
1005 }
James Bottomleye88a0c22008-03-09 11:57:56 -05001006 return mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007}
1008EXPORT_SYMBOL_GPL(dma_get_required_mask);
1009#endif