xref: /openbmc/linux/include/linux/of_platform.h (revision 73aca58b)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 #ifndef _LINUX_OF_PLATFORM_H
3 #define _LINUX_OF_PLATFORM_H
4 /*
5  *    Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp.
6  *			 <benh@kernel.crashing.org>
7  */
8 
9 #include <linux/mod_devicetable.h>
10 #include <linux/of_device.h>
11 #include <linux/platform_device.h>
12 
13 struct device;
14 struct of_device_id;
15 
16 /**
17  * struct of_dev_auxdata - lookup table entry for device names & platform_data
18  * @compatible: compatible value of node to match against node
19  * @phys_addr: Start address of registers to match against node
20  * @name: Name to assign for matching nodes
21  * @platform_data: platform_data to assign for matching nodes
22  *
23  * This lookup table allows the caller of of_platform_populate() to override
24  * the names of devices when creating devices from the device tree.  The table
25  * should be terminated with an empty entry.  It also allows the platform_data
26  * pointer to be set.
27  *
28  * The reason for this functionality is that some Linux infrastructure uses
29  * the device name to look up a specific device, but the Linux-specific names
30  * are not encoded into the device tree, so the kernel needs to provide specific
31  * values.
32  *
33  * Note: Using an auxdata lookup table should be considered a last resort when
34  * converting a platform to use the DT.  Normally the automatically generated
35  * device name will not matter, and drivers should obtain data from the device
36  * node instead of from an anonymous platform_data pointer.
37  */
38 struct of_dev_auxdata {
39 	char *compatible;
40 	resource_size_t phys_addr;
41 	char *name;
42 	void *platform_data;
43 };
44 
45 /* Macro to simplify populating a lookup table */
46 #define OF_DEV_AUXDATA(_compat,_phys,_name,_pdata) \
47 	{ .compatible = _compat, .phys_addr = _phys, .name = _name, \
48 	  .platform_data = _pdata }
49 
50 extern const struct of_device_id of_default_bus_match_table[];
51 
52 /* Platform drivers register/unregister */
53 extern struct platform_device *of_device_alloc(struct device_node *np,
54 					 const char *bus_id,
55 					 struct device *parent);
56 
57 extern int of_device_add(struct platform_device *pdev);
58 extern int of_device_register(struct platform_device *ofdev);
59 extern void of_device_unregister(struct platform_device *ofdev);
60 
61 #ifdef CONFIG_OF
62 extern struct platform_device *of_find_device_by_node(struct device_node *np);
63 #else
of_find_device_by_node(struct device_node * np)64 static inline struct platform_device *of_find_device_by_node(struct device_node *np)
65 {
66 	return NULL;
67 }
68 #endif
69 
70 extern int of_platform_bus_probe(struct device_node *root,
71 				 const struct of_device_id *matches,
72 				 struct device *parent);
73 
74 #ifdef CONFIG_OF_ADDRESS
75 /* Platform devices and busses creation */
76 extern struct platform_device *of_platform_device_create(struct device_node *np,
77 						   const char *bus_id,
78 						   struct device *parent);
79 
80 extern int of_platform_device_destroy(struct device *dev, void *data);
81 
82 extern int of_platform_populate(struct device_node *root,
83 				const struct of_device_id *matches,
84 				const struct of_dev_auxdata *lookup,
85 				struct device *parent);
86 extern int of_platform_default_populate(struct device_node *root,
87 					const struct of_dev_auxdata *lookup,
88 					struct device *parent);
89 extern void of_platform_depopulate(struct device *parent);
90 
91 extern int devm_of_platform_populate(struct device *dev);
92 
93 extern void devm_of_platform_depopulate(struct device *dev);
94 #else
95 /* Platform devices and busses creation */
of_platform_device_create(struct device_node * np,const char * bus_id,struct device * parent)96 static inline struct platform_device *of_platform_device_create(struct device_node *np,
97 								const char *bus_id,
98 								struct device *parent)
99 {
100 	return NULL;
101 }
of_platform_device_destroy(struct device * dev,void * data)102 static inline int of_platform_device_destroy(struct device *dev, void *data)
103 {
104 	return -ENODEV;
105 }
106 
of_platform_populate(struct device_node * root,const struct of_device_id * matches,const struct of_dev_auxdata * lookup,struct device * parent)107 static inline int of_platform_populate(struct device_node *root,
108 					const struct of_device_id *matches,
109 					const struct of_dev_auxdata *lookup,
110 					struct device *parent)
111 {
112 	return -ENODEV;
113 }
of_platform_default_populate(struct device_node * root,const struct of_dev_auxdata * lookup,struct device * parent)114 static inline int of_platform_default_populate(struct device_node *root,
115 					       const struct of_dev_auxdata *lookup,
116 					       struct device *parent)
117 {
118 	return -ENODEV;
119 }
of_platform_depopulate(struct device * parent)120 static inline void of_platform_depopulate(struct device *parent) { }
121 
devm_of_platform_populate(struct device * dev)122 static inline int devm_of_platform_populate(struct device *dev)
123 {
124 	return -ENODEV;
125 }
126 
devm_of_platform_depopulate(struct device * dev)127 static inline void devm_of_platform_depopulate(struct device *dev) { }
128 #endif
129 
130 #endif	/* _LINUX_OF_PLATFORM_H */
131