blob: 9e9227e1762d495b80ef48324ea6ec7c44bf1e27 [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>
Rob Herring9ec36ca2014-04-23 17:57:41 -050016#include <linux/of_irq.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/module.h>
18#include <linux/init.h>
19#include <linux/dma-mapping.h>
20#include <linux/bootmem.h>
21#include <linux/err.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080022#include <linux/slab.h>
Magnus Damm9d730222009-08-20 20:25:32 +020023#include <linux/pm_runtime.h>
Jean Delvare689ae232012-07-27 22:14:59 +020024#include <linux/idr.h>
Mika Westerberg91e56872012-10-31 22:45:02 +010025#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
Ben Dooksa1bdc7a2005-10-13 17:54:41 +010027#include "base.h"
Rafael J. Wysockibed2b422012-08-06 01:45:11 +020028#include "power/power.h"
Ben Dooksa1bdc7a2005-10-13 17:54:41 +010029
Jean Delvare689ae232012-07-27 22:14:59 +020030/* For automatically allocated device IDs */
31static DEFINE_IDA(platform_devid_ida);
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033struct device platform_bus = {
Kay Sievers1e0b2cf2008-10-30 01:36:48 +010034 .init_name = "platform",
Linus Torvalds1da177e2005-04-16 15:20:36 -070035};
Dmitry Torokhova96b2042005-12-10 01:36:28 -050036EXPORT_SYMBOL_GPL(platform_bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38/**
Kumar Galaa77ce812011-06-10 01:52:57 -050039 * arch_setup_pdev_archdata - Allow manipulation of archdata before its used
Randy Dunlap7de636f2011-07-27 12:11:25 -070040 * @pdev: platform device
Kumar Galaa77ce812011-06-10 01:52:57 -050041 *
42 * This is called before platform_device_add() such that any pdev_archdata may
43 * be setup before the platform_notifier is called. So if a user needs to
44 * manipulate any relevant information in the pdev_archdata they can do:
45 *
Sebastian Andrzej Siewiorb1d6d822012-10-29 18:04:53 +010046 * platform_device_alloc()
Fabio Porcedda0258e182013-03-26 10:35:16 +010047 * ... manipulate ...
48 * platform_device_add()
Kumar Galaa77ce812011-06-10 01:52:57 -050049 *
50 * And if they don't care they can just call platform_device_register() and
51 * everything will just work out.
52 */
53void __weak arch_setup_pdev_archdata(struct platform_device *pdev)
54{
55}
56
57/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080058 * platform_get_resource - get a resource for a device
59 * @dev: platform device
60 * @type: resource type
61 * @num: resource index
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080063struct resource *platform_get_resource(struct platform_device *dev,
64 unsigned int type, unsigned int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
66 int i;
67
68 for (i = 0; i < dev->num_resources; i++) {
69 struct resource *r = &dev->resource[i];
70
Magnus Dammc9f66162008-10-15 22:05:15 -070071 if (type == resource_type(r) && num-- == 0)
72 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 }
74 return NULL;
75}
Dmitry Torokhova96b2042005-12-10 01:36:28 -050076EXPORT_SYMBOL_GPL(platform_get_resource);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
78/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080079 * platform_get_irq - get an IRQ for a device
80 * @dev: platform device
81 * @num: IRQ number index
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 */
83int platform_get_irq(struct platform_device *dev, unsigned int num)
84{
Andreas Larsson5cf8f7d2012-10-29 23:26:56 +000085#ifdef CONFIG_SPARC
86 /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
87 if (!dev || num >= dev->archdata.num_irqs)
88 return -ENXIO;
89 return dev->archdata.irqs[num];
90#else
Rob Herring9ec36ca2014-04-23 17:57:41 -050091 struct resource *r;
92 if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node)
93 return of_irq_get(dev->dev.of_node, num);
94
95 r = platform_get_resource(dev, IORESOURCE_IRQ, num);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
David Vrabel305b3222006-01-19 17:52:27 +000097 return r ? r->start : -ENXIO;
Andreas Larsson5cf8f7d2012-10-29 23:26:56 +000098#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070099}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500100EXPORT_SYMBOL_GPL(platform_get_irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800103 * platform_get_resource_byname - get a resource for a device by name
104 * @dev: platform device
105 * @type: resource type
106 * @name: resource name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800108struct resource *platform_get_resource_byname(struct platform_device *dev,
Linus Walleijc0afe7b2009-04-27 02:38:16 +0200109 unsigned int type,
110 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111{
112 int i;
113
114 for (i = 0; i < dev->num_resources; i++) {
115 struct resource *r = &dev->resource[i];
116
Peter Ujfalusi1b8cb922012-08-23 17:10:00 +0300117 if (unlikely(!r->name))
118 continue;
119
Magnus Dammc9f66162008-10-15 22:05:15 -0700120 if (type == resource_type(r) && !strcmp(r->name, name))
121 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 }
123 return NULL;
124}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500125EXPORT_SYMBOL_GPL(platform_get_resource_byname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
127/**
Wolfram Sangd6ff8552012-11-13 17:47:13 +0100128 * platform_get_irq_byname - get an IRQ for a device by name
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800129 * @dev: platform device
130 * @name: IRQ name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 */
Linus Walleijc0afe7b2009-04-27 02:38:16 +0200132int platform_get_irq_byname(struct platform_device *dev, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
Grygorii Strashkoad696742014-05-20 13:42:02 +0300134 struct resource *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Grygorii Strashkoad696742014-05-20 13:42:02 +0300136 if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node)
137 return of_irq_get_byname(dev->dev.of_node, name);
138
139 r = platform_get_resource_byname(dev, IORESOURCE_IRQ, name);
David Vrabel305b3222006-01-19 17:52:27 +0000140 return r ? r->start : -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500142EXPORT_SYMBOL_GPL(platform_get_irq_byname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800145 * platform_add_devices - add a numbers of platform devices
146 * @devs: array of platform devices to add
147 * @num: number of platform devices in array
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 */
149int platform_add_devices(struct platform_device **devs, int num)
150{
151 int i, ret = 0;
152
153 for (i = 0; i < num; i++) {
154 ret = platform_device_register(devs[i]);
155 if (ret) {
156 while (--i >= 0)
157 platform_device_unregister(devs[i]);
158 break;
159 }
160 }
161
162 return ret;
163}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500164EXPORT_SYMBOL_GPL(platform_add_devices);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Russell King37c12e72005-11-05 21:19:33 +0000166struct platform_object {
167 struct platform_device pdev;
168 char name[1];
169};
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000172 * platform_device_put - destroy a platform device
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800173 * @pdev: platform device to free
Russell King37c12e72005-11-05 21:19:33 +0000174 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800175 * Free all memory associated with a platform device. This function must
176 * _only_ be externally called in error cases. All other usage is a bug.
Russell King37c12e72005-11-05 21:19:33 +0000177 */
178void platform_device_put(struct platform_device *pdev)
179{
180 if (pdev)
181 put_device(&pdev->dev);
182}
183EXPORT_SYMBOL_GPL(platform_device_put);
184
185static void platform_device_release(struct device *dev)
186{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800187 struct platform_object *pa = container_of(dev, struct platform_object,
188 pdev.dev);
Russell King37c12e72005-11-05 21:19:33 +0000189
Grant Likely7096d042010-10-20 11:45:13 -0600190 of_device_node_put(&pa->pdev.dev);
Russell King37c12e72005-11-05 21:19:33 +0000191 kfree(pa->pdev.dev.platform_data);
Samuel Ortize710d7d2011-04-08 00:43:01 +0200192 kfree(pa->pdev.mfd_cell);
Russell King37c12e72005-11-05 21:19:33 +0000193 kfree(pa->pdev.resource);
194 kfree(pa);
195}
196
197/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000198 * platform_device_alloc - create a platform device
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800199 * @name: base name of the device we're adding
200 * @id: instance id
Russell King37c12e72005-11-05 21:19:33 +0000201 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800202 * Create a platform device object which can have other objects attached
203 * to it, and which will have attached objects freed when it is released.
Russell King37c12e72005-11-05 21:19:33 +0000204 */
Jean Delvare1359555e2007-09-09 12:54:16 +0200205struct platform_device *platform_device_alloc(const char *name, int id)
Russell King37c12e72005-11-05 21:19:33 +0000206{
207 struct platform_object *pa;
208
209 pa = kzalloc(sizeof(struct platform_object) + strlen(name), GFP_KERNEL);
210 if (pa) {
211 strcpy(pa->name, name);
212 pa->pdev.name = pa->name;
213 pa->pdev.id = id;
214 device_initialize(&pa->pdev.dev);
215 pa->pdev.dev.release = platform_device_release;
Kumar Galaa77ce812011-06-10 01:52:57 -0500216 arch_setup_pdev_archdata(&pa->pdev);
Russell King37c12e72005-11-05 21:19:33 +0000217 }
218
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500219 return pa ? &pa->pdev : NULL;
Russell King37c12e72005-11-05 21:19:33 +0000220}
221EXPORT_SYMBOL_GPL(platform_device_alloc);
222
223/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000224 * platform_device_add_resources - add resources to a platform device
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800225 * @pdev: platform device allocated by platform_device_alloc to add resources to
226 * @res: set of resources that needs to be allocated for the device
227 * @num: number of resources
Russell King37c12e72005-11-05 21:19:33 +0000228 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800229 * Add a copy of the resources to the platform device. The memory
230 * associated with the resources will be freed when the platform device is
231 * released.
Russell King37c12e72005-11-05 21:19:33 +0000232 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800233int platform_device_add_resources(struct platform_device *pdev,
Geert Uytterhoeven0b7f1a72009-01-28 21:01:02 +0100234 const struct resource *res, unsigned int num)
Russell King37c12e72005-11-05 21:19:33 +0000235{
Uwe Kleine-Königcea89622011-04-20 09:44:44 +0200236 struct resource *r = NULL;
Russell King37c12e72005-11-05 21:19:33 +0000237
Uwe Kleine-Königcea89622011-04-20 09:44:44 +0200238 if (res) {
239 r = kmemdup(res, sizeof(struct resource) * num, GFP_KERNEL);
240 if (!r)
241 return -ENOMEM;
Russell King37c12e72005-11-05 21:19:33 +0000242 }
Uwe Kleine-Königcea89622011-04-20 09:44:44 +0200243
Uwe Kleine-König4a03d6f2011-04-20 09:44:45 +0200244 kfree(pdev->resource);
Uwe Kleine-Königcea89622011-04-20 09:44:44 +0200245 pdev->resource = r;
246 pdev->num_resources = num;
247 return 0;
Russell King37c12e72005-11-05 21:19:33 +0000248}
249EXPORT_SYMBOL_GPL(platform_device_add_resources);
250
251/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000252 * platform_device_add_data - add platform-specific data to a platform device
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800253 * @pdev: platform device allocated by platform_device_alloc to add resources to
254 * @data: platform specific data for this platform device
255 * @size: size of platform specific data
Russell King37c12e72005-11-05 21:19:33 +0000256 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800257 * Add a copy of platform specific data to the platform device's
258 * platform_data pointer. The memory associated with the platform data
259 * will be freed when the platform device is released.
Russell King37c12e72005-11-05 21:19:33 +0000260 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800261int platform_device_add_data(struct platform_device *pdev, const void *data,
262 size_t size)
Russell King37c12e72005-11-05 21:19:33 +0000263{
Uwe Kleine-König27a33f92011-04-20 09:44:42 +0200264 void *d = NULL;
Russell King37c12e72005-11-05 21:19:33 +0000265
Uwe Kleine-König27a33f92011-04-20 09:44:42 +0200266 if (data) {
267 d = kmemdup(data, size, GFP_KERNEL);
268 if (!d)
269 return -ENOMEM;
Russell King37c12e72005-11-05 21:19:33 +0000270 }
Uwe Kleine-König27a33f92011-04-20 09:44:42 +0200271
Uwe Kleine-König251e0312011-04-20 09:44:43 +0200272 kfree(pdev->dev.platform_data);
Uwe Kleine-König27a33f92011-04-20 09:44:42 +0200273 pdev->dev.platform_data = d;
274 return 0;
Russell King37c12e72005-11-05 21:19:33 +0000275}
276EXPORT_SYMBOL_GPL(platform_device_add_data);
277
278/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800279 * platform_device_add - add a platform device to device hierarchy
280 * @pdev: platform device we're adding
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800282 * This is part 2 of platform_device_register(), though may be called
283 * separately _iff_ pdev was allocated by platform_device_alloc().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 */
Russell King37c12e72005-11-05 21:19:33 +0000285int platform_device_add(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286{
Jean Delvare689ae232012-07-27 22:14:59 +0200287 int i, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289 if (!pdev)
290 return -EINVAL;
291
292 if (!pdev->dev.parent)
293 pdev->dev.parent = &platform_bus;
294
295 pdev->dev.bus = &platform_bus_type;
296
Jean Delvare689ae232012-07-27 22:14:59 +0200297 switch (pdev->id) {
298 default:
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100299 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
Jean Delvare689ae232012-07-27 22:14:59 +0200300 break;
301 case PLATFORM_DEVID_NONE:
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700302 dev_set_name(&pdev->dev, "%s", pdev->name);
Jean Delvare689ae232012-07-27 22:14:59 +0200303 break;
304 case PLATFORM_DEVID_AUTO:
305 /*
306 * Automatically allocated device ID. We mark it as such so
307 * that we remember it must be freed, and we append a suffix
308 * to avoid namespace collision with explicit IDs.
309 */
310 ret = ida_simple_get(&platform_devid_ida, 0, 0, GFP_KERNEL);
311 if (ret < 0)
312 goto err_out;
313 pdev->id = ret;
314 pdev->id_auto = true;
315 dev_set_name(&pdev->dev, "%s.%d.auto", pdev->name, pdev->id);
316 break;
317 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
319 for (i = 0; i < pdev->num_resources; i++) {
320 struct resource *p, *r = &pdev->resource[i];
321
322 if (r->name == NULL)
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100323 r->name = dev_name(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325 p = r->parent;
326 if (!p) {
Magnus Dammc9f66162008-10-15 22:05:15 -0700327 if (resource_type(r) == IORESOURCE_MEM)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 p = &iomem_resource;
Magnus Dammc9f66162008-10-15 22:05:15 -0700329 else if (resource_type(r) == IORESOURCE_IO)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 p = &ioport_resource;
331 }
332
Kumar Galad960bb42005-11-28 10:15:39 -0600333 if (p && insert_resource(p, r)) {
Fabio Porcedda0258e182013-03-26 10:35:16 +0100334 dev_err(&pdev->dev, "failed to claim resource %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 ret = -EBUSY;
336 goto failed;
337 }
338 }
339
340 pr_debug("Registering platform device '%s'. Parent at %s\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100341 dev_name(&pdev->dev), dev_name(pdev->dev.parent));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Russell Kinge3915532006-05-06 08:15:26 +0100343 ret = device_add(&pdev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 if (ret == 0)
345 return ret;
346
347 failed:
Jean Delvare689ae232012-07-27 22:14:59 +0200348 if (pdev->id_auto) {
349 ida_simple_remove(&platform_devid_ida, pdev->id);
350 pdev->id = PLATFORM_DEVID_AUTO;
351 }
352
Magnus Dammc9f66162008-10-15 22:05:15 -0700353 while (--i >= 0) {
354 struct resource *r = &pdev->resource[i];
355 unsigned long type = resource_type(r);
356
357 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
358 release_resource(r);
359 }
360
Jean Delvare689ae232012-07-27 22:14:59 +0200361 err_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 return ret;
363}
Russell King37c12e72005-11-05 21:19:33 +0000364EXPORT_SYMBOL_GPL(platform_device_add);
365
366/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800367 * platform_device_del - remove a platform-level device
368 * @pdev: platform device we're removing
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500369 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800370 * Note that this function will also release all memory- and port-based
371 * resources owned by the device (@dev->resource). This function must
372 * _only_ be externally called in error cases. All other usage is a bug.
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500373 */
374void platform_device_del(struct platform_device *pdev)
375{
376 int i;
377
378 if (pdev) {
Jean Delvaredc4c15d2007-05-02 20:55:54 +0200379 device_del(&pdev->dev);
380
Jean Delvare689ae232012-07-27 22:14:59 +0200381 if (pdev->id_auto) {
382 ida_simple_remove(&platform_devid_ida, pdev->id);
383 pdev->id = PLATFORM_DEVID_AUTO;
384 }
385
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500386 for (i = 0; i < pdev->num_resources; i++) {
387 struct resource *r = &pdev->resource[i];
Magnus Dammc9f66162008-10-15 22:05:15 -0700388 unsigned long type = resource_type(r);
389
390 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500391 release_resource(r);
392 }
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500393 }
394}
395EXPORT_SYMBOL_GPL(platform_device_del);
396
397/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800398 * platform_device_register - add a platform-level device
399 * @pdev: platform device we're adding
Russell King37c12e72005-11-05 21:19:33 +0000400 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800401int platform_device_register(struct platform_device *pdev)
Russell King37c12e72005-11-05 21:19:33 +0000402{
403 device_initialize(&pdev->dev);
Kumar Galaa77ce812011-06-10 01:52:57 -0500404 arch_setup_pdev_archdata(pdev);
Russell King37c12e72005-11-05 21:19:33 +0000405 return platform_device_add(pdev);
406}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500407EXPORT_SYMBOL_GPL(platform_device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
409/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800410 * platform_device_unregister - unregister a platform-level device
411 * @pdev: platform device we're unregistering
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800413 * Unregistration is done in 2 steps. First we release all resources
414 * and remove it from the subsystem, then we drop reference count by
415 * calling platform_device_put().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800417void platform_device_unregister(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500419 platform_device_del(pdev);
420 platform_device_put(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421}
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500422EXPORT_SYMBOL_GPL(platform_device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424/**
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200425 * platform_device_register_full - add a platform-level device with
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200426 * resources and platform-specific data
427 *
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200428 * @pdevinfo: data used to create device
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700429 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +0200430 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700431 */
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200432struct platform_device *platform_device_register_full(
Uwe Kleine-König5a3072b2011-12-08 22:53:29 +0100433 const struct platform_device_info *pdevinfo)
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700434{
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200435 int ret = -ENOMEM;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700436 struct platform_device *pdev;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700437
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200438 pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200439 if (!pdev)
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200440 goto err_alloc;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700441
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200442 pdev->dev.parent = pdevinfo->parent;
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100443 ACPI_COMPANION_SET(&pdev->dev, pdevinfo->acpi_node.companion);
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700444
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200445 if (pdevinfo->dma_mask) {
446 /*
447 * This memory isn't freed when the device is put,
448 * I don't have a nice idea for that though. Conceptually
449 * dma_mask in struct device should not be a pointer.
450 * See http://thread.gmane.org/gmane.linux.kernel.pci/9081
451 */
452 pdev->dev.dma_mask =
453 kmalloc(sizeof(*pdev->dev.dma_mask), GFP_KERNEL);
454 if (!pdev->dev.dma_mask)
455 goto err;
456
457 *pdev->dev.dma_mask = pdevinfo->dma_mask;
458 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
459 }
460
461 ret = platform_device_add_resources(pdev,
462 pdevinfo->res, pdevinfo->num_res);
Anton Vorontsov807508c2010-09-07 17:31:54 +0400463 if (ret)
464 goto err;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700465
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200466 ret = platform_device_add_data(pdev,
467 pdevinfo->data, pdevinfo->size_data);
Anton Vorontsov807508c2010-09-07 17:31:54 +0400468 if (ret)
469 goto err;
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200470
471 ret = platform_device_add(pdev);
472 if (ret) {
473err:
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100474 ACPI_COMPANION_SET(&pdev->dev, NULL);
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200475 kfree(pdev->dev.dma_mask);
476
477err_alloc:
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200478 platform_device_put(pdev);
479 return ERR_PTR(ret);
480 }
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700481
482 return pdev;
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700483}
Uwe Kleine-König01dcc602011-08-25 11:16:00 +0200484EXPORT_SYMBOL_GPL(platform_device_register_full);
Dmitry Baryshkovd8bf2542008-09-22 14:41:40 -0700485
Russell King00d3dcd2005-11-09 17:23:39 +0000486static int platform_drv_probe(struct device *_dev)
487{
488 struct platform_driver *drv = to_platform_driver(_dev->driver);
489 struct platform_device *dev = to_platform_device(_dev);
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100490 int ret;
Russell King00d3dcd2005-11-09 17:23:39 +0000491
Josh Cartwright9383f4c2014-02-13 22:00:43 -0600492 acpi_dev_pm_attach(_dev, true);
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100493
494 ret = drv->probe(dev);
Josh Cartwright9383f4c2014-02-13 22:00:43 -0600495 if (ret)
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100496 acpi_dev_pm_detach(_dev, true);
497
Johan Hovold3f9120b2013-09-23 16:27:26 +0200498 if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
499 dev_warn(_dev, "probe deferral not supported\n");
500 ret = -ENXIO;
501 }
502
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100503 return ret;
Russell King00d3dcd2005-11-09 17:23:39 +0000504}
505
David Brownellc67334f2006-11-16 23:28:47 -0800506static int platform_drv_probe_fail(struct device *_dev)
507{
508 return -ENXIO;
509}
510
Russell King00d3dcd2005-11-09 17:23:39 +0000511static int platform_drv_remove(struct device *_dev)
512{
513 struct platform_driver *drv = to_platform_driver(_dev->driver);
514 struct platform_device *dev = to_platform_device(_dev);
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100515 int ret;
Russell King00d3dcd2005-11-09 17:23:39 +0000516
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100517 ret = drv->remove(dev);
Josh Cartwright9383f4c2014-02-13 22:00:43 -0600518 acpi_dev_pm_detach(_dev, true);
Rafael J. Wysocki94d76d52012-11-26 10:04:53 +0100519
520 return ret;
Russell King00d3dcd2005-11-09 17:23:39 +0000521}
522
523static void platform_drv_shutdown(struct device *_dev)
524{
525 struct platform_driver *drv = to_platform_driver(_dev->driver);
526 struct platform_device *dev = to_platform_device(_dev);
527
528 drv->shutdown(dev);
Josh Cartwright9383f4c2014-02-13 22:00:43 -0600529 acpi_dev_pm_detach(_dev, true);
Russell King00d3dcd2005-11-09 17:23:39 +0000530}
531
Russell King00d3dcd2005-11-09 17:23:39 +0000532/**
Libo Chen94470572013-05-25 12:40:50 +0800533 * __platform_driver_register - register a driver for platform-level devices
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800534 * @drv: platform driver structure
Randy Dunlap08801f92013-07-14 17:43:06 -0700535 * @owner: owning module/driver
Russell King00d3dcd2005-11-09 17:23:39 +0000536 */
Libo Chen94470572013-05-25 12:40:50 +0800537int __platform_driver_register(struct platform_driver *drv,
538 struct module *owner)
Russell King00d3dcd2005-11-09 17:23:39 +0000539{
Libo Chen94470572013-05-25 12:40:50 +0800540 drv->driver.owner = owner;
Russell King00d3dcd2005-11-09 17:23:39 +0000541 drv->driver.bus = &platform_bus_type;
542 if (drv->probe)
543 drv->driver.probe = platform_drv_probe;
544 if (drv->remove)
545 drv->driver.remove = platform_drv_remove;
546 if (drv->shutdown)
547 drv->driver.shutdown = platform_drv_shutdown;
Magnus Damm783ea7d2009-06-04 22:13:33 +0200548
Russell King00d3dcd2005-11-09 17:23:39 +0000549 return driver_register(&drv->driver);
550}
Libo Chen94470572013-05-25 12:40:50 +0800551EXPORT_SYMBOL_GPL(__platform_driver_register);
Russell King00d3dcd2005-11-09 17:23:39 +0000552
553/**
Ben Hutchings3c31f072010-02-14 14:18:53 +0000554 * platform_driver_unregister - unregister a driver for platform-level devices
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800555 * @drv: platform driver structure
Russell King00d3dcd2005-11-09 17:23:39 +0000556 */
557void platform_driver_unregister(struct platform_driver *drv)
558{
559 driver_unregister(&drv->driver);
560}
561EXPORT_SYMBOL_GPL(platform_driver_unregister);
562
David Brownellc67334f2006-11-16 23:28:47 -0800563/**
564 * platform_driver_probe - register driver for non-hotpluggable device
565 * @drv: platform driver structure
Johan Hovold3f9120b2013-09-23 16:27:26 +0200566 * @probe: the driver probe routine, probably from an __init section
David Brownellc67334f2006-11-16 23:28:47 -0800567 *
568 * Use this instead of platform_driver_register() when you know the device
569 * is not hotpluggable and has already been registered, and you want to
570 * remove its run-once probe() infrastructure from memory after the driver
571 * has bound to the device.
572 *
573 * One typical use for this would be with drivers for controllers integrated
574 * into system-on-chip processors, where the controller devices have been
575 * configured as part of board setup.
576 *
Johan Hovold3f9120b2013-09-23 16:27:26 +0200577 * Note that this is incompatible with deferred probing.
Fabio Porcedda647c86d2013-03-26 10:35:15 +0100578 *
David Brownellc67334f2006-11-16 23:28:47 -0800579 * Returns zero if the driver registered and bound to a device, else returns
580 * a negative error code and with the driver not registered.
581 */
Andrew Mortonc63e0782006-12-04 14:56:36 -0800582int __init_or_module platform_driver_probe(struct platform_driver *drv,
David Brownellc67334f2006-11-16 23:28:47 -0800583 int (*probe)(struct platform_device *))
584{
585 int retval, code;
586
Johan Hovold3f9120b2013-09-23 16:27:26 +0200587 /*
588 * Prevent driver from requesting probe deferral to avoid further
589 * futile probe attempts.
590 */
591 drv->prevent_deferred_probe = true;
592
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700593 /* make sure driver won't have bind/unbind attributes */
594 drv->driver.suppress_bind_attrs = true;
595
David Brownellc67334f2006-11-16 23:28:47 -0800596 /* temporary section violation during probe() */
597 drv->probe = probe;
598 retval = code = platform_driver_register(drv);
599
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700600 /*
601 * Fixup that section violation, being paranoid about code scanning
David Brownellc67334f2006-11-16 23:28:47 -0800602 * the list of drivers in order to probe new devices. Check to see
603 * if the probe was successful, and make sure any forced probes of
604 * new devices fail.
605 */
Patrick Pannutod79d3242010-08-06 17:12:41 -0700606 spin_lock(&drv->driver.bus->p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800607 drv->probe = NULL;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800608 if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
David Brownellc67334f2006-11-16 23:28:47 -0800609 retval = -ENODEV;
610 drv->driver.probe = platform_drv_probe_fail;
Patrick Pannutod79d3242010-08-06 17:12:41 -0700611 spin_unlock(&drv->driver.bus->p->klist_drivers.k_lock);
David Brownellc67334f2006-11-16 23:28:47 -0800612
613 if (code != retval)
614 platform_driver_unregister(drv);
615 return retval;
616}
617EXPORT_SYMBOL_GPL(platform_driver_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800619/**
620 * platform_create_bundle - register driver and create corresponding device
621 * @driver: platform driver structure
622 * @probe: the driver probe routine, probably from an __init section
623 * @res: set of resources that needs to be allocated for the device
624 * @n_res: number of resources
625 * @data: platform specific data for this platform device
626 * @size: size of platform specific data
627 *
628 * Use this in legacy-style modules that probe hardware directly and
629 * register a single platform device and corresponding platform driver.
Jani Nikulaf0eae0e2010-03-11 18:11:45 +0200630 *
631 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800632 */
633struct platform_device * __init_or_module platform_create_bundle(
634 struct platform_driver *driver,
635 int (*probe)(struct platform_device *),
636 struct resource *res, unsigned int n_res,
637 const void *data, size_t size)
638{
639 struct platform_device *pdev;
640 int error;
641
642 pdev = platform_device_alloc(driver->driver.name, -1);
643 if (!pdev) {
644 error = -ENOMEM;
645 goto err_out;
646 }
647
Anton Vorontsov807508c2010-09-07 17:31:54 +0400648 error = platform_device_add_resources(pdev, res, n_res);
649 if (error)
650 goto err_pdev_put;
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800651
Anton Vorontsov807508c2010-09-07 17:31:54 +0400652 error = platform_device_add_data(pdev, data, size);
653 if (error)
654 goto err_pdev_put;
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800655
656 error = platform_device_add(pdev);
657 if (error)
658 goto err_pdev_put;
659
660 error = platform_driver_probe(driver, probe);
661 if (error)
662 goto err_pdev_del;
663
664 return pdev;
665
666err_pdev_del:
667 platform_device_del(pdev);
668err_pdev_put:
669 platform_device_put(pdev);
670err_out:
671 return ERR_PTR(error);
672}
673EXPORT_SYMBOL_GPL(platform_create_bundle);
674
David Brownella0245f72006-05-29 10:37:33 -0700675/* modalias support enables more hands-off userspace setup:
676 * (a) environment variable lets new-style hotplug events work once system is
677 * fully running: "modprobe $MODALIAS"
678 * (b) sysfs attribute lets new-style coldplug recover from hotplug events
679 * mishandled before system is fully running: "modprobe $(cat modalias)"
680 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800681static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
682 char *buf)
David Brownella0245f72006-05-29 10:37:33 -0700683{
684 struct platform_device *pdev = to_platform_device(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800685 int len;
686
Zhang Ruib9f73062014-01-14 16:46:38 +0800687 len = of_device_get_modalias(dev, buf, PAGE_SIZE -1);
688 if (len != -ENODEV)
689 return len;
690
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800691 len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
692 if (len != -ENODEV)
693 return len;
694
695 len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700696
697 return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
698}
Greg Kroah-Hartmand06262e2013-08-23 14:24:37 -0700699static DEVICE_ATTR_RO(modalias);
David Brownella0245f72006-05-29 10:37:33 -0700700
Greg Kroah-Hartmand06262e2013-08-23 14:24:37 -0700701static struct attribute *platform_dev_attrs[] = {
702 &dev_attr_modalias.attr,
703 NULL,
David Brownella0245f72006-05-29 10:37:33 -0700704};
Greg Kroah-Hartmand06262e2013-08-23 14:24:37 -0700705ATTRIBUTE_GROUPS(platform_dev);
David Brownella0245f72006-05-29 10:37:33 -0700706
Kay Sievers7eff2e72007-08-14 15:15:12 +0200707static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownella0245f72006-05-29 10:37:33 -0700708{
709 struct platform_device *pdev = to_platform_device(dev);
Grant Likelyeca39302010-06-08 07:48:21 -0600710 int rc;
711
712 /* Some devices have extra OF data and an OF-style MODALIAS */
Fabio Porcedda0258e182013-03-26 10:35:16 +0100713 rc = of_device_uevent_modalias(dev, env);
Grant Likelyeca39302010-06-08 07:48:21 -0600714 if (rc != -ENODEV)
715 return rc;
David Brownella0245f72006-05-29 10:37:33 -0700716
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800717 rc = acpi_device_uevent_modalias(dev, env);
718 if (rc != -ENODEV)
719 return rc;
720
Eric Miao57fee4a2009-02-04 11:52:40 +0800721 add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
Sebastian Andrzej Siewior0a268132011-08-15 16:51:22 +0200722 pdev->name);
David Brownella0245f72006-05-29 10:37:33 -0700723 return 0;
724}
725
Eric Miao57fee4a2009-02-04 11:52:40 +0800726static const struct platform_device_id *platform_match_id(
Uwe Kleine-König831fad22010-01-26 09:35:00 +0100727 const struct platform_device_id *id,
Eric Miao57fee4a2009-02-04 11:52:40 +0800728 struct platform_device *pdev)
729{
730 while (id->name[0]) {
731 if (strcmp(pdev->name, id->name) == 0) {
732 pdev->id_entry = id;
733 return id;
734 }
735 id++;
736 }
737 return NULL;
738}
739
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800741 * platform_match - bind platform device to platform driver.
742 * @dev: device.
743 * @drv: driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800745 * Platform device IDs are assumed to be encoded like this:
746 * "<name><instance>", where <name> is a short description of the type of
747 * device, like "pci" or "floppy", and <instance> is the enumerated
748 * instance of the device, like '0' or '42'. Driver IDs are simply
749 * "<name>". So, extract the <name> from the platform_device structure,
750 * and compare it against the name of the driver. Return whether they match
751 * or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800753static int platform_match(struct device *dev, struct device_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754{
Eric Miao71b3e0c2009-01-31 22:47:44 +0800755 struct platform_device *pdev = to_platform_device(dev);
Eric Miao57fee4a2009-02-04 11:52:40 +0800756 struct platform_driver *pdrv = to_platform_driver(drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Grant Likely05212152010-06-08 07:48:20 -0600758 /* Attempt an OF style match first */
759 if (of_driver_match_device(dev, drv))
760 return 1;
761
Mika Westerberg91e56872012-10-31 22:45:02 +0100762 /* Then try ACPI style match */
763 if (acpi_driver_match_device(dev, drv))
764 return 1;
765
Grant Likely05212152010-06-08 07:48:20 -0600766 /* Then try to match against the id table */
Eric Miao57fee4a2009-02-04 11:52:40 +0800767 if (pdrv->id_table)
768 return platform_match_id(pdrv->id_table, pdev) != NULL;
769
770 /* fall-back to driver name match */
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100771 return (strcmp(pdev->name, drv->name) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772}
773
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200774#ifdef CONFIG_PM_SLEEP
775
776static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777{
Magnus Damm783ea7d2009-06-04 22:13:33 +0200778 struct platform_driver *pdrv = to_platform_driver(dev->driver);
779 struct platform_device *pdev = to_platform_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 int ret = 0;
781
Magnus Damm783ea7d2009-06-04 22:13:33 +0200782 if (dev->driver && pdrv->suspend)
783 ret = pdrv->suspend(pdev, mesg);
David Brownell386415d2006-09-03 13:16:45 -0700784
785 return ret;
786}
787
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200788static int platform_legacy_resume(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789{
Magnus Damm783ea7d2009-06-04 22:13:33 +0200790 struct platform_driver *pdrv = to_platform_driver(dev->driver);
791 struct platform_device *pdev = to_platform_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 int ret = 0;
793
Magnus Damm783ea7d2009-06-04 22:13:33 +0200794 if (dev->driver && pdrv->resume)
795 ret = pdrv->resume(pdev);
Russell King9480e302005-10-28 09:52:56 -0700796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 return ret;
798}
799
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200800#endif /* CONFIG_PM_SLEEP */
Magnus Damm9d730222009-08-20 20:25:32 +0200801
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200802#ifdef CONFIG_SUSPEND
803
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200804int platform_pm_suspend(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200805{
806 struct device_driver *drv = dev->driver;
807 int ret = 0;
808
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200809 if (!drv)
810 return 0;
811
812 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200813 if (drv->pm->suspend)
814 ret = drv->pm->suspend(dev);
815 } else {
816 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
817 }
818
819 return ret;
820}
821
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200822int platform_pm_resume(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200823{
824 struct device_driver *drv = dev->driver;
825 int ret = 0;
826
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200827 if (!drv)
828 return 0;
829
830 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200831 if (drv->pm->resume)
832 ret = drv->pm->resume(dev);
833 } else {
834 ret = platform_legacy_resume(dev);
835 }
836
837 return ret;
838}
839
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200840#endif /* CONFIG_SUSPEND */
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200841
Rafael J. Wysocki1f112ce2011-04-11 22:54:42 +0200842#ifdef CONFIG_HIBERNATE_CALLBACKS
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200843
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200844int platform_pm_freeze(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200845{
846 struct device_driver *drv = dev->driver;
847 int ret = 0;
848
849 if (!drv)
850 return 0;
851
852 if (drv->pm) {
853 if (drv->pm->freeze)
854 ret = drv->pm->freeze(dev);
855 } else {
856 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
857 }
858
859 return ret;
860}
861
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200862int platform_pm_thaw(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200863{
864 struct device_driver *drv = dev->driver;
865 int ret = 0;
866
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200867 if (!drv)
868 return 0;
869
870 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200871 if (drv->pm->thaw)
872 ret = drv->pm->thaw(dev);
873 } else {
874 ret = platform_legacy_resume(dev);
875 }
876
877 return ret;
878}
879
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200880int platform_pm_poweroff(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200881{
882 struct device_driver *drv = dev->driver;
883 int ret = 0;
884
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200885 if (!drv)
886 return 0;
887
888 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200889 if (drv->pm->poweroff)
890 ret = drv->pm->poweroff(dev);
891 } else {
892 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
893 }
894
895 return ret;
896}
897
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200898int platform_pm_restore(struct device *dev)
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200899{
900 struct device_driver *drv = dev->driver;
901 int ret = 0;
902
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200903 if (!drv)
904 return 0;
905
906 if (drv->pm) {
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200907 if (drv->pm->restore)
908 ret = drv->pm->restore(dev);
909 } else {
910 ret = platform_legacy_resume(dev);
911 }
912
913 return ret;
914}
915
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200916#endif /* CONFIG_HIBERNATE_CALLBACKS */
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200917
Dmitry Torokhovd9ab7712009-07-22 00:37:25 +0200918static const struct dev_pm_ops platform_dev_pm_ops = {
Rafael J. Wysocki8b313a32011-04-29 00:36:32 +0200919 .runtime_suspend = pm_generic_runtime_suspend,
920 .runtime_resume = pm_generic_runtime_resume,
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200921 USE_PLATFORM_PM_SLEEP_OPS
Rafael J. Wysocki25e18492008-05-21 01:40:43 +0200922};
923
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924struct bus_type platform_bus_type = {
925 .name = "platform",
Greg Kroah-Hartmand06262e2013-08-23 14:24:37 -0700926 .dev_groups = platform_dev_groups,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 .match = platform_match,
David Brownella0245f72006-05-29 10:37:33 -0700928 .uevent = platform_uevent,
Magnus Damm9d730222009-08-20 20:25:32 +0200929 .pm = &platform_dev_pm_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930};
Dmitry Torokhova96b2042005-12-10 01:36:28 -0500931EXPORT_SYMBOL_GPL(platform_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
933int __init platform_bus_init(void)
934{
Cornelia Huckfbfb1442006-11-27 10:35:08 +0100935 int error;
936
Magnus Damm13977092009-03-30 14:37:25 -0700937 early_platform_cleanup();
938
Cornelia Huckfbfb1442006-11-27 10:35:08 +0100939 error = device_register(&platform_bus);
940 if (error)
941 return error;
942 error = bus_register(&platform_bus_type);
943 if (error)
944 device_unregister(&platform_bus);
945 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946}
947
948#ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
949u64 dma_get_required_mask(struct device *dev)
950{
951 u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
952 u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
953 u64 mask;
954
955 if (!high_totalram) {
956 /* convert to mask just covering totalram */
957 low_totalram = (1 << (fls(low_totalram) - 1));
958 low_totalram += low_totalram - 1;
959 mask = low_totalram;
960 } else {
961 high_totalram = (1 << (fls(high_totalram) - 1));
962 high_totalram += high_totalram - 1;
963 mask = (((u64)high_totalram) << 32) + 0xffffffff;
964 }
James Bottomleye88a0c22008-03-09 11:57:56 -0500965 return mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966}
967EXPORT_SYMBOL_GPL(dma_get_required_mask);
968#endif
Magnus Damm13977092009-03-30 14:37:25 -0700969
970static __initdata LIST_HEAD(early_platform_driver_list);
971static __initdata LIST_HEAD(early_platform_device_list);
972
973/**
Magnus Damm4d26e1392010-03-10 20:50:38 +0900974 * early_platform_driver_register - register early platform driver
Randy Dunlapd86c1302009-04-21 07:22:53 -0700975 * @epdrv: early_platform driver structure
Magnus Damm13977092009-03-30 14:37:25 -0700976 * @buf: string passed from early_param()
Magnus Damm4d26e1392010-03-10 20:50:38 +0900977 *
978 * Helper function for early_platform_init() / early_platform_init_buffer()
Magnus Damm13977092009-03-30 14:37:25 -0700979 */
980int __init early_platform_driver_register(struct early_platform_driver *epdrv,
981 char *buf)
982{
Magnus Dammc60e0502009-11-27 17:38:51 +0900983 char *tmp;
Magnus Damm13977092009-03-30 14:37:25 -0700984 int n;
985
986 /* Simply add the driver to the end of the global list.
987 * Drivers will by default be put on the list in compiled-in order.
988 */
989 if (!epdrv->list.next) {
990 INIT_LIST_HEAD(&epdrv->list);
991 list_add_tail(&epdrv->list, &early_platform_driver_list);
992 }
993
994 /* If the user has specified device then make sure the driver
995 * gets prioritized. The driver of the last device specified on
996 * command line will be put first on the list.
997 */
998 n = strlen(epdrv->pdrv->driver.name);
999 if (buf && !strncmp(buf, epdrv->pdrv->driver.name, n)) {
1000 list_move(&epdrv->list, &early_platform_driver_list);
1001
Magnus Dammc60e0502009-11-27 17:38:51 +09001002 /* Allow passing parameters after device name */
1003 if (buf[n] == '\0' || buf[n] == ',')
Magnus Damm13977092009-03-30 14:37:25 -07001004 epdrv->requested_id = -1;
Magnus Dammc60e0502009-11-27 17:38:51 +09001005 else {
1006 epdrv->requested_id = simple_strtoul(&buf[n + 1],
1007 &tmp, 10);
1008
1009 if (buf[n] != '.' || (tmp == &buf[n + 1])) {
1010 epdrv->requested_id = EARLY_PLATFORM_ID_ERROR;
1011 n = 0;
1012 } else
1013 n += strcspn(&buf[n + 1], ",") + 1;
1014 }
1015
1016 if (buf[n] == ',')
1017 n++;
1018
1019 if (epdrv->bufsize) {
1020 memcpy(epdrv->buffer, &buf[n],
1021 min_t(int, epdrv->bufsize, strlen(&buf[n]) + 1));
1022 epdrv->buffer[epdrv->bufsize - 1] = '\0';
1023 }
Magnus Damm13977092009-03-30 14:37:25 -07001024 }
1025
1026 return 0;
1027}
1028
1029/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001030 * early_platform_add_devices - adds a number of early platform devices
Magnus Damm13977092009-03-30 14:37:25 -07001031 * @devs: array of early platform devices to add
1032 * @num: number of early platform devices in array
Magnus Damm4d26e1392010-03-10 20:50:38 +09001033 *
1034 * Used by early architecture code to register early platform devices and
1035 * their platform data.
Magnus Damm13977092009-03-30 14:37:25 -07001036 */
1037void __init early_platform_add_devices(struct platform_device **devs, int num)
1038{
1039 struct device *dev;
1040 int i;
1041
1042 /* simply add the devices to list */
1043 for (i = 0; i < num; i++) {
1044 dev = &devs[i]->dev;
1045
1046 if (!dev->devres_head.next) {
Rafael J. Wysockibed2b422012-08-06 01:45:11 +02001047 pm_runtime_early_init(dev);
Magnus Damm13977092009-03-30 14:37:25 -07001048 INIT_LIST_HEAD(&dev->devres_head);
1049 list_add_tail(&dev->devres_head,
1050 &early_platform_device_list);
1051 }
1052 }
1053}
1054
1055/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001056 * early_platform_driver_register_all - register early platform drivers
Magnus Damm13977092009-03-30 14:37:25 -07001057 * @class_str: string to identify early platform driver class
Magnus Damm4d26e1392010-03-10 20:50:38 +09001058 *
1059 * Used by architecture code to register all early platform drivers
1060 * for a certain class. If omitted then only early platform drivers
1061 * with matching kernel command line class parameters will be registered.
Magnus Damm13977092009-03-30 14:37:25 -07001062 */
1063void __init early_platform_driver_register_all(char *class_str)
1064{
1065 /* The "class_str" parameter may or may not be present on the kernel
1066 * command line. If it is present then there may be more than one
1067 * matching parameter.
1068 *
1069 * Since we register our early platform drivers using early_param()
1070 * we need to make sure that they also get registered in the case
1071 * when the parameter is missing from the kernel command line.
1072 *
1073 * We use parse_early_options() to make sure the early_param() gets
1074 * called at least once. The early_param() may be called more than
1075 * once since the name of the preferred device may be specified on
1076 * the kernel command line. early_platform_driver_register() handles
1077 * this case for us.
1078 */
1079 parse_early_options(class_str);
1080}
1081
1082/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001083 * early_platform_match - find early platform device matching driver
Randy Dunlapd86c1302009-04-21 07:22:53 -07001084 * @epdrv: early platform driver structure
Magnus Damm13977092009-03-30 14:37:25 -07001085 * @id: id to match against
1086 */
Hanjun Guoa8257912013-08-17 20:42:25 +08001087static struct platform_device * __init
Magnus Damm13977092009-03-30 14:37:25 -07001088early_platform_match(struct early_platform_driver *epdrv, int id)
1089{
1090 struct platform_device *pd;
1091
1092 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1093 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1094 if (pd->id == id)
1095 return pd;
1096
1097 return NULL;
1098}
1099
1100/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001101 * early_platform_left - check if early platform driver has matching devices
Randy Dunlapd86c1302009-04-21 07:22:53 -07001102 * @epdrv: early platform driver structure
Magnus Damm13977092009-03-30 14:37:25 -07001103 * @id: return true if id or above exists
1104 */
Hanjun Guoa8257912013-08-17 20:42:25 +08001105static int __init early_platform_left(struct early_platform_driver *epdrv,
Magnus Damm13977092009-03-30 14:37:25 -07001106 int id)
1107{
1108 struct platform_device *pd;
1109
1110 list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1111 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1112 if (pd->id >= id)
1113 return 1;
1114
1115 return 0;
1116}
1117
1118/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001119 * early_platform_driver_probe_id - probe drivers matching class_str and id
Magnus Damm13977092009-03-30 14:37:25 -07001120 * @class_str: string to identify early platform driver class
1121 * @id: id to match against
1122 * @nr_probe: number of platform devices to successfully probe before exiting
1123 */
1124static int __init early_platform_driver_probe_id(char *class_str,
1125 int id,
1126 int nr_probe)
1127{
1128 struct early_platform_driver *epdrv;
1129 struct platform_device *match;
1130 int match_id;
1131 int n = 0;
1132 int left = 0;
1133
1134 list_for_each_entry(epdrv, &early_platform_driver_list, list) {
1135 /* only use drivers matching our class_str */
1136 if (strcmp(class_str, epdrv->class_str))
1137 continue;
1138
1139 if (id == -2) {
1140 match_id = epdrv->requested_id;
1141 left = 1;
1142
1143 } else {
1144 match_id = id;
1145 left += early_platform_left(epdrv, id);
1146
1147 /* skip requested id */
1148 switch (epdrv->requested_id) {
1149 case EARLY_PLATFORM_ID_ERROR:
1150 case EARLY_PLATFORM_ID_UNSET:
1151 break;
1152 default:
1153 if (epdrv->requested_id == id)
1154 match_id = EARLY_PLATFORM_ID_UNSET;
1155 }
1156 }
1157
1158 switch (match_id) {
1159 case EARLY_PLATFORM_ID_ERROR:
Fabio Porcedda0258e182013-03-26 10:35:16 +01001160 pr_warn("%s: unable to parse %s parameter\n",
1161 class_str, epdrv->pdrv->driver.name);
Magnus Damm13977092009-03-30 14:37:25 -07001162 /* fall-through */
1163 case EARLY_PLATFORM_ID_UNSET:
1164 match = NULL;
1165 break;
1166 default:
1167 match = early_platform_match(epdrv, match_id);
1168 }
1169
1170 if (match) {
Paul Mundta636ee72010-03-09 06:57:53 +00001171 /*
1172 * Set up a sensible init_name to enable
1173 * dev_name() and others to be used before the
1174 * rest of the driver core is initialized.
1175 */
Paul Mundt06fe53b2010-05-13 17:56:56 +09001176 if (!match->dev.init_name && slab_is_available()) {
Paul Mundta636ee72010-03-09 06:57:53 +00001177 if (match->id != -1)
Paul Mundtbd050862010-03-29 15:51:35 +09001178 match->dev.init_name =
1179 kasprintf(GFP_KERNEL, "%s.%d",
1180 match->name,
1181 match->id);
Paul Mundta636ee72010-03-09 06:57:53 +00001182 else
Paul Mundtbd050862010-03-29 15:51:35 +09001183 match->dev.init_name =
1184 kasprintf(GFP_KERNEL, "%s",
1185 match->name);
Paul Mundta636ee72010-03-09 06:57:53 +00001186
Paul Mundta636ee72010-03-09 06:57:53 +00001187 if (!match->dev.init_name)
1188 return -ENOMEM;
1189 }
Paul Mundtbd050862010-03-29 15:51:35 +09001190
Magnus Damm13977092009-03-30 14:37:25 -07001191 if (epdrv->pdrv->probe(match))
Fabio Porcedda0258e182013-03-26 10:35:16 +01001192 pr_warn("%s: unable to probe %s early.\n",
1193 class_str, match->name);
Magnus Damm13977092009-03-30 14:37:25 -07001194 else
1195 n++;
1196 }
1197
1198 if (n >= nr_probe)
1199 break;
1200 }
1201
1202 if (left)
1203 return n;
1204 else
1205 return -ENODEV;
1206}
1207
1208/**
Magnus Damm4d26e1392010-03-10 20:50:38 +09001209 * early_platform_driver_probe - probe a class of registered drivers
Magnus Damm13977092009-03-30 14:37:25 -07001210 * @class_str: string to identify early platform driver class
1211 * @nr_probe: number of platform devices to successfully probe before exiting
1212 * @user_only: only probe user specified early platform devices
Magnus Damm4d26e1392010-03-10 20:50:38 +09001213 *
1214 * Used by architecture code to probe registered early platform drivers
1215 * within a certain class. For probe to happen a registered early platform
1216 * device matching a registered early platform driver is needed.
Magnus Damm13977092009-03-30 14:37:25 -07001217 */
1218int __init early_platform_driver_probe(char *class_str,
1219 int nr_probe,
1220 int user_only)
1221{
1222 int k, n, i;
1223
1224 n = 0;
1225 for (i = -2; n < nr_probe; i++) {
1226 k = early_platform_driver_probe_id(class_str, i, nr_probe - n);
1227
1228 if (k < 0)
1229 break;
1230
1231 n += k;
1232
1233 if (user_only)
1234 break;
1235 }
1236
1237 return n;
1238}
1239
1240/**
1241 * early_platform_cleanup - clean up early platform code
1242 */
1243void __init early_platform_cleanup(void)
1244{
1245 struct platform_device *pd, *pd2;
1246
1247 /* clean up the devres list used to chain devices */
1248 list_for_each_entry_safe(pd, pd2, &early_platform_device_list,
1249 dev.devres_head) {
1250 list_del(&pd->dev.devres_head);
1251 memset(&pd->dev.devres_head, 0, sizeof(pd->dev.devres_head));
1252 }
1253}
1254