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;
136 if (res->flags & IORESOURCE_MEM)
137 r = request_mem_region(ret, size, name);
139 r = request_region(ret, size, name);
143 return (void __iomem *) ret;
145 EXPORT_SYMBOL(of_ioremap);
147 void of_iounmap(struct resource *res, void __iomem *base, unsigned long size)
149 if (res->flags & IORESOURCE_MEM)
150 release_mem_region((unsigned long) base, size);
152 release_region((unsigned long) base, size);
154 EXPORT_SYMBOL(of_iounmap);
156 static int node_match(struct device *dev, void *data)
158 struct of_device *op = to_of_device(dev);
159 struct device_node *dp = data;
161 return (op->node == dp);
164 struct of_device *of_find_device_by_node(struct device_node *dp)
166 struct device *dev = bus_find_device(&of_bus_type, NULL,
170 return to_of_device(dev);
174 EXPORT_SYMBOL(of_find_device_by_node);
177 struct bus_type isa_bus_type = {
179 .match = of_platform_bus_match,
180 .probe = of_device_probe,
181 .remove = of_device_remove,
182 .suspend = of_device_suspend,
183 .resume = of_device_resume,
185 EXPORT_SYMBOL(isa_bus_type);
187 struct bus_type ebus_bus_type = {
189 .match = of_platform_bus_match,
190 .probe = of_device_probe,
191 .remove = of_device_remove,
192 .suspend = of_device_suspend,
193 .resume = of_device_resume,
195 EXPORT_SYMBOL(ebus_bus_type);
199 struct bus_type sbus_bus_type = {
201 .match = of_platform_bus_match,
202 .probe = of_device_probe,
203 .remove = of_device_remove,
204 .suspend = of_device_suspend,
205 .resume = of_device_resume,
207 EXPORT_SYMBOL(sbus_bus_type);
210 struct bus_type of_bus_type = {
212 .match = of_platform_bus_match,
213 .probe = of_device_probe,
214 .remove = of_device_remove,
215 .suspend = of_device_suspend,
216 .resume = of_device_resume,
218 EXPORT_SYMBOL(of_bus_type);
220 static inline u64 of_read_addr(const u32 *cell, int size)
224 r = (r << 32) | *(cell++);
228 static void __init get_cells(struct device_node *dp,
229 int *addrc, int *sizec)
232 *addrc = of_n_addr_cells(dp);
234 *sizec = of_n_size_cells(dp);
237 /* Max address size we deal with */
238 #define OF_MAX_ADDR_CELLS 4
242 const char *addr_prop_name;
243 int (*match)(struct device_node *parent);
244 void (*count_cells)(struct device_node *child,
245 int *addrc, int *sizec);
246 int (*map)(u32 *addr, const u32 *range,
247 int na, int ns, int pna);
248 unsigned int (*get_flags)(const u32 *addr);
252 * Default translator (generic bus)
255 static void of_bus_default_count_cells(struct device_node *dev,
256 int *addrc, int *sizec)
258 get_cells(dev, addrc, sizec);
261 /* Make sure the least significant 64-bits are in-range. Even
262 * for 3 or 4 cell values it is a good enough approximation.
264 static int of_out_of_range(const u32 *addr, const u32 *base,
265 const u32 *size, int na, int ns)
267 u64 a = of_read_addr(addr, na);
268 u64 b = of_read_addr(base, na);
273 b += of_read_addr(size, ns);
280 static int of_bus_default_map(u32 *addr, const u32 *range,
281 int na, int ns, int pna)
283 u32 result[OF_MAX_ADDR_CELLS];
287 printk("of_device: Cannot handle size cells (%d) > 2.", ns);
291 if (of_out_of_range(addr, range, range + na + pna, na, ns))
294 /* Start with the parent range base. */
295 memcpy(result, range + na, pna * 4);
297 /* Add in the child address offset. */
298 for (i = 0; i < na; i++)
299 result[pna - 1 - i] +=
303 memcpy(addr, result, pna * 4);
308 static unsigned int of_bus_default_get_flags(const u32 *addr)
310 return IORESOURCE_MEM;
314 * PCI bus specific translator
317 static int of_bus_pci_match(struct device_node *np)
319 if (!strcmp(np->type, "pci") || !strcmp(np->type, "pciex")) {
320 const char *model = of_get_property(np, "model", NULL);
322 if (model && !strcmp(model, "SUNW,simba"))
325 /* Do not do PCI specific frobbing if the
326 * PCI bridge lacks a ranges property. We
327 * want to pass it through up to the next
328 * parent as-is, not with the PCI translate
329 * method which chops off the top address cell.
331 if (!of_find_property(np, "ranges", NULL))
340 static int of_bus_simba_match(struct device_node *np)
342 const char *model = of_get_property(np, "model", NULL);
344 if (model && !strcmp(model, "SUNW,simba"))
349 static int of_bus_simba_map(u32 *addr, const u32 *range,
350 int na, int ns, int pna)
355 static void of_bus_pci_count_cells(struct device_node *np,
356 int *addrc, int *sizec)
364 static int of_bus_pci_map(u32 *addr, const u32 *range,
365 int na, int ns, int pna)
367 u32 result[OF_MAX_ADDR_CELLS];
370 /* Check address type match */
371 if ((addr[0] ^ range[0]) & 0x03000000)
374 if (of_out_of_range(addr + 1, range + 1, range + na + pna,
378 /* Start with the parent range base. */
379 memcpy(result, range + na, pna * 4);
381 /* Add in the child address offset, skipping high cell. */
382 for (i = 0; i < na - 1; i++)
383 result[pna - 1 - i] +=
387 memcpy(addr, result, pna * 4);
392 static unsigned int of_bus_pci_get_flags(const u32 *addr)
394 unsigned int flags = 0;
397 switch((w >> 24) & 0x03) {
399 flags |= IORESOURCE_IO;
400 case 0x02: /* 32 bits */
401 case 0x03: /* 64 bits */
402 flags |= IORESOURCE_MEM;
405 flags |= IORESOURCE_PREFETCH;
410 * SBUS bus specific translator
413 static int of_bus_sbus_match(struct device_node *np)
415 return !strcmp(np->name, "sbus") ||
416 !strcmp(np->name, "sbi");
419 static void of_bus_sbus_count_cells(struct device_node *child,
420 int *addrc, int *sizec)
429 * FHC/Central bus specific translator.
431 * This is just needed to hard-code the address and size cell
432 * counts. 'fhc' and 'central' nodes lack the #address-cells and
433 * #size-cells properties, and if you walk to the root on such
434 * Enterprise boxes all you'll get is a #size-cells of 2 which is
435 * not what we want to use.
437 static int of_bus_fhc_match(struct device_node *np)
439 return !strcmp(np->name, "fhc") ||
440 !strcmp(np->name, "central");
443 #define of_bus_fhc_count_cells of_bus_sbus_count_cells
446 * Array of bus specific translators
449 static struct of_bus of_busses[] = {
453 .addr_prop_name = "assigned-addresses",
454 .match = of_bus_pci_match,
455 .count_cells = of_bus_pci_count_cells,
456 .map = of_bus_pci_map,
457 .get_flags = of_bus_pci_get_flags,
462 .addr_prop_name = "assigned-addresses",
463 .match = of_bus_simba_match,
464 .count_cells = of_bus_pci_count_cells,
465 .map = of_bus_simba_map,
466 .get_flags = of_bus_pci_get_flags,
471 .addr_prop_name = "reg",
472 .match = of_bus_sbus_match,
473 .count_cells = of_bus_sbus_count_cells,
474 .map = of_bus_default_map,
475 .get_flags = of_bus_default_get_flags,
480 .addr_prop_name = "reg",
481 .match = of_bus_fhc_match,
482 .count_cells = of_bus_fhc_count_cells,
483 .map = of_bus_default_map,
484 .get_flags = of_bus_default_get_flags,
489 .addr_prop_name = "reg",
491 .count_cells = of_bus_default_count_cells,
492 .map = of_bus_default_map,
493 .get_flags = of_bus_default_get_flags,
497 static struct of_bus *of_match_bus(struct device_node *np)
501 for (i = 0; i < ARRAY_SIZE(of_busses); i ++)
502 if (!of_busses[i].match || of_busses[i].match(np))
503 return &of_busses[i];
508 static int __init build_one_resource(struct device_node *parent,
512 int na, int ns, int pna)
518 ranges = of_get_property(parent, "ranges", &rlen);
519 if (ranges == NULL || rlen == 0) {
520 u32 result[OF_MAX_ADDR_CELLS];
523 memset(result, 0, pna * 4);
524 for (i = 0; i < na; i++)
525 result[pna - 1 - i] =
528 memcpy(addr, result, pna * 4);
532 /* Now walk through the ranges */
534 rone = na + pna + ns;
535 for (; rlen >= rone; rlen -= rone, ranges += rone) {
536 if (!bus->map(addr, ranges, na, ns, pna))
540 /* When we miss an I/O space match on PCI, just pass it up
541 * to the next PCI bridge and/or controller.
543 if (!strcmp(bus->name, "pci") &&
544 (addr[0] & 0x03000000) == 0x01000000)
550 static int __init use_1to1_mapping(struct device_node *pp)
554 /* If this is on the PMU bus, don't try to translate it even
555 * if a ranges property exists.
557 if (!strcmp(pp->name, "pmu"))
560 /* If we have a ranges property in the parent, use it. */
561 if (of_find_property(pp, "ranges", NULL) != NULL)
564 /* If the parent is the dma node of an ISA bus, pass
565 * the translation up to the root.
567 if (!strcmp(pp->name, "dma"))
570 /* Similarly for Simba PCI bridges. */
571 model = of_get_property(pp, "model", NULL);
572 if (model && !strcmp(model, "SUNW,simba"))
578 static int of_resource_verbose;
580 static void __init build_device_resources(struct of_device *op,
581 struct device *parent)
583 struct of_device *p_op;
592 p_op = to_of_device(parent);
593 bus = of_match_bus(p_op->node);
594 bus->count_cells(op->node, &na, &ns);
596 preg = of_get_property(op->node, bus->addr_prop_name, &num_reg);
597 if (!preg || num_reg == 0)
600 /* Convert to num-cells. */
603 /* Convert to num-entries. */
606 /* Prevent overrunning the op->resources[] array. */
607 if (num_reg > PROMREG_MAX) {
608 printk(KERN_WARNING "%s: Too many regs (%d), "
610 op->node->full_name, num_reg, PROMREG_MAX);
611 num_reg = PROMREG_MAX;
614 for (index = 0; index < num_reg; index++) {
615 struct resource *r = &op->resource[index];
616 u32 addr[OF_MAX_ADDR_CELLS];
617 const u32 *reg = (preg + (index * ((na + ns) * 4)));
618 struct device_node *dp = op->node;
619 struct device_node *pp = p_op->node;
620 struct of_bus *pbus, *dbus;
621 u64 size, result = OF_BAD_ADDR;
626 size = of_read_addr(reg + na, ns);
627 flags = bus->get_flags(reg);
629 memcpy(addr, reg, na * 4);
631 if (use_1to1_mapping(pp)) {
632 result = of_read_addr(addr, na);
644 result = of_read_addr(addr, dna);
648 pbus = of_match_bus(pp);
649 pbus->count_cells(dp, &pna, &pns);
651 if (build_one_resource(dp, dbus, pbus, addr,
661 memset(r, 0, sizeof(*r));
663 if (of_resource_verbose)
664 printk("%s reg[%d] -> %lx\n",
665 op->node->full_name, index,
668 if (result != OF_BAD_ADDR) {
669 if (tlb_type == hypervisor)
670 result &= 0x0fffffffffffffffUL;
673 r->end = result + size - 1;
676 r->name = op->node->name;
680 static struct device_node * __init
681 apply_interrupt_map(struct device_node *dp, struct device_node *pp,
682 const u32 *imap, int imlen, const u32 *imask,
685 struct device_node *cp;
686 unsigned int irq = *irq_p;
692 bus = of_match_bus(pp);
693 bus->count_cells(dp, &na, NULL);
695 reg = of_get_property(dp, "reg", &num_reg);
696 if (!reg || !num_reg)
699 imlen /= ((na + 3) * 4);
701 for (i = 0; i < imlen; i++) {
704 for (j = 0; j < na; j++) {
705 if ((reg[j] & imask[j]) != imap[j])
708 if (imap[na] == irq) {
709 handle = imap[na + 1];
718 /* Psycho and Sabre PCI controllers can have 'interrupt-map'
719 * properties that do not include the on-board device
720 * interrupts. Instead, the device's 'interrupts' property
721 * is already a fully specified INO value.
723 * Handle this by deciding that, if we didn't get a
724 * match in the parent's 'interrupt-map', and the
725 * parent is an IRQ translater, then use the parent as
726 * our IRQ controller.
735 cp = of_find_node_by_phandle(handle);
740 static unsigned int __init pci_irq_swizzle(struct device_node *dp,
741 struct device_node *pp,
744 const struct linux_prom_pci_registers *regs;
745 unsigned int bus, devfn, slot, ret;
747 if (irq < 1 || irq > 4)
750 regs = of_get_property(dp, "reg", NULL);
754 bus = (regs->phys_hi >> 16) & 0xff;
755 devfn = (regs->phys_hi >> 8) & 0xff;
756 slot = (devfn >> 3) & 0x1f;
759 /* Derived from Table 8-3, U2P User's Manual. This branch
760 * is handling a PCI controller that lacks a proper set of
761 * interrupt-map and interrupt-map-mask properties. The
762 * Ultra-E450 is one example.
764 * The bit layout is BSSLL, where:
765 * B: 0 on bus A, 1 on bus B
766 * D: 2-bit slot number, derived from PCI device number as
767 * (dev - 1) for bus A, or (dev - 2) for bus B
768 * L: 2-bit line number
773 slot = (slot - 1) << 2;
777 slot = (slot - 2) << 2;
781 ret = (bus | slot | irq);
783 /* Going through a PCI-PCI bridge that lacks a set of
784 * interrupt-map and interrupt-map-mask properties.
786 ret = ((irq - 1 + (slot & 3)) & 3) + 1;
792 static int of_irq_verbose;
794 static unsigned int __init build_one_device_irq(struct of_device *op,
795 struct device *parent,
798 struct device_node *dp = op->node;
799 struct device_node *pp, *ip;
800 unsigned int orig_irq = irq;
802 if (irq == 0xffffffff)
806 irq = dp->irq_trans->irq_build(dp, irq,
807 dp->irq_trans->data);
810 printk("%s: direct translate %x --> %x\n",
811 dp->full_name, orig_irq, irq);
816 /* Something more complicated. Walk up to the root, applying
817 * interrupt-map or bus specific translations, until we hit
820 * If we hit a bus type or situation we cannot handle, we
821 * stop and assume that the original IRQ number was in a
822 * format which has special meaning to it's immediate parent.
827 const void *imap, *imsk;
830 imap = of_get_property(pp, "interrupt-map", &imlen);
831 imsk = of_get_property(pp, "interrupt-map-mask", NULL);
833 struct device_node *iret;
834 int this_orig_irq = irq;
836 iret = apply_interrupt_map(dp, pp,
841 printk("%s: Apply [%s:%x] imap --> [%s:%x]\n",
843 pp->full_name, this_orig_irq,
844 (iret ? iret->full_name : "NULL"), irq);
849 if (iret->irq_trans) {
854 if (!strcmp(pp->type, "pci") ||
855 !strcmp(pp->type, "pciex")) {
856 unsigned int this_orig_irq = irq;
858 irq = pci_irq_swizzle(dp, pp, irq);
860 printk("%s: PCI swizzle [%s] "
863 pp->full_name, this_orig_irq,
879 irq = ip->irq_trans->irq_build(op->node, irq,
880 ip->irq_trans->data);
882 printk("%s: Apply IRQ trans [%s] %x --> %x\n",
883 op->node->full_name, ip->full_name, orig_irq, irq);
888 static struct of_device * __init scan_one_device(struct device_node *dp,
889 struct device *parent)
891 struct of_device *op = kzalloc(sizeof(*op), GFP_KERNEL);
892 const unsigned int *irq;
900 op->clock_freq = of_getintprop_default(dp, "clock-frequency",
902 op->portid = of_getintprop_default(dp, "upa-portid", -1);
903 if (op->portid == -1)
904 op->portid = of_getintprop_default(dp, "portid", -1);
906 irq = of_get_property(dp, "interrupts", &len);
908 memcpy(op->irqs, irq, len);
909 op->num_irqs = len / 4;
914 /* Prevent overrunning the op->irqs[] array. */
915 if (op->num_irqs > PROMINTR_MAX) {
916 printk(KERN_WARNING "%s: Too many irqs (%d), "
918 dp->full_name, op->num_irqs, PROMINTR_MAX);
919 op->num_irqs = PROMINTR_MAX;
922 build_device_resources(op, parent);
923 for (i = 0; i < op->num_irqs; i++)
924 op->irqs[i] = build_one_device_irq(op, parent, op->irqs[i]);
926 op->dev.parent = parent;
927 op->dev.bus = &of_bus_type;
929 strcpy(op->dev.bus_id, "root");
931 sprintf(op->dev.bus_id, "%08x", dp->node);
933 if (of_device_register(op)) {
934 printk("%s: Could not register of device.\n",
943 static void __init scan_tree(struct device_node *dp, struct device *parent)
946 struct of_device *op = scan_one_device(dp, parent);
949 scan_tree(dp->child, &op->dev);
955 static void __init scan_of_devices(void)
957 struct device_node *root = of_find_node_by_path("/");
958 struct of_device *parent;
960 parent = scan_one_device(root, NULL);
964 scan_tree(root->child, &parent->dev);
967 static int __init of_bus_driver_init(void)
971 err = bus_register(&of_bus_type);
974 err = bus_register(&isa_bus_type);
976 err = bus_register(&ebus_bus_type);
980 err = bus_register(&sbus_bus_type);
989 postcore_initcall(of_bus_driver_init);
991 static int __init of_debug(char *str)
995 get_option(&str, &val);
997 of_resource_verbose = 1;
1003 __setup("of_debug=", of_debug);
1005 int of_register_driver(struct of_platform_driver *drv, struct bus_type *bus)
1007 /* initialize common driver fields */
1008 drv->driver.name = drv->name;
1009 drv->driver.bus = bus;
1011 /* register with core */
1012 return driver_register(&drv->driver);
1015 void of_unregister_driver(struct of_platform_driver *drv)
1017 driver_unregister(&drv->driver);
1021 static ssize_t dev_show_devspec(struct device *dev, struct device_attribute *attr, char *buf)
1023 struct of_device *ofdev;
1025 ofdev = to_of_device(dev);
1026 return sprintf(buf, "%s", ofdev->node->full_name);
1029 static DEVICE_ATTR(devspec, S_IRUGO, dev_show_devspec, NULL);
1032 * of_release_dev - free an of device structure when all users of it are finished.
1033 * @dev: device that's been disconnected
1035 * Will be called only by the device core when all users of this of device are
1038 void of_release_dev(struct device *dev)
1040 struct of_device *ofdev;
1042 ofdev = to_of_device(dev);
1047 int of_device_register(struct of_device *ofdev)
1051 BUG_ON(ofdev->node == NULL);
1053 rc = device_register(&ofdev->dev);
1057 rc = device_create_file(&ofdev->dev, &dev_attr_devspec);
1059 device_unregister(&ofdev->dev);
1064 void of_device_unregister(struct of_device *ofdev)
1066 device_remove_file(&ofdev->dev, &dev_attr_devspec);
1067 device_unregister(&ofdev->dev);
1070 struct of_device* of_platform_device_create(struct device_node *np,
1072 struct device *parent,
1073 struct bus_type *bus)
1075 struct of_device *dev;
1077 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1081 dev->dev.parent = parent;
1083 dev->dev.release = of_release_dev;
1085 strlcpy(dev->dev.bus_id, bus_id, BUS_ID_SIZE);
1087 if (of_device_register(dev) != 0) {
1095 EXPORT_SYMBOL(of_match_device);
1096 EXPORT_SYMBOL(of_register_driver);
1097 EXPORT_SYMBOL(of_unregister_driver);
1098 EXPORT_SYMBOL(of_device_register);
1099 EXPORT_SYMBOL(of_device_unregister);
1100 EXPORT_SYMBOL(of_dev_get);
1101 EXPORT_SYMBOL(of_dev_put);
1102 EXPORT_SYMBOL(of_platform_device_create);
1103 EXPORT_SYMBOL(of_release_dev);