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