xref: /linux-6.15/include/linux/of_platform.h (revision 5bf2b193)
1 #ifndef _LINUX_OF_PLATFORM_H
2 #define _LINUX_OF_PLATFORM_H
3 /*
4  *    Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp.
5  *			 <[email protected]>
6  *
7  *  This program is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU General Public License
9  *  as published by the Free Software Foundation; either version
10  *  2 of the License, or (at your option) any later version.
11  *
12  */
13 
14 #ifdef CONFIG_OF_DEVICE
15 #include <linux/module.h>
16 #include <linux/device.h>
17 #include <linux/mod_devicetable.h>
18 #include <linux/pm.h>
19 #include <linux/of_device.h>
20 #include <linux/platform_device.h>
21 
22 /*
23  * An of_platform_driver driver is attached to a basic of_device on
24  * the "platform bus" (platform_bus_type).
25  */
26 struct of_platform_driver
27 {
28 	int	(*probe)(struct platform_device* dev,
29 			 const struct of_device_id *match);
30 	int	(*remove)(struct platform_device* dev);
31 
32 	int	(*suspend)(struct platform_device* dev, pm_message_t state);
33 	int	(*resume)(struct platform_device* dev);
34 	int	(*shutdown)(struct platform_device* dev);
35 
36 	struct device_driver	driver;
37 	struct platform_driver	platform_driver;
38 };
39 #define	to_of_platform_driver(drv) \
40 	container_of(drv,struct of_platform_driver, driver)
41 
42 extern int of_register_driver(struct of_platform_driver *drv,
43 			      struct bus_type *bus);
44 extern void of_unregister_driver(struct of_platform_driver *drv);
45 
46 /* Platform drivers register/unregister */
47 extern int of_register_platform_driver(struct of_platform_driver *drv);
48 extern void of_unregister_platform_driver(struct of_platform_driver *drv);
49 
50 extern struct platform_device *of_device_alloc(struct device_node *np,
51 					 const char *bus_id,
52 					 struct device *parent);
53 extern struct platform_device *of_find_device_by_node(struct device_node *np);
54 
55 extern int of_bus_type_init(struct bus_type *bus, const char *name);
56 
57 #if !defined(CONFIG_SPARC) /* SPARC has its own device registration method */
58 /* Platform devices and busses creation */
59 extern struct platform_device *of_platform_device_create(struct device_node *np,
60 						   const char *bus_id,
61 						   struct device *parent);
62 
63 /* pseudo "matches" value to not do deep probe */
64 #define OF_NO_DEEP_PROBE ((struct of_device_id *)-1)
65 
66 extern int of_platform_bus_probe(struct device_node *root,
67 				 const struct of_device_id *matches,
68 				 struct device *parent);
69 #endif /* !CONFIG_SPARC */
70 
71 #endif /* CONFIG_OF_DEVICE */
72 
73 #endif	/* _LINUX_OF_PLATFORM_H */
74