include/linux/platform_device.h

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