Merge branch 'irq' into release
[linux-2.6.git] / 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 struct platform_device {
18         const char      * name;
19         int             id;
20         struct device   dev;
21         u32             num_resources;
22         struct resource * resource;
23         void            *platform_data;
24
25         struct platform_device_id       *id_entry;
26 };
27
28 #define platform_get_device_id(pdev)    ((pdev)->id_entry)
29
30 #define to_platform_device(x) container_of((x), struct platform_device, dev)
31
32 extern int platform_device_register(struct platform_device *);
33 extern void platform_device_unregister(struct platform_device *);
34
35 extern struct bus_type platform_bus_type;
36 extern struct device platform_bus;
37
38 extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
39 extern int platform_get_irq(struct platform_device *, unsigned int);
40 extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, char *);
41 extern int platform_get_irq_byname(struct platform_device *, char *);
42 extern int platform_add_devices(struct platform_device **, int);
43
44 extern struct platform_device *platform_device_register_simple(const char *, int id,
45                                         struct resource *, unsigned int);
46 extern struct platform_device *platform_device_register_data(struct device *,
47                 const char *, int, const void *, size_t);
48
49 extern struct platform_device *platform_device_alloc(const char *name, int id);
50 extern int platform_device_add_resources(struct platform_device *pdev, struct resource *res, unsigned int num);
51 extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size);
52 extern int platform_device_add(struct platform_device *pdev);
53 extern void platform_device_del(struct platform_device *pdev);
54 extern void platform_device_put(struct platform_device *pdev);
55
56 struct platform_driver {
57         int (*probe)(struct platform_device *);
58         int (*remove)(struct platform_device *);
59         void (*shutdown)(struct platform_device *);
60         int (*suspend)(struct platform_device *, pm_message_t state);
61         int (*suspend_late)(struct platform_device *, pm_message_t state);
62         int (*resume_early)(struct platform_device *);
63         int (*resume)(struct platform_device *);
64         struct device_driver driver;
65         struct platform_device_id *id_table;
66 };
67
68 extern int platform_driver_register(struct platform_driver *);
69 extern 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  */
74 extern 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 */
81 struct 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
91 extern int early_platform_driver_register(struct early_platform_driver *epdrv,
92                                           char *buf);
93 extern void early_platform_add_devices(struct platform_device **devs, int num);
94
95 static inline int is_early_platform_device(struct platform_device *pdev)
96 {
97         return !pdev->dev.driver;
98 }
99
100 extern void early_platform_driver_register_all(char *class_str);
101 extern int early_platform_driver_probe(char *class_str,
102                                        int nr_probe, int user_only);
103 extern void early_platform_cleanup(void);
104
105
106 #ifndef MODULE
107 #define early_platform_init(class_string, platform_driver)              \
108 static __initdata struct early_platform_driver early_driver = {         \
109         .class_str = class_string,                                      \
110         .pdrv = platform_driver,                                        \
111         .requested_id = EARLY_PLATFORM_ID_UNSET,                        \
112 };                                                                      \
113 static int __init early_platform_driver_setup_func(char *buf)           \
114 {                                                                       \
115         return early_platform_driver_register(&early_driver, buf);      \
116 }                                                                       \
117 early_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_ */