8f73413fa2430b5a630122683e3b450a7360e5ba
[muen/linux.git] / drivers / of / platform.c
1 /*
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
15 #define pr_fmt(fmt)     "OF: " fmt
16
17 #include <linux/errno.h>
18 #include <linux/module.h>
19 #include <linux/amba/bus.h>
20 #include <linux/device.h>
21 #include <linux/dma-mapping.h>
22 #include <linux/slab.h>
23 #include <linux/of_address.h>
24 #include <linux/of_device.h>
25 #include <linux/of_iommu.h>
26 #include <linux/of_irq.h>
27 #include <linux/of_platform.h>
28 #include <linux/platform_device.h>
29
30 const struct of_device_id of_default_bus_match_table[] = {
31         { .compatible = "simple-bus", },
32         { .compatible = "simple-mfd", },
33         { .compatible = "isa", },
34 #ifdef CONFIG_ARM_AMBA
35         { .compatible = "arm,amba-bus", },
36 #endif /* CONFIG_ARM_AMBA */
37         {} /* Empty terminated list */
38 };
39
40 static int of_dev_node_match(struct device *dev, void *data)
41 {
42         return dev->of_node == data;
43 }
44
45 /**
46  * of_find_device_by_node - Find the platform_device associated with a node
47  * @np: Pointer to device tree node
48  *
49  * Takes a reference to the embedded struct device which needs to be dropped
50  * after use.
51  *
52  * Returns platform_device pointer, or NULL if not found
53  */
54 struct platform_device *of_find_device_by_node(struct device_node *np)
55 {
56         struct device *dev;
57
58         dev = bus_find_device(&platform_bus_type, NULL, np, of_dev_node_match);
59         return dev ? to_platform_device(dev) : NULL;
60 }
61 EXPORT_SYMBOL(of_find_device_by_node);
62
63 #ifdef CONFIG_OF_ADDRESS
64 /*
65  * The following routines scan a subtree and registers a device for
66  * each applicable node.
67  *
68  * Note: sparc doesn't use these routines because it has a different
69  * mechanism for creating devices from device tree nodes.
70  */
71
72 /**
73  * of_device_make_bus_id - Use the device node data to assign a unique name
74  * @dev: pointer to device structure that is linked to a device tree node
75  *
76  * This routine will first try using the translated bus address to
77  * derive a unique name. If it cannot, then it will prepend names from
78  * parent nodes until a unique name can be derived.
79  */
80 static void of_device_make_bus_id(struct device *dev)
81 {
82         struct device_node *node = dev->of_node;
83         const __be32 *reg;
84         u64 addr;
85
86         /* Construct the name, using parent nodes if necessary to ensure uniqueness */
87         while (node->parent) {
88                 /*
89                  * If the address can be translated, then that is as much
90                  * uniqueness as we need. Make it the first component and return
91                  */
92                 reg = of_get_property(node, "reg", NULL);
93                 if (reg && (addr = of_translate_address(node, reg)) != OF_BAD_ADDR) {
94                         dev_set_name(dev, dev_name(dev) ? "%llx.%s:%s" : "%llx.%s",
95                                      (unsigned long long)addr, node->name,
96                                      dev_name(dev));
97                         return;
98                 }
99
100                 /* format arguments only used if dev_name() resolves to NULL */
101                 dev_set_name(dev, dev_name(dev) ? "%s:%s" : "%s",
102                              kbasename(node->full_name), dev_name(dev));
103                 node = node->parent;
104         }
105 }
106
107 /**
108  * of_device_alloc - Allocate and initialize an of_device
109  * @np: device node to assign to device
110  * @bus_id: Name to assign to the device.  May be null to use default name.
111  * @parent: Parent device.
112  */
113 struct platform_device *of_device_alloc(struct device_node *np,
114                                   const char *bus_id,
115                                   struct device *parent)
116 {
117         struct platform_device *dev;
118         int rc, i, num_reg = 0, num_irq;
119         struct resource *res, temp_res;
120
121         dev = platform_device_alloc("", -1);
122         if (!dev)
123                 return NULL;
124
125         /* count the io and irq resources */
126         while (of_address_to_resource(np, num_reg, &temp_res) == 0)
127                 num_reg++;
128         num_irq = of_irq_count(np);
129
130         /* Populate the resource table */
131         if (num_irq || num_reg) {
132                 res = kzalloc(sizeof(*res) * (num_irq + num_reg), GFP_KERNEL);
133                 if (!res) {
134                         platform_device_put(dev);
135                         return NULL;
136                 }
137
138                 dev->num_resources = num_reg + num_irq;
139                 dev->resource = res;
140                 for (i = 0; i < num_reg; i++, res++) {
141                         rc = of_address_to_resource(np, i, res);
142                         WARN_ON(rc);
143                 }
144                 if (of_irq_to_resource_table(np, res, num_irq) != num_irq)
145                         pr_debug("not all legacy IRQ resources mapped for %s\n",
146                                  np->name);
147         }
148
149         dev->dev.of_node = of_node_get(np);
150         dev->dev.fwnode = &np->fwnode;
151         dev->dev.parent = parent ? : &platform_bus;
152
153         if (bus_id)
154                 dev_set_name(&dev->dev, "%s", bus_id);
155         else
156                 of_device_make_bus_id(&dev->dev);
157
158         return dev;
159 }
160 EXPORT_SYMBOL(of_device_alloc);
161
162 /**
163  * of_platform_device_create_pdata - Alloc, initialize and register an of_device
164  * @np: pointer to node to create device for
165  * @bus_id: name to assign device
166  * @platform_data: pointer to populate platform_data pointer with
167  * @parent: Linux device model parent device.
168  *
169  * Returns pointer to created platform device, or NULL if a device was not
170  * registered.  Unavailable devices will not get registered.
171  */
172 static struct platform_device *of_platform_device_create_pdata(
173                                         struct device_node *np,
174                                         const char *bus_id,
175                                         void *platform_data,
176                                         struct device *parent)
177 {
178         struct platform_device *dev;
179
180         if (!of_device_is_available(np) ||
181             of_node_test_and_set_flag(np, OF_POPULATED))
182                 return NULL;
183
184         dev = of_device_alloc(np, bus_id, parent);
185         if (!dev)
186                 goto err_clear_flag;
187
188         dev->dev.bus = &platform_bus_type;
189         dev->dev.platform_data = platform_data;
190         of_msi_configure(&dev->dev, dev->dev.of_node);
191
192         if (of_device_add(dev) != 0) {
193                 platform_device_put(dev);
194                 goto err_clear_flag;
195         }
196
197         return dev;
198
199 err_clear_flag:
200         of_node_clear_flag(np, OF_POPULATED);
201         return NULL;
202 }
203
204 /**
205  * of_platform_device_create - Alloc, initialize and register an of_device
206  * @np: pointer to node to create device for
207  * @bus_id: name to assign device
208  * @parent: Linux device model parent device.
209  *
210  * Returns pointer to created platform device, or NULL if a device was not
211  * registered.  Unavailable devices will not get registered.
212  */
213 struct platform_device *of_platform_device_create(struct device_node *np,
214                                             const char *bus_id,
215                                             struct device *parent)
216 {
217         return of_platform_device_create_pdata(np, bus_id, NULL, parent);
218 }
219 EXPORT_SYMBOL(of_platform_device_create);
220
221 #ifdef CONFIG_ARM_AMBA
222 static struct amba_device *of_amba_device_create(struct device_node *node,
223                                                  const char *bus_id,
224                                                  void *platform_data,
225                                                  struct device *parent)
226 {
227         struct amba_device *dev;
228         const void *prop;
229         int i, ret;
230
231         pr_debug("Creating amba device %s\n", node->full_name);
232
233         if (!of_device_is_available(node) ||
234             of_node_test_and_set_flag(node, OF_POPULATED))
235                 return NULL;
236
237         dev = amba_device_alloc(NULL, 0, 0);
238         if (!dev)
239                 goto err_clear_flag;
240
241         /* setup generic device info */
242         dev->dev.of_node = of_node_get(node);
243         dev->dev.fwnode = &node->fwnode;
244         dev->dev.parent = parent ? : &platform_bus;
245         dev->dev.platform_data = platform_data;
246         if (bus_id)
247                 dev_set_name(&dev->dev, "%s", bus_id);
248         else
249                 of_device_make_bus_id(&dev->dev);
250
251         /* Allow the HW Peripheral ID to be overridden */
252         prop = of_get_property(node, "arm,primecell-periphid", NULL);
253         if (prop)
254                 dev->periphid = of_read_ulong(prop, 1);
255
256         /* Decode the IRQs and address ranges */
257         for (i = 0; i < AMBA_NR_IRQS; i++)
258                 dev->irq[i] = irq_of_parse_and_map(node, i);
259
260         ret = of_address_to_resource(node, 0, &dev->res);
261         if (ret) {
262                 pr_err("amba: of_address_to_resource() failed (%d) for %s\n",
263                        ret, node->full_name);
264                 goto err_free;
265         }
266
267         ret = amba_device_add(dev, &iomem_resource);
268         if (ret) {
269                 pr_err("amba_device_add() failed (%d) for %s\n",
270                        ret, node->full_name);
271                 goto err_free;
272         }
273
274         return dev;
275
276 err_free:
277         amba_device_put(dev);
278 err_clear_flag:
279         of_node_clear_flag(node, OF_POPULATED);
280         return NULL;
281 }
282 #else /* CONFIG_ARM_AMBA */
283 static struct amba_device *of_amba_device_create(struct device_node *node,
284                                                  const char *bus_id,
285                                                  void *platform_data,
286                                                  struct device *parent)
287 {
288         return NULL;
289 }
290 #endif /* CONFIG_ARM_AMBA */
291
292 /**
293  * of_devname_lookup() - Given a device node, lookup the preferred Linux name
294  */
295 static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
296                                  struct device_node *np)
297 {
298         const struct of_dev_auxdata *auxdata;
299         struct resource res;
300         int compatible = 0;
301
302         if (!lookup)
303                 return NULL;
304
305         auxdata = lookup;
306         for (; auxdata->compatible; auxdata++) {
307                 if (!of_device_is_compatible(np, auxdata->compatible))
308                         continue;
309                 compatible++;
310                 if (!of_address_to_resource(np, 0, &res))
311                         if (res.start != auxdata->phys_addr)
312                                 continue;
313                 pr_debug("%s: devname=%s\n", np->full_name, auxdata->name);
314                 return auxdata;
315         }
316
317         if (!compatible)
318                 return NULL;
319
320         /* Try compatible match if no phys_addr and name are specified */
321         auxdata = lookup;
322         for (; auxdata->compatible; auxdata++) {
323                 if (!of_device_is_compatible(np, auxdata->compatible))
324                         continue;
325                 if (!auxdata->phys_addr && !auxdata->name) {
326                         pr_debug("%s: compatible match\n", np->full_name);
327                         return auxdata;
328                 }
329         }
330
331         return NULL;
332 }
333
334 /**
335  * of_platform_bus_create() - Create a device for a node and its children.
336  * @bus: device node of the bus to instantiate
337  * @matches: match table for bus nodes
338  * @lookup: auxdata table for matching id and platform_data with device nodes
339  * @parent: parent for new device, or NULL for top level.
340  * @strict: require compatible property
341  *
342  * Creates a platform_device for the provided device_node, and optionally
343  * recursively create devices for all the child nodes.
344  */
345 static int of_platform_bus_create(struct device_node *bus,
346                                   const struct of_device_id *matches,
347                                   const struct of_dev_auxdata *lookup,
348                                   struct device *parent, bool strict)
349 {
350         const struct of_dev_auxdata *auxdata;
351         struct device_node *child;
352         struct platform_device *dev;
353         const char *bus_id = NULL;
354         void *platform_data = NULL;
355         int rc = 0;
356
357         /* Make sure it has a compatible property */
358         if (strict && (!of_get_property(bus, "compatible", NULL))) {
359                 pr_debug("%s() - skipping %s, no compatible prop\n",
360                          __func__, bus->full_name);
361                 return 0;
362         }
363
364         if (of_node_check_flag(bus, OF_POPULATED_BUS)) {
365                 pr_debug("%s() - skipping %s, already populated\n",
366                         __func__, bus->full_name);
367                 return 0;
368         }
369
370         auxdata = of_dev_lookup(lookup, bus);
371         if (auxdata) {
372                 bus_id = auxdata->name;
373                 platform_data = auxdata->platform_data;
374         }
375
376         if (of_device_is_compatible(bus, "arm,primecell")) {
377                 /*
378                  * Don't return an error here to keep compatibility with older
379                  * device tree files.
380                  */
381                 of_amba_device_create(bus, bus_id, platform_data, parent);
382                 return 0;
383         }
384
385         dev = of_platform_device_create_pdata(bus, bus_id, platform_data, parent);
386         if (!dev || !of_match_node(matches, bus))
387                 return 0;
388
389         for_each_child_of_node(bus, child) {
390                 pr_debug("   create child: %s\n", child->full_name);
391                 rc = of_platform_bus_create(child, matches, lookup, &dev->dev, strict);
392                 if (rc) {
393                         of_node_put(child);
394                         break;
395                 }
396         }
397         of_node_set_flag(bus, OF_POPULATED_BUS);
398         return rc;
399 }
400
401 /**
402  * of_platform_bus_probe() - Probe the device-tree for platform buses
403  * @root: parent of the first level to probe or NULL for the root of the tree
404  * @matches: match table for bus nodes
405  * @parent: parent to hook devices from, NULL for toplevel
406  *
407  * Note that children of the provided root are not instantiated as devices
408  * unless the specified root itself matches the bus list and is not NULL.
409  */
410 int of_platform_bus_probe(struct device_node *root,
411                           const struct of_device_id *matches,
412                           struct device *parent)
413 {
414         struct device_node *child;
415         int rc = 0;
416
417         root = root ? of_node_get(root) : of_find_node_by_path("/");
418         if (!root)
419                 return -EINVAL;
420
421         pr_debug("%s()\n", __func__);
422         pr_debug(" starting at: %s\n", root->full_name);
423
424         /* Do a self check of bus type, if there's a match, create children */
425         if (of_match_node(matches, root)) {
426                 rc = of_platform_bus_create(root, matches, NULL, parent, false);
427         } else for_each_child_of_node(root, child) {
428                 if (!of_match_node(matches, child))
429                         continue;
430                 rc = of_platform_bus_create(child, matches, NULL, parent, false);
431                 if (rc) {
432                         of_node_put(child);
433                         break;
434                 }
435         }
436
437         of_node_put(root);
438         return rc;
439 }
440 EXPORT_SYMBOL(of_platform_bus_probe);
441
442 /**
443  * of_platform_populate() - Populate platform_devices from device tree data
444  * @root: parent of the first level to probe or NULL for the root of the tree
445  * @matches: match table, NULL to use the default
446  * @lookup: auxdata table for matching id and platform_data with device nodes
447  * @parent: parent to hook devices from, NULL for toplevel
448  *
449  * Similar to of_platform_bus_probe(), this function walks the device tree
450  * and creates devices from nodes.  It differs in that it follows the modern
451  * convention of requiring all device nodes to have a 'compatible' property,
452  * and it is suitable for creating devices which are children of the root
453  * node (of_platform_bus_probe will only create children of the root which
454  * are selected by the @matches argument).
455  *
456  * New board support should be using this function instead of
457  * of_platform_bus_probe().
458  *
459  * Returns 0 on success, < 0 on failure.
460  */
461 int of_platform_populate(struct device_node *root,
462                         const struct of_device_id *matches,
463                         const struct of_dev_auxdata *lookup,
464                         struct device *parent)
465 {
466         struct device_node *child;
467         int rc = 0;
468
469         root = root ? of_node_get(root) : of_find_node_by_path("/");
470         if (!root)
471                 return -EINVAL;
472
473         pr_debug("%s()\n", __func__);
474         pr_debug(" starting at: %s\n", root->full_name);
475
476         for_each_child_of_node(root, child) {
477                 rc = of_platform_bus_create(child, matches, lookup, parent, true);
478                 if (rc) {
479                         of_node_put(child);
480                         break;
481                 }
482         }
483         of_node_set_flag(root, OF_POPULATED_BUS);
484
485         of_node_put(root);
486         return rc;
487 }
488 EXPORT_SYMBOL_GPL(of_platform_populate);
489
490 int of_platform_default_populate(struct device_node *root,
491                                  const struct of_dev_auxdata *lookup,
492                                  struct device *parent)
493 {
494         return of_platform_populate(root, of_default_bus_match_table, lookup,
495                                     parent);
496 }
497 EXPORT_SYMBOL_GPL(of_platform_default_populate);
498
499 #ifndef CONFIG_PPC
500 static int __init of_platform_default_populate_init(void)
501 {
502         struct device_node *node;
503
504         if (!of_have_populated_dt())
505                 return -ENODEV;
506
507         /*
508          * Handle ramoops explicitly, since it is inside /reserved-memory,
509          * which lacks a "compatible" property.
510          */
511         node = of_find_node_by_path("/reserved-memory");
512         if (node) {
513                 node = of_find_compatible_node(node, NULL, "ramoops");
514                 if (node)
515                         of_platform_device_create(node, NULL, NULL);
516         }
517
518         /* Populate everything else. */
519         of_platform_default_populate(NULL, NULL, NULL);
520
521         return 0;
522 }
523 arch_initcall_sync(of_platform_default_populate_init);
524 #endif
525
526 static int of_platform_device_destroy(struct device *dev, void *data)
527 {
528         /* Do not touch devices not populated from the device tree */
529         if (!dev->of_node || !of_node_check_flag(dev->of_node, OF_POPULATED))
530                 return 0;
531
532         /* Recurse for any nodes that were treated as busses */
533         if (of_node_check_flag(dev->of_node, OF_POPULATED_BUS))
534                 device_for_each_child(dev, NULL, of_platform_device_destroy);
535
536         if (dev->bus == &platform_bus_type)
537                 platform_device_unregister(to_platform_device(dev));
538 #ifdef CONFIG_ARM_AMBA
539         else if (dev->bus == &amba_bustype)
540                 amba_device_unregister(to_amba_device(dev));
541 #endif
542
543         of_node_clear_flag(dev->of_node, OF_POPULATED);
544         of_node_clear_flag(dev->of_node, OF_POPULATED_BUS);
545         return 0;
546 }
547
548 /**
549  * of_platform_depopulate() - Remove devices populated from device tree
550  * @parent: device which children will be removed
551  *
552  * Complementary to of_platform_populate(), this function removes children
553  * of the given device (and, recurrently, their children) that have been
554  * created from their respective device tree nodes (and only those,
555  * leaving others - eg. manually created - unharmed).
556  */
557 void of_platform_depopulate(struct device *parent)
558 {
559         if (parent->of_node && of_node_check_flag(parent->of_node, OF_POPULATED_BUS)) {
560                 device_for_each_child(parent, NULL, of_platform_device_destroy);
561                 of_node_clear_flag(parent->of_node, OF_POPULATED_BUS);
562         }
563 }
564 EXPORT_SYMBOL_GPL(of_platform_depopulate);
565
566 static void devm_of_platform_populate_release(struct device *dev, void *res)
567 {
568         of_platform_depopulate(*(struct device **)res);
569 }
570
571 /**
572  * devm_of_platform_populate() - Populate platform_devices from device tree data
573  * @dev: device that requested to populate from device tree data
574  *
575  * Similar to of_platform_populate(), but will automatically call
576  * of_platform_depopulate() when the device is unbound from the bus.
577  *
578  * Returns 0 on success, < 0 on failure.
579  */
580 int devm_of_platform_populate(struct device *dev)
581 {
582         struct device **ptr;
583         int ret;
584
585         if (!dev)
586                 return -EINVAL;
587
588         ptr = devres_alloc(devm_of_platform_populate_release,
589                            sizeof(*ptr), GFP_KERNEL);
590         if (!ptr)
591                 return -ENOMEM;
592
593         ret = of_platform_populate(dev->of_node, NULL, NULL, dev);
594         if (ret) {
595                 devres_free(ptr);
596         } else {
597                 *ptr = dev;
598                 devres_add(dev, ptr);
599         }
600
601         return ret;
602 }
603 EXPORT_SYMBOL_GPL(devm_of_platform_populate);
604
605 static int devm_of_platform_match(struct device *dev, void *res, void *data)
606 {
607         struct device **ptr = res;
608
609         if (!ptr) {
610                 WARN_ON(!ptr);
611                 return 0;
612         }
613
614         return *ptr == data;
615 }
616
617 /**
618  * devm_of_platform_depopulate() - Remove devices populated from device tree
619  * @dev: device that requested to depopulate from device tree data
620  *
621  * Complementary to devm_of_platform_populate(), this function removes children
622  * of the given device (and, recurrently, their children) that have been
623  * created from their respective device tree nodes (and only those,
624  * leaving others - eg. manually created - unharmed).
625  */
626 void devm_of_platform_depopulate(struct device *dev)
627 {
628         int ret;
629
630         ret = devres_release(dev, devm_of_platform_populate_release,
631                              devm_of_platform_match, dev);
632
633         WARN_ON(ret);
634 }
635 EXPORT_SYMBOL_GPL(devm_of_platform_depopulate);
636
637 #ifdef CONFIG_OF_DYNAMIC
638 static int of_platform_notify(struct notifier_block *nb,
639                                 unsigned long action, void *arg)
640 {
641         struct of_reconfig_data *rd = arg;
642         struct platform_device *pdev_parent, *pdev;
643         bool children_left;
644
645         switch (of_reconfig_get_state_change(action, rd)) {
646         case OF_RECONFIG_CHANGE_ADD:
647                 /* verify that the parent is a bus */
648                 if (!of_node_check_flag(rd->dn->parent, OF_POPULATED_BUS))
649                         return NOTIFY_OK;       /* not for us */
650
651                 /* already populated? (driver using of_populate manually) */
652                 if (of_node_check_flag(rd->dn, OF_POPULATED))
653                         return NOTIFY_OK;
654
655                 /* pdev_parent may be NULL when no bus platform device */
656                 pdev_parent = of_find_device_by_node(rd->dn->parent);
657                 pdev = of_platform_device_create(rd->dn, NULL,
658                                 pdev_parent ? &pdev_parent->dev : NULL);
659                 of_dev_put(pdev_parent);
660
661                 if (pdev == NULL) {
662                         pr_err("%s: failed to create for '%s'\n",
663                                         __func__, rd->dn->full_name);
664                         /* of_platform_device_create tosses the error code */
665                         return notifier_from_errno(-EINVAL);
666                 }
667                 break;
668
669         case OF_RECONFIG_CHANGE_REMOVE:
670
671                 /* already depopulated? */
672                 if (!of_node_check_flag(rd->dn, OF_POPULATED))
673                         return NOTIFY_OK;
674
675                 /* find our device by node */
676                 pdev = of_find_device_by_node(rd->dn);
677                 if (pdev == NULL)
678                         return NOTIFY_OK;       /* no? not meant for us */
679
680                 /* unregister takes one ref away */
681                 of_platform_device_destroy(&pdev->dev, &children_left);
682
683                 /* and put the reference of the find */
684                 of_dev_put(pdev);
685                 break;
686         }
687
688         return NOTIFY_OK;
689 }
690
691 static struct notifier_block platform_of_notifier = {
692         .notifier_call = of_platform_notify,
693 };
694
695 void of_platform_register_reconfig_notifier(void)
696 {
697         WARN_ON(of_reconfig_notifier_register(&platform_of_notifier));
698 }
699 #endif /* CONFIG_OF_DYNAMIC */
700
701 #endif /* CONFIG_OF_ADDRESS */