blob: e714709704e4578ccc3703ca30108e596461ad28 [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
Andrew Mortondaa41222009-08-06 16:00:44 -070013#include <linux/string.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010014#include <linux/platform_device.h>
Grant Likely05212152010-06-08 07:48:20 -060015#include <linux/of_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/module.h>
17#include <linux/init.h>
18#include <linux/dma-mapping.h>
19#include <linux/bootmem.h>
20#include <linux/err.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080021#include <linux/slab.h>
Magnus Damm9d730222009-08-20 20:25:32 +020022#include <linux/pm_runtime.h>
Jean Delvare689ae232012-07-27 22:14:59 +020023#include <linux/idr.h>
Mika Westerberg91e56872012-10-31 22:45:02 +010024#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Ben Dooksa1bdc7a2005-10-13 17:54:41 +010026#include "base.h"
Rafael J. Wysockibed2b422012-08-06 01:45:11 +020027#include "power/power.h"
Ben Dooksa1bdc7a2005-10-13 17:54:41 +010028
Jean Delvare689ae232012-07-27 22:14:59 +020029/* For automatically allocated device IDs */
30static DEFINE_IDA(platform_devid_ida);
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032struct device platform_bus = {
Kay Sievers1e0b2cf2008-10-30 01:36:48 +010033 .init_name = "platform",
Linus Torvalds1da177e2005-04-16 15:20:36 -070034};
Dmitry Torokhova96b2042005-12-10 01:36:28 -050035EXPORT_SYMBOL_GPL(platform_bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37/**
Kumar Galaa77ce812011-06-10 01:52:57 -050038 * arch_setup_pdev_archdata - Allow manipulation of archdata before its used
Randy Dunlap7de636f2011-07-27 12:11:25 -070039 * @pdev: platform device
Kumar Galaa77ce812011-06-10 01:52:57 -050040 *
41 * This is called before platform_device_add() such that any pdev_archdata may
42 * be setup before the platform_notifier is called. So if a user needs to
43 * manipulate any relevant information in the pdev_archdata they can do:
44 *
Sebastian Andrzej Siewiorb1d6d822012-10-29 18:04:53 +010045 * platform_device_alloc()
Fabio Porcedda0258e182013-03-26 10:35:16 +010046 * ... manipulate ...
47 * platform_device_add()
Kumar Galaa77ce812011-06-10 01:52:57 -050048 *
49 * And if they don't care they can just call platform_device_register() and
50 * everything will just work out.
51 */
52void __weak arch_setup_pdev_archdata(struct platform_device *pdev)
53{
54}
55
56/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080057 * platform_get_resource - get a resource for a device
58 * @dev: platform device
59 * @type: resource type
60 * @num: resource index
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080062struct resource *platform_get_resource(struct platform_device *dev,
63 unsigned int type, unsigned int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064{
65 int i;
66
67 for (i = 0; i < dev->num_resources; i++) {
68 struct resource *r = &dev->resource[i];
69
Magnus Dammc9f66162008-10-15 22:05:15 -070070 if (type == resource_type(r) && num-- == 0)
71 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 }
73 return NULL;
74}
Dmitry Torokhova96b2042005-12-10 01:36:28 -050075EXPORT_SYMBOL_GPL(platform_get_resource);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080078 * platform_get_irq - get an IRQ for a device
79 * @dev: platform device
80 * @num: IRQ number index
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 */
82int platform_get_irq(struct platform_device *dev, unsigned int num)
83{
Andreas Larsson5cf8f7d2012-10-29 23:26:56 +000084#ifdef CONFIG_SPARC
85 /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
86 if (!dev || num >= dev->archdata.num_irqs)
87 return -ENXIO;
88 return dev->archdata.irqs[num];
89#else
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 struct resource *r = platform_get_resource(dev, IORESOURCE_IRQ, num);
91
David Vrabel305b3222006-01-19 17:52:27 +000092 return r ? r->start : -ENXIO;
Andreas Larsson5cf8f7d2012-10-29 23:26:56 +000093#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070094}
Dmitry Torokhova96b2042005-12-10 01:36:28 -050095EXPORT_SYMBOL_GPL(platform_get_irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080098 * platform_get_resource_byname - get a resource for a device by name
99 * @dev: platform device
100 * @type: resource type
101 * @name: resource name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800103struct resource *platform_get_resource_byname(struct platform_device *dev,
Linus Walleijc0afe7b2009-04-27 02:38:16 +0200104 unsigned int type,
105 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106{
107 int i;
108
109 for (i = 0; i < dev->num_resources; i++) {
110 struct resource *r = &dev->resource[i];
111
Peter Ujfalusi1b8cb922012-08-23 17:10:00 +0300112 if (unlikely(!r->name))
113 continue;
114
Magnus Dammc9f66162008-10-15 22:05:15 -0700115 if (type == resource_type(r) && !strcmp(r->name, name))
116 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 }
118 return NULL;
119}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500120EXPORT_SYMBOL_GPL(platform_get_resource_byname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122/**
Wolfram Sangd6ff8552012-11-13 17:47:13 +0100123 * platform_get_irq_byname - get an IRQ for a device by name
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800124 * @dev: platform device
125 * @name: IRQ name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 */
Linus Walleijc0afe7b2009-04-27 02:38:16 +0200127int platform_get_irq_byname(struct platform_device *dev, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800129 struct resource *r = platform_get_resource_byname(dev, IORESOURCE_IRQ,
130 name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
David Vrabel305b3222006-01-19 17:52:27 +0000132 return r ? r->start : -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500134EXPORT_SYMBOL_GPL(platform_get_irq_byname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800137 * platform_add_devices - add a numbers of platform devices
138 * @devs: array of platform devices to add
139 * @num: number of platform devices in array
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 */
141int platform_add_devices(struct platform_device **devs, int num)
142{
143 int i, ret = 0;
144
145 for (i = 0; i < num; i++) {
146 ret = platform_device_register(devs[i]);
147 if (ret) {
148 while (--i >= 0)
149 platform_device_unregister(devs[i]);
150 break;
151 }
152 }
153
154 return ret;
155}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500156EXPORT_SYMBOL_GPL(platform_add_devices);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Russell King37c12e72005-11-05 21:19:33 +0000158struct platform_object {
159 struct platform_device pdev;
160 char name[1];
161};
162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000164 * platform_device_put - destroy a platform device
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800165 * @pdev: platform device to free
Russell King37c12e72005-11-05 21:19:33 +0000166 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800167 * Free all memory associated with a platform device. This function must
168 * _only_ be externally called in error cases. All other usage is a bug.
Russell King37c12e72005-11-05 21:19:33 +0000169 */
170void platform_device_put(struct platform_device *pdev)
171{
172 if (pdev)
173 put_device(&pdev->dev);
174}
175EXPORT_SYMBOL_GPL(platform_device_put);
176
177static void platform_device_release(struct device *dev)
178{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800179 struct platform_object *pa = container_of(dev, struct platform_object,
180 pdev.dev);
Russell King37c12e72005-11-05 21:19:33 +0000181
Grant Likely7096d042010-10-20 11:45:13 -0600182 of_device_node_put(&pa->pdev.dev);
Russell King37c12e72005-11-05 21:19:33 +0000183 kfree(pa->pdev.dev.platform_data);
Samuel Ortize710d7d2011-04-08 00:43:01 +0200184 kfree(pa->pdev.mfd_cell);
Russell King37c12e72005-11-05 21:19:33 +0000185 kfree(pa->pdev.resource);
186 kfree(pa);
187}
188
189/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000190 * platform_device_alloc - create a platform device
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800191 * @name: base name of the device we're adding
192 * @id: instance id
Russell King37c12e72005-11-05 21:19:33 +0000193 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800194 * Create a platform device object which can have other objects attached
195 * to it, and which will have attached objects freed when it is released.
Russell King37c12e72005-11-05 21:19:33 +0000196 */
Jean Delvare1359555e2007-09-09 12:54:16 +0200197struct platform_device *platform_device_alloc(const char *name, int id)
Russell King37c12e72005-11-05 21:19:33 +0000198{
199 struct platform_object *pa;
200
201 pa = kzalloc(sizeof(struct platform_object) + strlen(name), GFP_KERNEL);
202 if (pa) {
203 strcpy(pa->name, name);
204 pa->pdev.name = pa->name;
205 pa->pdev.id = id;
206 device_initialize(&pa->pdev.dev);
207 pa->pdev.dev.release = platform_device_release;
Kumar Galaa77ce812011-06-10 01:52:57 -0500208 arch_setup_pdev_archdata(&pa->pdev);
Russell King37c12e72005-11-05 21:19:33 +0000209 }
210
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500211 return pa ? &pa->pdev : NULL;
Russell King37c12e72005-11-05 21:19:33 +0000212}
213EXPORT_SYMBOL_GPL(platform_device_alloc);
214
215/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000216 * platform_device_add_resources - add resources to a platform device
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800217 * @pdev: platform device allocated by platform_device_alloc to add resources to
218 * @res: set of resources that needs to be allocated for the device
219 * @num: number of resources
Russell King37c12e72005-11-05 21:19:33 +0000220 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800221 * Add a copy of the resources to the platform device. The memory
222 * associated with the resources will be freed when the platform device is
223 * released.
Russell King37c12e72005-11-05 21:19:33 +0000224 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800225int platform_device_add_resources(struct platform_device *pdev,
Geert Uytterhoeven0b7f1a72009-01-28 21:01:02 +0100226 const struct resource *res, unsigned int num)
Russell King37c12e72005-11-05 21:19:33 +0000227{
Uwe Kleine-Königcea89622011-04-20 09:44:44 +0200228 struct resource *r = NULL;
Russell King37c12e72005-11-05 21:19:33 +0000229
Uwe Kleine-Königcea89622011-04-20 09:44:44 +0200230 if (res) {
231 r = kmemdup(res, sizeof(struct resource) * num, GFP_KERNEL);
232 if (!r)
233 return -ENOMEM;
Russell King37c12e72005-11-05 21:19:33 +0000234 }
Uwe Kleine-Königcea89622011-04-20 09:44:44 +0200235
Uwe Kleine-König4a03d6f2011-04-20 09:44:45 +0200236 kfree(pdev->resource);
Uwe Kleine-Königcea89622011-04-20 09:44:44 +0200237 pdev->resource = r;
238 pdev->num_resources = num;
239 return 0;
Russell King37c12e72005-11-05 21:19:33 +0000240}
241EXPORT_SYMBOL_GPL(platform_device_add_resources);
242
243/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000244 * platform_device_add_data - add platform-specific data to a platform device
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800245 * @pdev: platform device allocated by platform_device_alloc to add resources to
246 * @data: platform specific data for this platform device
247 * @size: size of platform specific data
Russell King37c12e72005-11-05 21:19:33 +0000248 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800249 * Add a copy of platform specific data to the platform device's
250 * platform_data pointer. The memory associated with the platform data
251 * will be freed when the platform device is released.
Russell King37c12e72005-11-05 21:19:33 +0000252 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800253int platform_device_add_data(struct platform_device *pdev, const void *data,
254 size_t size)
Russell King37c12e72005-11-05 21:19:33 +0000255{
Uwe Kleine-König27a33f92011-04-20 09:44:42 +0200256 void *d = NULL;
Russell King37c12e72005-11-05 21:19:33 +0000257
Uwe Kleine-König27a33f92011-04-20 09:44:42 +0200258 if (data) {
259 d = kmemdup(data, size, GFP_KERNEL);
260 if (!d)
261 return -ENOMEM;
Russell King37c12e72005-11-05 21:19:33 +0000262 }
Uwe Kleine-König27a33f92011-04-20 09:44:42 +0200263
Uwe Kleine-König251e0312011-04-20 09:44:43 +0200264 kfree(pdev->dev.platform_data);
Uwe Kleine-König27a33f92011-04-20 09:44:42 +0200265 pdev->dev.platform_data = d;
266 return 0;
Russell King37c12e72005-11-05 21:19:33 +0000267}
268EXPORT_SYMBOL_GPL(platform_device_add_data);
269
270/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800271 * platform_device_add - add a platform device to device hierarchy
272 * @pdev: platform device we're adding
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800274 * This is part 2 of platform_device_register(), though may be called
275 * separately _iff_ pdev was allocated by platform_device_alloc().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 */
Russell King37c12e72005-11-05 21:19:33 +0000277int platform_device_add(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278{
Jean Delvare689ae232012-07-27 22:14:59 +0200279 int i, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281 if (!pdev)
282 return -EINVAL;
283
284 if (!pdev->dev.parent)
285 pdev->dev.parent = &platform_bus;
286
287 pdev->dev.bus = &platform_bus_type;
288
Jean Delvare689ae232012-07-27 22:14:59 +0200289 switch (pdev->id) {
290 default:
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100291 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
Jean Delvare689ae232012-07-27 22:14:59 +0200292 break;
293 case PLATFORM_DEVID_NONE:
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700294 dev_set_name(&pdev->dev, "%s", pdev->name);
Jean Delvare689ae232012-07-27 22:14:59 +0200295 break;
296 case PLATFORM_DEVID_AUTO:
297 /*
298 * Automatically allocated device ID. We mark it as such so
299 * that we remember it must be freed, and we append a suffix
300 * to avoid namespace collision with explicit IDs.
301 */
302 ret = ida_simple_get(&platform_devid_ida, 0, 0, GFP_KERNEL);
303 if (ret < 0)
304 goto err_out;
305 pdev->id = ret;
306 pdev->id_auto = true;
307 dev_set_name(&pdev->dev, "%s.%d.auto", pdev->name, pdev->id);
308 break;
309 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 for (i = 0; i < pdev->num_resources; i++) {
312 struct resource *p, *r = &pdev->resource[i];
313
314 if (r->name == NULL)
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100315 r->name = dev_name(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317 p = r->parent;
318 if (!p) {
Magnus Dammc9f66162008-10-15 22:05:15 -0700319 if (resource_type(r) == IORESOURCE_MEM)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 p = &iomem_resource;
Magnus Dammc9f66162008-10-15 22:05:15 -0700321 else if (resource_type(r) == IORESOURCE_IO)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 p = &ioport_resource;
323 }
324
Kumar Galad960bb42005-11-28 10:15:39 -0600325 if (p && insert_resource(p, r)) {
Fabio Porcedda0258e182013-03-26 10:35:16 +0100326 dev_err(&pdev->dev, "failed to claim resource %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 ret = -EBUSY;
328 goto failed;
329 }
330 }
331
332 pr_debug("Registering platform device '%s'. Parent at %s\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100333 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
Russell Kinge3915532006-05-06 08:15:26 +0100335 ret = device_add(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 if (ret == 0)
337 return ret;
338
339 failed:
Jean Delvare689ae232012-07-27 22:14:59 +0200340 if (pdev->id_auto) {
341 ida_simple_remove(&platform_devid_ida, pdev->id);
342 pdev->id = PLATFORM_DEVID_AUTO;
343 }
344
Magnus Dammc9f66162008-10-15 22:05:15 -0700345 while (--i >= 0) {
346 struct resource *r = &pdev->resource[i];
347 unsigned long type = resource_type(r);
348
349 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
350 release_resource(r);
351 }
352
Jean Delvare689ae232012-07-27 22:14:59 +0200353 err_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 return ret;
355}
Russell King37c12e72005-11-05 21:19:33 +0000356EXPORT_SYMBOL_GPL(platform_device_add);
357
358/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800359 * platform_device_del - remove a platform-level device
360 * @pdev: platform device we're removing
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500361 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800362 * Note that this function will also release all memory- and port-based
363 * resources owned by the device (@dev->resource). This function must
364 * _only_ be externally called in error cases. All other usage is a bug.
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500365 */
366void platform_device_del(struct platform_device *pdev)
367{
368 int i;
369
370 if (pdev) {
Jean Delvaredc4c15d2007-05-02 20:55:54 +0200371 device_del(&pdev->dev);
372
Jean Delvare689ae232012-07-27 22:14:59 +0200373 if (pdev->id_auto) {
374 ida_simple_remove(&platform_devid_ida, pdev->id);
375 pdev->id = PLATFORM_DEVID_AUTO;
376 }
377
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500378 for (i = 0; i < pdev->num_resources; i++) {
379 struct resource *r = &pdev->resource[i];
Magnus Dammc9f66162008-10-15 22:05:15 -0700380 unsigned long type = resource_type(r);
381
382 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500383 release_resource(r);
384 }
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500385 }
386}
387EXPORT_SYMBOL_GPL(platform_device_del);
388
389/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800390 * platform_device_register - add a platform-level device
391 * @pdev: platform device we're adding
Russell King37c12e72005-11-05 21:19:33 +0000392 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800393int platform_device_register(struct platform_device *pdev)
Russell King37c12e72005-11-05 21:19:33 +0000394{
395 device_initialize(&pdev->dev);
Kumar Galaa77ce812011-06-10 01:52:57 -0500396 arch_setup_pdev_archdata(pdev);
Russell King37c12e72005-11-05 21:19:33 +0000397 return platform_device_add(pdev);
398}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500399EXPORT_SYMBOL_GPL(platform_device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800402 * platform_device_unregister - unregister a platform-level device
403 * @pdev: platform device we're unregistering
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800405 * Unregistration is done in 2 steps. First we release all resources
406 * and remove it from the subsystem, then we drop reference count by
407 * calling platform_device_put().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800409void platform_device_unregister(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410{
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500411 platform_device_del(pdev);
412 platform_device_put(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500414EXPORT_SYMBOL_GPL(platform_device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416/**
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200417 * platform_device_register_full - add a platform-level device with
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200418 * resources and platform-specific data
419 *
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200420 * @pdevinfo: data used to create device
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700421 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +0200422 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700423 */
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200424struct platform_device *platform_device_register_full(
Uwe Kleine-König5a3072b2011-12-08 22:53:29 +0100425 const struct platform_device_info *pdevinfo)
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700426{
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200427 int ret = -ENOMEM;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700428 struct platform_device *pdev;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700429
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200430 pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200431 if (!pdev)
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200432 goto err_alloc;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700433
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200434 pdev->dev.parent = pdevinfo->parent;
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100435 ACPI_COMPANION_SET(&pdev->dev, pdevinfo->acpi_node.companion);
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700436
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200437 if (pdevinfo->dma_mask) {
438 /*
439 * This memory isn't freed when the device is put,
440 * I don't have a nice idea for that though. Conceptually
441 * dma_mask in struct device should not be a pointer.
442 * See http://thread.gmane.org/gmane.linux.kernel.pci/9081
443 */
444 pdev->dev.dma_mask =
445 kmalloc(sizeof(*pdev->dev.dma_mask), GFP_KERNEL);
446 if (!pdev->dev.dma_mask)
447 goto err;
448
449 *pdev->dev.dma_mask = pdevinfo->dma_mask;
450 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
451 }
452
453 ret = platform_device_add_resources(pdev,
454 pdevinfo->res, pdevinfo->num_res);
Anton Vorontsov807508c2010-09-07 17:31:54 +0400455 if (ret)
456 goto err;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700457
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200458 ret = platform_device_add_data(pdev,
459 pdevinfo->data, pdevinfo->size_data);
Anton Vorontsov807508c2010-09-07 17:31:54 +0400460 if (ret)
461 goto err;
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200462
463 ret = platform_device_add(pdev);
464 if (ret) {
465err:
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100466 ACPI_COMPANION_SET(&pdev->dev, NULL);
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200467 kfree(pdev->dev.dma_mask);
468
469err_alloc:
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200470 platform_device_put(pdev);
471 return ERR_PTR(ret);
472 }
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700473
474 return pdev;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700475}
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200476EXPORT_SYMBOL_GPL(platform_device_register_full);
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700477
Russell King00d3dcd2005-11-09 17:23:39 +0000478static int platform_drv_probe(struct device *_dev)
479{
480 struct platform_driver *drv = to_platform_driver(_dev->driver);
481 struct platform_device *dev = to_platform_device(_dev);
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100482 int ret;
Russell King00d3dcd2005-11-09 17:23:39 +0000483
Josh Cartwright9383f4c2014-02-13 22:00:43 -0600484 acpi_dev_pm_attach(_dev, true);
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100485
486 ret = drv->probe(dev);
Josh Cartwright9383f4c2014-02-13 22:00:43 -0600487 if (ret)
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100488 acpi_dev_pm_detach(_dev, true);
489
Johan Hovold3f9120b2013-09-23 16:27:26 +0200490 if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
491 dev_warn(_dev, "probe deferral not supported\n");
492 ret = -ENXIO;
493 }
494
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100495 return ret;
Russell King00d3dcd2005-11-09 17:23:39 +0000496}
497
David Brownellc67334f2006-11-16 23:28:47 -0800498static int platform_drv_probe_fail(struct device *_dev)
499{
500 return -ENXIO;
501}
502
Russell King00d3dcd2005-11-09 17:23:39 +0000503static int platform_drv_remove(struct device *_dev)
504{
505 struct platform_driver *drv = to_platform_driver(_dev->driver);
506 struct platform_device *dev = to_platform_device(_dev);
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100507 int ret;
Russell King00d3dcd2005-11-09 17:23:39 +0000508
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100509 ret = drv->remove(dev);
Josh Cartwright9383f4c2014-02-13 22:00:43 -0600510 acpi_dev_pm_detach(_dev, true);
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100511
512 return ret;
Russell King00d3dcd2005-11-09 17:23:39 +0000513}
514
515static void platform_drv_shutdown(struct device *_dev)
516{
517 struct platform_driver *drv = to_platform_driver(_dev->driver);
518 struct platform_device *dev = to_platform_device(_dev);
519
520 drv->shutdown(dev);
Josh Cartwright9383f4c2014-02-13 22:00:43 -0600521 acpi_dev_pm_detach(_dev, true);
Russell King00d3dcd2005-11-09 17:23:39 +0000522}
523
Russell King00d3dcd2005-11-09 17:23:39 +0000524/**
Libo Chen94470572013-05-25 12:40:50 +0800525 * __platform_driver_register - register a driver for platform-level devices
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800526 * @drv: platform driver structure
Randy Dunlap08801f92013-07-14 17:43:06 -0700527 * @owner: owning module/driver
Russell King00d3dcd2005-11-09 17:23:39 +0000528 */
Libo Chen94470572013-05-25 12:40:50 +0800529int __platform_driver_register(struct platform_driver *drv,
530 struct module *owner)
Russell King00d3dcd2005-11-09 17:23:39 +0000531{
Libo Chen94470572013-05-25 12:40:50 +0800532 drv->driver.owner = owner;
Russell King00d3dcd2005-11-09 17:23:39 +0000533 drv->driver.bus = &platform_bus_type;
534 if (drv->probe)
535 drv->driver.probe = platform_drv_probe;
536 if (drv->remove)
537 drv->driver.remove = platform_drv_remove;
538 if (drv->shutdown)
539 drv->driver.shutdown = platform_drv_shutdown;
Magnus Damm783ea7d2009-06-04 22:13:33 +0200540
Russell King00d3dcd2005-11-09 17:23:39 +0000541 return driver_register(&drv->driver);
542}
Libo Chen94470572013-05-25 12:40:50 +0800543EXPORT_SYMBOL_GPL(__platform_driver_register);
Russell King00d3dcd2005-11-09 17:23:39 +0000544
545/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000546 * platform_driver_unregister - unregister a driver for platform-level devices
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800547 * @drv: platform driver structure
Russell King00d3dcd2005-11-09 17:23:39 +0000548 */
549void platform_driver_unregister(struct platform_driver *drv)
550{
551 driver_unregister(&drv->driver);
552}
553EXPORT_SYMBOL_GPL(platform_driver_unregister);
554
David Brownellc67334f2006-11-16 23:28:47 -0800555/**
556 * platform_driver_probe - register driver for non-hotpluggable device
557 * @drv: platform driver structure
Johan Hovold3f9120b2013-09-23 16:27:26 +0200558 * @probe: the driver probe routine, probably from an __init section
David Brownellc67334f2006-11-16 23:28:47 -0800559 *
560 * Use this instead of platform_driver_register() when you know the device
561 * is not hotpluggable and has already been registered, and you want to
562 * remove its run-once probe() infrastructure from memory after the driver
563 * has bound to the device.
564 *
565 * One typical use for this would be with drivers for controllers integrated
566 * into system-on-chip processors, where the controller devices have been
567 * configured as part of board setup.
568 *
Johan Hovold3f9120b2013-09-23 16:27:26 +0200569 * Note that this is incompatible with deferred probing.
Fabio Porcedda647c86d2013-03-26 10:35:15 +0100570 *
David Brownellc67334f2006-11-16 23:28:47 -0800571 * Returns zero if the driver registered and bound to a device, else returns
572 * a negative error code and with the driver not registered.
573 */
Andrew Mortonc63e0782006-12-04 14:56:36 -0800574int __init_or_module platform_driver_probe(struct platform_driver *drv,
David Brownellc67334f2006-11-16 23:28:47 -0800575 int (*probe)(struct platform_device *))
576{
577 int retval, code;
578
Johan Hovold3f9120b2013-09-23 16:27:26 +0200579 /*
580 * Prevent driver from requesting probe deferral to avoid further
581 * futile probe attempts.
582 */
583 drv->prevent_deferred_probe = true;
584
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700585 /* make sure driver won't have bind/unbind attributes */
586 drv->driver.suppress_bind_attrs = true;
587
David Brownellc67334f2006-11-16 23:28:47 -0800588 /* temporary section violation during probe() */
589 drv->probe = probe;
590 retval = code = platform_driver_register(drv);
591
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700592 /*
593 * Fixup that section violation, being paranoid about code scanning
David Brownellc67334f2006-11-16 23:28:47 -0800594 * the list of drivers in order to probe new devices. Check to see
595 * if the probe was successful, and make sure any forced probes of
596 * new devices fail.
597 */
Patrick Pannutod79d3242010-08-06 17:12:41 -0700598 spin_lock(&drv->driver.bus->p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800599 drv->probe = NULL;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800600 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
David Brownellc67334f2006-11-16 23:28:47 -0800601 retval = -ENODEV;
602 drv->driver.probe = platform_drv_probe_fail;
Patrick Pannutod79d3242010-08-06 17:12:41 -0700603 spin_unlock(&drv->driver.bus->p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800604
605 if (code != retval)
606 platform_driver_unregister(drv);
607 return retval;
608}
609EXPORT_SYMBOL_GPL(platform_driver_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800611/**
612 * platform_create_bundle - register driver and create corresponding device
613 * @driver: platform driver structure
614 * @probe: the driver probe routine, probably from an __init section
615 * @res: set of resources that needs to be allocated for the device
616 * @n_res: number of resources
617 * @data: platform specific data for this platform device
618 * @size: size of platform specific data
619 *
620 * Use this in legacy-style modules that probe hardware directly and
621 * register a single platform device and corresponding platform driver.
Jani Nikulaf0eae0e2010-03-11 18:11:45 +0200622 *
623 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800624 */
625struct platform_device * __init_or_module platform_create_bundle(
626 struct platform_driver *driver,
627 int (*probe)(struct platform_device *),
628 struct resource *res, unsigned int n_res,
629 const void *data, size_t size)
630{
631 struct platform_device *pdev;
632 int error;
633
634 pdev = platform_device_alloc(driver->driver.name, -1);
635 if (!pdev) {
636 error = -ENOMEM;
637 goto err_out;
638 }
639
Anton Vorontsov807508c2010-09-07 17:31:54 +0400640 error = platform_device_add_resources(pdev, res, n_res);
641 if (error)
642 goto err_pdev_put;
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800643
Anton Vorontsov807508c2010-09-07 17:31:54 +0400644 error = platform_device_add_data(pdev, data, size);
645 if (error)
646 goto err_pdev_put;
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800647
648 error = platform_device_add(pdev);
649 if (error)
650 goto err_pdev_put;
651
652 error = platform_driver_probe(driver, probe);
653 if (error)
654 goto err_pdev_del;
655
656 return pdev;
657
658err_pdev_del:
659 platform_device_del(pdev);
660err_pdev_put:
661 platform_device_put(pdev);
662err_out:
663 return ERR_PTR(error);
664}
665EXPORT_SYMBOL_GPL(platform_create_bundle);
666
David Brownella0245f72006-05-29 10:37:33 -0700667/* modalias support enables more hands-off userspace setup:
668 * (a) environment variable lets new-style hotplug events work once system is
669 * fully running: "modprobe $MODALIAS"
670 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
671 * mishandled before system is fully running: "modprobe $(cat modalias)"
672 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800673static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
674 char *buf)
David Brownella0245f72006-05-29 10:37:33 -0700675{
676 struct platform_device *pdev = to_platform_device(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800677 int len;
678
Zhang Ruib9f73062014-01-14 16:46:38 +0800679 len = of_device_get_modalias(dev, buf, PAGE_SIZE -1);
680 if (len != -ENODEV)
681 return len;
682
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800683 len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
684 if (len != -ENODEV)
685 return len;
686
687 len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700688
689 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
690}
Greg Kroah-Hartmand06262e2013-08-23 14:24:37 -0700691static DEVICE_ATTR_RO(modalias);
David Brownella0245f72006-05-29 10:37:33 -0700692
Greg Kroah-Hartmand06262e2013-08-23 14:24:37 -0700693static struct attribute *platform_dev_attrs[] = {
694 &dev_attr_modalias.attr,
695 NULL,
David Brownella0245f72006-05-29 10:37:33 -0700696};
Greg Kroah-Hartmand06262e2013-08-23 14:24:37 -0700697ATTRIBUTE_GROUPS(platform_dev);
David Brownella0245f72006-05-29 10:37:33 -0700698
Kay Sievers7eff2e72007-08-14 15:15:12 +0200699static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownella0245f72006-05-29 10:37:33 -0700700{
701 struct platform_device *pdev = to_platform_device(dev);
Grant Likelyeca39302010-06-08 07:48:21 -0600702 int rc;
703
704 /* Some devices have extra OF data and an OF-style MODALIAS */
Fabio Porcedda0258e182013-03-26 10:35:16 +0100705 rc = of_device_uevent_modalias(dev, env);
Grant Likelyeca39302010-06-08 07:48:21 -0600706 if (rc != -ENODEV)
707 return rc;
David Brownella0245f72006-05-29 10:37:33 -0700708
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800709 rc = acpi_device_uevent_modalias(dev, env);
710 if (rc != -ENODEV)
711 return rc;
712
Eric Miao57fee4a2009-02-04 11:52:40 +0800713 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
Sebastian Andrzej Siewior0a268132011-08-15 16:51:22 +0200714 pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700715 return 0;
716}
717
Eric Miao57fee4a2009-02-04 11:52:40 +0800718static const struct platform_device_id *platform_match_id(
Uwe Kleine-König831fad22010-01-26 09:35:00 +0100719 const struct platform_device_id *id,
Eric Miao57fee4a2009-02-04 11:52:40 +0800720 struct platform_device *pdev)
721{
722 while (id->name[0]) {
723 if (strcmp(pdev->name, id->name) == 0) {
724 pdev->id_entry = id;
725 return id;
726 }
727 id++;
728 }
729 return NULL;
730}
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800733 * platform_match - bind platform device to platform driver.
734 * @dev: device.
735 * @drv: driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800737 * Platform device IDs are assumed to be encoded like this:
738 * "<name><instance>", where <name> is a short description of the type of
739 * device, like "pci" or "floppy", and <instance> is the enumerated
740 * instance of the device, like '0' or '42'. Driver IDs are simply
741 * "<name>". So, extract the <name> from the platform_device structure,
742 * and compare it against the name of the driver. Return whether they match
743 * or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800745static int platform_match(struct device *dev, struct device_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746{
Eric Miao71b3e0c2009-01-31 22:47:44 +0800747 struct platform_device *pdev = to_platform_device(dev);
Eric Miao57fee4a2009-02-04 11:52:40 +0800748 struct platform_driver *pdrv = to_platform_driver(drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Grant Likely05212152010-06-08 07:48:20 -0600750 /* Attempt an OF style match first */
751 if (of_driver_match_device(dev, drv))
752 return 1;
753
Mika Westerberg91e56872012-10-31 22:45:02 +0100754 /* Then try ACPI style match */
755 if (acpi_driver_match_device(dev, drv))
756 return 1;
757
Grant Likely05212152010-06-08 07:48:20 -0600758 /* Then try to match against the id table */
Eric Miao57fee4a2009-02-04 11:52:40 +0800759 if (pdrv->id_table)
760 return platform_match_id(pdrv->id_table, pdev) != NULL;
761
762 /* fall-back to driver name match */
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100763 return (strcmp(pdev->name, drv->name) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764}
765
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200766#ifdef CONFIG_PM_SLEEP
767
768static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769{
Magnus Damm783ea7d2009-06-04 22:13:33 +0200770 struct platform_driver *pdrv = to_platform_driver(dev->driver);
771 struct platform_device *pdev = to_platform_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 int ret = 0;
773
Magnus Damm783ea7d2009-06-04 22:13:33 +0200774 if (dev->driver && pdrv->suspend)
775 ret = pdrv->suspend(pdev, mesg);
David Brownell386415d2006-09-03 13:16:45 -0700776
777 return ret;
778}
779
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200780static int platform_legacy_resume(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781{
Magnus Damm783ea7d2009-06-04 22:13:33 +0200782 struct platform_driver *pdrv = to_platform_driver(dev->driver);
783 struct platform_device *pdev = to_platform_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 int ret = 0;
785
Magnus Damm783ea7d2009-06-04 22:13:33 +0200786 if (dev->driver && pdrv->resume)
787 ret = pdrv->resume(pdev);
Russell King9480e302005-10-28 09:52:56 -0700788
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 return ret;
790}
791
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200792#endif /* CONFIG_PM_SLEEP */
Magnus Damm9d730222009-08-20 20:25:32 +0200793
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200794#ifdef CONFIG_SUSPEND
795
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200796int platform_pm_suspend(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200797{
798 struct device_driver *drv = dev->driver;
799 int ret = 0;
800
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200801 if (!drv)
802 return 0;
803
804 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200805 if (drv->pm->suspend)
806 ret = drv->pm->suspend(dev);
807 } else {
808 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
809 }
810
811 return ret;
812}
813
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200814int platform_pm_resume(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200815{
816 struct device_driver *drv = dev->driver;
817 int ret = 0;
818
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200819 if (!drv)
820 return 0;
821
822 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200823 if (drv->pm->resume)
824 ret = drv->pm->resume(dev);
825 } else {
826 ret = platform_legacy_resume(dev);
827 }
828
829 return ret;
830}
831
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200832#endif /* CONFIG_SUSPEND */
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200833
Rafael J. Wysocki1f112ce2011-04-11 22:54:42 +0200834#ifdef CONFIG_HIBERNATE_CALLBACKS
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200835
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200836int platform_pm_freeze(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200837{
838 struct device_driver *drv = dev->driver;
839 int ret = 0;
840
841 if (!drv)
842 return 0;
843
844 if (drv->pm) {
845 if (drv->pm->freeze)
846 ret = drv->pm->freeze(dev);
847 } else {
848 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
849 }
850
851 return ret;
852}
853
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200854int platform_pm_thaw(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200855{
856 struct device_driver *drv = dev->driver;
857 int ret = 0;
858
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200859 if (!drv)
860 return 0;
861
862 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200863 if (drv->pm->thaw)
864 ret = drv->pm->thaw(dev);
865 } else {
866 ret = platform_legacy_resume(dev);
867 }
868
869 return ret;
870}
871
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200872int platform_pm_poweroff(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200873{
874 struct device_driver *drv = dev->driver;
875 int ret = 0;
876
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200877 if (!drv)
878 return 0;
879
880 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200881 if (drv->pm->poweroff)
882 ret = drv->pm->poweroff(dev);
883 } else {
884 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
885 }
886
887 return ret;
888}
889
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200890int platform_pm_restore(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200891{
892 struct device_driver *drv = dev->driver;
893 int ret = 0;
894
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200895 if (!drv)
896 return 0;
897
898 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200899 if (drv->pm->restore)
900 ret = drv->pm->restore(dev);
901 } else {
902 ret = platform_legacy_resume(dev);
903 }
904
905 return ret;
906}
907
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200908#endif /* CONFIG_HIBERNATE_CALLBACKS */
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200909
Dmitry Torokhovd9ab7712009-07-22 00:37:25 +0200910static const struct dev_pm_ops platform_dev_pm_ops = {
Rafael J. Wysocki8b313a32011-04-29 00:36:32 +0200911 .runtime_suspend = pm_generic_runtime_suspend,
912 .runtime_resume = pm_generic_runtime_resume,
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200913 USE_PLATFORM_PM_SLEEP_OPS
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200914};
915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916struct bus_type platform_bus_type = {
917 .name = "platform",
Greg Kroah-Hartmand06262e2013-08-23 14:24:37 -0700918 .dev_groups = platform_dev_groups,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 .match = platform_match,
David Brownella0245f72006-05-29 10:37:33 -0700920 .uevent = platform_uevent,
Magnus Damm9d730222009-08-20 20:25:32 +0200921 .pm = &platform_dev_pm_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922};
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500923EXPORT_SYMBOL_GPL(platform_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
925int __init platform_bus_init(void)
926{
Cornelia Huckfbfb1442006-11-27 10:35:08 +0100927 int error;
928
Magnus Damm13977092009-03-30 14:37:25 -0700929 early_platform_cleanup();
930
Cornelia Huckfbfb1442006-11-27 10:35:08 +0100931 error = device_register(&platform_bus);
932 if (error)
933 return error;
934 error = bus_register(&platform_bus_type);
935 if (error)
936 device_unregister(&platform_bus);
937 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938}
939
940#ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
941u64 dma_get_required_mask(struct device *dev)
942{
943 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
944 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
945 u64 mask;
946
947 if (!high_totalram) {
948 /* convert to mask just covering totalram */
949 low_totalram = (1 << (fls(low_totalram) - 1));
950 low_totalram += low_totalram - 1;
951 mask = low_totalram;
952 } else {
953 high_totalram = (1 << (fls(high_totalram) - 1));
954 high_totalram += high_totalram - 1;
955 mask = (((u64)high_totalram) << 32) + 0xffffffff;
956 }
James Bottomleye88a0c22008-03-09 11:57:56 -0500957 return mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958}
959EXPORT_SYMBOL_GPL(dma_get_required_mask);
960#endif
Magnus Damm13977092009-03-30 14:37:25 -0700961
962static __initdata LIST_HEAD(early_platform_driver_list);
963static __initdata LIST_HEAD(early_platform_device_list);
964
965/**
Magnus Damm4d26e1392010-03-10 20:50:38 +0900966 * early_platform_driver_register - register early platform driver
Randy Dunlapd86c1302009-04-21 07:22:53 -0700967 * @epdrv: early_platform driver structure
Magnus Damm13977092009-03-30 14:37:25 -0700968 * @buf: string passed from early_param()
Magnus Damm4d26e1392010-03-10 20:50:38 +0900969 *
970 * Helper function for early_platform_init() / early_platform_init_buffer()
Magnus Damm13977092009-03-30 14:37:25 -0700971 */
972int __init early_platform_driver_register(struct early_platform_driver *epdrv,
973 char *buf)
974{
Magnus Dammc60e0502009-11-27 17:38:51 +0900975 char *tmp;
Magnus Damm13977092009-03-30 14:37:25 -0700976 int n;
977
978 /* Simply add the driver to the end of the global list.
979 * Drivers will by default be put on the list in compiled-in order.
980 */
981 if (!epdrv->list.next) {
982 INIT_LIST_HEAD(&epdrv->list);
983 list_add_tail(&epdrv->list, &early_platform_driver_list);
984 }
985
986 /* If the user has specified device then make sure the driver
987 * gets prioritized. The driver of the last device specified on
988 * command line will be put first on the list.
989 */
990 n = strlen(epdrv->pdrv->driver.name);
991 if (buf && !strncmp(buf, epdrv->pdrv->driver.name, n)) {
992 list_move(&epdrv->list, &early_platform_driver_list);
993
Magnus Dammc60e0502009-11-27 17:38:51 +0900994 /* Allow passing parameters after device name */
995 if (buf[n] == '\0' || buf[n] == ',')
Magnus Damm13977092009-03-30 14:37:25 -0700996 epdrv->requested_id = -1;
Magnus Dammc60e0502009-11-27 17:38:51 +0900997 else {
998 epdrv->requested_id = simple_strtoul(&buf[n + 1],
999 &tmp, 10);
1000
1001 if (buf[n] != '.' || (tmp == &buf[n + 1])) {
1002 epdrv->requested_id = EARLY_PLATFORM_ID_ERROR;
1003 n = 0;
1004 } else
1005 n += strcspn(&buf[n + 1], ",") + 1;
1006 }
1007
1008 if (buf[n] == ',')
1009 n++;
1010
1011 if (epdrv->bufsize) {
1012 memcpy(epdrv->buffer, &buf[n],
1013 min_t(int, epdrv->bufsize, strlen(&buf[n]) + 1));
1014 epdrv->buffer[epdrv->bufsize - 1] = '\0';
1015 }
Magnus Damm13977092009-03-30 14:37:25 -07001016 }
1017
1018 return 0;
1019}
1020
1021/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001022 * early_platform_add_devices - adds a number of early platform devices
Magnus Damm13977092009-03-30 14:37:25 -07001023 * @devs: array of early platform devices to add
1024 * @num: number of early platform devices in array
Magnus Damm4d26e1392010-03-10 20:50:38 +09001025 *
1026 * Used by early architecture code to register early platform devices and
1027 * their platform data.
Magnus Damm13977092009-03-30 14:37:25 -07001028 */
1029void __init early_platform_add_devices(struct platform_device **devs, int num)
1030{
1031 struct device *dev;
1032 int i;
1033
1034 /* simply add the devices to list */
1035 for (i = 0; i < num; i++) {
1036 dev = &devs[i]->dev;
1037
1038 if (!dev->devres_head.next) {
Rafael J. Wysockibed2b422012-08-06 01:45:11 +02001039 pm_runtime_early_init(dev);
Magnus Damm13977092009-03-30 14:37:25 -07001040 INIT_LIST_HEAD(&dev->devres_head);
1041 list_add_tail(&dev->devres_head,
1042 &early_platform_device_list);
1043 }
1044 }
1045}
1046
1047/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001048 * early_platform_driver_register_all - register early platform drivers
Magnus Damm13977092009-03-30 14:37:25 -07001049 * @class_str: string to identify early platform driver class
Magnus Damm4d26e1392010-03-10 20:50:38 +09001050 *
1051 * Used by architecture code to register all early platform drivers
1052 * for a certain class. If omitted then only early platform drivers
1053 * with matching kernel command line class parameters will be registered.
Magnus Damm13977092009-03-30 14:37:25 -07001054 */
1055void __init early_platform_driver_register_all(char *class_str)
1056{
1057 /* The "class_str" parameter may or may not be present on the kernel
1058 * command line. If it is present then there may be more than one
1059 * matching parameter.
1060 *
1061 * Since we register our early platform drivers using early_param()
1062 * we need to make sure that they also get registered in the case
1063 * when the parameter is missing from the kernel command line.
1064 *
1065 * We use parse_early_options() to make sure the early_param() gets
1066 * called at least once. The early_param() may be called more than
1067 * once since the name of the preferred device may be specified on
1068 * the kernel command line. early_platform_driver_register() handles
1069 * this case for us.
1070 */
1071 parse_early_options(class_str);
1072}
1073
1074/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001075 * early_platform_match - find early platform device matching driver
Randy Dunlapd86c1302009-04-21 07:22:53 -07001076 * @epdrv: early platform driver structure
Magnus Damm13977092009-03-30 14:37:25 -07001077 * @id: id to match against
1078 */
Hanjun Guoa8257912013-08-17 20:42:25 +08001079static struct platform_device * __init
Magnus Damm13977092009-03-30 14:37:25 -07001080early_platform_match(struct early_platform_driver *epdrv, int id)
1081{
1082 struct platform_device *pd;
1083
1084 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1085 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1086 if (pd->id == id)
1087 return pd;
1088
1089 return NULL;
1090}
1091
1092/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001093 * early_platform_left - check if early platform driver has matching devices
Randy Dunlapd86c1302009-04-21 07:22:53 -07001094 * @epdrv: early platform driver structure
Magnus Damm13977092009-03-30 14:37:25 -07001095 * @id: return true if id or above exists
1096 */
Hanjun Guoa8257912013-08-17 20:42:25 +08001097static int __init early_platform_left(struct early_platform_driver *epdrv,
Magnus Damm13977092009-03-30 14:37:25 -07001098 int id)
1099{
1100 struct platform_device *pd;
1101
1102 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1103 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1104 if (pd->id >= id)
1105 return 1;
1106
1107 return 0;
1108}
1109
1110/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001111 * early_platform_driver_probe_id - probe drivers matching class_str and id
Magnus Damm13977092009-03-30 14:37:25 -07001112 * @class_str: string to identify early platform driver class
1113 * @id: id to match against
1114 * @nr_probe: number of platform devices to successfully probe before exiting
1115 */
1116static int __init early_platform_driver_probe_id(char *class_str,
1117 int id,
1118 int nr_probe)
1119{
1120 struct early_platform_driver *epdrv;
1121 struct platform_device *match;
1122 int match_id;
1123 int n = 0;
1124 int left = 0;
1125
1126 list_for_each_entry(epdrv, &early_platform_driver_list, list) {
1127 /* only use drivers matching our class_str */
1128 if (strcmp(class_str, epdrv->class_str))
1129 continue;
1130
1131 if (id == -2) {
1132 match_id = epdrv->requested_id;
1133 left = 1;
1134
1135 } else {
1136 match_id = id;
1137 left += early_platform_left(epdrv, id);
1138
1139 /* skip requested id */
1140 switch (epdrv->requested_id) {
1141 case EARLY_PLATFORM_ID_ERROR:
1142 case EARLY_PLATFORM_ID_UNSET:
1143 break;
1144 default:
1145 if (epdrv->requested_id == id)
1146 match_id = EARLY_PLATFORM_ID_UNSET;
1147 }
1148 }
1149
1150 switch (match_id) {
1151 case EARLY_PLATFORM_ID_ERROR:
Fabio Porcedda0258e182013-03-26 10:35:16 +01001152 pr_warn("%s: unable to parse %s parameter\n",
1153 class_str, epdrv->pdrv->driver.name);
Magnus Damm13977092009-03-30 14:37:25 -07001154 /* fall-through */
1155 case EARLY_PLATFORM_ID_UNSET:
1156 match = NULL;
1157 break;
1158 default:
1159 match = early_platform_match(epdrv, match_id);
1160 }
1161
1162 if (match) {
Paul Mundta636ee72010-03-09 06:57:53 +00001163 /*
1164 * Set up a sensible init_name to enable
1165 * dev_name() and others to be used before the
1166 * rest of the driver core is initialized.
1167 */
Paul Mundt06fe53b2010-05-13 17:56:56 +09001168 if (!match->dev.init_name && slab_is_available()) {
Paul Mundta636ee72010-03-09 06:57:53 +00001169 if (match->id != -1)
Paul Mundtbd050862010-03-29 15:51:35 +09001170 match->dev.init_name =
1171 kasprintf(GFP_KERNEL, "%s.%d",
1172 match->name,
1173 match->id);
Paul Mundta636ee72010-03-09 06:57:53 +00001174 else
Paul Mundtbd050862010-03-29 15:51:35 +09001175 match->dev.init_name =
1176 kasprintf(GFP_KERNEL, "%s",
1177 match->name);
Paul Mundta636ee72010-03-09 06:57:53 +00001178
Paul Mundta636ee72010-03-09 06:57:53 +00001179 if (!match->dev.init_name)
1180 return -ENOMEM;
1181 }
Paul Mundtbd050862010-03-29 15:51:35 +09001182
Magnus Damm13977092009-03-30 14:37:25 -07001183 if (epdrv->pdrv->probe(match))
Fabio Porcedda0258e182013-03-26 10:35:16 +01001184 pr_warn("%s: unable to probe %s early.\n",
1185 class_str, match->name);
Magnus Damm13977092009-03-30 14:37:25 -07001186 else
1187 n++;
1188 }
1189
1190 if (n >= nr_probe)
1191 break;
1192 }
1193
1194 if (left)
1195 return n;
1196 else
1197 return -ENODEV;
1198}
1199
1200/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001201 * early_platform_driver_probe - probe a class of registered drivers
Magnus Damm13977092009-03-30 14:37:25 -07001202 * @class_str: string to identify early platform driver class
1203 * @nr_probe: number of platform devices to successfully probe before exiting
1204 * @user_only: only probe user specified early platform devices
Magnus Damm4d26e1392010-03-10 20:50:38 +09001205 *
1206 * Used by architecture code to probe registered early platform drivers
1207 * within a certain class. For probe to happen a registered early platform
1208 * device matching a registered early platform driver is needed.
Magnus Damm13977092009-03-30 14:37:25 -07001209 */
1210int __init early_platform_driver_probe(char *class_str,
1211 int nr_probe,
1212 int user_only)
1213{
1214 int k, n, i;
1215
1216 n = 0;
1217 for (i = -2; n < nr_probe; i++) {
1218 k = early_platform_driver_probe_id(class_str, i, nr_probe - n);
1219
1220 if (k < 0)
1221 break;
1222
1223 n += k;
1224
1225 if (user_only)
1226 break;
1227 }
1228
1229 return n;
1230}
1231
1232/**
1233 * early_platform_cleanup - clean up early platform code
1234 */
1235void __init early_platform_cleanup(void)
1236{
1237 struct platform_device *pd, *pd2;
1238
1239 /* clean up the devres list used to chain devices */
1240 list_for_each_entry_safe(pd, pd2, &early_platform_device_list,
1241 dev.devres_head) {
1242 list_del(&pd->dev.devres_head);
1243 memset(&pd->dev.devres_head, 0, sizeof(pd->dev.devres_head));
1244 }
1245}
1246