blob: 9abf1db6aea652ee28152f39bd7e024995f07c75 [file] [log] [blame]
Russell Kingbbbf5082005-10-29 22:17:58 +01001/*
2 * platform_device.h - generic, centralized driver model
3 *
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 *
6 * This file is released under the GPLv2
7 *
8 * See Documentation/driver-model/ for more information.
9 */
10
11#ifndef _PLATFORM_DEVICE_H_
12#define _PLATFORM_DEVICE_H_
13
14#include <linux/device.h>
Eric Miao57fee4a2009-02-04 11:52:40 +080015#include <linux/mod_devicetable.h>
Russell Kingbbbf5082005-10-29 22:17:58 +010016
Jean Delvare689ae232012-07-27 22:14:59 +020017#define PLATFORM_DEVID_NONE (-1)
18#define PLATFORM_DEVID_AUTO (-2)
19
Samuel Ortize710d7d2011-04-08 00:43:01 +020020struct mfd_cell;
21
Russell Kingbbbf5082005-10-29 22:17:58 +010022struct platform_device {
Fabio Porcedda6ae07f22013-03-26 10:35:17 +010023 const char *name;
Jean Delvare1359555e2007-09-09 12:54:16 +020024 int id;
Jean Delvare689ae232012-07-27 22:14:59 +020025 bool id_auto;
Russell Kingbbbf5082005-10-29 22:17:58 +010026 struct device dev;
27 u32 num_resources;
Fabio Porcedda6ae07f22013-03-26 10:35:17 +010028 struct resource *resource;
Eric Miao57fee4a2009-02-04 11:52:40 +080029
Eric Miao3d03ba42010-01-01 15:43:28 +080030 const struct platform_device_id *id_entry;
Magnus Dammd7aacad2009-07-08 13:21:31 +020031
Samuel Ortize710d7d2011-04-08 00:43:01 +020032 /* MFD cell pointer */
33 struct mfd_cell *mfd_cell;
34
Magnus Dammd7aacad2009-07-08 13:21:31 +020035 /* arch specific additions */
36 struct pdev_archdata archdata;
Russell Kingbbbf5082005-10-29 22:17:58 +010037};
38
Eric Miao57fee4a2009-02-04 11:52:40 +080039#define platform_get_device_id(pdev) ((pdev)->id_entry)
40
Russell Kingbbbf5082005-10-29 22:17:58 +010041#define to_platform_device(x) container_of((x), struct platform_device, dev)
42
43extern int platform_device_register(struct platform_device *);
44extern void platform_device_unregister(struct platform_device *);
45
46extern struct bus_type platform_bus_type;
47extern struct device platform_bus;
48
Kumar Galaa77ce812011-06-10 01:52:57 -050049extern void arch_setup_pdev_archdata(struct platform_device *);
Fabio Porcedda6ae07f22013-03-26 10:35:17 +010050extern struct resource *platform_get_resource(struct platform_device *,
51 unsigned int, unsigned int);
Russell Kingbbbf5082005-10-29 22:17:58 +010052extern int platform_get_irq(struct platform_device *, unsigned int);
Fabio Porcedda6ae07f22013-03-26 10:35:17 +010053extern struct resource *platform_get_resource_byname(struct platform_device *,
54 unsigned int,
55 const char *);
Linus Walleijc0afe7b2009-04-27 02:38:16 +020056extern int platform_get_irq_byname(struct platform_device *, const char *);
Russell Kingbbbf5082005-10-29 22:17:58 +010057extern int platform_add_devices(struct platform_device **, int);
58
Uwe Kleine-König01dcc602011-08-25 11:16:00 +020059struct platform_device_info {
60 struct device *parent;
Rafael J. Wysocki863f9f32012-11-21 00:21:59 +010061 struct acpi_dev_node acpi_node;
Uwe Kleine-König01dcc602011-08-25 11:16:00 +020062
63 const char *name;
64 int id;
65
66 const struct resource *res;
67 unsigned int num_res;
68
69 const void *data;
70 size_t size_data;
71 u64 dma_mask;
72};
73extern struct platform_device *platform_device_register_full(
Uwe Kleine-König5a3072b2011-12-08 22:53:29 +010074 const struct platform_device_info *pdevinfo);
Uwe Kleine-König01dcc602011-08-25 11:16:00 +020075
76/**
77 * platform_device_register_resndata - add a platform-level device with
78 * resources and platform-specific data
79 *
80 * @parent: parent device for the device we're adding
81 * @name: base name of the device we're adding
82 * @id: instance id
83 * @res: set of resources that needs to be allocated for the device
84 * @num: number of resources
85 * @data: platform specific data for this platform device
86 * @size: size of platform specific data
87 *
88 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
89 */
90static inline struct platform_device *platform_device_register_resndata(
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +020091 struct device *parent, const char *name, int id,
92 const struct resource *res, unsigned int num,
Uwe Kleine-König01dcc602011-08-25 11:16:00 +020093 const void *data, size_t size) {
94
95 struct platform_device_info pdevinfo = {
96 .parent = parent,
97 .name = name,
98 .id = id,
99 .res = res,
100 .num_res = num,
101 .data = data,
102 .size_data = size,
103 .dma_mask = 0,
104 };
105
106 return platform_device_register_full(&pdevinfo);
107}
Uwe Kleine-König44f28bd2010-06-21 16:11:44 +0200108
109/**
110 * platform_device_register_simple - add a platform-level device and its resources
111 * @name: base name of the device we're adding
112 * @id: instance id
113 * @res: set of resources that needs to be allocated for the device
114 * @num: number of resources
115 *
116 * This function creates a simple platform device that requires minimal
117 * resource and memory management. Canned release function freeing memory
118 * allocated for the device allows drivers using such devices to be
119 * unloaded without waiting for the last reference to the device to be
120 * dropped.
121 *
122 * This interface is primarily intended for use with legacy drivers which
123 * probe hardware directly. Because such drivers create sysfs device nodes
124 * themselves, rather than letting system infrastructure handle such device
125 * enumeration tasks, they don't fully conform to the Linux driver model.
126 * In particular, when such drivers are built as modules, they can't be
127 * "hotplugged".
128 *
129 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
130 */
131static inline struct platform_device *platform_device_register_simple(
132 const char *name, int id,
133 const struct resource *res, unsigned int num)
134{
135 return platform_device_register_resndata(NULL, name, id,
136 res, num, NULL, 0);
137}
138
139/**
140 * platform_device_register_data - add a platform-level device with platform-specific data
141 * @parent: parent device for the device we're adding
142 * @name: base name of the device we're adding
143 * @id: instance id
144 * @data: platform specific data for this platform device
145 * @size: size of platform specific data
146 *
147 * This function creates a simple platform device that requires minimal
148 * resource and memory management. Canned release function freeing memory
149 * allocated for the device allows drivers using such devices to be
150 * unloaded without waiting for the last reference to the device to be
151 * dropped.
152 *
153 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
154 */
155static inline struct platform_device *platform_device_register_data(
156 struct device *parent, const char *name, int id,
157 const void *data, size_t size)
158{
159 return platform_device_register_resndata(parent, name, id,
160 NULL, 0, data, size);
161}
Russell Kingbbbf5082005-10-29 22:17:58 +0100162
Jean Delvare1359555e2007-09-09 12:54:16 +0200163extern struct platform_device *platform_device_alloc(const char *name, int id);
Geert Uytterhoeven0b7f1a72009-01-28 21:01:02 +0100164extern int platform_device_add_resources(struct platform_device *pdev,
165 const struct resource *res,
166 unsigned int num);
Fabio Porcedda6ae07f22013-03-26 10:35:17 +0100167extern int platform_device_add_data(struct platform_device *pdev,
168 const void *data, size_t size);
Russell King37c12e72005-11-05 21:19:33 +0000169extern int platform_device_add(struct platform_device *pdev);
Dmitry Torokhov93ce3062005-12-10 01:36:27 -0500170extern void platform_device_del(struct platform_device *pdev);
Russell King37c12e72005-11-05 21:19:33 +0000171extern void platform_device_put(struct platform_device *pdev);
172
Russell King00d3dcd2005-11-09 17:23:39 +0000173struct platform_driver {
174 int (*probe)(struct platform_device *);
175 int (*remove)(struct platform_device *);
176 void (*shutdown)(struct platform_device *);
177 int (*suspend)(struct platform_device *, pm_message_t state);
178 int (*resume)(struct platform_device *);
179 struct device_driver driver;
Uwe Kleine-König831fad22010-01-26 09:35:00 +0100180 const struct platform_device_id *id_table;
Russell King00d3dcd2005-11-09 17:23:39 +0000181};
182
183extern int platform_driver_register(struct platform_driver *);
184extern void platform_driver_unregister(struct platform_driver *);
185
David Brownellc67334f2006-11-16 23:28:47 -0800186/* non-hotpluggable platform devices may use this so that probe() and
187 * its support may live in __init sections, conserving runtime memory.
188 */
189extern int platform_driver_probe(struct platform_driver *driver,
190 int (*probe)(struct platform_device *));
191
Marc Kleine-Budde71d64292011-02-16 23:23:27 +0100192static inline void *platform_get_drvdata(const struct platform_device *pdev)
193{
194 return dev_get_drvdata(&pdev->dev);
195}
196
Fabio Porcedda6ae07f22013-03-26 10:35:17 +0100197static inline void platform_set_drvdata(struct platform_device *pdev,
198 void *data)
Marc Kleine-Budde71d64292011-02-16 23:23:27 +0100199{
200 dev_set_drvdata(&pdev->dev, data);
201}
Russell King00d3dcd2005-11-09 17:23:39 +0000202
Grant Likely940ab882011-10-05 11:29:49 -0600203/* module_platform_driver() - Helper macro for drivers that don't do
204 * anything special in module init/exit. This eliminates a lot of
205 * boilerplate. Each module may only use this macro once, and
206 * calling it replaces module_init() and module_exit()
207 */
208#define module_platform_driver(__platform_driver) \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +0100209 module_driver(__platform_driver, platform_driver_register, \
210 platform_driver_unregister)
Grant Likely940ab882011-10-05 11:29:49 -0600211
Fabio Porceddabab734f2013-01-09 12:15:26 +0100212/* module_platform_driver_probe() - Helper macro for drivers that don't do
213 * anything special in module init/exit. This eliminates a lot of
214 * boilerplate. Each module may only use this macro once, and
215 * calling it replaces module_init() and module_exit()
216 */
217#define module_platform_driver_probe(__platform_driver, __platform_probe) \
218static int __init __platform_driver##_init(void) \
219{ \
220 return platform_driver_probe(&(__platform_driver), \
221 __platform_probe); \
222} \
223module_init(__platform_driver##_init); \
224static void __exit __platform_driver##_exit(void) \
225{ \
226 platform_driver_unregister(&(__platform_driver)); \
227} \
228module_exit(__platform_driver##_exit);
229
Fabio Porcedda6ae07f22013-03-26 10:35:17 +0100230extern struct platform_device *platform_create_bundle(
231 struct platform_driver *driver, int (*probe)(struct platform_device *),
232 struct resource *res, unsigned int n_res,
233 const void *data, size_t size);
Dmitry Torokhovecdf6ce2009-12-29 20:11:20 -0800234
Magnus Damm13977092009-03-30 14:37:25 -0700235/* early platform driver interface */
236struct early_platform_driver {
237 const char *class_str;
238 struct platform_driver *pdrv;
239 struct list_head list;
240 int requested_id;
Magnus Dammc60e0502009-11-27 17:38:51 +0900241 char *buffer;
242 int bufsize;
Magnus Damm13977092009-03-30 14:37:25 -0700243};
244
245#define EARLY_PLATFORM_ID_UNSET -2
246#define EARLY_PLATFORM_ID_ERROR -3
247
248extern int early_platform_driver_register(struct early_platform_driver *epdrv,
249 char *buf);
250extern void early_platform_add_devices(struct platform_device **devs, int num);
251
252static inline int is_early_platform_device(struct platform_device *pdev)
253{
254 return !pdev->dev.driver;
255}
256
257extern void early_platform_driver_register_all(char *class_str);
258extern int early_platform_driver_probe(char *class_str,
259 int nr_probe, int user_only);
260extern void early_platform_cleanup(void);
261
Magnus Dammc60e0502009-11-27 17:38:51 +0900262#define early_platform_init(class_string, platdrv) \
263 early_platform_init_buffer(class_string, platdrv, NULL, 0)
Magnus Damm13977092009-03-30 14:37:25 -0700264
265#ifndef MODULE
Magnus Dammc60e0502009-11-27 17:38:51 +0900266#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
Magnus Damm13977092009-03-30 14:37:25 -0700267static __initdata struct early_platform_driver early_driver = { \
268 .class_str = class_string, \
Magnus Dammc60e0502009-11-27 17:38:51 +0900269 .buffer = buf, \
270 .bufsize = bufsiz, \
271 .pdrv = platdrv, \
Magnus Damm13977092009-03-30 14:37:25 -0700272 .requested_id = EARLY_PLATFORM_ID_UNSET, \
273}; \
Magnus Dammc60e0502009-11-27 17:38:51 +0900274static int __init early_platform_driver_setup_func(char *buffer) \
Magnus Damm13977092009-03-30 14:37:25 -0700275{ \
Magnus Dammc60e0502009-11-27 17:38:51 +0900276 return early_platform_driver_register(&early_driver, buffer); \
Magnus Damm13977092009-03-30 14:37:25 -0700277} \
278early_param(class_string, early_platform_driver_setup_func)
279#else /* MODULE */
Magnus Dammc60e0502009-11-27 17:38:51 +0900280#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
281static inline char *early_platform_driver_setup_func(void) \
282{ \
283 return bufsiz ? buf : NULL; \
284}
Magnus Damm13977092009-03-30 14:37:25 -0700285#endif /* MODULE */
286
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200287#ifdef CONFIG_SUSPEND
288extern int platform_pm_suspend(struct device *dev);
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200289extern int platform_pm_resume(struct device *dev);
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200290#else
291#define platform_pm_suspend NULL
292#define platform_pm_resume NULL
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200293#endif
294
295#ifdef CONFIG_HIBERNATE_CALLBACKS
296extern int platform_pm_freeze(struct device *dev);
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200297extern int platform_pm_thaw(struct device *dev);
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200298extern int platform_pm_poweroff(struct device *dev);
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200299extern int platform_pm_restore(struct device *dev);
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200300#else
301#define platform_pm_freeze NULL
302#define platform_pm_thaw NULL
303#define platform_pm_poweroff NULL
304#define platform_pm_restore NULL
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200305#endif
306
307#ifdef CONFIG_PM_SLEEP
308#define USE_PLATFORM_PM_SLEEP_OPS \
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200309 .suspend = platform_pm_suspend, \
310 .resume = platform_pm_resume, \
311 .freeze = platform_pm_freeze, \
312 .thaw = platform_pm_thaw, \
313 .poweroff = platform_pm_poweroff, \
Rafael J. Wysocki9b39e732011-12-18 00:34:24 +0100314 .restore = platform_pm_restore,
Rafael J. Wysocki69c9dd12011-04-29 00:36:05 +0200315#else
316#define USE_PLATFORM_PM_SLEEP_OPS
317#endif
318
Russell Kingbbbf5082005-10-29 22:17:58 +0100319#endif /* _PLATFORM_DEVICE_H_ */