Merge tag 'staging-4.3-rc5' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh...
[linux-2.6-block.git] / include / linux / platform_device.h
CommitLineData
bbbf508d
RK
1/*
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>
57fee4a5 15#include <linux/mod_devicetable.h>
bbbf508d 16
689ae231
JD
17#define PLATFORM_DEVID_NONE (-1)
18#define PLATFORM_DEVID_AUTO (-2)
19
e710d7d5
SO
20struct mfd_cell;
21
bbbf508d 22struct platform_device {
6ae07f27 23 const char *name;
1359555e 24 int id;
689ae231 25 bool id_auto;
bbbf508d
RK
26 struct device dev;
27 u32 num_resources;
6ae07f27 28 struct resource *resource;
57fee4a5 29
3d03ba4d 30 const struct platform_device_id *id_entry;
3d713e0e 31 char *driver_override; /* Driver name to force a match */
d7aacadd 32
e710d7d5
SO
33 /* MFD cell pointer */
34 struct mfd_cell *mfd_cell;
35
d7aacadd
MD
36 /* arch specific additions */
37 struct pdev_archdata archdata;
bbbf508d
RK
38};
39
57fee4a5
EM
40#define platform_get_device_id(pdev) ((pdev)->id_entry)
41
bbbf508d
RK
42#define to_platform_device(x) container_of((x), struct platform_device, dev)
43
44extern int platform_device_register(struct platform_device *);
45extern void platform_device_unregister(struct platform_device *);
46
47extern struct bus_type platform_bus_type;
48extern struct device platform_bus;
49
a77ce816 50extern void arch_setup_pdev_archdata(struct platform_device *);
6ae07f27
FP
51extern struct resource *platform_get_resource(struct platform_device *,
52 unsigned int, unsigned int);
bbbf508d 53extern int platform_get_irq(struct platform_device *, unsigned int);
6ae07f27
FP
54extern struct resource *platform_get_resource_byname(struct platform_device *,
55 unsigned int,
56 const char *);
c0afe7ba 57extern int platform_get_irq_byname(struct platform_device *, const char *);
bbbf508d
RK
58extern int platform_add_devices(struct platform_device **, int);
59
01dcc60a
UKK
60struct platform_device_info {
61 struct device *parent;
ce793486 62 struct fwnode_handle *fwnode;
01dcc60a
UKK
63
64 const char *name;
65 int id;
66
67 const struct resource *res;
68 unsigned int num_res;
69
70 const void *data;
71 size_t size_data;
72 u64 dma_mask;
73};
74extern struct platform_device *platform_device_register_full(
5a3072be 75 const struct platform_device_info *pdevinfo);
01dcc60a
UKK
76
77/**
78 * platform_device_register_resndata - add a platform-level device with
79 * resources and platform-specific data
80 *
81 * @parent: parent device for the device we're adding
82 * @name: base name of the device we're adding
83 * @id: instance id
84 * @res: set of resources that needs to be allocated for the device
85 * @num: number of resources
86 * @data: platform specific data for this platform device
87 * @size: size of platform specific data
88 *
89 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
90 */
91static inline struct platform_device *platform_device_register_resndata(
44f28bde
UKK
92 struct device *parent, const char *name, int id,
93 const struct resource *res, unsigned int num,
01dcc60a
UKK
94 const void *data, size_t size) {
95
96 struct platform_device_info pdevinfo = {
97 .parent = parent,
98 .name = name,
99 .id = id,
100 .res = res,
101 .num_res = num,
102 .data = data,
103 .size_data = size,
104 .dma_mask = 0,
105 };
106
107 return platform_device_register_full(&pdevinfo);
108}
44f28bde
UKK
109
110/**
111 * platform_device_register_simple - add a platform-level device and its resources
112 * @name: base name of the device we're adding
113 * @id: instance id
114 * @res: set of resources that needs to be allocated for the device
115 * @num: number of resources
116 *
117 * This function creates a simple platform device that requires minimal
118 * resource and memory management. Canned release function freeing memory
119 * allocated for the device allows drivers using such devices to be
120 * unloaded without waiting for the last reference to the device to be
121 * dropped.
122 *
123 * This interface is primarily intended for use with legacy drivers which
124 * probe hardware directly. Because such drivers create sysfs device nodes
125 * themselves, rather than letting system infrastructure handle such device
126 * enumeration tasks, they don't fully conform to the Linux driver model.
127 * In particular, when such drivers are built as modules, they can't be
128 * "hotplugged".
129 *
130 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
131 */
132static inline struct platform_device *platform_device_register_simple(
133 const char *name, int id,
134 const struct resource *res, unsigned int num)
135{
136 return platform_device_register_resndata(NULL, name, id,
137 res, num, NULL, 0);
138}
139
140/**
141 * platform_device_register_data - add a platform-level device with platform-specific data
142 * @parent: parent device for the device we're adding
143 * @name: base name of the device we're adding
144 * @id: instance id
145 * @data: platform specific data for this platform device
146 * @size: size of platform specific data
147 *
148 * This function creates a simple platform device that requires minimal
149 * resource and memory management. Canned release function freeing memory
150 * allocated for the device allows drivers using such devices to be
151 * unloaded without waiting for the last reference to the device to be
152 * dropped.
153 *
154 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
155 */
156static inline struct platform_device *platform_device_register_data(
157 struct device *parent, const char *name, int id,
158 const void *data, size_t size)
159{
160 return platform_device_register_resndata(parent, name, id,
161 NULL, 0, data, size);
162}
bbbf508d 163
1359555e 164extern struct platform_device *platform_device_alloc(const char *name, int id);
0b7f1a7e
GU
165extern int platform_device_add_resources(struct platform_device *pdev,
166 const struct resource *res,
167 unsigned int num);
6ae07f27
FP
168extern int platform_device_add_data(struct platform_device *pdev,
169 const void *data, size_t size);
37c12e74 170extern int platform_device_add(struct platform_device *pdev);
93ce3061 171extern void platform_device_del(struct platform_device *pdev);
37c12e74
RK
172extern void platform_device_put(struct platform_device *pdev);
173
00d3dcdd
RK
174struct platform_driver {
175 int (*probe)(struct platform_device *);
176 int (*remove)(struct platform_device *);
177 void (*shutdown)(struct platform_device *);
178 int (*suspend)(struct platform_device *, pm_message_t state);
179 int (*resume)(struct platform_device *);
180 struct device_driver driver;
831fad2f 181 const struct platform_device_id *id_table;
3f9120b0 182 bool prevent_deferred_probe;
00d3dcdd
RK
183};
184
10dbc5e3
RH
185#define to_platform_driver(drv) (container_of((drv), struct platform_driver, \
186 driver))
187
9447057e
LC
188/*
189 * use a macro to avoid include chaining to get THIS_MODULE
190 */
191#define platform_driver_register(drv) \
192 __platform_driver_register(drv, THIS_MODULE)
193extern int __platform_driver_register(struct platform_driver *,
194 struct module *);
00d3dcdd
RK
195extern void platform_driver_unregister(struct platform_driver *);
196
c67334fb
DB
197/* non-hotpluggable platform devices may use this so that probe() and
198 * its support may live in __init sections, conserving runtime memory.
199 */
c3b50dc2
WS
200#define platform_driver_probe(drv, probe) \
201 __platform_driver_probe(drv, probe, THIS_MODULE)
202extern int __platform_driver_probe(struct platform_driver *driver,
203 int (*probe)(struct platform_device *), struct module *module);
c67334fb 204
71d64290
MKB
205static inline void *platform_get_drvdata(const struct platform_device *pdev)
206{
207 return dev_get_drvdata(&pdev->dev);
208}
209
6ae07f27
FP
210static inline void platform_set_drvdata(struct platform_device *pdev,
211 void *data)
71d64290
MKB
212{
213 dev_set_drvdata(&pdev->dev, data);
214}
00d3dcdd 215
940ab889
GL
216/* module_platform_driver() - Helper macro for drivers that don't do
217 * anything special in module init/exit. This eliminates a lot of
218 * boilerplate. Each module may only use this macro once, and
219 * calling it replaces module_init() and module_exit()
220 */
221#define module_platform_driver(__platform_driver) \
907d0ed1
LPC
222 module_driver(__platform_driver, platform_driver_register, \
223 platform_driver_unregister)
940ab889 224
f309d444
PG
225/* builtin_platform_driver() - Helper macro for builtin drivers that
226 * don't do anything special in driver init. This eliminates some
227 * boilerplate. Each driver may only use this macro once, and
228 * calling it replaces device_initcall(). Note this is meant to be
229 * a parallel of module_platform_driver() above, but w/o _exit stuff.
230 */
231#define builtin_platform_driver(__platform_driver) \
232 builtin_driver(__platform_driver, platform_driver_register)
233
bab734fc
FP
234/* module_platform_driver_probe() - Helper macro for drivers that don't do
235 * anything special in module init/exit. This eliminates a lot of
236 * boilerplate. Each module may only use this macro once, and
237 * calling it replaces module_init() and module_exit()
238 */
239#define module_platform_driver_probe(__platform_driver, __platform_probe) \
240static int __init __platform_driver##_init(void) \
241{ \
242 return platform_driver_probe(&(__platform_driver), \
243 __platform_probe); \
244} \
245module_init(__platform_driver##_init); \
246static void __exit __platform_driver##_exit(void) \
247{ \
248 platform_driver_unregister(&(__platform_driver)); \
249} \
250module_exit(__platform_driver##_exit);
251
f309d444
PG
252/* builtin_platform_driver_probe() - Helper macro for drivers that don't do
253 * anything special in device init. This eliminates some boilerplate. Each
254 * driver may only use this macro once, and using it replaces device_initcall.
255 * This is meant to be a parallel of module_platform_driver_probe above, but
256 * without the __exit parts.
257 */
258#define builtin_platform_driver_probe(__platform_driver, __platform_probe) \
259static int __init __platform_driver##_init(void) \
260{ \
261 return platform_driver_probe(&(__platform_driver), \
262 __platform_probe); \
263} \
264device_initcall(__platform_driver##_init); \
265
291f653a
WS
266#define platform_create_bundle(driver, probe, res, n_res, data, size) \
267 __platform_create_bundle(driver, probe, res, n_res, data, size, THIS_MODULE)
268extern struct platform_device *__platform_create_bundle(
6ae07f27
FP
269 struct platform_driver *driver, int (*probe)(struct platform_device *),
270 struct resource *res, unsigned int n_res,
291f653a 271 const void *data, size_t size, struct module *module);
ecdf6ceb 272
13977091
MD
273/* early platform driver interface */
274struct early_platform_driver {
275 const char *class_str;
276 struct platform_driver *pdrv;
277 struct list_head list;
278 int requested_id;
c60e0504
MD
279 char *buffer;
280 int bufsize;
13977091
MD
281};
282
283#define EARLY_PLATFORM_ID_UNSET -2
284#define EARLY_PLATFORM_ID_ERROR -3
285
286extern int early_platform_driver_register(struct early_platform_driver *epdrv,
287 char *buf);
288extern void early_platform_add_devices(struct platform_device **devs, int num);
289
290static inline int is_early_platform_device(struct platform_device *pdev)
291{
292 return !pdev->dev.driver;
293}
294
295extern void early_platform_driver_register_all(char *class_str);
296extern int early_platform_driver_probe(char *class_str,
297 int nr_probe, int user_only);
298extern void early_platform_cleanup(void);
299
c60e0504
MD
300#define early_platform_init(class_string, platdrv) \
301 early_platform_init_buffer(class_string, platdrv, NULL, 0)
13977091
MD
302
303#ifndef MODULE
c60e0504 304#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
13977091
MD
305static __initdata struct early_platform_driver early_driver = { \
306 .class_str = class_string, \
c60e0504
MD
307 .buffer = buf, \
308 .bufsize = bufsiz, \
309 .pdrv = platdrv, \
13977091
MD
310 .requested_id = EARLY_PLATFORM_ID_UNSET, \
311}; \
c60e0504 312static int __init early_platform_driver_setup_func(char *buffer) \
13977091 313{ \
c60e0504 314 return early_platform_driver_register(&early_driver, buffer); \
13977091
MD
315} \
316early_param(class_string, early_platform_driver_setup_func)
317#else /* MODULE */
c60e0504
MD
318#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
319static inline char *early_platform_driver_setup_func(void) \
320{ \
321 return bufsiz ? buf : NULL; \
322}
13977091
MD
323#endif /* MODULE */
324
69c9dd1e
RW
325#ifdef CONFIG_SUSPEND
326extern int platform_pm_suspend(struct device *dev);
69c9dd1e 327extern int platform_pm_resume(struct device *dev);
69c9dd1e
RW
328#else
329#define platform_pm_suspend NULL
330#define platform_pm_resume NULL
69c9dd1e
RW
331#endif
332
333#ifdef CONFIG_HIBERNATE_CALLBACKS
334extern int platform_pm_freeze(struct device *dev);
69c9dd1e 335extern int platform_pm_thaw(struct device *dev);
69c9dd1e 336extern int platform_pm_poweroff(struct device *dev);
69c9dd1e 337extern int platform_pm_restore(struct device *dev);
69c9dd1e
RW
338#else
339#define platform_pm_freeze NULL
340#define platform_pm_thaw NULL
341#define platform_pm_poweroff NULL
342#define platform_pm_restore NULL
69c9dd1e
RW
343#endif
344
345#ifdef CONFIG_PM_SLEEP
346#define USE_PLATFORM_PM_SLEEP_OPS \
69c9dd1e
RW
347 .suspend = platform_pm_suspend, \
348 .resume = platform_pm_resume, \
349 .freeze = platform_pm_freeze, \
350 .thaw = platform_pm_thaw, \
351 .poweroff = platform_pm_poweroff, \
9b39e73d 352 .restore = platform_pm_restore,
69c9dd1e
RW
353#else
354#define USE_PLATFORM_PM_SLEEP_OPS
355#endif
356
bbbf508d 357#endif /* _PLATFORM_DEVICE_H_ */