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