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>
19 struct platform_device {
24 struct resource * resource;
26 const struct platform_device_id *id_entry;
28 /* MFD cell pointer */
29 struct mfd_cell *mfd_cell;
31 /* arch specific additions */
32 struct pdev_archdata archdata;
35 #define platform_get_device_id(pdev) ((pdev)->id_entry)
37 #define to_platform_device(x) container_of((x), struct platform_device, dev)
39 extern int platform_device_register(struct platform_device *);
40 extern void platform_device_unregister(struct platform_device *);
42 extern struct bus_type platform_bus_type;
43 extern struct device platform_bus;
45 extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
46 extern int platform_get_irq(struct platform_device *, unsigned int);
47 extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, const char *);
48 extern int platform_get_irq_byname(struct platform_device *, const char *);
49 extern int platform_add_devices(struct platform_device **, int);
51 extern struct platform_device *platform_device_register_resndata(
52 struct device *parent, const char *name, int id,
53 const struct resource *res, unsigned int num,
54 const void *data, size_t size);
57 * platform_device_register_simple - add a platform-level device and its resources
58 * @name: base name of the device we're adding
60 * @res: set of resources that needs to be allocated for the device
61 * @num: number of resources
63 * This function creates a simple platform device that requires minimal
64 * resource and memory management. Canned release function freeing memory
65 * allocated for the device allows drivers using such devices to be
66 * unloaded without waiting for the last reference to the device to be
69 * This interface is primarily intended for use with legacy drivers which
70 * probe hardware directly. Because such drivers create sysfs device nodes
71 * themselves, rather than letting system infrastructure handle such device
72 * enumeration tasks, they don't fully conform to the Linux driver model.
73 * In particular, when such drivers are built as modules, they can't be
76 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
78 static inline struct platform_device *platform_device_register_simple(
79 const char *name, int id,
80 const struct resource *res, unsigned int num)
82 return platform_device_register_resndata(NULL, name, id,
87 * platform_device_register_data - add a platform-level device with platform-specific data
88 * @parent: parent device for the device we're adding
89 * @name: base name of the device we're adding
91 * @data: platform specific data for this platform device
92 * @size: size of platform specific data
94 * This function creates a simple platform device that requires minimal
95 * resource and memory management. Canned release function freeing memory
96 * allocated for the device allows drivers using such devices to be
97 * unloaded without waiting for the last reference to the device to be
100 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
102 static inline struct platform_device *platform_device_register_data(
103 struct device *parent, const char *name, int id,
104 const void *data, size_t size)
106 return platform_device_register_resndata(parent, name, id,
107 NULL, 0, data, size);
110 extern struct platform_device *platform_device_alloc(const char *name, int id);
111 extern int platform_device_add_resources(struct platform_device *pdev,
112 const struct resource *res,
114 extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size);
115 extern int platform_device_add(struct platform_device *pdev);
116 extern void platform_device_del(struct platform_device *pdev);
117 extern void platform_device_put(struct platform_device *pdev);
119 struct platform_driver {
120 int (*probe)(struct platform_device *);
121 int (*remove)(struct platform_device *);
122 void (*shutdown)(struct platform_device *);
123 int (*suspend)(struct platform_device *, pm_message_t state);
124 int (*resume)(struct platform_device *);
125 struct device_driver driver;
126 const struct platform_device_id *id_table;
129 extern int platform_driver_register(struct platform_driver *);
130 extern void platform_driver_unregister(struct platform_driver *);
132 /* non-hotpluggable platform devices may use this so that probe() and
133 * its support may live in __init sections, conserving runtime memory.
135 extern int platform_driver_probe(struct platform_driver *driver,
136 int (*probe)(struct platform_device *));
138 static inline void *platform_get_drvdata(const struct platform_device *pdev)
140 return dev_get_drvdata(&pdev->dev);
143 static inline void platform_set_drvdata(struct platform_device *pdev, void *data)
145 dev_set_drvdata(&pdev->dev, data);
148 extern struct platform_device *platform_create_bundle(struct platform_driver *driver,
149 int (*probe)(struct platform_device *),
150 struct resource *res, unsigned int n_res,
151 const void *data, size_t size);
153 extern const struct dev_pm_ops * platform_bus_get_pm_ops(void);
154 extern void platform_bus_set_pm_ops(const struct dev_pm_ops *pm);
156 /* early platform driver interface */
157 struct early_platform_driver {
158 const char *class_str;
159 struct platform_driver *pdrv;
160 struct list_head list;
166 #define EARLY_PLATFORM_ID_UNSET -2
167 #define EARLY_PLATFORM_ID_ERROR -3
169 extern int early_platform_driver_register(struct early_platform_driver *epdrv,
171 extern void early_platform_add_devices(struct platform_device **devs, int num);
173 static inline int is_early_platform_device(struct platform_device *pdev)
175 return !pdev->dev.driver;
178 extern void early_platform_driver_register_all(char *class_str);
179 extern int early_platform_driver_probe(char *class_str,
180 int nr_probe, int user_only);
181 extern void early_platform_cleanup(void);
183 #define early_platform_init(class_string, platdrv) \
184 early_platform_init_buffer(class_string, platdrv, NULL, 0)
187 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
188 static __initdata struct early_platform_driver early_driver = { \
189 .class_str = class_string, \
193 .requested_id = EARLY_PLATFORM_ID_UNSET, \
195 static int __init early_platform_driver_setup_func(char *buffer) \
197 return early_platform_driver_register(&early_driver, buffer); \
199 early_param(class_string, early_platform_driver_setup_func)
201 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
202 static inline char *early_platform_driver_setup_func(void) \
204 return bufsiz ? buf : NULL; \
208 #ifdef CONFIG_PM_SLEEP
209 extern int platform_pm_prepare(struct device *dev);
210 extern void platform_pm_complete(struct device *dev);
212 #define platform_pm_prepare NULL
213 #define platform_pm_complete NULL
216 #ifdef CONFIG_SUSPEND
217 extern int platform_pm_suspend(struct device *dev);
218 extern int platform_pm_suspend_noirq(struct device *dev);
219 extern int platform_pm_resume(struct device *dev);
220 extern int platform_pm_resume_noirq(struct device *dev);
222 #define platform_pm_suspend NULL
223 #define platform_pm_resume NULL
224 #define platform_pm_suspend_noirq NULL
225 #define platform_pm_resume_noirq NULL
228 #ifdef CONFIG_HIBERNATE_CALLBACKS
229 extern int platform_pm_freeze(struct device *dev);
230 extern int platform_pm_freeze_noirq(struct device *dev);
231 extern int platform_pm_thaw(struct device *dev);
232 extern int platform_pm_thaw_noirq(struct device *dev);
233 extern int platform_pm_poweroff(struct device *dev);
234 extern int platform_pm_poweroff_noirq(struct device *dev);
235 extern int platform_pm_restore(struct device *dev);
236 extern int platform_pm_restore_noirq(struct device *dev);
238 #define platform_pm_freeze NULL
239 #define platform_pm_thaw NULL
240 #define platform_pm_poweroff NULL
241 #define platform_pm_restore NULL
242 #define platform_pm_freeze_noirq NULL
243 #define platform_pm_thaw_noirq NULL
244 #define platform_pm_poweroff_noirq NULL
245 #define platform_pm_restore_noirq NULL
248 #ifdef CONFIG_PM_SLEEP
249 #define USE_PLATFORM_PM_SLEEP_OPS \
250 .prepare = platform_pm_prepare, \
251 .complete = platform_pm_complete, \
252 .suspend = platform_pm_suspend, \
253 .resume = platform_pm_resume, \
254 .freeze = platform_pm_freeze, \
255 .thaw = platform_pm_thaw, \
256 .poweroff = platform_pm_poweroff, \
257 .restore = platform_pm_restore, \
258 .suspend_noirq = platform_pm_suspend_noirq, \
259 .resume_noirq = platform_pm_resume_noirq, \
260 .freeze_noirq = platform_pm_freeze_noirq, \
261 .thaw_noirq = platform_pm_thaw_noirq, \
262 .poweroff_noirq = platform_pm_poweroff_noirq, \
263 .restore_noirq = platform_pm_restore_noirq,
265 #define USE_PLATFORM_PM_SLEEP_OPS
268 #endif /* _PLATFORM_DEVICE_H_ */