Commit | Line | Data |
---|---|---|
bbbf508d RK |
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> | |
57fee4a5 | 15 | #include <linux/mod_devicetable.h> |
bbbf508d | 16 | |
e710d7d5 SO |
17 | struct mfd_cell; |
18 | ||
bbbf508d RK |
19 | struct platform_device { |
20 | const char * name; | |
1359555e | 21 | int id; |
bbbf508d RK |
22 | struct device dev; |
23 | u32 num_resources; | |
24 | struct resource * resource; | |
57fee4a5 | 25 | |
3d03ba4d | 26 | const struct platform_device_id *id_entry; |
d7aacadd | 27 | |
e710d7d5 SO |
28 | /* MFD cell pointer */ |
29 | struct mfd_cell *mfd_cell; | |
30 | ||
d7aacadd MD |
31 | /* arch specific additions */ |
32 | struct pdev_archdata archdata; | |
bbbf508d RK |
33 | }; |
34 | ||
57fee4a5 EM |
35 | #define platform_get_device_id(pdev) ((pdev)->id_entry) |
36 | ||
bbbf508d RK |
37 | #define to_platform_device(x) container_of((x), struct platform_device, dev) |
38 | ||
39 | extern int platform_device_register(struct platform_device *); | |
40 | extern void platform_device_unregister(struct platform_device *); | |
41 | ||
42 | extern struct bus_type platform_bus_type; | |
43 | extern struct device platform_bus; | |
44 | ||
45 | extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int); | |
46 | extern int platform_get_irq(struct platform_device *, unsigned int); | |
c0afe7ba LW |
47 | extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, const char *); |
48 | extern int platform_get_irq_byname(struct platform_device *, const char *); | |
bbbf508d RK |
49 | extern int platform_add_devices(struct platform_device **, int); |
50 | ||
44f28bde UKK |
51 | extern struct platform_device *platform_device_register_resndata( |
52 | struct device *parent, const char *name, int id, | |
53 | const struct resource *res, unsigned int num, | |
54 | const void *data, size_t size); | |
55 | ||
56 | /** | |
57 | * platform_device_register_simple - add a platform-level device and its resources | |
58 | * @name: base name of the device we're adding | |
59 | * @id: instance id | |
60 | * @res: set of resources that needs to be allocated for the device | |
61 | * @num: number of resources | |
62 | * | |
63 | * This function creates a simple platform device that requires minimal | |
64 | * resource and memory management. Canned release function freeing memory | |
65 | * allocated for the device allows drivers using such devices to be | |
66 | * unloaded without waiting for the last reference to the device to be | |
67 | * dropped. | |
68 | * | |
69 | * This interface is primarily intended for use with legacy drivers which | |
70 | * probe hardware directly. Because such drivers create sysfs device nodes | |
71 | * themselves, rather than letting system infrastructure handle such device | |
72 | * enumeration tasks, they don't fully conform to the Linux driver model. | |
73 | * In particular, when such drivers are built as modules, they can't be | |
74 | * "hotplugged". | |
75 | * | |
76 | * Returns &struct platform_device pointer on success, or ERR_PTR() on error. | |
77 | */ | |
78 | static inline struct platform_device *platform_device_register_simple( | |
79 | const char *name, int id, | |
80 | const struct resource *res, unsigned int num) | |
81 | { | |
82 | return platform_device_register_resndata(NULL, name, id, | |
83 | res, num, NULL, 0); | |
84 | } | |
85 | ||
86 | /** | |
87 | * platform_device_register_data - add a platform-level device with platform-specific data | |
88 | * @parent: parent device for the device we're adding | |
89 | * @name: base name of the device we're adding | |
90 | * @id: instance id | |
91 | * @data: platform specific data for this platform device | |
92 | * @size: size of platform specific data | |
93 | * | |
94 | * This function creates a simple platform device that requires minimal | |
95 | * resource and memory management. Canned release function freeing memory | |
96 | * allocated for the device allows drivers using such devices to be | |
97 | * unloaded without waiting for the last reference to the device to be | |
98 | * dropped. | |
99 | * | |
100 | * Returns &struct platform_device pointer on success, or ERR_PTR() on error. | |
101 | */ | |
102 | static inline struct platform_device *platform_device_register_data( | |
103 | struct device *parent, const char *name, int id, | |
104 | const void *data, size_t size) | |
105 | { | |
106 | return platform_device_register_resndata(parent, name, id, | |
107 | NULL, 0, data, size); | |
108 | } | |
bbbf508d | 109 | |
1359555e | 110 | extern struct platform_device *platform_device_alloc(const char *name, int id); |
0b7f1a7e GU |
111 | extern int platform_device_add_resources(struct platform_device *pdev, |
112 | const struct resource *res, | |
113 | unsigned int num); | |
6eefd34f | 114 | extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size); |
37c12e74 | 115 | extern int platform_device_add(struct platform_device *pdev); |
93ce3061 | 116 | extern void platform_device_del(struct platform_device *pdev); |
37c12e74 RK |
117 | extern void platform_device_put(struct platform_device *pdev); |
118 | ||
00d3dcdd RK |
119 | struct platform_driver { |
120 | int (*probe)(struct platform_device *); | |
121 | int (*remove)(struct platform_device *); | |
122 | void (*shutdown)(struct platform_device *); | |
123 | int (*suspend)(struct platform_device *, pm_message_t state); | |
124 | int (*resume)(struct platform_device *); | |
125 | struct device_driver driver; | |
831fad2f | 126 | const struct platform_device_id *id_table; |
00d3dcdd RK |
127 | }; |
128 | ||
129 | extern int platform_driver_register(struct platform_driver *); | |
130 | extern void platform_driver_unregister(struct platform_driver *); | |
131 | ||
c67334fb DB |
132 | /* non-hotpluggable platform devices may use this so that probe() and |
133 | * its support may live in __init sections, conserving runtime memory. | |
134 | */ | |
135 | extern int platform_driver_probe(struct platform_driver *driver, | |
136 | int (*probe)(struct platform_device *)); | |
137 | ||
71d64290 MKB |
138 | static inline void *platform_get_drvdata(const struct platform_device *pdev) |
139 | { | |
140 | return dev_get_drvdata(&pdev->dev); | |
141 | } | |
142 | ||
143 | static inline void platform_set_drvdata(struct platform_device *pdev, void *data) | |
144 | { | |
145 | dev_set_drvdata(&pdev->dev, data); | |
146 | } | |
00d3dcdd | 147 | |
ecdf6ceb DT |
148 | extern struct platform_device *platform_create_bundle(struct platform_driver *driver, |
149 | int (*probe)(struct platform_device *), | |
150 | struct resource *res, unsigned int n_res, | |
151 | const void *data, size_t size); | |
152 | ||
c64a0926 KH |
153 | extern const struct dev_pm_ops * platform_bus_get_pm_ops(void); |
154 | extern void platform_bus_set_pm_ops(const struct dev_pm_ops *pm); | |
155 | ||
13977091 MD |
156 | /* early platform driver interface */ |
157 | struct early_platform_driver { | |
158 | const char *class_str; | |
159 | struct platform_driver *pdrv; | |
160 | struct list_head list; | |
161 | int requested_id; | |
c60e0504 MD |
162 | char *buffer; |
163 | int bufsize; | |
13977091 MD |
164 | }; |
165 | ||
166 | #define EARLY_PLATFORM_ID_UNSET -2 | |
167 | #define EARLY_PLATFORM_ID_ERROR -3 | |
168 | ||
169 | extern int early_platform_driver_register(struct early_platform_driver *epdrv, | |
170 | char *buf); | |
171 | extern void early_platform_add_devices(struct platform_device **devs, int num); | |
172 | ||
173 | static inline int is_early_platform_device(struct platform_device *pdev) | |
174 | { | |
175 | return !pdev->dev.driver; | |
176 | } | |
177 | ||
178 | extern void early_platform_driver_register_all(char *class_str); | |
179 | extern int early_platform_driver_probe(char *class_str, | |
180 | int nr_probe, int user_only); | |
181 | extern void early_platform_cleanup(void); | |
182 | ||
c60e0504 MD |
183 | #define early_platform_init(class_string, platdrv) \ |
184 | early_platform_init_buffer(class_string, platdrv, NULL, 0) | |
13977091 MD |
185 | |
186 | #ifndef MODULE | |
c60e0504 | 187 | #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \ |
13977091 MD |
188 | static __initdata struct early_platform_driver early_driver = { \ |
189 | .class_str = class_string, \ | |
c60e0504 MD |
190 | .buffer = buf, \ |
191 | .bufsize = bufsiz, \ | |
192 | .pdrv = platdrv, \ | |
13977091 MD |
193 | .requested_id = EARLY_PLATFORM_ID_UNSET, \ |
194 | }; \ | |
c60e0504 | 195 | static int __init early_platform_driver_setup_func(char *buffer) \ |
13977091 | 196 | { \ |
c60e0504 | 197 | return early_platform_driver_register(&early_driver, buffer); \ |
13977091 MD |
198 | } \ |
199 | early_param(class_string, early_platform_driver_setup_func) | |
200 | #else /* MODULE */ | |
c60e0504 MD |
201 | #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \ |
202 | static inline char *early_platform_driver_setup_func(void) \ | |
203 | { \ | |
204 | return bufsiz ? buf : NULL; \ | |
205 | } | |
13977091 MD |
206 | #endif /* MODULE */ |
207 | ||
bbbf508d | 208 | #endif /* _PLATFORM_DEVICE_H_ */ |