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 struct mfd_cell;
18
19 struct platform_device {
20 const char * name;
21 int id;
22 struct device dev;
23 u32 num_resources;
24 struct resource * resource;
25
26 const struct platform_device_id *id_entry;
27
28 /* MFD cell pointer */
29 struct mfd_cell *mfd_cell;
30
31 /* arch specific additions */
32 struct pdev_archdata archdata;
33 };
34
35 #define platform_get_device_id(pdev) ((pdev)->id_entry)
36
37 #define to_platform_device(x) container_of((x), struct platform_device, dev)
38
39 extern int platform_device_register(struct platform_device *);
40 extern void platform_device_unregister(struct platform_device *);
41
42 extern struct bus_type platform_bus_type;
43 extern struct device platform_bus;
44
45 extern void arch_setup_pdev_archdata(struct platform_device *);
46 extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
47 extern int platform_get_irq(struct platform_device *, unsigned int);
48 extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, const char *);
49 extern int platform_get_irq_byname(struct platform_device *, const char *);
50 extern int platform_add_devices(struct platform_device **, int);
51
52 struct platform_device_info {
53 struct device *parent;
54
55 const char *name;
56 int id;
57
58 const struct resource *res;
59 unsigned int num_res;
60
61 const void *data;
62 size_t size_data;
63 u64 dma_mask;
64 };
65 extern struct platform_device *platform_device_register_full(
66 const struct platform_device_info *pdevinfo);
67
68 /**
69 * platform_device_register_resndata - add a platform-level device with
70 * resources and platform-specific data
71 *
72 * @parent: parent device for the device we're adding
73 * @name: base name of the device we're adding
74 * @id: instance id
75 * @res: set of resources that needs to be allocated for the device
76 * @num: number of resources
77 * @data: platform specific data for this platform device
78 * @size: size of platform specific data
79 *
80 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
81 */
platform_device_register_resndata(struct device * parent,const char * name,int id,const struct resource * res,unsigned int num,const void * data,size_t size)82 static inline struct platform_device *platform_device_register_resndata(
83 struct device *parent, const char *name, int id,
84 const struct resource *res, unsigned int num,
85 const void *data, size_t size) {
86
87 struct platform_device_info pdevinfo = {
88 .parent = parent,
89 .name = name,
90 .id = id,
91 .res = res,
92 .num_res = num,
93 .data = data,
94 .size_data = size,
95 .dma_mask = 0,
96 };
97
98 return platform_device_register_full(&pdevinfo);
99 }
100
101 /**
102 * platform_device_register_simple - add a platform-level device and its resources
103 * @name: base name of the device we're adding
104 * @id: instance id
105 * @res: set of resources that needs to be allocated for the device
106 * @num: number of resources
107 *
108 * This function creates a simple platform device that requires minimal
109 * resource and memory management. Canned release function freeing memory
110 * allocated for the device allows drivers using such devices to be
111 * unloaded without waiting for the last reference to the device to be
112 * dropped.
113 *
114 * This interface is primarily intended for use with legacy drivers which
115 * probe hardware directly. Because such drivers create sysfs device nodes
116 * themselves, rather than letting system infrastructure handle such device
117 * enumeration tasks, they don't fully conform to the Linux driver model.
118 * In particular, when such drivers are built as modules, they can't be
119 * "hotplugged".
120 *
121 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
122 */
platform_device_register_simple(const char * name,int id,const struct resource * res,unsigned int num)123 static inline struct platform_device *platform_device_register_simple(
124 const char *name, int id,
125 const struct resource *res, unsigned int num)
126 {
127 return platform_device_register_resndata(NULL, name, id,
128 res, num, NULL, 0);
129 }
130
131 /**
132 * platform_device_register_data - add a platform-level device with platform-specific data
133 * @parent: parent device for the device we're adding
134 * @name: base name of the device we're adding
135 * @id: instance id
136 * @data: platform specific data for this platform device
137 * @size: size of platform specific data
138 *
139 * This function creates a simple platform device that requires minimal
140 * resource and memory management. Canned release function freeing memory
141 * allocated for the device allows drivers using such devices to be
142 * unloaded without waiting for the last reference to the device to be
143 * dropped.
144 *
145 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
146 */
platform_device_register_data(struct device * parent,const char * name,int id,const void * data,size_t size)147 static inline struct platform_device *platform_device_register_data(
148 struct device *parent, const char *name, int id,
149 const void *data, size_t size)
150 {
151 return platform_device_register_resndata(parent, name, id,
152 NULL, 0, data, size);
153 }
154
155 extern struct platform_device *platform_device_alloc(const char *name, int id);
156 extern int platform_device_add_resources(struct platform_device *pdev,
157 const struct resource *res,
158 unsigned int num);
159 extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size);
160 extern int platform_device_add(struct platform_device *pdev);
161 extern void platform_device_del(struct platform_device *pdev);
162 extern void platform_device_put(struct platform_device *pdev);
163
164 struct platform_driver {
165 int (*probe)(struct platform_device *);
166 int (*remove)(struct platform_device *);
167 void (*shutdown)(struct platform_device *);
168 int (*suspend)(struct platform_device *, pm_message_t state);
169 int (*resume)(struct platform_device *);
170 struct device_driver driver;
171 const struct platform_device_id *id_table;
172 };
173
174 extern int platform_driver_register(struct platform_driver *);
175 extern void platform_driver_unregister(struct platform_driver *);
176
177 /* non-hotpluggable platform devices may use this so that probe() and
178 * its support may live in __init sections, conserving runtime memory.
179 */
180 extern int platform_driver_probe(struct platform_driver *driver,
181 int (*probe)(struct platform_device *));
182
platform_get_drvdata(const struct platform_device * pdev)183 static inline void *platform_get_drvdata(const struct platform_device *pdev)
184 {
185 return dev_get_drvdata(&pdev->dev);
186 }
187
platform_set_drvdata(struct platform_device * pdev,void * data)188 static inline void platform_set_drvdata(struct platform_device *pdev, void *data)
189 {
190 dev_set_drvdata(&pdev->dev, data);
191 }
192
193 /* module_platform_driver() - Helper macro for drivers that don't do
194 * anything special in module init/exit. This eliminates a lot of
195 * boilerplate. Each module may only use this macro once, and
196 * calling it replaces module_init() and module_exit()
197 */
198 #define module_platform_driver(__platform_driver) \
199 module_driver(__platform_driver, platform_driver_register, \
200 platform_driver_unregister)
201
202 extern struct platform_device *platform_create_bundle(struct platform_driver *driver,
203 int (*probe)(struct platform_device *),
204 struct resource *res, unsigned int n_res,
205 const void *data, size_t size);
206
207 /* early platform driver interface */
208 struct early_platform_driver {
209 const char *class_str;
210 struct platform_driver *pdrv;
211 struct list_head list;
212 int requested_id;
213 char *buffer;
214 int bufsize;
215 };
216
217 #define EARLY_PLATFORM_ID_UNSET -2
218 #define EARLY_PLATFORM_ID_ERROR -3
219
220 extern int early_platform_driver_register(struct early_platform_driver *epdrv,
221 char *buf);
222 extern void early_platform_add_devices(struct platform_device **devs, int num);
223
is_early_platform_device(struct platform_device * pdev)224 static inline int is_early_platform_device(struct platform_device *pdev)
225 {
226 return !pdev->dev.driver;
227 }
228
229 extern void early_platform_driver_register_all(char *class_str);
230 extern int early_platform_driver_probe(char *class_str,
231 int nr_probe, int user_only);
232 extern void early_platform_cleanup(void);
233
234 #define early_platform_init(class_string, platdrv) \
235 early_platform_init_buffer(class_string, platdrv, NULL, 0)
236
237 #ifndef MODULE
238 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
239 static __initdata struct early_platform_driver early_driver = { \
240 .class_str = class_string, \
241 .buffer = buf, \
242 .bufsize = bufsiz, \
243 .pdrv = platdrv, \
244 .requested_id = EARLY_PLATFORM_ID_UNSET, \
245 }; \
246 static int __init early_platform_driver_setup_func(char *buffer) \
247 { \
248 return early_platform_driver_register(&early_driver, buffer); \
249 } \
250 early_param(class_string, early_platform_driver_setup_func)
251 #else /* MODULE */
252 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
253 static inline char *early_platform_driver_setup_func(void) \
254 { \
255 return bufsiz ? buf : NULL; \
256 }
257 #endif /* MODULE */
258
259 #ifdef CONFIG_SUSPEND
260 extern int platform_pm_suspend(struct device *dev);
261 extern int platform_pm_resume(struct device *dev);
262 #else
263 #define platform_pm_suspend NULL
264 #define platform_pm_resume NULL
265 #endif
266
267 #ifdef CONFIG_HIBERNATE_CALLBACKS
268 extern int platform_pm_freeze(struct device *dev);
269 extern int platform_pm_thaw(struct device *dev);
270 extern int platform_pm_poweroff(struct device *dev);
271 extern int platform_pm_restore(struct device *dev);
272 #else
273 #define platform_pm_freeze NULL
274 #define platform_pm_thaw NULL
275 #define platform_pm_poweroff NULL
276 #define platform_pm_restore NULL
277 #endif
278
279 #ifdef CONFIG_PM_SLEEP
280 #define USE_PLATFORM_PM_SLEEP_OPS \
281 .suspend = platform_pm_suspend, \
282 .resume = platform_pm_resume, \
283 .freeze = platform_pm_freeze, \
284 .thaw = platform_pm_thaw, \
285 .poweroff = platform_pm_poweroff, \
286 .restore = platform_pm_restore,
287 #else
288 #define USE_PLATFORM_PM_SLEEP_OPS
289 #endif
290
291 #endif /* _PLATFORM_DEVICE_H_ */
292