Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 mfd_cell;
18
19struct platform_device {
20 const char * name;
21 int id;
22 struct device dev;
23 u32 num_resources;
24 struct resource * resource;
25
26 const struct platform_device_id *id_entry;
27
28 /* MFD cell pointer */
29 struct mfd_cell *mfd_cell;
30
31 /* arch specific additions */
32 struct pdev_archdata archdata;
33};
34
35#define platform_get_device_id(pdev) ((pdev)->id_entry)
36
37#define to_platform_device(x) container_of((x), struct platform_device, dev)
38
39extern int platform_device_register(struct platform_device *);
40extern void platform_device_unregister(struct platform_device *);
41
42extern struct bus_type platform_bus_type;
43extern struct device platform_bus;
44
45extern void arch_setup_pdev_archdata(struct platform_device *);
46extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
47extern int platform_get_irq(struct platform_device *, unsigned int);
48extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, const char *);
49extern int platform_get_irq_byname(struct platform_device *, const char *);
50extern int platform_add_devices(struct platform_device **, int);
51
52extern struct platform_device *platform_device_register_resndata(
53 struct device *parent, const char *name, int id,
54 const struct resource *res, unsigned int num,
55 const void *data, size_t size);
56
57/**
58 * platform_device_register_simple - add a platform-level device and its resources
59 * @name: base name of the device we're adding
60 * @id: instance id
61 * @res: set of resources that needs to be allocated for the device
62 * @num: number of resources
63 *
64 * This function creates a simple platform device that requires minimal
65 * resource and memory management. Canned release function freeing memory
66 * allocated for the device allows drivers using such devices to be
67 * unloaded without waiting for the last reference to the device to be
68 * dropped.
69 *
70 * This interface is primarily intended for use with legacy drivers which
71 * probe hardware directly. Because such drivers create sysfs device nodes
72 * themselves, rather than letting system infrastructure handle such device
73 * enumeration tasks, they don't fully conform to the Linux driver model.
74 * In particular, when such drivers are built as modules, they can't be
75 * "hotplugged".
76 *
77 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
78 */
79static inline struct platform_device *platform_device_register_simple(
80 const char *name, int id,
81 const struct resource *res, unsigned int num)
82{
83 return platform_device_register_resndata(NULL, name, id,
84 res, num, NULL, 0);
85}
86
87/**
88 * platform_device_register_data - add a platform-level device with platform-specific data
89 * @parent: parent device for the device we're adding
90 * @name: base name of the device we're adding
91 * @id: instance id
92 * @data: platform specific data for this platform device
93 * @size: size of platform specific data
94 *
95 * This function creates a simple platform device that requires minimal
96 * resource and memory management. Canned release function freeing memory
97 * allocated for the device allows drivers using such devices to be
98 * unloaded without waiting for the last reference to the device to be
99 * dropped.
100 *
101 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
102 */
103static inline struct platform_device *platform_device_register_data(
104 struct device *parent, const char *name, int id,
105 const void *data, size_t size)
106{
107 return platform_device_register_resndata(parent, name, id,
108 NULL, 0, data, size);
109}
110
111extern struct platform_device *platform_device_alloc(const char *name, int id);
112extern int platform_device_add_resources(struct platform_device *pdev,
113 const struct resource *res,
114 unsigned int num);
115extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size);
116extern int platform_device_add(struct platform_device *pdev);
117extern void platform_device_del(struct platform_device *pdev);
118extern void platform_device_put(struct platform_device *pdev);
119
120struct platform_driver {
121 int (*probe)(struct platform_device *);
122 int (*remove)(struct platform_device *);
123 void (*shutdown)(struct platform_device *);
124 int (*suspend)(struct platform_device *, pm_message_t state);
125 int (*resume)(struct platform_device *);
126 struct device_driver driver;
127 const struct platform_device_id *id_table;
128};
129
130extern int platform_driver_register(struct platform_driver *);
131extern void platform_driver_unregister(struct platform_driver *);
132
133/* non-hotpluggable platform devices may use this so that probe() and
134 * its support may live in __init sections, conserving runtime memory.
135 */
136extern int platform_driver_probe(struct platform_driver *driver,
137 int (*probe)(struct platform_device *));
138
139static inline void *platform_get_drvdata(const struct platform_device *pdev)
140{
141 return dev_get_drvdata(&pdev->dev);
142}
143
144static inline void platform_set_drvdata(struct platform_device *pdev, void *data)
145{
146 dev_set_drvdata(&pdev->dev, data);
147}
148
149extern struct platform_device *platform_create_bundle(struct platform_driver *driver,
150 int (*probe)(struct platform_device *),
151 struct resource *res, unsigned int n_res,
152 const void *data, size_t size);
153
154/* early platform driver interface */
155struct early_platform_driver {
156 const char *class_str;
157 struct platform_driver *pdrv;
158 struct list_head list;
159 int requested_id;
160 char *buffer;
161 int bufsize;
162};
163
164#define EARLY_PLATFORM_ID_UNSET -2
165#define EARLY_PLATFORM_ID_ERROR -3
166
167extern int early_platform_driver_register(struct early_platform_driver *epdrv,
168 char *buf);
169extern void early_platform_add_devices(struct platform_device **devs, int num);
170
171static inline int is_early_platform_device(struct platform_device *pdev)
172{
173 return !pdev->dev.driver;
174}
175
176extern void early_platform_driver_register_all(char *class_str);
177extern int early_platform_driver_probe(char *class_str,
178 int nr_probe, int user_only);
179extern void early_platform_cleanup(void);
180
181#define early_platform_init(class_string, platdrv) \
182 early_platform_init_buffer(class_string, platdrv, NULL, 0)
183
184#ifndef MODULE
185#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
186static __initdata struct early_platform_driver early_driver = { \
187 .class_str = class_string, \
188 .buffer = buf, \
189 .bufsize = bufsiz, \
190 .pdrv = platdrv, \
191 .requested_id = EARLY_PLATFORM_ID_UNSET, \
192}; \
193static int __init early_platform_driver_setup_func(char *buffer) \
194{ \
195 return early_platform_driver_register(&early_driver, buffer); \
196} \
197early_param(class_string, early_platform_driver_setup_func)
198#else /* MODULE */
199#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
200static inline char *early_platform_driver_setup_func(void) \
201{ \
202 return bufsiz ? buf : NULL; \
203}
204#endif /* MODULE */
205
206#ifdef CONFIG_PM_SLEEP
207extern int platform_pm_prepare(struct device *dev);
208extern void platform_pm_complete(struct device *dev);
209#else
210#define platform_pm_prepare NULL
211#define platform_pm_complete NULL
212#endif
213
214#ifdef CONFIG_SUSPEND
215extern int platform_pm_suspend(struct device *dev);
216extern int platform_pm_suspend_noirq(struct device *dev);
217extern int platform_pm_resume(struct device *dev);
218extern int platform_pm_resume_noirq(struct device *dev);
219#else
220#define platform_pm_suspend NULL
221#define platform_pm_resume NULL
222#define platform_pm_suspend_noirq NULL
223#define platform_pm_resume_noirq NULL
224#endif
225
226#ifdef CONFIG_HIBERNATE_CALLBACKS
227extern int platform_pm_freeze(struct device *dev);
228extern int platform_pm_freeze_noirq(struct device *dev);
229extern int platform_pm_thaw(struct device *dev);
230extern int platform_pm_thaw_noirq(struct device *dev);
231extern int platform_pm_poweroff(struct device *dev);
232extern int platform_pm_poweroff_noirq(struct device *dev);
233extern int platform_pm_restore(struct device *dev);
234extern int platform_pm_restore_noirq(struct device *dev);
235#else
236#define platform_pm_freeze NULL
237#define platform_pm_thaw NULL
238#define platform_pm_poweroff NULL
239#define platform_pm_restore NULL
240#define platform_pm_freeze_noirq NULL
241#define platform_pm_thaw_noirq NULL
242#define platform_pm_poweroff_noirq NULL
243#define platform_pm_restore_noirq NULL
244#endif
245
246#ifdef CONFIG_PM_SLEEP
247#define USE_PLATFORM_PM_SLEEP_OPS \
248 .prepare = platform_pm_prepare, \
249 .complete = platform_pm_complete, \
250 .suspend = platform_pm_suspend, \
251 .resume = platform_pm_resume, \
252 .freeze = platform_pm_freeze, \
253 .thaw = platform_pm_thaw, \
254 .poweroff = platform_pm_poweroff, \
255 .restore = platform_pm_restore, \
256 .suspend_noirq = platform_pm_suspend_noirq, \
257 .resume_noirq = platform_pm_resume_noirq, \
258 .freeze_noirq = platform_pm_freeze_noirq, \
259 .thaw_noirq = platform_pm_thaw_noirq, \
260 .poweroff_noirq = platform_pm_poweroff_noirq, \
261 .restore_noirq = platform_pm_restore_noirq,
262#else
263#define USE_PLATFORM_PM_SLEEP_OPS
264#endif
265
266#endif /* _PLATFORM_DEVICE_H_ */