1 #include <linux/string.h>
2 #include <linux/kernel.h>
3 #include <linux/init.h>
4 #include <linux/module.h>
5 #include <linux/mod_devicetable.h>
6 #include <linux/slab.h>
9 #include <asm/of_device.h>
12 * of_match_device - Tell if an of_device structure has a matching
14 * @ids: array of of device match structures to search in
15 * @dev: the of device structure to match against
17 * Used by a driver to check whether an of_device present in the
18 * system is in its list of supported devices.
20 const struct of_device_id *of_match_device(const struct of_device_id *matches,
21 const struct of_device *dev)
25 while (matches->name[0] || matches->type[0] || matches->compatible[0]) {
28 match &= dev->node->name
29 && !strcmp(matches->name, dev->node->name);
31 match &= dev->node->type
32 && !strcmp(matches->type, dev->node->type);
33 if (matches->compatible[0])
34 match &= of_device_is_compatible(dev->node,
43 static int of_platform_bus_match(struct device *dev, struct device_driver *drv)
45 struct of_device * of_dev = to_of_device(dev);
46 struct of_platform_driver * of_drv = to_of_platform_driver(drv);
47 const struct of_device_id * matches = of_drv->match_table;
52 return of_match_device(matches, of_dev) != NULL;
55 struct of_device *of_dev_get(struct of_device *dev)
61 tmp = get_device(&dev->dev);
63 return to_of_device(tmp);
68 void of_dev_put(struct of_device *dev)
71 put_device(&dev->dev);
75 static int of_device_probe(struct device *dev)
78 struct of_platform_driver *drv;
79 struct of_device *of_dev;
80 const struct of_device_id *match;
82 drv = to_of_platform_driver(dev->driver);
83 of_dev = to_of_device(dev);
90 match = of_match_device(drv->match_table, of_dev);
92 error = drv->probe(of_dev, match);
99 static int of_device_remove(struct device *dev)
101 struct of_device * of_dev = to_of_device(dev);
102 struct of_platform_driver * drv = to_of_platform_driver(dev->driver);
104 if (dev->driver && drv->remove)
109 static int of_device_suspend(struct device *dev, pm_message_t state)
111 struct of_device * of_dev = to_of_device(dev);
112 struct of_platform_driver * drv = to_of_platform_driver(dev->driver);
115 if (dev->driver && drv->suspend)
116 error = drv->suspend(of_dev, state);
120 static int of_device_resume(struct device * dev)
122 struct of_device * of_dev = to_of_device(dev);
123 struct of_platform_driver * drv = to_of_platform_driver(dev->driver);
126 if (dev->driver && drv->resume)
127 error = drv->resume(of_dev);
131 void __iomem *of_ioremap(struct resource *res, unsigned long offset, unsigned long size, char *name)
133 unsigned long ret = res->start + offset;
135 if (!request_region(ret, size, name))
138 return (void __iomem *) ret;
140 EXPORT_SYMBOL(of_ioremap);
142 void of_iounmap(void __iomem *base, unsigned long size)
144 release_region((unsigned long) base, size);
146 EXPORT_SYMBOL(of_iounmap);
148 static int node_match(struct device *dev, void *data)
150 struct of_device *op = to_of_device(dev);
151 struct device_node *dp = data;
153 return (op->node == dp);
156 struct of_device *of_find_device_by_node(struct device_node *dp)
158 struct device *dev = bus_find_device(&of_bus_type, NULL,
162 return to_of_device(dev);
166 EXPORT_SYMBOL(of_find_device_by_node);
169 struct bus_type isa_bus_type = {
171 .match = of_platform_bus_match,
172 .probe = of_device_probe,
173 .remove = of_device_remove,
174 .suspend = of_device_suspend,
175 .resume = of_device_resume,
177 EXPORT_SYMBOL(isa_bus_type);
179 struct bus_type ebus_bus_type = {
181 .match = of_platform_bus_match,
182 .probe = of_device_probe,
183 .remove = of_device_remove,
184 .suspend = of_device_suspend,
185 .resume = of_device_resume,
187 EXPORT_SYMBOL(ebus_bus_type);
191 struct bus_type sbus_bus_type = {
193 .match = of_platform_bus_match,
194 .probe = of_device_probe,
195 .remove = of_device_remove,
196 .suspend = of_device_suspend,
197 .resume = of_device_resume,
199 EXPORT_SYMBOL(sbus_bus_type);
202 struct bus_type of_bus_type = {
204 .match = of_platform_bus_match,
205 .probe = of_device_probe,
206 .remove = of_device_remove,
207 .suspend = of_device_suspend,
208 .resume = of_device_resume,
210 EXPORT_SYMBOL(of_bus_type);
212 static inline u64 of_read_addr(const u32 *cell, int size)
216 r = (r << 32) | *(cell++);
220 static void __init get_cells(struct device_node *dp,
221 int *addrc, int *sizec)
224 *addrc = of_n_addr_cells(dp);
226 *sizec = of_n_size_cells(dp);
229 /* Max address size we deal with */
230 #define OF_MAX_ADDR_CELLS 4
234 const char *addr_prop_name;
235 int (*match)(struct device_node *parent);
236 void (*count_cells)(struct device_node *child,
237 int *addrc, int *sizec);
238 int (*map)(u32 *addr, const u32 *range,
239 int na, int ns, int pna);
240 unsigned int (*get_flags)(u32 *addr);
244 * Default translator (generic bus)
247 static void of_bus_default_count_cells(struct device_node *dev,
248 int *addrc, int *sizec)
250 get_cells(dev, addrc, sizec);
253 /* Make sure the least significant 64-bits are in-range. Even
254 * for 3 or 4 cell values it is a good enough approximation.
256 static int of_out_of_range(const u32 *addr, const u32 *base,
257 const u32 *size, int na, int ns)
259 u64 a = of_read_addr(addr, na);
260 u64 b = of_read_addr(base, na);
265 b += of_read_addr(size, ns);
272 static int of_bus_default_map(u32 *addr, const u32 *range,
273 int na, int ns, int pna)
275 u32 result[OF_MAX_ADDR_CELLS];
279 printk("of_device: Cannot handle size cells (%d) > 2.", ns);
283 if (of_out_of_range(addr, range, range + na + pna, na, ns))
286 /* Start with the parent range base. */
287 memcpy(result, range + na, pna * 4);
289 /* Add in the child address offset. */
290 for (i = 0; i < na; i++)
291 result[pna - 1 - i] +=
295 memcpy(addr, result, pna * 4);
300 static unsigned int of_bus_default_get_flags(u32 *addr)
302 return IORESOURCE_MEM;
306 * PCI bus specific translator
309 static int of_bus_pci_match(struct device_node *np)
311 if (!strcmp(np->type, "pci") || !strcmp(np->type, "pciex")) {
312 /* Do not do PCI specific frobbing if the
313 * PCI bridge lacks a ranges property. We
314 * want to pass it through up to the next
315 * parent as-is, not with the PCI translate
316 * method which chops off the top address cell.
318 if (!of_find_property(np, "ranges", NULL))
327 static void of_bus_pci_count_cells(struct device_node *np,
328 int *addrc, int *sizec)
336 static int of_bus_pci_map(u32 *addr, const u32 *range,
337 int na, int ns, int pna)
339 u32 result[OF_MAX_ADDR_CELLS];
342 /* Check address type match */
343 if ((addr[0] ^ range[0]) & 0x03000000)
346 if (of_out_of_range(addr + 1, range + 1, range + na + pna,
350 /* Start with the parent range base. */
351 memcpy(result, range + na, pna * 4);
353 /* Add in the child address offset, skipping high cell. */
354 for (i = 0; i < na - 1; i++)
355 result[pna - 1 - i] +=
359 memcpy(addr, result, pna * 4);
364 static unsigned int of_bus_pci_get_flags(u32 *addr)
366 unsigned int flags = 0;
369 switch((w >> 24) & 0x03) {
371 flags |= IORESOURCE_IO;
372 case 0x02: /* 32 bits */
373 case 0x03: /* 64 bits */
374 flags |= IORESOURCE_MEM;
377 flags |= IORESOURCE_PREFETCH;
382 * SBUS bus specific translator
385 static int of_bus_sbus_match(struct device_node *np)
387 return !strcmp(np->name, "sbus") ||
388 !strcmp(np->name, "sbi");
391 static void of_bus_sbus_count_cells(struct device_node *child,
392 int *addrc, int *sizec)
401 * FHC/Central bus specific translator.
403 * This is just needed to hard-code the address and size cell
404 * counts. 'fhc' and 'central' nodes lack the #address-cells and
405 * #size-cells properties, and if you walk to the root on such
406 * Enterprise boxes all you'll get is a #size-cells of 2 which is
407 * not what we want to use.
409 static int of_bus_fhc_match(struct device_node *np)
411 return !strcmp(np->name, "fhc") ||
412 !strcmp(np->name, "central");
415 #define of_bus_fhc_count_cells of_bus_sbus_count_cells
418 * Array of bus specific translators
421 static struct of_bus of_busses[] = {
425 .addr_prop_name = "assigned-addresses",
426 .match = of_bus_pci_match,
427 .count_cells = of_bus_pci_count_cells,
428 .map = of_bus_pci_map,
429 .get_flags = of_bus_pci_get_flags,
434 .addr_prop_name = "reg",
435 .match = of_bus_sbus_match,
436 .count_cells = of_bus_sbus_count_cells,
437 .map = of_bus_default_map,
438 .get_flags = of_bus_default_get_flags,
443 .addr_prop_name = "reg",
444 .match = of_bus_fhc_match,
445 .count_cells = of_bus_fhc_count_cells,
446 .map = of_bus_default_map,
447 .get_flags = of_bus_default_get_flags,
452 .addr_prop_name = "reg",
454 .count_cells = of_bus_default_count_cells,
455 .map = of_bus_default_map,
456 .get_flags = of_bus_default_get_flags,
460 static struct of_bus *of_match_bus(struct device_node *np)
464 for (i = 0; i < ARRAY_SIZE(of_busses); i ++)
465 if (!of_busses[i].match || of_busses[i].match(np))
466 return &of_busses[i];
471 static int __init build_one_resource(struct device_node *parent,
475 int na, int ns, int pna)
481 ranges = of_get_property(parent, "ranges", &rlen);
482 if (ranges == NULL || rlen == 0) {
483 u32 result[OF_MAX_ADDR_CELLS];
486 memset(result, 0, pna * 4);
487 for (i = 0; i < na; i++)
488 result[pna - 1 - i] =
491 memcpy(addr, result, pna * 4);
495 /* Now walk through the ranges */
497 rone = na + pna + ns;
498 for (; rlen >= rone; rlen -= rone, ranges += rone) {
499 if (!bus->map(addr, ranges, na, ns, pna))
506 static int __init use_1to1_mapping(struct device_node *pp)
510 /* If this is on the PMU bus, don't try to translate it even
511 * if a ranges property exists.
513 if (!strcmp(pp->name, "pmu"))
516 /* If we have a ranges property in the parent, use it. */
517 if (of_find_property(pp, "ranges", NULL) != NULL)
520 /* If the parent is the dma node of an ISA bus, pass
521 * the translation up to the root.
523 if (!strcmp(pp->name, "dma"))
526 /* Similarly for Simba PCI bridges. */
527 model = of_get_property(pp, "model", NULL);
528 if (model && !strcmp(model, "SUNW,simba"))
534 static int of_resource_verbose;
536 static void __init build_device_resources(struct of_device *op,
537 struct device *parent)
539 struct of_device *p_op;
548 p_op = to_of_device(parent);
549 bus = of_match_bus(p_op->node);
550 bus->count_cells(op->node, &na, &ns);
552 preg = of_get_property(op->node, bus->addr_prop_name, &num_reg);
553 if (!preg || num_reg == 0)
556 /* Convert to num-cells. */
559 /* Convert to num-entries. */
562 /* Prevent overruning the op->resources[] array. */
563 if (num_reg > PROMREG_MAX) {
564 printk(KERN_WARNING "%s: Too many regs (%d), "
566 op->node->full_name, num_reg, PROMREG_MAX);
567 num_reg = PROMREG_MAX;
570 for (index = 0; index < num_reg; index++) {
571 struct resource *r = &op->resource[index];
572 u32 addr[OF_MAX_ADDR_CELLS];
573 u32 *reg = (preg + (index * ((na + ns) * 4)));
574 struct device_node *dp = op->node;
575 struct device_node *pp = p_op->node;
577 u64 size, result = OF_BAD_ADDR;
582 size = of_read_addr(reg + na, ns);
583 flags = bus->get_flags(reg);
585 memcpy(addr, reg, na * 4);
587 if (use_1to1_mapping(pp)) {
588 result = of_read_addr(addr, na);
599 result = of_read_addr(addr, dna);
603 pbus = of_match_bus(pp);
604 pbus->count_cells(dp, &pna, &pns);
606 if (build_one_resource(dp, bus, pbus, addr,
616 memset(r, 0, sizeof(*r));
618 if (of_resource_verbose)
619 printk("%s reg[%d] -> %lx\n",
620 op->node->full_name, index,
623 if (result != OF_BAD_ADDR) {
624 if (tlb_type == hypervisor)
625 result &= 0x0fffffffffffffffUL;
628 r->end = result + size - 1;
634 r->name = op->node->name;
638 static struct device_node * __init
639 apply_interrupt_map(struct device_node *dp, struct device_node *pp,
640 u32 *imap, int imlen, u32 *imask,
643 struct device_node *cp;
644 unsigned int irq = *irq_p;
650 bus = of_match_bus(pp);
651 bus->count_cells(dp, &na, NULL);
653 reg = of_get_property(dp, "reg", &num_reg);
654 if (!reg || !num_reg)
657 imlen /= ((na + 3) * 4);
659 for (i = 0; i < imlen; i++) {
662 for (j = 0; j < na; j++) {
663 if ((reg[j] & imask[j]) != imap[j])
666 if (imap[na] == irq) {
667 handle = imap[na + 1];
676 /* Psycho and Sabre PCI controllers can have 'interrupt-map'
677 * properties that do not include the on-board device
678 * interrupts. Instead, the device's 'interrupts' property
679 * is already a fully specified INO value.
681 * Handle this by deciding that, if we didn't get a
682 * match in the parent's 'interrupt-map', and the
683 * parent is an IRQ translater, then use the parent as
684 * our IRQ controller.
693 cp = of_find_node_by_phandle(handle);
698 static unsigned int __init pci_irq_swizzle(struct device_node *dp,
699 struct device_node *pp,
702 struct linux_prom_pci_registers *regs;
703 unsigned int devfn, slot, ret;
705 if (irq < 1 || irq > 4)
708 regs = of_get_property(dp, "reg", NULL);
712 devfn = (regs->phys_hi >> 8) & 0xff;
713 slot = (devfn >> 3) & 0x1f;
715 ret = ((irq - 1 + (slot & 3)) & 3) + 1;
720 static int of_irq_verbose;
722 static unsigned int __init build_one_device_irq(struct of_device *op,
723 struct device *parent,
726 struct device_node *dp = op->node;
727 struct device_node *pp, *ip;
728 unsigned int orig_irq = irq;
730 if (irq == 0xffffffff)
734 irq = dp->irq_trans->irq_build(dp, irq,
735 dp->irq_trans->data);
738 printk("%s: direct translate %x --> %x\n",
739 dp->full_name, orig_irq, irq);
744 /* Something more complicated. Walk up to the root, applying
745 * interrupt-map or bus specific translations, until we hit
748 * If we hit a bus type or situation we cannot handle, we
749 * stop and assume that the original IRQ number was in a
750 * format which has special meaning to it's immediate parent.
758 imap = of_get_property(pp, "interrupt-map", &imlen);
759 imsk = of_get_property(pp, "interrupt-map-mask", NULL);
761 struct device_node *iret;
762 int this_orig_irq = irq;
764 iret = apply_interrupt_map(dp, pp,
769 printk("%s: Apply [%s:%x] imap --> [%s:%x]\n",
771 pp->full_name, this_orig_irq,
772 (iret ? iret->full_name : "NULL"), irq);
777 if (iret->irq_trans) {
782 if (!strcmp(pp->type, "pci") ||
783 !strcmp(pp->type, "pciex")) {
784 unsigned int this_orig_irq = irq;
786 irq = pci_irq_swizzle(dp, pp, irq);
788 printk("%s: PCI swizzle [%s] "
791 pp->full_name, this_orig_irq,
807 irq = ip->irq_trans->irq_build(op->node, irq,
808 ip->irq_trans->data);
810 printk("%s: Apply IRQ trans [%s] %x --> %x\n",
811 op->node->full_name, ip->full_name, orig_irq, irq);
816 static struct of_device * __init scan_one_device(struct device_node *dp,
817 struct device *parent)
819 struct of_device *op = kzalloc(sizeof(*op), GFP_KERNEL);
828 op->clock_freq = of_getintprop_default(dp, "clock-frequency",
830 op->portid = of_getintprop_default(dp, "upa-portid", -1);
831 if (op->portid == -1)
832 op->portid = of_getintprop_default(dp, "portid", -1);
834 irq = of_get_property(dp, "interrupts", &len);
836 memcpy(op->irqs, irq, len);
837 op->num_irqs = len / 4;
842 /* Prevent overruning the op->irqs[] array. */
843 if (op->num_irqs > PROMINTR_MAX) {
844 printk(KERN_WARNING "%s: Too many irqs (%d), "
846 dp->full_name, op->num_irqs, PROMINTR_MAX);
847 op->num_irqs = PROMINTR_MAX;
850 build_device_resources(op, parent);
851 for (i = 0; i < op->num_irqs; i++)
852 op->irqs[i] = build_one_device_irq(op, parent, op->irqs[i]);
854 op->dev.parent = parent;
855 op->dev.bus = &of_bus_type;
857 strcpy(op->dev.bus_id, "root");
859 strcpy(op->dev.bus_id, dp->path_component_name);
861 if (of_device_register(op)) {
862 printk("%s: Could not register of device.\n",
871 static void __init scan_tree(struct device_node *dp, struct device *parent)
874 struct of_device *op = scan_one_device(dp, parent);
877 scan_tree(dp->child, &op->dev);
883 static void __init scan_of_devices(void)
885 struct device_node *root = of_find_node_by_path("/");
886 struct of_device *parent;
888 parent = scan_one_device(root, NULL);
892 scan_tree(root->child, &parent->dev);
895 static int __init of_bus_driver_init(void)
899 err = bus_register(&of_bus_type);
902 err = bus_register(&isa_bus_type);
904 err = bus_register(&ebus_bus_type);
908 err = bus_register(&sbus_bus_type);
917 postcore_initcall(of_bus_driver_init);
919 static int __init of_debug(char *str)
923 get_option(&str, &val);
925 of_resource_verbose = 1;
931 __setup("of_debug=", of_debug);
933 int of_register_driver(struct of_platform_driver *drv, struct bus_type *bus)
935 /* initialize common driver fields */
936 drv->driver.name = drv->name;
937 drv->driver.bus = bus;
939 /* register with core */
940 return driver_register(&drv->driver);
943 void of_unregister_driver(struct of_platform_driver *drv)
945 driver_unregister(&drv->driver);
949 static ssize_t dev_show_devspec(struct device *dev, struct device_attribute *attr, char *buf)
951 struct of_device *ofdev;
953 ofdev = to_of_device(dev);
954 return sprintf(buf, "%s", ofdev->node->full_name);
957 static DEVICE_ATTR(devspec, S_IRUGO, dev_show_devspec, NULL);
960 * of_release_dev - free an of device structure when all users of it are finished.
961 * @dev: device that's been disconnected
963 * Will be called only by the device core when all users of this of device are
966 void of_release_dev(struct device *dev)
968 struct of_device *ofdev;
970 ofdev = to_of_device(dev);
975 int of_device_register(struct of_device *ofdev)
979 BUG_ON(ofdev->node == NULL);
981 rc = device_register(&ofdev->dev);
985 rc = device_create_file(&ofdev->dev, &dev_attr_devspec);
987 device_unregister(&ofdev->dev);
992 void of_device_unregister(struct of_device *ofdev)
994 device_remove_file(&ofdev->dev, &dev_attr_devspec);
995 device_unregister(&ofdev->dev);
998 struct of_device* of_platform_device_create(struct device_node *np,
1000 struct device *parent,
1001 struct bus_type *bus)
1003 struct of_device *dev;
1005 dev = kmalloc(sizeof(*dev), GFP_KERNEL);
1008 memset(dev, 0, sizeof(*dev));
1010 dev->dev.parent = parent;
1012 dev->dev.release = of_release_dev;
1014 strlcpy(dev->dev.bus_id, bus_id, BUS_ID_SIZE);
1016 if (of_device_register(dev) != 0) {
1024 EXPORT_SYMBOL(of_match_device);
1025 EXPORT_SYMBOL(of_register_driver);
1026 EXPORT_SYMBOL(of_unregister_driver);
1027 EXPORT_SYMBOL(of_device_register);
1028 EXPORT_SYMBOL(of_device_unregister);
1029 EXPORT_SYMBOL(of_dev_get);
1030 EXPORT_SYMBOL(of_dev_put);
1031 EXPORT_SYMBOL(of_platform_device_create);
1032 EXPORT_SYMBOL(of_release_dev);