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
;
32 /* MFD cell pointer */
33 struct mfd_cell
*mfd_cell
;
35 /* arch specific additions */
36 struct pdev_archdata archdata
;
39 #define platform_get_device_id(pdev) ((pdev)->id_entry)
41 #define to_platform_device(x) container_of((x), struct platform_device, dev)
43 extern int platform_device_register(struct platform_device
*);
44 extern void platform_device_unregister(struct platform_device
*);
46 extern struct bus_type platform_bus_type
;
47 extern struct device platform_bus
;
49 extern void arch_setup_pdev_archdata(struct platform_device
*);
50 extern struct resource
*platform_get_resource(struct platform_device
*, unsigned int, unsigned int);
51 extern int platform_get_irq(struct platform_device
*, unsigned int);
52 extern struct resource
*platform_get_resource_byname(struct platform_device
*, unsigned int, const char *);
53 extern int platform_get_irq_byname(struct platform_device
*, const char *);
54 extern int platform_add_devices(struct platform_device
**, int);
56 struct platform_device_info
{
57 struct device
*parent
;
58 struct acpi_dev_node acpi_node
;
63 const struct resource
*res
;
70 extern struct platform_device
*platform_device_register_full(
71 const struct platform_device_info
*pdevinfo
);
74 * platform_device_register_resndata - add a platform-level device with
75 * resources and platform-specific data
77 * @parent: parent device for the device we're adding
78 * @name: base name of the device we're adding
80 * @res: set of resources that needs to be allocated for the device
81 * @num: number of resources
82 * @data: platform specific data for this platform device
83 * @size: size of platform specific data
85 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
87 static inline struct platform_device
*platform_device_register_resndata(
88 struct device
*parent
, const char *name
, int id
,
89 const struct resource
*res
, unsigned int num
,
90 const void *data
, size_t size
) {
92 struct platform_device_info pdevinfo
= {
103 return platform_device_register_full(&pdevinfo
);
107 * platform_device_register_simple - add a platform-level device and its resources
108 * @name: base name of the device we're adding
110 * @res: set of resources that needs to be allocated for the device
111 * @num: number of resources
113 * This function creates a simple platform device that requires minimal
114 * resource and memory management. Canned release function freeing memory
115 * allocated for the device allows drivers using such devices to be
116 * unloaded without waiting for the last reference to the device to be
119 * This interface is primarily intended for use with legacy drivers which
120 * probe hardware directly. Because such drivers create sysfs device nodes
121 * themselves, rather than letting system infrastructure handle such device
122 * enumeration tasks, they don't fully conform to the Linux driver model.
123 * In particular, when such drivers are built as modules, they can't be
126 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
128 static inline struct platform_device
*platform_device_register_simple(
129 const char *name
, int id
,
130 const struct resource
*res
, unsigned int num
)
132 return platform_device_register_resndata(NULL
, name
, id
,
137 * platform_device_register_data - add a platform-level device with platform-specific data
138 * @parent: parent device for the device we're adding
139 * @name: base name of the device we're adding
141 * @data: platform specific data for this platform device
142 * @size: size of platform specific data
144 * This function creates a simple platform device that requires minimal
145 * resource and memory management. Canned release function freeing memory
146 * allocated for the device allows drivers using such devices to be
147 * unloaded without waiting for the last reference to the device to be
150 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
152 static inline struct platform_device
*platform_device_register_data(
153 struct device
*parent
, const char *name
, int id
,
154 const void *data
, size_t size
)
156 return platform_device_register_resndata(parent
, name
, id
,
157 NULL
, 0, data
, size
);
160 extern struct platform_device
*platform_device_alloc(const char *name
, int id
);
161 extern int platform_device_add_resources(struct platform_device
*pdev
,
162 const struct resource
*res
,
164 extern int platform_device_add_data(struct platform_device
*pdev
, const void *data
, size_t size
);
165 extern int platform_device_add(struct platform_device
*pdev
);
166 extern void platform_device_del(struct platform_device
*pdev
);
167 extern void platform_device_put(struct platform_device
*pdev
);
169 struct platform_driver
{
170 int (*probe
)(struct platform_device
*);
171 int (*remove
)(struct platform_device
*);
172 void (*shutdown
)(struct platform_device
*);
173 int (*suspend
)(struct platform_device
*, pm_message_t state
);
174 int (*resume
)(struct platform_device
*);
175 struct device_driver driver
;
176 const struct platform_device_id
*id_table
;
179 extern int platform_driver_register(struct platform_driver
*);
180 extern void platform_driver_unregister(struct platform_driver
*);
182 /* non-hotpluggable platform devices may use this so that probe() and
183 * its support may live in __init sections, conserving runtime memory.
185 extern int platform_driver_probe(struct platform_driver
*driver
,
186 int (*probe
)(struct platform_device
*));
188 static inline void *platform_get_drvdata(const struct platform_device
*pdev
)
190 return dev_get_drvdata(&pdev
->dev
);
193 static inline void platform_set_drvdata(struct platform_device
*pdev
, void *data
)
195 dev_set_drvdata(&pdev
->dev
, data
);
198 /* module_platform_driver() - Helper macro for drivers that don't do
199 * anything special in module init/exit. This eliminates a lot of
200 * boilerplate. Each module may only use this macro once, and
201 * calling it replaces module_init() and module_exit()
203 #define module_platform_driver(__platform_driver) \
204 module_driver(__platform_driver, platform_driver_register, \
205 platform_driver_unregister)
207 extern struct platform_device
*platform_create_bundle(struct platform_driver
*driver
,
208 int (*probe
)(struct platform_device
*),
209 struct resource
*res
, unsigned int n_res
,
210 const void *data
, size_t size
);
212 /* early platform driver interface */
213 struct early_platform_driver
{
214 const char *class_str
;
215 struct platform_driver
*pdrv
;
216 struct list_head list
;
222 #define EARLY_PLATFORM_ID_UNSET -2
223 #define EARLY_PLATFORM_ID_ERROR -3
225 extern int early_platform_driver_register(struct early_platform_driver
*epdrv
,
227 extern void early_platform_add_devices(struct platform_device
**devs
, int num
);
229 static inline int is_early_platform_device(struct platform_device
*pdev
)
231 return !pdev
->dev
.driver
;
234 extern void early_platform_driver_register_all(char *class_str
);
235 extern int early_platform_driver_probe(char *class_str
,
236 int nr_probe
, int user_only
);
237 extern void early_platform_cleanup(void);
239 #define early_platform_init(class_string, platdrv) \
240 early_platform_init_buffer(class_string, platdrv, NULL, 0)
243 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
244 static __initdata struct early_platform_driver early_driver = { \
245 .class_str = class_string, \
249 .requested_id = EARLY_PLATFORM_ID_UNSET, \
251 static int __init early_platform_driver_setup_func(char *buffer) \
253 return early_platform_driver_register(&early_driver, buffer); \
255 early_param(class_string, early_platform_driver_setup_func)
257 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
258 static inline char *early_platform_driver_setup_func(void) \
260 return bufsiz ? buf : NULL; \
264 #ifdef CONFIG_SUSPEND
265 extern int platform_pm_suspend(struct device
*dev
);
266 extern int platform_pm_resume(struct device
*dev
);
268 #define platform_pm_suspend NULL
269 #define platform_pm_resume NULL
272 #ifdef CONFIG_HIBERNATE_CALLBACKS
273 extern int platform_pm_freeze(struct device
*dev
);
274 extern int platform_pm_thaw(struct device
*dev
);
275 extern int platform_pm_poweroff(struct device
*dev
);
276 extern int platform_pm_restore(struct device
*dev
);
278 #define platform_pm_freeze NULL
279 #define platform_pm_thaw NULL
280 #define platform_pm_poweroff NULL
281 #define platform_pm_restore NULL
284 #ifdef CONFIG_PM_SLEEP
285 #define USE_PLATFORM_PM_SLEEP_OPS \
286 .suspend = platform_pm_suspend, \
287 .resume = platform_pm_resume, \
288 .freeze = platform_pm_freeze, \
289 .thaw = platform_pm_thaw, \
290 .poweroff = platform_pm_poweroff, \
291 .restore = platform_pm_restore,
293 #define USE_PLATFORM_PM_SLEEP_OPS
296 #endif /* _PLATFORM_DEVICE_H_ */