blob: 62a8768d96b3cc31593d19481b9db1102e87bc71 [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 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)
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100245 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 else
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100247 dev_set_name(&pdev->dev, pdev->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 for (i = 0; i < pdev->num_resources; i++) {
250 struct resource *p, *r = &pdev->resource[i];
251
252 if (r->name == NULL)
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100253 r->name = dev_name(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255 p = r->parent;
256 if (!p) {
Magnus Dammc9f66162008-10-15 22:05:15 -0700257 if (resource_type(r) == IORESOURCE_MEM)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 p = &iomem_resource;
Magnus Dammc9f66162008-10-15 22:05:15 -0700259 else if (resource_type(r) == IORESOURCE_IO)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 p = &ioport_resource;
261 }
262
Kumar Galad960bb42005-11-28 10:15:39 -0600263 if (p && insert_resource(p, r)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 printk(KERN_ERR
265 "%s: failed to claim resource %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100266 dev_name(&pdev->dev), i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 ret = -EBUSY;
268 goto failed;
269 }
270 }
271
272 pr_debug("Registering platform device '%s'. Parent at %s\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100273 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Russell Kinge3915532006-05-06 08:15:26 +0100275 ret = device_add(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 if (ret == 0)
277 return ret;
278
279 failed:
Magnus Dammc9f66162008-10-15 22:05:15 -0700280 while (--i >= 0) {
281 struct resource *r = &pdev->resource[i];
282 unsigned long type = resource_type(r);
283
284 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
285 release_resource(r);
286 }
287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 return ret;
289}
Russell King37c12e72005-11-05 21:19:33 +0000290EXPORT_SYMBOL_GPL(platform_device_add);
291
292/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800293 * platform_device_del - remove a platform-level device
294 * @pdev: platform device we're removing
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500295 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800296 * Note that this function will also release all memory- and port-based
297 * resources owned by the device (@dev->resource). This function must
298 * _only_ be externally called in error cases. All other usage is a bug.
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500299 */
300void platform_device_del(struct platform_device *pdev)
301{
302 int i;
303
304 if (pdev) {
Jean Delvaredc4c15d2007-05-02 20:55:54 +0200305 device_del(&pdev->dev);
306
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500307 for (i = 0; i < pdev->num_resources; i++) {
308 struct resource *r = &pdev->resource[i];
Magnus Dammc9f66162008-10-15 22:05:15 -0700309 unsigned long type = resource_type(r);
310
311 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500312 release_resource(r);
313 }
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500314 }
315}
316EXPORT_SYMBOL_GPL(platform_device_del);
317
318/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800319 * platform_device_register - add a platform-level device
320 * @pdev: platform device we're adding
Russell King37c12e72005-11-05 21:19:33 +0000321 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800322int platform_device_register(struct platform_device *pdev)
Russell King37c12e72005-11-05 21:19:33 +0000323{
324 device_initialize(&pdev->dev);
325 return platform_device_add(pdev);
326}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500327EXPORT_SYMBOL_GPL(platform_device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800330 * platform_device_unregister - unregister a platform-level device
331 * @pdev: platform device we're unregistering
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800333 * Unregistration is done in 2 steps. First we release all resources
334 * and remove it from the subsystem, then we drop reference count by
335 * calling platform_device_put().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800337void platform_device_unregister(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338{
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500339 platform_device_del(pdev);
340 platform_device_put(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500342EXPORT_SYMBOL_GPL(platform_device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800345 * platform_device_register_simple
346 * @name: base name of the device we're adding
347 * @id: instance id
348 * @res: set of resources that needs to be allocated for the device
349 * @num: number of resources
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800351 * This function creates a simple platform device that requires minimal
352 * resource and memory management. Canned release function freeing memory
353 * allocated for the device allows drivers using such devices to be
354 * unloaded without waiting for the last reference to the device to be
355 * dropped.
David Brownell49a4ec12007-05-08 00:29:39 -0700356 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800357 * This interface is primarily intended for use with legacy drivers which
358 * probe hardware directly. Because such drivers create sysfs device nodes
359 * themselves, rather than letting system infrastructure handle such device
360 * enumeration tasks, they don't fully conform to the Linux driver model.
361 * In particular, when such drivers are built as modules, they can't be
362 * "hotplugged".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800364struct platform_device *platform_device_register_simple(const char *name,
365 int id,
366 struct resource *res,
367 unsigned int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368{
Russell King37c12e72005-11-05 21:19:33 +0000369 struct platform_device *pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 int retval;
371
Russell King37c12e72005-11-05 21:19:33 +0000372 pdev = platform_device_alloc(name, id);
373 if (!pdev) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 retval = -ENOMEM;
375 goto error;
376 }
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 if (num) {
Russell King37c12e72005-11-05 21:19:33 +0000379 retval = platform_device_add_resources(pdev, res, num);
380 if (retval)
381 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 }
383
Russell King37c12e72005-11-05 21:19:33 +0000384 retval = platform_device_add(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 if (retval)
386 goto error;
387
Russell King37c12e72005-11-05 21:19:33 +0000388 return pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390error:
Russell King37c12e72005-11-05 21:19:33 +0000391 platform_device_put(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 return ERR_PTR(retval);
393}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500394EXPORT_SYMBOL_GPL(platform_device_register_simple);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700396/**
397 * platform_device_register_data
398 * @parent: parent device for the device we're adding
399 * @name: base name of the device we're adding
400 * @id: instance id
401 * @data: platform specific data for this platform device
402 * @size: size of platform specific data
403 *
404 * This function creates a simple platform device that requires minimal
405 * resource and memory management. Canned release function freeing memory
406 * allocated for the device allows drivers using such devices to be
407 * unloaded without waiting for the last reference to the device to be
408 * dropped.
409 */
410struct platform_device *platform_device_register_data(
411 struct device *parent,
412 const char *name, int id,
413 const void *data, size_t size)
414{
415 struct platform_device *pdev;
416 int retval;
417
418 pdev = platform_device_alloc(name, id);
419 if (!pdev) {
420 retval = -ENOMEM;
421 goto error;
422 }
423
424 pdev->dev.parent = parent;
425
426 if (size) {
427 retval = platform_device_add_data(pdev, data, size);
428 if (retval)
429 goto error;
430 }
431
432 retval = platform_device_add(pdev);
433 if (retval)
434 goto error;
435
436 return pdev;
437
438error:
439 platform_device_put(pdev);
440 return ERR_PTR(retval);
441}
442
Russell King00d3dcd2005-11-09 17:23:39 +0000443static int platform_drv_probe(struct device *_dev)
444{
445 struct platform_driver *drv = to_platform_driver(_dev->driver);
446 struct platform_device *dev = to_platform_device(_dev);
447
448 return drv->probe(dev);
449}
450
David Brownellc67334f2006-11-16 23:28:47 -0800451static int platform_drv_probe_fail(struct device *_dev)
452{
453 return -ENXIO;
454}
455
Russell King00d3dcd2005-11-09 17:23:39 +0000456static int platform_drv_remove(struct device *_dev)
457{
458 struct platform_driver *drv = to_platform_driver(_dev->driver);
459 struct platform_device *dev = to_platform_device(_dev);
460
461 return drv->remove(dev);
462}
463
464static void platform_drv_shutdown(struct device *_dev)
465{
466 struct platform_driver *drv = to_platform_driver(_dev->driver);
467 struct platform_device *dev = to_platform_device(_dev);
468
469 drv->shutdown(dev);
470}
471
472static int platform_drv_suspend(struct device *_dev, pm_message_t state)
473{
474 struct platform_driver *drv = to_platform_driver(_dev->driver);
475 struct platform_device *dev = to_platform_device(_dev);
476
477 return drv->suspend(dev, state);
478}
479
480static int platform_drv_resume(struct device *_dev)
481{
482 struct platform_driver *drv = to_platform_driver(_dev->driver);
483 struct platform_device *dev = to_platform_device(_dev);
484
485 return drv->resume(dev);
486}
487
488/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800489 * platform_driver_register
490 * @drv: platform driver structure
Russell King00d3dcd2005-11-09 17:23:39 +0000491 */
492int platform_driver_register(struct platform_driver *drv)
493{
494 drv->driver.bus = &platform_bus_type;
495 if (drv->probe)
496 drv->driver.probe = platform_drv_probe;
497 if (drv->remove)
498 drv->driver.remove = platform_drv_remove;
499 if (drv->shutdown)
500 drv->driver.shutdown = platform_drv_shutdown;
501 if (drv->suspend)
502 drv->driver.suspend = platform_drv_suspend;
503 if (drv->resume)
504 drv->driver.resume = platform_drv_resume;
505 return driver_register(&drv->driver);
506}
507EXPORT_SYMBOL_GPL(platform_driver_register);
508
509/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800510 * platform_driver_unregister
511 * @drv: platform driver structure
Russell King00d3dcd2005-11-09 17:23:39 +0000512 */
513void platform_driver_unregister(struct platform_driver *drv)
514{
515 driver_unregister(&drv->driver);
516}
517EXPORT_SYMBOL_GPL(platform_driver_unregister);
518
David Brownellc67334f2006-11-16 23:28:47 -0800519/**
520 * platform_driver_probe - register driver for non-hotpluggable device
521 * @drv: platform driver structure
522 * @probe: the driver probe routine, probably from an __init section
523 *
524 * Use this instead of platform_driver_register() when you know the device
525 * is not hotpluggable and has already been registered, and you want to
526 * remove its run-once probe() infrastructure from memory after the driver
527 * has bound to the device.
528 *
529 * One typical use for this would be with drivers for controllers integrated
530 * into system-on-chip processors, where the controller devices have been
531 * configured as part of board setup.
532 *
533 * Returns zero if the driver registered and bound to a device, else returns
534 * a negative error code and with the driver not registered.
535 */
Andrew Mortonc63e0782006-12-04 14:56:36 -0800536int __init_or_module platform_driver_probe(struct platform_driver *drv,
David Brownellc67334f2006-11-16 23:28:47 -0800537 int (*probe)(struct platform_device *))
538{
539 int retval, code;
540
541 /* temporary section violation during probe() */
542 drv->probe = probe;
543 retval = code = platform_driver_register(drv);
544
545 /* Fixup that section violation, being paranoid about code scanning
546 * the list of drivers in order to probe new devices. Check to see
547 * if the probe was successful, and make sure any forced probes of
548 * new devices fail.
549 */
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700550 spin_lock(&platform_bus_type.p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800551 drv->probe = NULL;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800552 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
David Brownellc67334f2006-11-16 23:28:47 -0800553 retval = -ENODEV;
554 drv->driver.probe = platform_drv_probe_fail;
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700555 spin_unlock(&platform_bus_type.p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800556
557 if (code != retval)
558 platform_driver_unregister(drv);
559 return retval;
560}
561EXPORT_SYMBOL_GPL(platform_driver_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
David Brownella0245f72006-05-29 10:37:33 -0700563/* modalias support enables more hands-off userspace setup:
564 * (a) environment variable lets new-style hotplug events work once system is
565 * fully running: "modprobe $MODALIAS"
566 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
567 * mishandled before system is fully running: "modprobe $(cat modalias)"
568 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800569static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
570 char *buf)
David Brownella0245f72006-05-29 10:37:33 -0700571{
572 struct platform_device *pdev = to_platform_device(dev);
Kay Sievers43cc71e2007-08-18 04:40:39 +0200573 int len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700574
575 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
576}
577
578static struct device_attribute platform_dev_attrs[] = {
579 __ATTR_RO(modalias),
580 __ATTR_NULL,
581};
582
Kay Sievers7eff2e72007-08-14 15:15:12 +0200583static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownella0245f72006-05-29 10:37:33 -0700584{
585 struct platform_device *pdev = to_platform_device(dev);
586
Kay Sievers7eff2e72007-08-14 15:15:12 +0200587 add_uevent_var(env, "MODALIAS=platform:%s", pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700588 return 0;
589}
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800592 * platform_match - bind platform device to platform driver.
593 * @dev: device.
594 * @drv: driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800596 * Platform device IDs are assumed to be encoded like this:
597 * "<name><instance>", where <name> is a short description of the type of
598 * device, like "pci" or "floppy", and <instance> is the enumerated
599 * instance of the device, like '0' or '42'. Driver IDs are simply
600 * "<name>". So, extract the <name> from the platform_device structure,
601 * and compare it against the name of the driver. Return whether they match
602 * or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800604static int platform_match(struct device *dev, struct device_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
Eric Miao71b3e0c2009-01-31 22:47:44 +0800606 struct platform_device *pdev = to_platform_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100608 return (strcmp(pdev->name, drv->name) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609}
610
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200611#ifdef CONFIG_PM_SLEEP
612
613static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614{
615 int ret = 0;
616
Russell King9480e302005-10-28 09:52:56 -0700617 if (dev->driver && dev->driver->suspend)
David Brownell386415d2006-09-03 13:16:45 -0700618 ret = dev->driver->suspend(dev, mesg);
619
620 return ret;
621}
622
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200623static int platform_legacy_suspend_late(struct device *dev, pm_message_t mesg)
David Brownell386415d2006-09-03 13:16:45 -0700624{
Eric Miao71b3e0c2009-01-31 22:47:44 +0800625 struct platform_driver *pdrv = to_platform_driver(dev->driver);
626 struct platform_device *pdev = to_platform_device(dev);
David Brownell386415d2006-09-03 13:16:45 -0700627 int ret = 0;
628
Eric Miao71b3e0c2009-01-31 22:47:44 +0800629 if (dev->driver && pdrv->suspend_late)
630 ret = pdrv->suspend_late(pdev, mesg);
David Brownell386415d2006-09-03 13:16:45 -0700631
632 return ret;
633}
634
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200635static int platform_legacy_resume_early(struct device *dev)
David Brownell386415d2006-09-03 13:16:45 -0700636{
Eric Miao71b3e0c2009-01-31 22:47:44 +0800637 struct platform_driver *pdrv = to_platform_driver(dev->driver);
638 struct platform_device *pdev = to_platform_device(dev);
David Brownell386415d2006-09-03 13:16:45 -0700639 int ret = 0;
640
Eric Miao71b3e0c2009-01-31 22:47:44 +0800641 if (dev->driver && pdrv->resume_early)
642 ret = pdrv->resume_early(pdev);
Russell King9480e302005-10-28 09:52:56 -0700643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 return ret;
645}
646
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200647static int platform_legacy_resume(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
649 int ret = 0;
650
Russell King9480e302005-10-28 09:52:56 -0700651 if (dev->driver && dev->driver->resume)
652 ret = dev->driver->resume(dev);
653
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 return ret;
655}
656
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200657static int platform_pm_prepare(struct device *dev)
658{
659 struct device_driver *drv = dev->driver;
660 int ret = 0;
661
662 if (drv && drv->pm && drv->pm->prepare)
663 ret = drv->pm->prepare(dev);
664
665 return ret;
666}
667
668static void platform_pm_complete(struct device *dev)
669{
670 struct device_driver *drv = dev->driver;
671
672 if (drv && drv->pm && drv->pm->complete)
673 drv->pm->complete(dev);
674}
675
676#ifdef CONFIG_SUSPEND
677
678static int platform_pm_suspend(struct device *dev)
679{
680 struct device_driver *drv = dev->driver;
681 int ret = 0;
682
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200683 if (!drv)
684 return 0;
685
686 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200687 if (drv->pm->suspend)
688 ret = drv->pm->suspend(dev);
689 } else {
690 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
691 }
692
693 return ret;
694}
695
696static int platform_pm_suspend_noirq(struct device *dev)
697{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200698 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200699 int ret = 0;
700
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200701 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200702 return 0;
703
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200704 if (drv->pm) {
705 if (drv->pm->suspend_noirq)
706 ret = drv->pm->suspend_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200707 } else {
708 ret = platform_legacy_suspend_late(dev, PMSG_SUSPEND);
709 }
710
711 return ret;
712}
713
714static int platform_pm_resume(struct device *dev)
715{
716 struct device_driver *drv = dev->driver;
717 int ret = 0;
718
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200719 if (!drv)
720 return 0;
721
722 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200723 if (drv->pm->resume)
724 ret = drv->pm->resume(dev);
725 } else {
726 ret = platform_legacy_resume(dev);
727 }
728
729 return ret;
730}
731
732static int platform_pm_resume_noirq(struct device *dev)
733{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200734 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200735 int ret = 0;
736
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200737 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200738 return 0;
739
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200740 if (drv->pm) {
741 if (drv->pm->resume_noirq)
742 ret = drv->pm->resume_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200743 } else {
744 ret = platform_legacy_resume_early(dev);
745 }
746
747 return ret;
748}
749
750#else /* !CONFIG_SUSPEND */
751
752#define platform_pm_suspend NULL
753#define platform_pm_resume NULL
754#define platform_pm_suspend_noirq NULL
755#define platform_pm_resume_noirq NULL
756
757#endif /* !CONFIG_SUSPEND */
758
759#ifdef CONFIG_HIBERNATION
760
761static int platform_pm_freeze(struct device *dev)
762{
763 struct device_driver *drv = dev->driver;
764 int ret = 0;
765
766 if (!drv)
767 return 0;
768
769 if (drv->pm) {
770 if (drv->pm->freeze)
771 ret = drv->pm->freeze(dev);
772 } else {
773 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
774 }
775
776 return ret;
777}
778
779static int platform_pm_freeze_noirq(struct device *dev)
780{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200781 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200782 int ret = 0;
783
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200784 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200785 return 0;
786
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200787 if (drv->pm) {
788 if (drv->pm->freeze_noirq)
789 ret = drv->pm->freeze_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200790 } else {
791 ret = platform_legacy_suspend_late(dev, PMSG_FREEZE);
792 }
793
794 return ret;
795}
796
797static int platform_pm_thaw(struct device *dev)
798{
799 struct device_driver *drv = dev->driver;
800 int ret = 0;
801
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200802 if (!drv)
803 return 0;
804
805 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200806 if (drv->pm->thaw)
807 ret = drv->pm->thaw(dev);
808 } else {
809 ret = platform_legacy_resume(dev);
810 }
811
812 return ret;
813}
814
815static int platform_pm_thaw_noirq(struct device *dev)
816{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200817 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200818 int ret = 0;
819
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200820 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200821 return 0;
822
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200823 if (drv->pm) {
824 if (drv->pm->thaw_noirq)
825 ret = drv->pm->thaw_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200826 } else {
827 ret = platform_legacy_resume_early(dev);
828 }
829
830 return ret;
831}
832
833static int platform_pm_poweroff(struct device *dev)
834{
835 struct device_driver *drv = dev->driver;
836 int ret = 0;
837
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200838 if (!drv)
839 return 0;
840
841 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200842 if (drv->pm->poweroff)
843 ret = drv->pm->poweroff(dev);
844 } else {
845 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
846 }
847
848 return ret;
849}
850
851static int platform_pm_poweroff_noirq(struct device *dev)
852{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200853 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200854 int ret = 0;
855
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200856 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200857 return 0;
858
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200859 if (drv->pm) {
860 if (drv->pm->poweroff_noirq)
861 ret = drv->pm->poweroff_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200862 } else {
863 ret = platform_legacy_suspend_late(dev, PMSG_HIBERNATE);
864 }
865
866 return ret;
867}
868
869static int platform_pm_restore(struct device *dev)
870{
871 struct device_driver *drv = dev->driver;
872 int ret = 0;
873
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200874 if (!drv)
875 return 0;
876
877 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200878 if (drv->pm->restore)
879 ret = drv->pm->restore(dev);
880 } else {
881 ret = platform_legacy_resume(dev);
882 }
883
884 return ret;
885}
886
887static int platform_pm_restore_noirq(struct device *dev)
888{
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200889 struct device_driver *drv = dev->driver;
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200890 int ret = 0;
891
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200892 if (!drv)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200893 return 0;
894
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200895 if (drv->pm) {
896 if (drv->pm->restore_noirq)
897 ret = drv->pm->restore_noirq(dev);
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200898 } else {
899 ret = platform_legacy_resume_early(dev);
900 }
901
902 return ret;
903}
904
905#else /* !CONFIG_HIBERNATION */
906
907#define platform_pm_freeze NULL
908#define platform_pm_thaw NULL
909#define platform_pm_poweroff NULL
910#define platform_pm_restore NULL
911#define platform_pm_freeze_noirq NULL
912#define platform_pm_thaw_noirq NULL
913#define platform_pm_poweroff_noirq NULL
914#define platform_pm_restore_noirq NULL
915
916#endif /* !CONFIG_HIBERNATION */
917
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200918static struct dev_pm_ops platform_dev_pm_ops = {
919 .prepare = platform_pm_prepare,
920 .complete = platform_pm_complete,
921 .suspend = platform_pm_suspend,
922 .resume = platform_pm_resume,
923 .freeze = platform_pm_freeze,
924 .thaw = platform_pm_thaw,
925 .poweroff = platform_pm_poweroff,
926 .restore = platform_pm_restore,
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200927 .suspend_noirq = platform_pm_suspend_noirq,
928 .resume_noirq = platform_pm_resume_noirq,
929 .freeze_noirq = platform_pm_freeze_noirq,
930 .thaw_noirq = platform_pm_thaw_noirq,
931 .poweroff_noirq = platform_pm_poweroff_noirq,
932 .restore_noirq = platform_pm_restore_noirq,
933};
934
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200935#define PLATFORM_PM_OPS_PTR (&platform_dev_pm_ops)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200936
937#else /* !CONFIG_PM_SLEEP */
938
939#define PLATFORM_PM_OPS_PTR NULL
940
941#endif /* !CONFIG_PM_SLEEP */
942
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943struct bus_type platform_bus_type = {
944 .name = "platform",
David Brownella0245f72006-05-29 10:37:33 -0700945 .dev_attrs = platform_dev_attrs,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 .match = platform_match,
David Brownella0245f72006-05-29 10:37:33 -0700947 .uevent = platform_uevent,
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200948 .pm = PLATFORM_PM_OPS_PTR,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949};
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500950EXPORT_SYMBOL_GPL(platform_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
952int __init platform_bus_init(void)
953{
Cornelia Huckfbfb1442006-11-27 10:35:08 +0100954 int error;
955
956 error = device_register(&platform_bus);
957 if (error)
958 return error;
959 error = bus_register(&platform_bus_type);
960 if (error)
961 device_unregister(&platform_bus);
962 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963}
964
965#ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
966u64 dma_get_required_mask(struct device *dev)
967{
968 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
969 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
970 u64 mask;
971
972 if (!high_totalram) {
973 /* convert to mask just covering totalram */
974 low_totalram = (1 << (fls(low_totalram) - 1));
975 low_totalram += low_totalram - 1;
976 mask = low_totalram;
977 } else {
978 high_totalram = (1 << (fls(high_totalram) - 1));
979 high_totalram += high_totalram - 1;
980 mask = (((u64)high_totalram) << 32) + 0xffffffff;
981 }
James Bottomleye88a0c22008-03-09 11:57:56 -0500982 return mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983}
984EXPORT_SYMBOL_GPL(dma_get_required_mask);
985#endif