2 * platform_device.h - generic, centralized driver model
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
6 * This file is released under the GPLv2
8 * See Documentation/driver-model/ for more information.
11 #ifndef _PLATFORM_DEVICE_H_
12 #define _PLATFORM_DEVICE_H_
14 #include <linux/device.h>
15 #include <linux/mod_devicetable.h>
17 #define PLATFORM_DEVID_NONE (-1)
18 #define PLATFORM_DEVID_AUTO (-2)
22 struct platform_device
{
28 struct resource
*resource
;
30 const struct platform_device_id
*id_entry
;
31 char *driver_override
; /* Driver name to force a match */
33 /* MFD cell pointer */
34 struct mfd_cell
*mfd_cell
;
36 /* arch specific additions */
37 struct pdev_archdata archdata
;
40 #define platform_get_device_id(pdev) ((pdev)->id_entry)
42 #define to_platform_device(x) container_of((x), struct platform_device, dev)
44 extern int platform_device_register(struct platform_device
*);
45 extern void platform_device_unregister(struct platform_device
*);
47 extern struct bus_type platform_bus_type
;
48 extern struct device platform_bus
;
50 extern void arch_setup_pdev_archdata(struct platform_device
*);
51 extern struct resource
*platform_get_resource(struct platform_device
*,
52 unsigned int, unsigned int);
53 extern int platform_get_irq(struct platform_device
*, unsigned int);
54 extern struct resource
*platform_get_resource_byname(struct platform_device
*,
57 extern int platform_get_irq_byname(struct platform_device
*, const char *);
58 extern int platform_add_devices(struct platform_device
**, int);
60 struct platform_device_info
{
61 struct device
*parent
;
62 struct acpi_dev_node acpi_node
;
67 const struct resource
*res
;
74 extern struct platform_device
*platform_device_register_full(
75 const struct platform_device_info
*pdevinfo
);
78 * platform_device_register_resndata - add a platform-level device with
79 * resources and platform-specific data
81 * @parent: parent device for the device we're adding
82 * @name: base name of the device we're adding
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
89 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
91 static inline struct platform_device
*platform_device_register_resndata(
92 struct device
*parent
, const char *name
, int id
,
93 const struct resource
*res
, unsigned int num
,
94 const void *data
, size_t size
) {
96 struct platform_device_info pdevinfo
= {
107 return platform_device_register_full(&pdevinfo
);
111 * platform_device_register_simple - add a platform-level device and its resources
112 * @name: base name of the device we're adding
114 * @res: set of resources that needs to be allocated for the device
115 * @num: number of resources
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
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
130 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
132 static inline struct platform_device
*platform_device_register_simple(
133 const char *name
, int id
,
134 const struct resource
*res
, unsigned int num
)
136 return platform_device_register_resndata(NULL
, name
, id
,
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
145 * @data: platform specific data for this platform device
146 * @size: size of platform specific data
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
154 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
156 static inline struct platform_device
*platform_device_register_data(
157 struct device
*parent
, const char *name
, int id
,
158 const void *data
, size_t size
)
160 return platform_device_register_resndata(parent
, name
, id
,
161 NULL
, 0, data
, size
);
164 extern struct platform_device
*platform_device_alloc(const char *name
, int id
);
165 extern int platform_device_add_resources(struct platform_device
*pdev
,
166 const struct resource
*res
,
168 extern int platform_device_add_data(struct platform_device
*pdev
,
169 const void *data
, size_t size
);
170 extern int platform_device_add(struct platform_device
*pdev
);
171 extern void platform_device_del(struct platform_device
*pdev
);
172 extern void platform_device_put(struct platform_device
*pdev
);
174 struct 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
;
181 const struct platform_device_id
*id_table
;
182 bool prevent_deferred_probe
;
185 #define to_platform_driver(drv) (container_of((drv), struct platform_driver, \
189 * use a macro to avoid include chaining to get THIS_MODULE
191 #define platform_driver_register(drv) \
192 __platform_driver_register(drv, THIS_MODULE)
193 extern int __platform_driver_register(struct platform_driver
*,
195 extern void platform_driver_unregister(struct platform_driver
*);
197 /* non-hotpluggable platform devices may use this so that probe() and
198 * its support may live in __init sections, conserving runtime memory.
200 extern int platform_driver_probe(struct platform_driver
*driver
,
201 int (*probe
)(struct platform_device
*));
203 static inline void *platform_get_drvdata(const struct platform_device
*pdev
)
205 return dev_get_drvdata(&pdev
->dev
);
208 static inline void platform_set_drvdata(struct platform_device
*pdev
,
211 dev_set_drvdata(&pdev
->dev
, data
);
214 /* module_platform_driver() - Helper macro for drivers that don't do
215 * anything special in module init/exit. This eliminates a lot of
216 * boilerplate. Each module may only use this macro once, and
217 * calling it replaces module_init() and module_exit()
219 #define module_platform_driver(__platform_driver) \
220 module_driver(__platform_driver, platform_driver_register, \
221 platform_driver_unregister)
223 /* module_platform_driver_probe() - Helper macro for drivers that don't do
224 * anything special in module init/exit. This eliminates a lot of
225 * boilerplate. Each module may only use this macro once, and
226 * calling it replaces module_init() and module_exit()
228 #define module_platform_driver_probe(__platform_driver, __platform_probe) \
229 static int __init __platform_driver##_init(void) \
231 return platform_driver_probe(&(__platform_driver), \
234 module_init(__platform_driver##_init); \
235 static void __exit __platform_driver##_exit(void) \
237 platform_driver_unregister(&(__platform_driver)); \
239 module_exit(__platform_driver##_exit);
241 extern struct platform_device
*platform_create_bundle(
242 struct platform_driver
*driver
, int (*probe
)(struct platform_device
*),
243 struct resource
*res
, unsigned int n_res
,
244 const void *data
, size_t size
);
246 /* early platform driver interface */
247 struct early_platform_driver
{
248 const char *class_str
;
249 struct platform_driver
*pdrv
;
250 struct list_head list
;
256 #define EARLY_PLATFORM_ID_UNSET -2
257 #define EARLY_PLATFORM_ID_ERROR -3
259 extern int early_platform_driver_register(struct early_platform_driver
*epdrv
,
261 extern void early_platform_add_devices(struct platform_device
**devs
, int num
);
263 static inline int is_early_platform_device(struct platform_device
*pdev
)
265 return !pdev
->dev
.driver
;
268 extern void early_platform_driver_register_all(char *class_str
);
269 extern int early_platform_driver_probe(char *class_str
,
270 int nr_probe
, int user_only
);
271 extern void early_platform_cleanup(void);
273 #define early_platform_init(class_string, platdrv) \
274 early_platform_init_buffer(class_string, platdrv, NULL, 0)
277 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
278 static __initdata struct early_platform_driver early_driver = { \
279 .class_str = class_string, \
283 .requested_id = EARLY_PLATFORM_ID_UNSET, \
285 static int __init early_platform_driver_setup_func(char *buffer) \
287 return early_platform_driver_register(&early_driver, buffer); \
289 early_param(class_string, early_platform_driver_setup_func)
291 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
292 static inline char *early_platform_driver_setup_func(void) \
294 return bufsiz ? buf : NULL; \
298 #ifdef CONFIG_SUSPEND
299 extern int platform_pm_suspend(struct device
*dev
);
300 extern int platform_pm_resume(struct device
*dev
);
302 #define platform_pm_suspend NULL
303 #define platform_pm_resume NULL
306 #ifdef CONFIG_HIBERNATE_CALLBACKS
307 extern int platform_pm_freeze(struct device
*dev
);
308 extern int platform_pm_thaw(struct device
*dev
);
309 extern int platform_pm_poweroff(struct device
*dev
);
310 extern int platform_pm_restore(struct device
*dev
);
312 #define platform_pm_freeze NULL
313 #define platform_pm_thaw NULL
314 #define platform_pm_poweroff NULL
315 #define platform_pm_restore NULL
318 #ifdef CONFIG_PM_SLEEP
319 #define USE_PLATFORM_PM_SLEEP_OPS \
320 .suspend = platform_pm_suspend, \
321 .resume = platform_pm_resume, \
322 .freeze = platform_pm_freeze, \
323 .thaw = platform_pm_thaw, \
324 .poweroff = platform_pm_poweroff, \
325 .restore = platform_pm_restore,
327 #define USE_PLATFORM_PM_SLEEP_OPS
330 #endif /* _PLATFORM_DEVICE_H_ */