Loading...
1// SPDX-License-Identifier: GPL-2.0
2#include <linux/kernel.h>
3#include <linux/of.h>
4#include <linux/of_device.h>
5#include <linux/of_address.h>
6#include <linux/of_iommu.h>
7#include <linux/of_reserved_mem.h>
8#include <linux/dma-direct.h> /* for bus_dma_region */
9#include <linux/dma-map-ops.h>
10#include <linux/init.h>
11#include <linux/mod_devicetable.h>
12#include <linux/slab.h>
13#include <linux/platform_device.h>
14
15#include <asm/errno.h>
16#include "of_private.h"
17
18/**
19 * of_match_device - Tell if a struct device matches an of_device_id list
20 * @matches: array of of device match structures to search in
21 * @dev: the of device structure to match against
22 *
23 * Used by a driver to check whether an platform_device present in the
24 * system is in its list of supported devices.
25 */
26const struct of_device_id *of_match_device(const struct of_device_id *matches,
27 const struct device *dev)
28{
29 if (!matches || !dev->of_node || dev->of_node_reused)
30 return NULL;
31 return of_match_node(matches, dev->of_node);
32}
33EXPORT_SYMBOL(of_match_device);
34
35static void
36of_dma_set_restricted_buffer(struct device *dev, struct device_node *np)
37{
38 struct device_node *node, *of_node = dev->of_node;
39 int count, i;
40
41 if (!IS_ENABLED(CONFIG_DMA_RESTRICTED_POOL))
42 return;
43
44 count = of_property_count_elems_of_size(of_node, "memory-region",
45 sizeof(u32));
46 /*
47 * If dev->of_node doesn't exist or doesn't contain memory-region, try
48 * the OF node having DMA configuration.
49 */
50 if (count <= 0) {
51 of_node = np;
52 count = of_property_count_elems_of_size(
53 of_node, "memory-region", sizeof(u32));
54 }
55
56 for (i = 0; i < count; i++) {
57 node = of_parse_phandle(of_node, "memory-region", i);
58 /*
59 * There might be multiple memory regions, but only one
60 * restricted-dma-pool region is allowed.
61 */
62 if (of_device_is_compatible(node, "restricted-dma-pool") &&
63 of_device_is_available(node)) {
64 of_node_put(node);
65 break;
66 }
67 of_node_put(node);
68 }
69
70 /*
71 * Attempt to initialize a restricted-dma-pool region if one was found.
72 * Note that count can hold a negative error code.
73 */
74 if (i < count && of_reserved_mem_device_init_by_idx(dev, of_node, i))
75 dev_warn(dev, "failed to initialise \"restricted-dma-pool\" memory node\n");
76}
77
78/**
79 * of_dma_configure_id - Setup DMA configuration
80 * @dev: Device to apply DMA configuration
81 * @np: Pointer to OF node having DMA configuration
82 * @force_dma: Whether device is to be set up by of_dma_configure() even if
83 * DMA capability is not explicitly described by firmware.
84 * @id: Optional const pointer value input id
85 *
86 * Try to get devices's DMA configuration from DT and update it
87 * accordingly.
88 *
89 * If platform code needs to use its own special DMA configuration, it
90 * can use a platform bus notifier and handle BUS_NOTIFY_ADD_DEVICE events
91 * to fix up DMA configuration.
92 */
93int of_dma_configure_id(struct device *dev, struct device_node *np,
94 bool force_dma, const u32 *id)
95{
96 const struct bus_dma_region *map = NULL;
97 struct device_node *bus_np;
98 u64 mask, end = 0;
99 bool coherent, set_map = false;
100 int ret;
101
102 if (np == dev->of_node)
103 bus_np = __of_get_dma_parent(np);
104 else
105 bus_np = of_node_get(np);
106
107 ret = of_dma_get_range(bus_np, &map);
108 of_node_put(bus_np);
109 if (ret < 0) {
110 /*
111 * For legacy reasons, we have to assume some devices need
112 * DMA configuration regardless of whether "dma-ranges" is
113 * correctly specified or not.
114 */
115 if (!force_dma)
116 return ret == -ENODEV ? 0 : ret;
117 } else {
118 /* Determine the overall bounds of all DMA regions */
119 end = dma_range_map_max(map);
120 set_map = true;
121 }
122
123 /*
124 * If @dev is expected to be DMA-capable then the bus code that created
125 * it should have initialised its dma_mask pointer by this point. For
126 * now, we'll continue the legacy behaviour of coercing it to the
127 * coherent mask if not, but we'll no longer do so quietly.
128 */
129 if (!dev->dma_mask) {
130 dev_warn(dev, "DMA mask not set\n");
131 dev->dma_mask = &dev->coherent_dma_mask;
132 }
133
134 if (!end && dev->coherent_dma_mask)
135 end = dev->coherent_dma_mask;
136 else if (!end)
137 end = (1ULL << 32) - 1;
138
139 /*
140 * Limit coherent and dma mask based on size and default mask
141 * set by the driver.
142 */
143 mask = DMA_BIT_MASK(ilog2(end) + 1);
144 dev->coherent_dma_mask &= mask;
145 *dev->dma_mask &= mask;
146 /* ...but only set bus limit and range map if we found valid dma-ranges earlier */
147 if (set_map) {
148 dev->bus_dma_limit = end;
149 dev->dma_range_map = map;
150 }
151
152 coherent = of_dma_is_coherent(np);
153 dev_dbg(dev, "device is%sdma coherent\n",
154 coherent ? " " : " not ");
155
156 ret = of_iommu_configure(dev, np, id);
157 if (ret == -EPROBE_DEFER) {
158 /* Don't touch range map if it wasn't set from a valid dma-ranges */
159 if (set_map)
160 dev->dma_range_map = NULL;
161 kfree(map);
162 return -EPROBE_DEFER;
163 }
164 /* Take all other IOMMU errors to mean we'll just carry on without it */
165 dev_dbg(dev, "device is%sbehind an iommu\n",
166 !ret ? " " : " not ");
167
168 arch_setup_dma_ops(dev, coherent);
169
170 if (ret)
171 of_dma_set_restricted_buffer(dev, np);
172
173 return 0;
174}
175EXPORT_SYMBOL_GPL(of_dma_configure_id);
176
177const void *of_device_get_match_data(const struct device *dev)
178{
179 const struct of_device_id *match;
180
181 match = of_match_device(dev->driver->of_match_table, dev);
182 if (!match)
183 return NULL;
184
185 return match->data;
186}
187EXPORT_SYMBOL(of_device_get_match_data);
188
189/**
190 * of_device_modalias - Fill buffer with newline terminated modalias string
191 * @dev: Calling device
192 * @str: Modalias string
193 * @len: Size of @str
194 */
195ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
196{
197 ssize_t sl;
198
199 if (!dev || !dev->of_node || dev->of_node_reused)
200 return -ENODEV;
201
202 sl = of_modalias(dev->of_node, str, len - 2);
203 if (sl < 0)
204 return sl;
205 if (sl > len - 2)
206 return -ENOMEM;
207
208 str[sl++] = '\n';
209 str[sl] = 0;
210 return sl;
211}
212EXPORT_SYMBOL_GPL(of_device_modalias);
213
214/**
215 * of_device_uevent - Display OF related uevent information
216 * @dev: Device to display the uevent information for
217 * @env: Kernel object's userspace event reference to fill up
218 */
219void of_device_uevent(const struct device *dev, struct kobj_uevent_env *env)
220{
221 const char *compat, *type;
222 struct alias_prop *app;
223 struct property *p;
224 int seen = 0;
225
226 if ((!dev) || (!dev->of_node))
227 return;
228
229 add_uevent_var(env, "OF_NAME=%pOFn", dev->of_node);
230 add_uevent_var(env, "OF_FULLNAME=%pOF", dev->of_node);
231 type = of_node_get_device_type(dev->of_node);
232 if (type)
233 add_uevent_var(env, "OF_TYPE=%s", type);
234
235 /* Since the compatible field can contain pretty much anything
236 * it's not really legal to split it out with commas. We split it
237 * up using a number of environment variables instead. */
238 of_property_for_each_string(dev->of_node, "compatible", p, compat) {
239 add_uevent_var(env, "OF_COMPATIBLE_%d=%s", seen, compat);
240 seen++;
241 }
242 add_uevent_var(env, "OF_COMPATIBLE_N=%d", seen);
243
244 seen = 0;
245 mutex_lock(&of_mutex);
246 list_for_each_entry(app, &aliases_lookup, link) {
247 if (dev->of_node == app->np) {
248 add_uevent_var(env, "OF_ALIAS_%d=%s", seen,
249 app->alias);
250 seen++;
251 }
252 }
253 mutex_unlock(&of_mutex);
254}
255EXPORT_SYMBOL_GPL(of_device_uevent);
256
257int of_device_uevent_modalias(const struct device *dev, struct kobj_uevent_env *env)
258{
259 int sl;
260
261 if ((!dev) || (!dev->of_node) || dev->of_node_reused)
262 return -ENODEV;
263
264 /* Devicetree modalias is tricky, we add it in 2 steps */
265 if (add_uevent_var(env, "MODALIAS="))
266 return -ENOMEM;
267
268 sl = of_modalias(dev->of_node, &env->buf[env->buflen-1],
269 sizeof(env->buf) - env->buflen);
270 if (sl < 0)
271 return sl;
272 if (sl >= (sizeof(env->buf) - env->buflen))
273 return -ENOMEM;
274 env->buflen += sl;
275
276 return 0;
277}
278EXPORT_SYMBOL_GPL(of_device_uevent_modalias);
279
280/**
281 * of_device_make_bus_id - Use the device node data to assign a unique name
282 * @dev: pointer to device structure that is linked to a device tree node
283 *
284 * This routine will first try using the translated bus address to
285 * derive a unique name. If it cannot, then it will prepend names from
286 * parent nodes until a unique name can be derived.
287 */
288void of_device_make_bus_id(struct device *dev)
289{
290 struct device_node *node = dev->of_node;
291 const __be32 *reg;
292 u64 addr;
293 u32 mask;
294
295 /* Construct the name, using parent nodes if necessary to ensure uniqueness */
296 while (node->parent) {
297 /*
298 * If the address can be translated, then that is as much
299 * uniqueness as we need. Make it the first component and return
300 */
301 reg = of_get_property(node, "reg", NULL);
302 if (reg && (addr = of_translate_address(node, reg)) != OF_BAD_ADDR) {
303 if (!of_property_read_u32(node, "mask", &mask))
304 dev_set_name(dev, dev_name(dev) ? "%llx.%x.%pOFn:%s" : "%llx.%x.%pOFn",
305 addr, ffs(mask) - 1, node, dev_name(dev));
306
307 else
308 dev_set_name(dev, dev_name(dev) ? "%llx.%pOFn:%s" : "%llx.%pOFn",
309 addr, node, dev_name(dev));
310 return;
311 }
312
313 /* format arguments only used if dev_name() resolves to NULL */
314 dev_set_name(dev, dev_name(dev) ? "%s:%s" : "%s",
315 kbasename(node->full_name), dev_name(dev));
316 node = node->parent;
317 }
318}
319EXPORT_SYMBOL_GPL(of_device_make_bus_id);
1// SPDX-License-Identifier: GPL-2.0
2#include <linux/string.h>
3#include <linux/kernel.h>
4#include <linux/of.h>
5#include <linux/of_device.h>
6#include <linux/of_address.h>
7#include <linux/of_iommu.h>
8#include <linux/dma-direct.h> /* for bus_dma_region */
9#include <linux/dma-map-ops.h>
10#include <linux/init.h>
11#include <linux/module.h>
12#include <linux/mod_devicetable.h>
13#include <linux/slab.h>
14#include <linux/platform_device.h>
15
16#include <asm/errno.h>
17#include "of_private.h"
18
19/**
20 * of_match_device - Tell if a struct device matches an of_device_id list
21 * @matches: array of of device match structures to search in
22 * @dev: the of device structure to match against
23 *
24 * Used by a driver to check whether an platform_device present in the
25 * system is in its list of supported devices.
26 */
27const struct of_device_id *of_match_device(const struct of_device_id *matches,
28 const struct device *dev)
29{
30 if ((!matches) || (!dev->of_node))
31 return NULL;
32 return of_match_node(matches, dev->of_node);
33}
34EXPORT_SYMBOL(of_match_device);
35
36int of_device_add(struct platform_device *ofdev)
37{
38 BUG_ON(ofdev->dev.of_node == NULL);
39
40 /* name and id have to be set so that the platform bus doesn't get
41 * confused on matching */
42 ofdev->name = dev_name(&ofdev->dev);
43 ofdev->id = PLATFORM_DEVID_NONE;
44
45 /*
46 * If this device has not binding numa node in devicetree, that is
47 * of_node_to_nid returns NUMA_NO_NODE. device_add will assume that this
48 * device is on the same node as the parent.
49 */
50 set_dev_node(&ofdev->dev, of_node_to_nid(ofdev->dev.of_node));
51
52 return device_add(&ofdev->dev);
53}
54
55/**
56 * of_dma_configure_id - Setup DMA configuration
57 * @dev: Device to apply DMA configuration
58 * @np: Pointer to OF node having DMA configuration
59 * @force_dma: Whether device is to be set up by of_dma_configure() even if
60 * DMA capability is not explicitly described by firmware.
61 * @id: Optional const pointer value input id
62 *
63 * Try to get devices's DMA configuration from DT and update it
64 * accordingly.
65 *
66 * If platform code needs to use its own special DMA configuration, it
67 * can use a platform bus notifier and handle BUS_NOTIFY_ADD_DEVICE events
68 * to fix up DMA configuration.
69 */
70int of_dma_configure_id(struct device *dev, struct device_node *np,
71 bool force_dma, const u32 *id)
72{
73 const struct iommu_ops *iommu;
74 const struct bus_dma_region *map = NULL;
75 u64 dma_start = 0;
76 u64 mask, end, size = 0;
77 bool coherent;
78 int ret;
79
80 ret = of_dma_get_range(np, &map);
81 if (ret < 0) {
82 /*
83 * For legacy reasons, we have to assume some devices need
84 * DMA configuration regardless of whether "dma-ranges" is
85 * correctly specified or not.
86 */
87 if (!force_dma)
88 return ret == -ENODEV ? 0 : ret;
89 } else {
90 const struct bus_dma_region *r = map;
91 u64 dma_end = 0;
92
93 /* Determine the overall bounds of all DMA regions */
94 for (dma_start = ~0; r->size; r++) {
95 /* Take lower and upper limits */
96 if (r->dma_start < dma_start)
97 dma_start = r->dma_start;
98 if (r->dma_start + r->size > dma_end)
99 dma_end = r->dma_start + r->size;
100 }
101 size = dma_end - dma_start;
102
103 /*
104 * Add a work around to treat the size as mask + 1 in case
105 * it is defined in DT as a mask.
106 */
107 if (size & 1) {
108 dev_warn(dev, "Invalid size 0x%llx for dma-range(s)\n",
109 size);
110 size = size + 1;
111 }
112
113 if (!size) {
114 dev_err(dev, "Adjusted size 0x%llx invalid\n", size);
115 kfree(map);
116 return -EINVAL;
117 }
118 }
119
120 /*
121 * If @dev is expected to be DMA-capable then the bus code that created
122 * it should have initialised its dma_mask pointer by this point. For
123 * now, we'll continue the legacy behaviour of coercing it to the
124 * coherent mask if not, but we'll no longer do so quietly.
125 */
126 if (!dev->dma_mask) {
127 dev_warn(dev, "DMA mask not set\n");
128 dev->dma_mask = &dev->coherent_dma_mask;
129 }
130
131 if (!size && dev->coherent_dma_mask)
132 size = max(dev->coherent_dma_mask, dev->coherent_dma_mask + 1);
133 else if (!size)
134 size = 1ULL << 32;
135
136 /*
137 * Limit coherent and dma mask based on size and default mask
138 * set by the driver.
139 */
140 end = dma_start + size - 1;
141 mask = DMA_BIT_MASK(ilog2(end) + 1);
142 dev->coherent_dma_mask &= mask;
143 *dev->dma_mask &= mask;
144 /* ...but only set bus limit and range map if we found valid dma-ranges earlier */
145 if (!ret) {
146 dev->bus_dma_limit = end;
147 dev->dma_range_map = map;
148 }
149
150 coherent = of_dma_is_coherent(np);
151 dev_dbg(dev, "device is%sdma coherent\n",
152 coherent ? " " : " not ");
153
154 iommu = of_iommu_configure(dev, np, id);
155 if (PTR_ERR(iommu) == -EPROBE_DEFER) {
156 /* Don't touch range map if it wasn't set from a valid dma-ranges */
157 if (!ret)
158 dev->dma_range_map = NULL;
159 kfree(map);
160 return -EPROBE_DEFER;
161 }
162
163 dev_dbg(dev, "device is%sbehind an iommu\n",
164 iommu ? " " : " not ");
165
166 arch_setup_dma_ops(dev, dma_start, size, iommu, coherent);
167
168 return 0;
169}
170EXPORT_SYMBOL_GPL(of_dma_configure_id);
171
172int of_device_register(struct platform_device *pdev)
173{
174 device_initialize(&pdev->dev);
175 return of_device_add(pdev);
176}
177EXPORT_SYMBOL(of_device_register);
178
179void of_device_unregister(struct platform_device *ofdev)
180{
181 device_unregister(&ofdev->dev);
182}
183EXPORT_SYMBOL(of_device_unregister);
184
185const void *of_device_get_match_data(const struct device *dev)
186{
187 const struct of_device_id *match;
188
189 match = of_match_device(dev->driver->of_match_table, dev);
190 if (!match)
191 return NULL;
192
193 return match->data;
194}
195EXPORT_SYMBOL(of_device_get_match_data);
196
197static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len)
198{
199 const char *compat;
200 char *c;
201 struct property *p;
202 ssize_t csize;
203 ssize_t tsize;
204
205 if ((!dev) || (!dev->of_node))
206 return -ENODEV;
207
208 /* Name & Type */
209 /* %p eats all alphanum characters, so %c must be used here */
210 csize = snprintf(str, len, "of:N%pOFn%c%s", dev->of_node, 'T',
211 of_node_get_device_type(dev->of_node));
212 tsize = csize;
213 len -= csize;
214 if (str)
215 str += csize;
216
217 of_property_for_each_string(dev->of_node, "compatible", p, compat) {
218 csize = strlen(compat) + 1;
219 tsize += csize;
220 if (csize > len)
221 continue;
222
223 csize = snprintf(str, len, "C%s", compat);
224 for (c = str; c; ) {
225 c = strchr(c, ' ');
226 if (c)
227 *c++ = '_';
228 }
229 len -= csize;
230 str += csize;
231 }
232
233 return tsize;
234}
235
236int of_device_request_module(struct device *dev)
237{
238 char *str;
239 ssize_t size;
240 int ret;
241
242 size = of_device_get_modalias(dev, NULL, 0);
243 if (size < 0)
244 return size;
245
246 str = kmalloc(size + 1, GFP_KERNEL);
247 if (!str)
248 return -ENOMEM;
249
250 of_device_get_modalias(dev, str, size);
251 str[size] = '\0';
252 ret = request_module(str);
253 kfree(str);
254
255 return ret;
256}
257EXPORT_SYMBOL_GPL(of_device_request_module);
258
259/**
260 * of_device_modalias - Fill buffer with newline terminated modalias string
261 * @dev: Calling device
262 * @str: Modalias string
263 * @len: Size of @str
264 */
265ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
266{
267 ssize_t sl = of_device_get_modalias(dev, str, len - 2);
268 if (sl < 0)
269 return sl;
270 if (sl > len - 2)
271 return -ENOMEM;
272
273 str[sl++] = '\n';
274 str[sl] = 0;
275 return sl;
276}
277EXPORT_SYMBOL_GPL(of_device_modalias);
278
279/**
280 * of_device_uevent - Display OF related uevent information
281 * @dev: Device to apply DMA configuration
282 * @env: Kernel object's userspace event reference
283 */
284void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)
285{
286 const char *compat, *type;
287 struct alias_prop *app;
288 struct property *p;
289 int seen = 0;
290
291 if ((!dev) || (!dev->of_node))
292 return;
293
294 add_uevent_var(env, "OF_NAME=%pOFn", dev->of_node);
295 add_uevent_var(env, "OF_FULLNAME=%pOF", dev->of_node);
296 type = of_node_get_device_type(dev->of_node);
297 if (type)
298 add_uevent_var(env, "OF_TYPE=%s", type);
299
300 /* Since the compatible field can contain pretty much anything
301 * it's not really legal to split it out with commas. We split it
302 * up using a number of environment variables instead. */
303 of_property_for_each_string(dev->of_node, "compatible", p, compat) {
304 add_uevent_var(env, "OF_COMPATIBLE_%d=%s", seen, compat);
305 seen++;
306 }
307 add_uevent_var(env, "OF_COMPATIBLE_N=%d", seen);
308
309 seen = 0;
310 mutex_lock(&of_mutex);
311 list_for_each_entry(app, &aliases_lookup, link) {
312 if (dev->of_node == app->np) {
313 add_uevent_var(env, "OF_ALIAS_%d=%s", seen,
314 app->alias);
315 seen++;
316 }
317 }
318 mutex_unlock(&of_mutex);
319}
320
321int of_device_uevent_modalias(struct device *dev, struct kobj_uevent_env *env)
322{
323 int sl;
324
325 if ((!dev) || (!dev->of_node))
326 return -ENODEV;
327
328 /* Devicetree modalias is tricky, we add it in 2 steps */
329 if (add_uevent_var(env, "MODALIAS="))
330 return -ENOMEM;
331
332 sl = of_device_get_modalias(dev, &env->buf[env->buflen-1],
333 sizeof(env->buf) - env->buflen);
334 if (sl >= (sizeof(env->buf) - env->buflen))
335 return -ENOMEM;
336 env->buflen += sl;
337
338 return 0;
339}
340EXPORT_SYMBOL_GPL(of_device_uevent_modalias);