LXR linux/include/linux/platform

   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
  17struct platform_device {
  18        const char      * name;
  19        int             id;
  20        struct device   dev;
  21        u32             num_resources;
  22        struct resource * resource;
  23
  24        struct platform_device_id       *id_entry;
  25
  26        /* arch specific additions */
  27        struct pdev_archdata    archdata;
  28};
  29
  30#define platform_get_device_id(pdev)    ((pdev)->id_entry)
  31
  32#define to_platform_device(x) container_of((x), struct platform_device, dev)
  33
  34extern int platform_device_register(struct platform_device *);
  35extern void platform_device_unregister(struct platform_device *);
  36
  37extern struct bus_type platform_bus_type;
  38extern struct device platform_bus;
  39
  40extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
  41extern int platform_get_irq(struct platform_device *, unsigned int);
  42extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, const char *);
  43extern int platform_get_irq_byname(struct platform_device *, const char *);
  44extern int platform_add_devices(struct platform_device **, int);
  45
  46extern struct platform_device *platform_device_register_simple(const char *, int id,
  47                                        struct resource *, unsigned int);
  48extern struct platform_device *platform_device_register_data(struct device *,
  49                const char *, int, const void *, size_t);
  50
  51extern struct platform_device *platform_device_alloc(const char *name, int id);
  52extern int platform_device_add_resources(struct platform_device *pdev, struct resource *res, unsigned int num);
  53extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size);
  54extern int platform_device_add(struct platform_device *pdev);
  55extern void platform_device_del(struct platform_device *pdev);
  56extern void platform_device_put(struct platform_device *pdev);
  57
  58struct platform_driver {
  59        int (*probe)(struct platform_device *);
  60        int (*remove)(struct platform_device *);
  61        void (*shutdown)(struct platform_device *);
  62        int (*suspend)(struct platform_device *, pm_message_t state);
  63        int (*resume)(struct platform_device *);
  64        struct device_driver driver;
  65        struct platform_device_id *id_table;
  66};
  67
  68extern int platform_driver_register(struct platform_driver *);
  69extern void platform_driver_unregister(struct platform_driver *);
  70
  71/* non-hotpluggable platform devices may use this so that probe() and
  72 * its support may live in __init sections, conserving runtime memory.
  73 */
  74extern int platform_driver_probe(struct platform_driver *driver,
  75                int (*probe)(struct platform_device *));
  76
  77#define platform_get_drvdata(_dev)      dev_get_drvdata(&(_dev)->dev)
  78#define platform_set_drvdata(_dev,data) dev_set_drvdata(&(_dev)->dev, (data))
  79
  80/* early platform driver interface */
  81struct early_platform_driver {
  82        const char *class_str;
  83        struct platform_driver *pdrv;
  84        struct list_head list;
  85        int requested_id;
  86};
  87
  88#define EARLY_PLATFORM_ID_UNSET -2
  89#define EARLY_PLATFORM_ID_ERROR -3
  90
  91extern int early_platform_driver_register(struct early_platform_driver *epdrv,
  92                                          char *buf);
  93extern void early_platform_add_devices(struct platform_device **devs, int num);
  94
  95static inline int is_early_platform_device(struct platform_device *pdev)
  96{
  97        return !pdev->dev.driver;
  98}
  99
 100extern void early_platform_driver_register_all(char *class_str);
 101extern int early_platform_driver_probe(char *class_str,
 102                                       int nr_probe, int user_only);
 103extern void early_platform_cleanup(void);
 104
 105
 106#ifndef MODULE
 107#define early_platform_init(class_string, platform_driver)              \
 108static __initdata struct early_platform_driver early_driver = {         \
 109        .class_str = class_string,                                      \
 110        .pdrv = platform_driver,                                        \
 111        .requested_id = EARLY_PLATFORM_ID_UNSET,                        \
 112};                                                                      \
 113static int __init early_platform_driver_setup_func(char *buf)           \
 114{                                                                       \
 115        return early_platform_driver_register(&early_driver, buf);      \
 116}                                                                       \
 117early_param(class_string, early_platform_driver_setup_func)
 118#else /* MODULE */
 119#define early_platform_init(class_string, platform_driver)
 120#endif /* MODULE */
 121
 122#endif /* _PLATFORM_DEVICE_H_ */
 123