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