Driver core: add platform_create_bundle() helper
[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
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
34 extern int platform_device_register(struct platform_device *);
35 extern void platform_device_unregister(struct platform_device *);
36
37 extern struct bus_type platform_bus_type;
38 extern struct device platform_bus;
39
40 extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
41 extern int platform_get_irq(struct platform_device *, unsigned int);
42 extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, const char *);
43 extern int platform_get_irq_byname(struct platform_device *, const char *);
44 extern int platform_add_devices(struct platform_device **, int);
45
46 extern struct platform_device *platform_device_register_simple(const char *, int id,
47                                         struct resource *, unsigned int);
48 extern struct platform_device *platform_device_register_data(struct device *,
49                 const char *, int, const void *, size_t);
50
51 extern struct platform_device *platform_device_alloc(const char *name, int id);
52 extern int platform_device_add_resources(struct platform_device *pdev, struct resource *res, unsigned int num);
53 extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size);
54 extern int platform_device_add(struct platform_device *pdev);
55 extern void platform_device_del(struct platform_device *pdev);
56 extern void platform_device_put(struct platform_device *pdev);
57
58 struct 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
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 extern struct platform_device *platform_create_bundle(struct platform_driver *driver,
81                                         int (*probe)(struct platform_device *),
82                                         struct resource *res, unsigned int n_res,
83                                         const void *data, size_t size);
84
85 /* early platform driver interface */
86 struct early_platform_driver {
87         const char *class_str;
88         struct platform_driver *pdrv;
89         struct list_head list;
90         int requested_id;
91         char *buffer;
92         int bufsize;
93 };
94
95 #define EARLY_PLATFORM_ID_UNSET -2
96 #define EARLY_PLATFORM_ID_ERROR -3
97
98 extern int early_platform_driver_register(struct early_platform_driver *epdrv,
99                                           char *buf);
100 extern void early_platform_add_devices(struct platform_device **devs, int num);
101
102 static inline int is_early_platform_device(struct platform_device *pdev)
103 {
104         return !pdev->dev.driver;
105 }
106
107 extern void early_platform_driver_register_all(char *class_str);
108 extern int early_platform_driver_probe(char *class_str,
109                                        int nr_probe, int user_only);
110 extern void early_platform_cleanup(void);
111
112 #define early_platform_init(class_string, platdrv)              \
113         early_platform_init_buffer(class_string, platdrv, NULL, 0)
114
115 #ifndef MODULE
116 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz)  \
117 static __initdata struct early_platform_driver early_driver = {         \
118         .class_str = class_string,                                      \
119         .buffer = buf,                                                  \
120         .bufsize = bufsiz,                                              \
121         .pdrv = platdrv,                                                \
122         .requested_id = EARLY_PLATFORM_ID_UNSET,                        \
123 };                                                                      \
124 static int __init early_platform_driver_setup_func(char *buffer)        \
125 {                                                                       \
126         return early_platform_driver_register(&early_driver, buffer);   \
127 }                                                                       \
128 early_param(class_string, early_platform_driver_setup_func)
129 #else /* MODULE */
130 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz)  \
131 static inline char *early_platform_driver_setup_func(void)              \
132 {                                                                       \
133         return bufsiz ? buf : NULL;                                     \
134 }
135 #endif /* MODULE */
136
137 #endif /* _PLATFORM_DEVICE_H_ */