1 /* 2 * platform_device.h - generic, centralized driver model 3 * 4 * Copyright (c) 2001-2003 Patrick Mochel <[email protected]> 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 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 */ 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 */ 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 */ 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 183 static inline void *platform_get_drvdata(const struct platform_device *pdev) 184 { 185 return dev_get_drvdata(&pdev->dev); 186 } 187 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 static int __init __platform_driver##_init(void) \ 200 { \ 201 return platform_driver_register(&(__platform_driver)); \ 202 } \ 203 module_init(__platform_driver##_init); \ 204 static void __exit __platform_driver##_exit(void) \ 205 { \ 206 platform_driver_unregister(&(__platform_driver)); \ 207 } \ 208 module_exit(__platform_driver##_exit); 209 210 extern struct platform_device *platform_create_bundle(struct platform_driver *driver, 211 int (*probe)(struct platform_device *), 212 struct resource *res, unsigned int n_res, 213 const void *data, size_t size); 214 215 /* early platform driver interface */ 216 struct early_platform_driver { 217 const char *class_str; 218 struct platform_driver *pdrv; 219 struct list_head list; 220 int requested_id; 221 char *buffer; 222 int bufsize; 223 }; 224 225 #define EARLY_PLATFORM_ID_UNSET -2 226 #define EARLY_PLATFORM_ID_ERROR -3 227 228 extern int early_platform_driver_register(struct early_platform_driver *epdrv, 229 char *buf); 230 extern void early_platform_add_devices(struct platform_device **devs, int num); 231 232 static inline int is_early_platform_device(struct platform_device *pdev) 233 { 234 return !pdev->dev.driver; 235 } 236 237 extern void early_platform_driver_register_all(char *class_str); 238 extern int early_platform_driver_probe(char *class_str, 239 int nr_probe, int user_only); 240 extern void early_platform_cleanup(void); 241 242 #define early_platform_init(class_string, platdrv) \ 243 early_platform_init_buffer(class_string, platdrv, NULL, 0) 244 245 #ifndef MODULE 246 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \ 247 static __initdata struct early_platform_driver early_driver = { \ 248 .class_str = class_string, \ 249 .buffer = buf, \ 250 .bufsize = bufsiz, \ 251 .pdrv = platdrv, \ 252 .requested_id = EARLY_PLATFORM_ID_UNSET, \ 253 }; \ 254 static int __init early_platform_driver_setup_func(char *buffer) \ 255 { \ 256 return early_platform_driver_register(&early_driver, buffer); \ 257 } \ 258 early_param(class_string, early_platform_driver_setup_func) 259 #else /* MODULE */ 260 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \ 261 static inline char *early_platform_driver_setup_func(void) \ 262 { \ 263 return bufsiz ? buf : NULL; \ 264 } 265 #endif /* MODULE */ 266 267 #ifdef CONFIG_PM_SLEEP 268 extern int platform_pm_prepare(struct device *dev); 269 extern void platform_pm_complete(struct device *dev); 270 #else 271 #define platform_pm_prepare NULL 272 #define platform_pm_complete NULL 273 #endif 274 275 #ifdef CONFIG_SUSPEND 276 extern int platform_pm_suspend(struct device *dev); 277 extern int platform_pm_suspend_noirq(struct device *dev); 278 extern int platform_pm_resume(struct device *dev); 279 extern int platform_pm_resume_noirq(struct device *dev); 280 #else 281 #define platform_pm_suspend NULL 282 #define platform_pm_resume NULL 283 #define platform_pm_suspend_noirq NULL 284 #define platform_pm_resume_noirq NULL 285 #endif 286 287 #ifdef CONFIG_HIBERNATE_CALLBACKS 288 extern int platform_pm_freeze(struct device *dev); 289 extern int platform_pm_freeze_noirq(struct device *dev); 290 extern int platform_pm_thaw(struct device *dev); 291 extern int platform_pm_thaw_noirq(struct device *dev); 292 extern int platform_pm_poweroff(struct device *dev); 293 extern int platform_pm_poweroff_noirq(struct device *dev); 294 extern int platform_pm_restore(struct device *dev); 295 extern int platform_pm_restore_noirq(struct device *dev); 296 #else 297 #define platform_pm_freeze NULL 298 #define platform_pm_thaw NULL 299 #define platform_pm_poweroff NULL 300 #define platform_pm_restore NULL 301 #define platform_pm_freeze_noirq NULL 302 #define platform_pm_thaw_noirq NULL 303 #define platform_pm_poweroff_noirq NULL 304 #define platform_pm_restore_noirq NULL 305 #endif 306 307 #ifdef CONFIG_PM_SLEEP 308 #define USE_PLATFORM_PM_SLEEP_OPS \ 309 .prepare = platform_pm_prepare, \ 310 .complete = platform_pm_complete, \ 311 .suspend = platform_pm_suspend, \ 312 .resume = platform_pm_resume, \ 313 .freeze = platform_pm_freeze, \ 314 .thaw = platform_pm_thaw, \ 315 .poweroff = platform_pm_poweroff, \ 316 .restore = platform_pm_restore, \ 317 .suspend_noirq = platform_pm_suspend_noirq, \ 318 .resume_noirq = platform_pm_resume_noirq, \ 319 .freeze_noirq = platform_pm_freeze_noirq, \ 320 .thaw_noirq = platform_pm_thaw_noirq, \ 321 .poweroff_noirq = platform_pm_poweroff_noirq, \ 322 .restore_noirq = platform_pm_restore_noirq, 323 #else 324 #define USE_PLATFORM_PM_SLEEP_OPS 325 #endif 326 327 #endif /* _PLATFORM_DEVICE_H_ */ 328