blob: b80891b438168491b6434afb2086b4f2424ffc7e [file] [log] [blame]
Stephen Rothwell3f23de12007-05-03 02:38:57 +10001/*
2 * Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp.
3 * <benh@kernel.crashing.org>
4 * and Arnd Bergmann, IBM Corp.
5 * Merged from powerpc/kernel/of_platform.c and
6 * sparc{,64}/kernel/of_device.c by Stephen Rothwell
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version
11 * 2 of the License, or (at your option) any later version.
12 *
13 */
14#include <linux/errno.h>
Stephen Rothwell5c457082007-10-17 21:17:42 -070015#include <linux/module.h>
Grant Likely5de15402011-06-21 10:59:34 -060016#include <linux/amba/bus.h>
Stephen Rothwell3f23de12007-05-03 02:38:57 +100017#include <linux/device.h>
Grant Likely5fd200f2010-06-08 07:48:13 -060018#include <linux/dma-mapping.h>
Grant Likely50ef5282010-06-08 07:48:20 -060019#include <linux/slab.h>
Grant Likely9e3288d2010-06-08 07:48:26 -060020#include <linux/of_address.h>
Stephen Rothwell3f23de12007-05-03 02:38:57 +100021#include <linux/of_device.h>
Grant Likely9e3288d2010-06-08 07:48:26 -060022#include <linux/of_irq.h>
Stephen Rothwell3f23de12007-05-03 02:38:57 +100023#include <linux/of_platform.h>
Grant Likelyeca39302010-06-08 07:48:21 -060024#include <linux/platform_device.h>
25
Grant Likelycbb49c22011-06-21 10:59:34 -060026const struct of_device_id of_default_bus_match_table[] = {
27 { .compatible = "simple-bus", },
28#ifdef CONFIG_ARM_AMBA
29 { .compatible = "arm,amba-bus", },
30#endif /* CONFIG_ARM_AMBA */
31 {} /* Empty terminated list */
32};
33
Jonas Bonnc6085582010-07-23 19:19:35 +020034static int of_dev_node_match(struct device *dev, void *data)
35{
36 return dev->of_node == data;
37}
38
39/**
40 * of_find_device_by_node - Find the platform_device associated with a node
41 * @np: Pointer to device tree node
42 *
43 * Returns platform_device pointer, or NULL if not found
44 */
45struct platform_device *of_find_device_by_node(struct device_node *np)
46{
47 struct device *dev;
48
49 dev = bus_find_device(&platform_bus_type, NULL, np, of_dev_node_match);
50 return dev ? to_platform_device(dev) : NULL;
51}
52EXPORT_SYMBOL(of_find_device_by_node);
53
Grant Likely596c9552010-07-14 23:51:43 -060054#if defined(CONFIG_PPC_DCR)
55#include <asm/dcr.h>
56#endif
57
Grant Likely964dba22012-02-24 14:58:34 -070058#ifdef CONFIG_OF_ADDRESS
Grant Likely5fd200f2010-06-08 07:48:13 -060059/*
60 * The following routines scan a subtree and registers a device for
61 * each applicable node.
62 *
63 * Note: sparc doesn't use these routines because it has a different
64 * mechanism for creating devices from device tree nodes.
65 */
66
67/**
Grant Likely94c09312010-06-08 07:48:14 -060068 * of_device_make_bus_id - Use the device node data to assign a unique name
69 * @dev: pointer to device structure that is linked to a device tree node
70 *
71 * This routine will first try using either the dcr-reg or the reg property
72 * value to derive a unique name. As a last resort it will use the node
73 * name followed by a unique number.
74 */
Grant Likelyc6601222010-07-23 15:04:01 -060075void of_device_make_bus_id(struct device *dev)
Grant Likely94c09312010-06-08 07:48:14 -060076{
77 static atomic_t bus_no_reg_magic;
78 struct device_node *node = dev->of_node;
Kim Phillips24fb5302012-10-08 19:42:11 -050079 const __be32 *reg;
Grant Likely94c09312010-06-08 07:48:14 -060080 u64 addr;
Stephen Warren5d61b162012-07-25 17:34:37 -060081 const __be32 *addrp;
Grant Likely94c09312010-06-08 07:48:14 -060082 int magic;
83
84#ifdef CONFIG_PPC_DCR
85 /*
86 * If it's a DCR based device, use 'd' for native DCRs
87 * and 'D' for MMIO DCRs.
88 */
89 reg = of_get_property(node, "dcr-reg", NULL);
90 if (reg) {
91#ifdef CONFIG_PPC_DCR_NATIVE
92 dev_set_name(dev, "d%x.%s", *reg, node->name);
93#else /* CONFIG_PPC_DCR_NATIVE */
94 u64 addr = of_translate_dcr_address(node, *reg, NULL);
95 if (addr != OF_BAD_ADDR) {
96 dev_set_name(dev, "D%llx.%s",
97 (unsigned long long)addr, node->name);
98 return;
99 }
100#endif /* !CONFIG_PPC_DCR_NATIVE */
101 }
102#endif /* CONFIG_PPC_DCR */
103
104 /*
105 * For MMIO, get the physical address
106 */
107 reg = of_get_property(node, "reg", NULL);
108 if (reg) {
Stephen Warren5d61b162012-07-25 17:34:37 -0600109 if (of_can_translate_address(node)) {
110 addr = of_translate_address(node, reg);
111 } else {
112 addrp = of_get_address(node, 0, NULL, NULL);
113 if (addrp)
114 addr = of_read_number(addrp, 1);
115 else
116 addr = OF_BAD_ADDR;
117 }
Grant Likely94c09312010-06-08 07:48:14 -0600118 if (addr != OF_BAD_ADDR) {
119 dev_set_name(dev, "%llx.%s",
120 (unsigned long long)addr, node->name);
121 return;
122 }
123 }
124
125 /*
126 * No BusID, use the node name and add a globally incremented
127 * counter (and pray...)
128 */
129 magic = atomic_add_return(1, &bus_no_reg_magic);
130 dev_set_name(dev, "%s.%d", node->name, magic - 1);
131}
132
133/**
134 * of_device_alloc - Allocate and initialize an of_device
135 * @np: device node to assign to device
136 * @bus_id: Name to assign to the device. May be null to use default name.
137 * @parent: Parent device.
138 */
Grant Likely94a0cb12010-07-22 13:59:23 -0600139struct platform_device *of_device_alloc(struct device_node *np,
Grant Likely94c09312010-06-08 07:48:14 -0600140 const char *bus_id,
141 struct device *parent)
142{
Grant Likely94a0cb12010-07-22 13:59:23 -0600143 struct platform_device *dev;
Andres Salomon52f65372010-10-10 21:35:05 -0600144 int rc, i, num_reg = 0, num_irq;
Grant Likelyac80a512010-06-08 07:48:15 -0600145 struct resource *res, temp_res;
Grant Likely94c09312010-06-08 07:48:14 -0600146
Grant Likely7096d042010-10-20 11:45:13 -0600147 dev = platform_device_alloc("", -1);
148 if (!dev)
149 return NULL;
150
151 /* count the io and irq resources */
Stephen Warren5d61b162012-07-25 17:34:37 -0600152 if (of_can_translate_address(np))
153 while (of_address_to_resource(np, num_reg, &temp_res) == 0)
154 num_reg++;
Andres Salomon52f65372010-10-10 21:35:05 -0600155 num_irq = of_irq_count(np);
Grant Likelyac80a512010-06-08 07:48:15 -0600156
Grant Likelyac80a512010-06-08 07:48:15 -0600157 /* Populate the resource table */
158 if (num_irq || num_reg) {
Grant Likely7096d042010-10-20 11:45:13 -0600159 res = kzalloc(sizeof(*res) * (num_irq + num_reg), GFP_KERNEL);
160 if (!res) {
161 platform_device_put(dev);
162 return NULL;
163 }
164
Grant Likelyac80a512010-06-08 07:48:15 -0600165 dev->num_resources = num_reg + num_irq;
166 dev->resource = res;
167 for (i = 0; i < num_reg; i++, res++) {
168 rc = of_address_to_resource(np, i, res);
169 WARN_ON(rc);
170 }
Andres Salomon52f65372010-10-10 21:35:05 -0600171 WARN_ON(of_irq_to_resource_table(np, res, num_irq) != num_irq);
Grant Likelyac80a512010-06-08 07:48:15 -0600172 }
Grant Likely94c09312010-06-08 07:48:14 -0600173
174 dev->dev.of_node = of_node_get(np);
Kumar Gala314b02f2011-07-08 00:17:27 -0500175#if defined(CONFIG_MICROBLAZE)
Grant Likely94c09312010-06-08 07:48:14 -0600176 dev->dev.dma_mask = &dev->archdata.dma_mask;
Grant Likely9e3288d2010-06-08 07:48:26 -0600177#endif
Grant Likely94c09312010-06-08 07:48:14 -0600178 dev->dev.parent = parent;
Grant Likely94c09312010-06-08 07:48:14 -0600179
180 if (bus_id)
181 dev_set_name(&dev->dev, "%s", bus_id);
182 else
183 of_device_make_bus_id(&dev->dev);
184
185 return dev;
186}
187EXPORT_SYMBOL(of_device_alloc);
188
189/**
Grant Likely15c35972011-06-21 10:59:35 -0600190 * of_platform_device_create_pdata - Alloc, initialize and register an of_device
Grant Likely5fd200f2010-06-08 07:48:13 -0600191 * @np: pointer to node to create device for
192 * @bus_id: name to assign device
Grant Likely15c35972011-06-21 10:59:35 -0600193 * @platform_data: pointer to populate platform_data pointer with
Grant Likely5fd200f2010-06-08 07:48:13 -0600194 * @parent: Linux device model parent device.
Grant Likelycd1e6502011-01-03 15:51:11 -0700195 *
196 * Returns pointer to created platform device, or NULL if a device was not
197 * registered. Unavailable devices will not get registered.
Grant Likely5fd200f2010-06-08 07:48:13 -0600198 */
Grant Likely15c35972011-06-21 10:59:35 -0600199struct platform_device *of_platform_device_create_pdata(
200 struct device_node *np,
201 const char *bus_id,
202 void *platform_data,
203 struct device *parent)
Grant Likely5fd200f2010-06-08 07:48:13 -0600204{
Grant Likely94a0cb12010-07-22 13:59:23 -0600205 struct platform_device *dev;
Grant Likely5fd200f2010-06-08 07:48:13 -0600206
Grant Likelycd1e6502011-01-03 15:51:11 -0700207 if (!of_device_is_available(np))
208 return NULL;
209
Grant Likely5fd200f2010-06-08 07:48:13 -0600210 dev = of_device_alloc(np, bus_id, parent);
211 if (!dev)
212 return NULL;
213
Kumar Gala314b02f2011-07-08 00:17:27 -0500214#if defined(CONFIG_MICROBLAZE)
Grant Likely5fd200f2010-06-08 07:48:13 -0600215 dev->archdata.dma_mask = 0xffffffffUL;
Grant Likely9e3288d2010-06-08 07:48:26 -0600216#endif
Grant Likely5fd200f2010-06-08 07:48:13 -0600217 dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
Grant Likelyeca39302010-06-08 07:48:21 -0600218 dev->dev.bus = &platform_bus_type;
Grant Likely15c35972011-06-21 10:59:35 -0600219 dev->dev.platform_data = platform_data;
Grant Likely5fd200f2010-06-08 07:48:13 -0600220
221 /* We do not fill the DMA ops for platform devices by default.
222 * This is currently the responsibility of the platform code
223 * to do such, possibly using a device notifier
224 */
225
Grant Likely7096d042010-10-20 11:45:13 -0600226 if (of_device_add(dev) != 0) {
227 platform_device_put(dev);
Grant Likely5fd200f2010-06-08 07:48:13 -0600228 return NULL;
229 }
230
231 return dev;
232}
Grant Likely15c35972011-06-21 10:59:35 -0600233
234/**
235 * of_platform_device_create - Alloc, initialize and register an of_device
236 * @np: pointer to node to create device for
237 * @bus_id: name to assign device
238 * @parent: Linux device model parent device.
239 *
240 * Returns pointer to created platform device, or NULL if a device was not
241 * registered. Unavailable devices will not get registered.
242 */
243struct platform_device *of_platform_device_create(struct device_node *np,
244 const char *bus_id,
245 struct device *parent)
246{
247 return of_platform_device_create_pdata(np, bus_id, NULL, parent);
248}
Grant Likely5fd200f2010-06-08 07:48:13 -0600249EXPORT_SYMBOL(of_platform_device_create);
250
Grant Likely5de15402011-06-21 10:59:34 -0600251#ifdef CONFIG_ARM_AMBA
252static struct amba_device *of_amba_device_create(struct device_node *node,
253 const char *bus_id,
254 void *platform_data,
255 struct device *parent)
256{
257 struct amba_device *dev;
258 const void *prop;
259 int i, ret;
260
261 pr_debug("Creating amba device %s\n", node->full_name);
262
263 if (!of_device_is_available(node))
264 return NULL;
265
Russell Kingc0f72f82011-12-18 11:45:17 +0000266 dev = amba_device_alloc(NULL, 0, 0);
Grant Likely5de15402011-06-21 10:59:34 -0600267 if (!dev)
268 return NULL;
269
270 /* setup generic device info */
271 dev->dev.coherent_dma_mask = ~0;
272 dev->dev.of_node = of_node_get(node);
273 dev->dev.parent = parent;
274 dev->dev.platform_data = platform_data;
275 if (bus_id)
276 dev_set_name(&dev->dev, "%s", bus_id);
277 else
278 of_device_make_bus_id(&dev->dev);
279
280 /* setup amba-specific device info */
281 dev->dma_mask = ~0;
282
283 /* Allow the HW Peripheral ID to be overridden */
284 prop = of_get_property(node, "arm,primecell-periphid", NULL);
285 if (prop)
286 dev->periphid = of_read_ulong(prop, 1);
287
288 /* Decode the IRQs and address ranges */
289 for (i = 0; i < AMBA_NR_IRQS; i++)
290 dev->irq[i] = irq_of_parse_and_map(node, i);
291
292 ret = of_address_to_resource(node, 0, &dev->res);
293 if (ret)
294 goto err_free;
295
Russell Kingc0f72f82011-12-18 11:45:17 +0000296 ret = amba_device_add(dev, &iomem_resource);
Grant Likely5de15402011-06-21 10:59:34 -0600297 if (ret)
298 goto err_free;
299
300 return dev;
301
302err_free:
Russell Kingc0f72f82011-12-18 11:45:17 +0000303 amba_device_put(dev);
Grant Likely5de15402011-06-21 10:59:34 -0600304 return NULL;
305}
306#else /* CONFIG_ARM_AMBA */
307static struct amba_device *of_amba_device_create(struct device_node *node,
308 const char *bus_id,
309 void *platform_data,
310 struct device *parent)
311{
312 return NULL;
313}
314#endif /* CONFIG_ARM_AMBA */
315
Grant Likely5fd200f2010-06-08 07:48:13 -0600316/**
Grant Likely15c35972011-06-21 10:59:35 -0600317 * of_devname_lookup() - Given a device node, lookup the preferred Linux name
318 */
319static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
320 struct device_node *np)
321{
322 struct resource res;
Olof Johansson303f59d2011-11-02 22:07:29 -0700323
324 if (!lookup)
325 return NULL;
326
Grant Likelyf88e1ae2011-12-12 09:26:00 -0700327 for(; lookup->compatible != NULL; lookup++) {
Olof Johansson303f59d2011-11-02 22:07:29 -0700328 if (!of_device_is_compatible(np, lookup->compatible))
329 continue;
Lee Jones84774e62012-07-05 15:15:36 +0100330 if (!of_address_to_resource(np, 0, &res))
331 if (res.start != lookup->phys_addr)
332 continue;
Olof Johansson303f59d2011-11-02 22:07:29 -0700333 pr_debug("%s: devname=%s\n", np->full_name, lookup->name);
334 return lookup;
Grant Likely15c35972011-06-21 10:59:35 -0600335 }
Olof Johansson303f59d2011-11-02 22:07:29 -0700336
Grant Likely15c35972011-06-21 10:59:35 -0600337 return NULL;
338}
339
340/**
Grant Likely38e9e212011-03-18 10:21:28 -0600341 * of_platform_bus_create() - Create a device for a node and its children.
Grant Likely5fd200f2010-06-08 07:48:13 -0600342 * @bus: device node of the bus to instantiate
Grant Likely1eed4c02011-03-18 10:21:29 -0600343 * @matches: match table for bus nodes
Olof Johansson303f59d2011-11-02 22:07:29 -0700344 * @lookup: auxdata table for matching id and platform_data with device nodes
Grant Likely38e9e212011-03-18 10:21:28 -0600345 * @parent: parent for new device, or NULL for top level.
Olof Johansson303f59d2011-11-02 22:07:29 -0700346 * @strict: require compatible property
Grant Likely38e9e212011-03-18 10:21:28 -0600347 *
348 * Creates a platform_device for the provided device_node, and optionally
349 * recursively create devices for all the child nodes.
Grant Likely5fd200f2010-06-08 07:48:13 -0600350 */
Grant Likely38e9e212011-03-18 10:21:28 -0600351static int of_platform_bus_create(struct device_node *bus,
Grant Likely5fd200f2010-06-08 07:48:13 -0600352 const struct of_device_id *matches,
Grant Likely15c35972011-06-21 10:59:35 -0600353 const struct of_dev_auxdata *lookup,
Grant Likely29d4f8a2011-06-21 10:59:34 -0600354 struct device *parent, bool strict)
Grant Likely5fd200f2010-06-08 07:48:13 -0600355{
Grant Likely15c35972011-06-21 10:59:35 -0600356 const struct of_dev_auxdata *auxdata;
Grant Likely5fd200f2010-06-08 07:48:13 -0600357 struct device_node *child;
Grant Likely94a0cb12010-07-22 13:59:23 -0600358 struct platform_device *dev;
Grant Likely15c35972011-06-21 10:59:35 -0600359 const char *bus_id = NULL;
360 void *platform_data = NULL;
Grant Likely5fd200f2010-06-08 07:48:13 -0600361 int rc = 0;
362
Grant Likely29d4f8a2011-06-21 10:59:34 -0600363 /* Make sure it has a compatible property */
364 if (strict && (!of_get_property(bus, "compatible", NULL))) {
365 pr_debug("%s() - skipping %s, no compatible prop\n",
366 __func__, bus->full_name);
367 return 0;
368 }
369
Grant Likely15c35972011-06-21 10:59:35 -0600370 auxdata = of_dev_lookup(lookup, bus);
371 if (auxdata) {
372 bus_id = auxdata->name;
373 platform_data = auxdata->platform_data;
374 }
375
Grant Likely5de15402011-06-21 10:59:34 -0600376 if (of_device_is_compatible(bus, "arm,primecell")) {
Grant Likely15c35972011-06-21 10:59:35 -0600377 of_amba_device_create(bus, bus_id, platform_data, parent);
Grant Likely5de15402011-06-21 10:59:34 -0600378 return 0;
379 }
380
Grant Likely15c35972011-06-21 10:59:35 -0600381 dev = of_platform_device_create_pdata(bus, bus_id, platform_data, parent);
Grant Likely38e9e212011-03-18 10:21:28 -0600382 if (!dev || !of_match_node(matches, bus))
383 return 0;
384
Grant Likely5fd200f2010-06-08 07:48:13 -0600385 for_each_child_of_node(bus, child) {
386 pr_debug(" create child: %s\n", child->full_name);
Grant Likely15c35972011-06-21 10:59:35 -0600387 rc = of_platform_bus_create(child, matches, lookup, &dev->dev, strict);
Grant Likely5fd200f2010-06-08 07:48:13 -0600388 if (rc) {
389 of_node_put(child);
390 break;
391 }
392 }
393 return rc;
394}
395
396/**
Grant Likely38e9e212011-03-18 10:21:28 -0600397 * of_platform_bus_probe() - Probe the device-tree for platform buses
Grant Likely5fd200f2010-06-08 07:48:13 -0600398 * @root: parent of the first level to probe or NULL for the root of the tree
Grant Likely1eed4c02011-03-18 10:21:29 -0600399 * @matches: match table for bus nodes
Grant Likely5fd200f2010-06-08 07:48:13 -0600400 * @parent: parent to hook devices from, NULL for toplevel
401 *
402 * Note that children of the provided root are not instantiated as devices
403 * unless the specified root itself matches the bus list and is not NULL.
404 */
405int of_platform_bus_probe(struct device_node *root,
406 const struct of_device_id *matches,
407 struct device *parent)
408{
409 struct device_node *child;
Grant Likely5fd200f2010-06-08 07:48:13 -0600410 int rc = 0;
411
Grant Likely1eed4c02011-03-18 10:21:29 -0600412 root = root ? of_node_get(root) : of_find_node_by_path("/");
413 if (!root)
Grant Likely60d59912010-06-08 07:48:25 -0600414 return -EINVAL;
Grant Likely5fd200f2010-06-08 07:48:13 -0600415
416 pr_debug("of_platform_bus_probe()\n");
417 pr_debug(" starting at: %s\n", root->full_name);
418
Grant Likely1eed4c02011-03-18 10:21:29 -0600419 /* Do a self check of bus type, if there's a match, create children */
Grant Likely5fd200f2010-06-08 07:48:13 -0600420 if (of_match_node(matches, root)) {
Grant Likely15c35972011-06-21 10:59:35 -0600421 rc = of_platform_bus_create(root, matches, NULL, parent, false);
Grant Likely38e9e212011-03-18 10:21:28 -0600422 } else for_each_child_of_node(root, child) {
Grant Likely5fd200f2010-06-08 07:48:13 -0600423 if (!of_match_node(matches, child))
424 continue;
Grant Likely15c35972011-06-21 10:59:35 -0600425 rc = of_platform_bus_create(child, matches, NULL, parent, false);
Grant Likely38e9e212011-03-18 10:21:28 -0600426 if (rc)
Grant Likely5fd200f2010-06-08 07:48:13 -0600427 break;
Grant Likely5fd200f2010-06-08 07:48:13 -0600428 }
Grant Likely38e9e212011-03-18 10:21:28 -0600429
Grant Likely5fd200f2010-06-08 07:48:13 -0600430 of_node_put(root);
431 return rc;
432}
433EXPORT_SYMBOL(of_platform_bus_probe);
Grant Likely29d4f8a2011-06-21 10:59:34 -0600434
435/**
436 * of_platform_populate() - Populate platform_devices from device tree data
437 * @root: parent of the first level to probe or NULL for the root of the tree
438 * @matches: match table, NULL to use the default
439 * @parent: parent to hook devices from, NULL for toplevel
440 *
441 * Similar to of_platform_bus_probe(), this function walks the device tree
442 * and creates devices from nodes. It differs in that it follows the modern
443 * convention of requiring all device nodes to have a 'compatible' property,
444 * and it is suitable for creating devices which are children of the root
445 * node (of_platform_bus_probe will only create children of the root which
446 * are selected by the @matches argument).
447 *
448 * New board support should be using this function instead of
449 * of_platform_bus_probe().
450 *
451 * Returns 0 on success, < 0 on failure.
452 */
453int of_platform_populate(struct device_node *root,
454 const struct of_device_id *matches,
Grant Likely15c35972011-06-21 10:59:35 -0600455 const struct of_dev_auxdata *lookup,
Grant Likely29d4f8a2011-06-21 10:59:34 -0600456 struct device *parent)
457{
458 struct device_node *child;
459 int rc = 0;
460
461 root = root ? of_node_get(root) : of_find_node_by_path("/");
462 if (!root)
463 return -EINVAL;
464
465 for_each_child_of_node(root, child) {
Grant Likely15c35972011-06-21 10:59:35 -0600466 rc = of_platform_bus_create(child, matches, lookup, parent, true);
Grant Likely29d4f8a2011-06-21 10:59:34 -0600467 if (rc)
468 break;
469 }
470
471 of_node_put(root);
472 return rc;
473}
Stephen Warrene001f1c2012-06-07 17:57:36 -0600474EXPORT_SYMBOL_GPL(of_platform_populate);
Grant Likely964dba22012-02-24 14:58:34 -0700475#endif /* CONFIG_OF_ADDRESS */