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 16 #define PLATFORM_DEVID_NONE (-1) 17 #define PLATFORM_DEVID_AUTO (-2) 18 19 struct mfd_cell; 20 struct property_entry; 21 struct platform_device_id; 22 23 struct platform_device { 24 const char *name; 25 int id; 26 bool id_auto; 27 struct device dev; 28 u32 num_resources; 29 struct resource *resource; 30 31 const struct platform_device_id *id_entry; 32 char *driver_override; /* Driver name to force a match */ 33 34 /* MFD cell pointer */ 35 struct mfd_cell *mfd_cell; 36 37 /* arch specific additions */ 38 struct pdev_archdata archdata; 39 }; 40 41 #define platform_get_device_id(pdev) ((pdev)->id_entry) 42 43 #define dev_is_platform(dev) ((dev)->bus == &platform_bus_type) 44 #define to_platform_device(x) container_of((x), struct platform_device, dev) 45 46 extern int platform_device_register(struct platform_device *); 47 extern void platform_device_unregister(struct platform_device *); 48 49 extern struct bus_type platform_bus_type; 50 extern struct device platform_bus; 51 52 extern void arch_setup_pdev_archdata(struct platform_device *); 53 extern struct resource *platform_get_resource(struct platform_device *, 54 unsigned int, unsigned int); 55 extern void __iomem * 56 devm_platform_ioremap_resource(struct platform_device *pdev, 57 unsigned int index); 58 extern int platform_get_irq(struct platform_device *, unsigned int); 59 extern int platform_irq_count(struct platform_device *); 60 extern struct resource *platform_get_resource_byname(struct platform_device *, 61 unsigned int, 62 const char *); 63 extern int platform_get_irq_byname(struct platform_device *, const char *); 64 extern int platform_add_devices(struct platform_device **, int); 65 66 struct platform_device_info { 67 struct device *parent; 68 struct fwnode_handle *fwnode; 69 bool of_node_reused; 70 71 const char *name; 72 int id; 73 74 const struct resource *res; 75 unsigned int num_res; 76 77 const void *data; 78 size_t size_data; 79 u64 dma_mask; 80 81 struct property_entry *properties; 82 }; 83 extern struct platform_device *platform_device_register_full( 84 const struct platform_device_info *pdevinfo); 85 86 /** 87 * platform_device_register_resndata - add a platform-level device with 88 * resources and platform-specific data 89 * 90 * @parent: parent device for the device we're adding 91 * @name: base name of the device we're adding 92 * @id: instance id 93 * @res: set of resources that needs to be allocated for the device 94 * @num: number of resources 95 * @data: platform specific data for this platform device 96 * @size: size of platform specific data 97 * 98 * Returns &struct platform_device pointer on success, or ERR_PTR() on error. 99 */ 100 static inline struct platform_device *platform_device_register_resndata( 101 struct device *parent, const char *name, int id, 102 const struct resource *res, unsigned int num, 103 const void *data, size_t size) { 104 105 struct platform_device_info pdevinfo = { 106 .parent = parent, 107 .name = name, 108 .id = id, 109 .res = res, 110 .num_res = num, 111 .data = data, 112 .size_data = size, 113 .dma_mask = 0, 114 }; 115 116 return platform_device_register_full(&pdevinfo); 117 } 118 119 /** 120 * platform_device_register_simple - add a platform-level device and its resources 121 * @name: base name of the device we're adding 122 * @id: instance id 123 * @res: set of resources that needs to be allocated for the device 124 * @num: number of resources 125 * 126 * This function creates a simple platform device that requires minimal 127 * resource and memory management. Canned release function freeing memory 128 * allocated for the device allows drivers using such devices to be 129 * unloaded without waiting for the last reference to the device to be 130 * dropped. 131 * 132 * This interface is primarily intended for use with legacy drivers which 133 * probe hardware directly. Because such drivers create sysfs device nodes 134 * themselves, rather than letting system infrastructure handle such device 135 * enumeration tasks, they don't fully conform to the Linux driver model. 136 * In particular, when such drivers are built as modules, they can't be 137 * "hotplugged". 138 * 139 * Returns &struct platform_device pointer on success, or ERR_PTR() on error. 140 */ 141 static inline struct platform_device *platform_device_register_simple( 142 const char *name, int id, 143 const struct resource *res, unsigned int num) 144 { 145 return platform_device_register_resndata(NULL, name, id, 146 res, num, NULL, 0); 147 } 148 149 /** 150 * platform_device_register_data - add a platform-level device with platform-specific data 151 * @parent: parent device for the device we're adding 152 * @name: base name of the device we're adding 153 * @id: instance id 154 * @data: platform specific data for this platform device 155 * @size: size of platform specific data 156 * 157 * This function creates a simple platform device that requires minimal 158 * resource and memory management. Canned release function freeing memory 159 * allocated for the device allows drivers using such devices to be 160 * unloaded without waiting for the last reference to the device to be 161 * dropped. 162 * 163 * Returns &struct platform_device pointer on success, or ERR_PTR() on error. 164 */ 165 static inline struct platform_device *platform_device_register_data( 166 struct device *parent, const char *name, int id, 167 const void *data, size_t size) 168 { 169 return platform_device_register_resndata(parent, name, id, 170 NULL, 0, data, size); 171 } 172 173 extern struct platform_device *platform_device_alloc(const char *name, int id); 174 extern int platform_device_add_resources(struct platform_device *pdev, 175 const struct resource *res, 176 unsigned int num); 177 extern int platform_device_add_data(struct platform_device *pdev, 178 const void *data, size_t size); 179 extern int platform_device_add_properties(struct platform_device *pdev, 180 const struct property_entry *properties); 181 extern int platform_device_add(struct platform_device *pdev); 182 extern void platform_device_del(struct platform_device *pdev); 183 extern void platform_device_put(struct platform_device *pdev); 184 185 struct platform_driver { 186 int (*probe)(struct platform_device *); 187 int (*remove)(struct platform_device *); 188 void (*shutdown)(struct platform_device *); 189 int (*suspend)(struct platform_device *, pm_message_t state); 190 int (*resume)(struct platform_device *); 191 struct device_driver driver; 192 const struct platform_device_id *id_table; 193 bool prevent_deferred_probe; 194 }; 195 196 #define to_platform_driver(drv) (container_of((drv), struct platform_driver, \ 197 driver)) 198 199 /* 200 * use a macro to avoid include chaining to get THIS_MODULE 201 */ 202 #define platform_driver_register(drv) \ 203 __platform_driver_register(drv, THIS_MODULE) 204 extern int __platform_driver_register(struct platform_driver *, 205 struct module *); 206 extern void platform_driver_unregister(struct platform_driver *); 207 208 /* non-hotpluggable platform devices may use this so that probe() and 209 * its support may live in __init sections, conserving runtime memory. 210 */ 211 #define platform_driver_probe(drv, probe) \ 212 __platform_driver_probe(drv, probe, THIS_MODULE) 213 extern int __platform_driver_probe(struct platform_driver *driver, 214 int (*probe)(struct platform_device *), struct module *module); 215 216 static inline void *platform_get_drvdata(const struct platform_device *pdev) 217 { 218 return dev_get_drvdata(&pdev->dev); 219 } 220 221 static inline void platform_set_drvdata(struct platform_device *pdev, 222 void *data) 223 { 224 dev_set_drvdata(&pdev->dev, data); 225 } 226 227 /* module_platform_driver() - Helper macro for drivers that don't do 228 * anything special in module init/exit. This eliminates a lot of 229 * boilerplate. Each module may only use this macro once, and 230 * calling it replaces module_init() and module_exit() 231 */ 232 #define module_platform_driver(__platform_driver) \ 233 module_driver(__platform_driver, platform_driver_register, \ 234 platform_driver_unregister) 235 236 /* builtin_platform_driver() - Helper macro for builtin drivers that 237 * don't do anything special in driver init. This eliminates some 238 * boilerplate. Each driver may only use this macro once, and 239 * calling it replaces device_initcall(). Note this is meant to be 240 * a parallel of module_platform_driver() above, but w/o _exit stuff. 241 */ 242 #define builtin_platform_driver(__platform_driver) \ 243 builtin_driver(__platform_driver, platform_driver_register) 244 245 /* module_platform_driver_probe() - Helper macro for drivers that don't do 246 * anything special in module init/exit. This eliminates a lot of 247 * boilerplate. Each module may only use this macro once, and 248 * calling it replaces module_init() and module_exit() 249 */ 250 #define module_platform_driver_probe(__platform_driver, __platform_probe) \ 251 static int __init __platform_driver##_init(void) \ 252 { \ 253 return platform_driver_probe(&(__platform_driver), \ 254 __platform_probe); \ 255 } \ 256 module_init(__platform_driver##_init); \ 257 static void __exit __platform_driver##_exit(void) \ 258 { \ 259 platform_driver_unregister(&(__platform_driver)); \ 260 } \ 261 module_exit(__platform_driver##_exit); 262 263 /* builtin_platform_driver_probe() - Helper macro for drivers that don't do 264 * anything special in device init. This eliminates some boilerplate. Each 265 * driver may only use this macro once, and using it replaces device_initcall. 266 * This is meant to be a parallel of module_platform_driver_probe above, but 267 * without the __exit parts. 268 */ 269 #define builtin_platform_driver_probe(__platform_driver, __platform_probe) \ 270 static int __init __platform_driver##_init(void) \ 271 { \ 272 return platform_driver_probe(&(__platform_driver), \ 273 __platform_probe); \ 274 } \ 275 device_initcall(__platform_driver##_init); \ 276 277 #define platform_create_bundle(driver, probe, res, n_res, data, size) \ 278 __platform_create_bundle(driver, probe, res, n_res, data, size, THIS_MODULE) 279 extern struct platform_device *__platform_create_bundle( 280 struct platform_driver *driver, int (*probe)(struct platform_device *), 281 struct resource *res, unsigned int n_res, 282 const void *data, size_t size, struct module *module); 283 284 int __platform_register_drivers(struct platform_driver * const *drivers, 285 unsigned int count, struct module *owner); 286 void platform_unregister_drivers(struct platform_driver * const *drivers, 287 unsigned int count); 288 289 #define platform_register_drivers(drivers, count) \ 290 __platform_register_drivers(drivers, count, THIS_MODULE) 291 292 /* early platform driver interface */ 293 struct early_platform_driver { 294 const char *class_str; 295 struct platform_driver *pdrv; 296 struct list_head list; 297 int requested_id; 298 char *buffer; 299 int bufsize; 300 }; 301 302 #define EARLY_PLATFORM_ID_UNSET -2 303 #define EARLY_PLATFORM_ID_ERROR -3 304 305 extern int early_platform_driver_register(struct early_platform_driver *epdrv, 306 char *buf); 307 extern void early_platform_add_devices(struct platform_device **devs, int num); 308 309 static inline int is_early_platform_device(struct platform_device *pdev) 310 { 311 return !pdev->dev.driver; 312 } 313 314 extern void early_platform_driver_register_all(char *class_str); 315 extern int early_platform_driver_probe(char *class_str, 316 int nr_probe, int user_only); 317 extern void early_platform_cleanup(void); 318 319 #define early_platform_init(class_string, platdrv) \ 320 early_platform_init_buffer(class_string, platdrv, NULL, 0) 321 322 #ifndef MODULE 323 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \ 324 static __initdata struct early_platform_driver early_driver = { \ 325 .class_str = class_string, \ 326 .buffer = buf, \ 327 .bufsize = bufsiz, \ 328 .pdrv = platdrv, \ 329 .requested_id = EARLY_PLATFORM_ID_UNSET, \ 330 }; \ 331 static int __init early_platform_driver_setup_func(char *buffer) \ 332 { \ 333 return early_platform_driver_register(&early_driver, buffer); \ 334 } \ 335 early_param(class_string, early_platform_driver_setup_func) 336 #else /* MODULE */ 337 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \ 338 static inline char *early_platform_driver_setup_func(void) \ 339 { \ 340 return bufsiz ? buf : NULL; \ 341 } 342 #endif /* MODULE */ 343 344 #ifdef CONFIG_SUSPEND 345 extern int platform_pm_suspend(struct device *dev); 346 extern int platform_pm_resume(struct device *dev); 347 #else 348 #define platform_pm_suspend NULL 349 #define platform_pm_resume NULL 350 #endif 351 352 #ifdef CONFIG_HIBERNATE_CALLBACKS 353 extern int platform_pm_freeze(struct device *dev); 354 extern int platform_pm_thaw(struct device *dev); 355 extern int platform_pm_poweroff(struct device *dev); 356 extern int platform_pm_restore(struct device *dev); 357 #else 358 #define platform_pm_freeze NULL 359 #define platform_pm_thaw NULL 360 #define platform_pm_poweroff NULL 361 #define platform_pm_restore NULL 362 #endif 363 364 extern int platform_dma_configure(struct device *dev); 365 366 #ifdef CONFIG_PM_SLEEP 367 #define USE_PLATFORM_PM_SLEEP_OPS \ 368 .suspend = platform_pm_suspend, \ 369 .resume = platform_pm_resume, \ 370 .freeze = platform_pm_freeze, \ 371 .thaw = platform_pm_thaw, \ 372 .poweroff = platform_pm_poweroff, \ 373 .restore = platform_pm_restore, 374 #else 375 #define USE_PLATFORM_PM_SLEEP_OPS 376 #endif 377 378 #endif /* _PLATFORM_DEVICE_H_ */ 379