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