Branch data Line data Source code
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>
15 : : #include <linux/mod_devicetable.h>
16 : :
17 : : #define PLATFORM_DEVID_NONE (-1)
18 : : #define PLATFORM_DEVID_AUTO (-2)
19 : :
20 : : struct mfd_cell;
21 : :
22 : : struct platform_device {
23 : : const char *name;
24 : : int id;
25 : : bool id_auto;
26 : : struct device dev;
27 : : u32 num_resources;
28 : : struct resource *resource;
29 : :
30 : : const struct platform_device_id *id_entry;
31 : :
32 : : /* MFD cell pointer */
33 : : struct mfd_cell *mfd_cell;
34 : :
35 : : /* arch specific additions */
36 : : struct pdev_archdata archdata;
37 : : };
38 : :
39 : : #define platform_get_device_id(pdev) ((pdev)->id_entry)
40 : :
41 : : #define to_platform_device(x) container_of((x), struct platform_device, dev)
42 : :
43 : : extern int platform_device_register(struct platform_device *);
44 : : extern void platform_device_unregister(struct platform_device *);
45 : :
46 : : extern struct bus_type platform_bus_type;
47 : : extern struct device platform_bus;
48 : :
49 : : extern void arch_setup_pdev_archdata(struct platform_device *);
50 : : extern struct resource *platform_get_resource(struct platform_device *,
51 : : unsigned int, unsigned int);
52 : : extern int platform_get_irq(struct platform_device *, unsigned int);
53 : : extern struct resource *platform_get_resource_byname(struct platform_device *,
54 : : unsigned int,
55 : : const char *);
56 : : extern int platform_get_irq_byname(struct platform_device *, const char *);
57 : : extern int platform_add_devices(struct platform_device **, int);
58 : :
59 : : struct platform_device_info {
60 : : struct device *parent;
61 : : struct acpi_dev_node acpi_node;
62 : :
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 : : };
73 : : extern struct platform_device *platform_device_register_full(
74 : : const struct platform_device_info *pdevinfo);
75 : :
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 : : */
90 : : static inline struct platform_device *platform_device_register_resndata(
91 : : struct device *parent, const char *name, int id,
92 : : const struct resource *res, unsigned int num,
93 : : const void *data, size_t size) {
94 : :
95 : 0 : 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 : 0 : return platform_device_register_full(&pdevinfo);
107 : : }
108 : :
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 : : */
131 : : static 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 : : */
155 : : static 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 : : }
162 : :
163 : : extern struct platform_device *platform_device_alloc(const char *name, int id);
164 : : extern int platform_device_add_resources(struct platform_device *pdev,
165 : : const struct resource *res,
166 : : unsigned int num);
167 : : extern int platform_device_add_data(struct platform_device *pdev,
168 : : const void *data, size_t size);
169 : : extern int platform_device_add(struct platform_device *pdev);
170 : : extern void platform_device_del(struct platform_device *pdev);
171 : : extern void platform_device_put(struct platform_device *pdev);
172 : :
173 : : struct 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;
180 : : const struct platform_device_id *id_table;
181 : : bool prevent_deferred_probe;
182 : : };
183 : :
184 : : #define to_platform_driver(drv) (container_of((drv), struct platform_driver, \
185 : : driver))
186 : :
187 : : /*
188 : : * use a macro to avoid include chaining to get THIS_MODULE
189 : : */
190 : : #define platform_driver_register(drv) \
191 : : __platform_driver_register(drv, THIS_MODULE)
192 : : extern int __platform_driver_register(struct platform_driver *,
193 : : struct module *);
194 : : extern void platform_driver_unregister(struct platform_driver *);
195 : :
196 : : /* non-hotpluggable platform devices may use this so that probe() and
197 : : * its support may live in __init sections, conserving runtime memory.
198 : : */
199 : : extern int platform_driver_probe(struct platform_driver *driver,
200 : : int (*probe)(struct platform_device *));
201 : :
202 : : static inline void *platform_get_drvdata(const struct platform_device *pdev)
203 : : {
204 : 0 : return dev_get_drvdata(&pdev->dev);
205 : : }
206 : :
207 : : static inline void platform_set_drvdata(struct platform_device *pdev,
208 : : void *data)
209 : : {
210 : 0 : dev_set_drvdata(&pdev->dev, data);
211 : : }
212 : :
213 : : /* module_platform_driver() - Helper macro for drivers that don't do
214 : : * anything special in module init/exit. This eliminates a lot of
215 : : * boilerplate. Each module may only use this macro once, and
216 : : * calling it replaces module_init() and module_exit()
217 : : */
218 : : #define module_platform_driver(__platform_driver) \
219 : : module_driver(__platform_driver, platform_driver_register, \
220 : : platform_driver_unregister)
221 : :
222 : : /* module_platform_driver_probe() - Helper macro for drivers that don't do
223 : : * anything special in module init/exit. This eliminates a lot of
224 : : * boilerplate. Each module may only use this macro once, and
225 : : * calling it replaces module_init() and module_exit()
226 : : */
227 : : #define module_platform_driver_probe(__platform_driver, __platform_probe) \
228 : : static int __init __platform_driver##_init(void) \
229 : : { \
230 : : return platform_driver_probe(&(__platform_driver), \
231 : : __platform_probe); \
232 : : } \
233 : : module_init(__platform_driver##_init); \
234 : : static void __exit __platform_driver##_exit(void) \
235 : : { \
236 : : platform_driver_unregister(&(__platform_driver)); \
237 : : } \
238 : : module_exit(__platform_driver##_exit);
239 : :
240 : : extern struct platform_device *platform_create_bundle(
241 : : struct platform_driver *driver, int (*probe)(struct platform_device *),
242 : : struct resource *res, unsigned int n_res,
243 : : const void *data, size_t size);
244 : :
245 : : /* early platform driver interface */
246 : : struct early_platform_driver {
247 : : const char *class_str;
248 : : struct platform_driver *pdrv;
249 : : struct list_head list;
250 : : int requested_id;
251 : : char *buffer;
252 : : int bufsize;
253 : : };
254 : :
255 : : #define EARLY_PLATFORM_ID_UNSET -2
256 : : #define EARLY_PLATFORM_ID_ERROR -3
257 : :
258 : : extern int early_platform_driver_register(struct early_platform_driver *epdrv,
259 : : char *buf);
260 : : extern void early_platform_add_devices(struct platform_device **devs, int num);
261 : :
262 : : static inline int is_early_platform_device(struct platform_device *pdev)
263 : : {
264 : : return !pdev->dev.driver;
265 : : }
266 : :
267 : : extern void early_platform_driver_register_all(char *class_str);
268 : : extern int early_platform_driver_probe(char *class_str,
269 : : int nr_probe, int user_only);
270 : : extern void early_platform_cleanup(void);
271 : :
272 : : #define early_platform_init(class_string, platdrv) \
273 : : early_platform_init_buffer(class_string, platdrv, NULL, 0)
274 : :
275 : : #ifndef MODULE
276 : : #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
277 : : static __initdata struct early_platform_driver early_driver = { \
278 : : .class_str = class_string, \
279 : : .buffer = buf, \
280 : : .bufsize = bufsiz, \
281 : : .pdrv = platdrv, \
282 : : .requested_id = EARLY_PLATFORM_ID_UNSET, \
283 : : }; \
284 : : static int __init early_platform_driver_setup_func(char *buffer) \
285 : : { \
286 : : return early_platform_driver_register(&early_driver, buffer); \
287 : : } \
288 : : early_param(class_string, early_platform_driver_setup_func)
289 : : #else /* MODULE */
290 : : #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
291 : : static inline char *early_platform_driver_setup_func(void) \
292 : : { \
293 : : return bufsiz ? buf : NULL; \
294 : : }
295 : : #endif /* MODULE */
296 : :
297 : : #ifdef CONFIG_SUSPEND
298 : : extern int platform_pm_suspend(struct device *dev);
299 : : extern int platform_pm_resume(struct device *dev);
300 : : #else
301 : : #define platform_pm_suspend NULL
302 : : #define platform_pm_resume NULL
303 : : #endif
304 : :
305 : : #ifdef CONFIG_HIBERNATE_CALLBACKS
306 : : extern int platform_pm_freeze(struct device *dev);
307 : : extern int platform_pm_thaw(struct device *dev);
308 : : extern int platform_pm_poweroff(struct device *dev);
309 : : extern int platform_pm_restore(struct device *dev);
310 : : #else
311 : : #define platform_pm_freeze NULL
312 : : #define platform_pm_thaw NULL
313 : : #define platform_pm_poweroff NULL
314 : : #define platform_pm_restore NULL
315 : : #endif
316 : :
317 : : #ifdef CONFIG_PM_SLEEP
318 : : #define USE_PLATFORM_PM_SLEEP_OPS \
319 : : .suspend = platform_pm_suspend, \
320 : : .resume = platform_pm_resume, \
321 : : .freeze = platform_pm_freeze, \
322 : : .thaw = platform_pm_thaw, \
323 : : .poweroff = platform_pm_poweroff, \
324 : : .restore = platform_pm_restore,
325 : : #else
326 : : #define USE_PLATFORM_PM_SLEEP_OPS
327 : : #endif
328 : :
329 : : #endif /* _PLATFORM_DEVICE_H_ */
|
