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
11struct device;
12struct device_node;
13struct of_device_id;
14struct platform_device;
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 */
38struct 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/* Platform drivers register/unregister */
51extern struct platform_device *of_device_alloc(struct device_node *np,
52 const char *bus_id,
53 struct device *parent);
54
55extern int of_device_add(struct platform_device *pdev);
56extern int of_device_register(struct platform_device *ofdev);
57extern void of_device_unregister(struct platform_device *ofdev);
58
59#ifdef CONFIG_OF
60extern struct platform_device *of_find_device_by_node(struct device_node *np);
61#else
62static inline struct platform_device *of_find_device_by_node(struct device_node *np)
63{
64 return NULL;
65}
66#endif
67
68extern int of_platform_bus_probe(struct device_node *root,
69 const struct of_device_id *matches,
70 struct device *parent);
71
72#ifdef CONFIG_OF_ADDRESS
73/* Platform devices and busses creation */
74extern struct platform_device *of_platform_device_create(struct device_node *np,
75 const char *bus_id,
76 struct device *parent);
77
78extern int of_platform_device_destroy(struct device *dev, void *data);
79
80extern int of_platform_populate(struct device_node *root,
81 const struct of_device_id *matches,
82 const struct of_dev_auxdata *lookup,
83 struct device *parent);
84extern int of_platform_default_populate(struct device_node *root,
85 const struct of_dev_auxdata *lookup,
86 struct device *parent);
87extern void of_platform_depopulate(struct device *parent);
88
89extern int devm_of_platform_populate(struct device *dev);
90
91extern void devm_of_platform_depopulate(struct device *dev);
92#else
93/* Platform devices and busses creation */
94static inline struct platform_device *of_platform_device_create(struct device_node *np,
95 const char *bus_id,
96 struct device *parent)
97{
98 return NULL;
99}
100static inline int of_platform_device_destroy(struct device *dev, void *data)
101{
102 return -ENODEV;
103}
104
105static inline int of_platform_populate(struct device_node *root,
106 const struct of_device_id *matches,
107 const struct of_dev_auxdata *lookup,
108 struct device *parent)
109{
110 return -ENODEV;
111}
112static inline int of_platform_default_populate(struct device_node *root,
113 const struct of_dev_auxdata *lookup,
114 struct device *parent)
115{
116 return -ENODEV;
117}
118static inline void of_platform_depopulate(struct device *parent) { }
119
120static inline int devm_of_platform_populate(struct device *dev)
121{
122 return -ENODEV;
123}
124
125static inline void devm_of_platform_depopulate(struct device *dev) { }
126#endif
127
128#endif /* _LINUX_OF_PLATFORM_H */
129