1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * platform_device.h - generic, centralized driver model
5 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
7 * See Documentation/driver-api/driver-model/ for more information.
10 #ifndef _PLATFORM_DEVICE_H_
11 #define _PLATFORM_DEVICE_H_
13 #include <linux/device.h>
15 #define PLATFORM_DEVID_NONE (-1)
16 #define PLATFORM_DEVID_AUTO (-2)
19 struct property_entry;
20 struct platform_device_id;
22 struct platform_device {
29 struct resource *resource;
31 const struct platform_device_id *id_entry;
32 char *driver_override; /* Driver name to force a match */
34 /* MFD cell pointer */
35 struct mfd_cell *mfd_cell;
37 /* arch specific additions */
38 struct pdev_archdata archdata;
41 #define platform_get_device_id(pdev) ((pdev)->id_entry)
43 #define dev_is_platform(dev) ((dev)->bus == &platform_bus_type)
44 #define to_platform_device(x) container_of((x), struct platform_device, dev)
46 extern int platform_device_register(struct platform_device *);
47 extern void platform_device_unregister(struct platform_device *);
49 extern struct bus_type platform_bus_type;
50 extern struct device platform_bus;
52 extern struct resource *platform_get_resource(struct platform_device *,
53 unsigned int, unsigned int);
54 extern struct device *
55 platform_find_device_by_driver(struct device *start,
56 const struct device_driver *drv);
58 devm_platform_ioremap_resource(struct platform_device *pdev,
60 extern int platform_get_irq(struct platform_device *, unsigned int);
61 extern int platform_get_irq_optional(struct platform_device *, unsigned int);
62 extern int platform_irq_count(struct platform_device *);
63 extern struct resource *platform_get_resource_byname(struct platform_device *,
66 extern int platform_get_irq_byname(struct platform_device *, const char *);
67 extern int platform_add_devices(struct platform_device **, int);
69 struct platform_device_info {
70 struct device *parent;
71 struct fwnode_handle *fwnode;
77 const struct resource *res;
84 struct property_entry *properties;
86 extern struct platform_device *platform_device_register_full(
87 const struct platform_device_info *pdevinfo);
90 * platform_device_register_resndata - add a platform-level device with
91 * resources and platform-specific data
93 * @parent: parent device for the device we're adding
94 * @name: base name of the device we're adding
96 * @res: set of resources that needs to be allocated for the device
97 * @num: number of resources
98 * @data: platform specific data for this platform device
99 * @size: size of platform specific data
101 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
103 static inline struct platform_device *platform_device_register_resndata(
104 struct device *parent, const char *name, int id,
105 const struct resource *res, unsigned int num,
106 const void *data, size_t size) {
108 struct platform_device_info pdevinfo = {
119 return platform_device_register_full(&pdevinfo);
123 * platform_device_register_simple - add a platform-level device and its resources
124 * @name: base name of the device we're adding
126 * @res: set of resources that needs to be allocated for the device
127 * @num: number of resources
129 * This function creates a simple platform device that requires minimal
130 * resource and memory management. Canned release function freeing memory
131 * allocated for the device allows drivers using such devices to be
132 * unloaded without waiting for the last reference to the device to be
135 * This interface is primarily intended for use with legacy drivers which
136 * probe hardware directly. Because such drivers create sysfs device nodes
137 * themselves, rather than letting system infrastructure handle such device
138 * enumeration tasks, they don't fully conform to the Linux driver model.
139 * In particular, when such drivers are built as modules, they can't be
142 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
144 static inline struct platform_device *platform_device_register_simple(
145 const char *name, int id,
146 const struct resource *res, unsigned int num)
148 return platform_device_register_resndata(NULL, name, id,
153 * platform_device_register_data - add a platform-level device with platform-specific data
154 * @parent: parent device for the device we're adding
155 * @name: base name of the device we're adding
157 * @data: platform specific data for this platform device
158 * @size: size of platform specific data
160 * This function creates a simple platform device that requires minimal
161 * resource and memory management. Canned release function freeing memory
162 * allocated for the device allows drivers using such devices to be
163 * unloaded without waiting for the last reference to the device to be
166 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
168 static inline struct platform_device *platform_device_register_data(
169 struct device *parent, const char *name, int id,
170 const void *data, size_t size)
172 return platform_device_register_resndata(parent, name, id,
173 NULL, 0, data, size);
176 extern struct platform_device *platform_device_alloc(const char *name, int id);
177 extern int platform_device_add_resources(struct platform_device *pdev,
178 const struct resource *res,
180 extern int platform_device_add_data(struct platform_device *pdev,
181 const void *data, size_t size);
182 extern int platform_device_add_properties(struct platform_device *pdev,
183 const struct property_entry *properties);
184 extern int platform_device_add(struct platform_device *pdev);
185 extern void platform_device_del(struct platform_device *pdev);
186 extern void platform_device_put(struct platform_device *pdev);
188 struct platform_driver {
189 int (*probe)(struct platform_device *);
190 int (*remove)(struct platform_device *);
191 void (*shutdown)(struct platform_device *);
192 int (*suspend)(struct platform_device *, pm_message_t state);
193 int (*resume)(struct platform_device *);
194 struct device_driver driver;
195 const struct platform_device_id *id_table;
196 bool prevent_deferred_probe;
199 #define to_platform_driver(drv) (container_of((drv), struct platform_driver, \
203 * use a macro to avoid include chaining to get THIS_MODULE
205 #define platform_driver_register(drv) \
206 __platform_driver_register(drv, THIS_MODULE)
207 extern int __platform_driver_register(struct platform_driver *,
209 extern void platform_driver_unregister(struct platform_driver *);
211 /* non-hotpluggable platform devices may use this so that probe() and
212 * its support may live in __init sections, conserving runtime memory.
214 #define platform_driver_probe(drv, probe) \
215 __platform_driver_probe(drv, probe, THIS_MODULE)
216 extern int __platform_driver_probe(struct platform_driver *driver,
217 int (*probe)(struct platform_device *), struct module *module);
219 static inline void *platform_get_drvdata(const struct platform_device *pdev)
221 return dev_get_drvdata(&pdev->dev);
224 static inline void platform_set_drvdata(struct platform_device *pdev,
227 dev_set_drvdata(&pdev->dev, data);
230 /* module_platform_driver() - Helper macro for drivers that don't do
231 * anything special in module init/exit. This eliminates a lot of
232 * boilerplate. Each module may only use this macro once, and
233 * calling it replaces module_init() and module_exit()
235 #define module_platform_driver(__platform_driver) \
236 module_driver(__platform_driver, platform_driver_register, \
237 platform_driver_unregister)
239 /* builtin_platform_driver() - Helper macro for builtin drivers that
240 * don't do anything special in driver init. This eliminates some
241 * boilerplate. Each driver may only use this macro once, and
242 * calling it replaces device_initcall(). Note this is meant to be
243 * a parallel of module_platform_driver() above, but w/o _exit stuff.
245 #define builtin_platform_driver(__platform_driver) \
246 builtin_driver(__platform_driver, platform_driver_register)
248 /* module_platform_driver_probe() - Helper macro for drivers that don't do
249 * anything special in module init/exit. This eliminates a lot of
250 * boilerplate. Each module may only use this macro once, and
251 * calling it replaces module_init() and module_exit()
253 #define module_platform_driver_probe(__platform_driver, __platform_probe) \
254 static int __init __platform_driver##_init(void) \
256 return platform_driver_probe(&(__platform_driver), \
259 module_init(__platform_driver##_init); \
260 static void __exit __platform_driver##_exit(void) \
262 platform_driver_unregister(&(__platform_driver)); \
264 module_exit(__platform_driver##_exit);
266 /* builtin_platform_driver_probe() - Helper macro for drivers that don't do
267 * anything special in device init. This eliminates some boilerplate. Each
268 * driver may only use this macro once, and using it replaces device_initcall.
269 * This is meant to be a parallel of module_platform_driver_probe above, but
270 * without the __exit parts.
272 #define builtin_platform_driver_probe(__platform_driver, __platform_probe) \
273 static int __init __platform_driver##_init(void) \
275 return platform_driver_probe(&(__platform_driver), \
278 device_initcall(__platform_driver##_init); \
280 #define platform_create_bundle(driver, probe, res, n_res, data, size) \
281 __platform_create_bundle(driver, probe, res, n_res, data, size, THIS_MODULE)
282 extern struct platform_device *__platform_create_bundle(
283 struct platform_driver *driver, int (*probe)(struct platform_device *),
284 struct resource *res, unsigned int n_res,
285 const void *data, size_t size, struct module *module);
287 int __platform_register_drivers(struct platform_driver * const *drivers,
288 unsigned int count, struct module *owner);
289 void platform_unregister_drivers(struct platform_driver * const *drivers,
292 #define platform_register_drivers(drivers, count) \
293 __platform_register_drivers(drivers, count, THIS_MODULE)
295 /* early platform driver interface */
296 struct early_platform_driver {
297 const char *class_str;
298 struct platform_driver *pdrv;
299 struct list_head list;
305 #define EARLY_PLATFORM_ID_UNSET -2
306 #define EARLY_PLATFORM_ID_ERROR -3
308 extern int early_platform_driver_register(struct early_platform_driver *epdrv,
310 extern void early_platform_add_devices(struct platform_device **devs, int num);
312 static inline int is_early_platform_device(struct platform_device *pdev)
314 return !pdev->dev.driver;
317 extern void early_platform_driver_register_all(char *class_str);
318 extern int early_platform_driver_probe(char *class_str,
319 int nr_probe, int user_only);
320 extern void early_platform_cleanup(void);
322 #define early_platform_init(class_string, platdrv) \
323 early_platform_init_buffer(class_string, platdrv, NULL, 0)
326 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
327 static __initdata struct early_platform_driver early_driver = { \
328 .class_str = class_string, \
332 .requested_id = EARLY_PLATFORM_ID_UNSET, \
334 static int __init early_platform_driver_setup_func(char *buffer) \
336 return early_platform_driver_register(&early_driver, buffer); \
338 early_param(class_string, early_platform_driver_setup_func)
340 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
341 static inline char *early_platform_driver_setup_func(void) \
343 return bufsiz ? buf : NULL; \
347 #ifdef CONFIG_SUSPEND
348 extern int platform_pm_suspend(struct device *dev);
349 extern int platform_pm_resume(struct device *dev);
351 #define platform_pm_suspend NULL
352 #define platform_pm_resume NULL
355 #ifdef CONFIG_HIBERNATE_CALLBACKS
356 extern int platform_pm_freeze(struct device *dev);
357 extern int platform_pm_thaw(struct device *dev);
358 extern int platform_pm_poweroff(struct device *dev);
359 extern int platform_pm_restore(struct device *dev);
361 #define platform_pm_freeze NULL
362 #define platform_pm_thaw NULL
363 #define platform_pm_poweroff NULL
364 #define platform_pm_restore NULL
367 extern int platform_dma_configure(struct device *dev);
369 #ifdef CONFIG_PM_SLEEP
370 #define USE_PLATFORM_PM_SLEEP_OPS \
371 .suspend = platform_pm_suspend, \
372 .resume = platform_pm_resume, \
373 .freeze = platform_pm_freeze, \
374 .thaw = platform_pm_thaw, \
375 .poweroff = platform_pm_poweroff, \
376 .restore = platform_pm_restore,
378 #define USE_PLATFORM_PM_SLEEP_OPS
381 #endif /* _PLATFORM_DEVICE_H_ */