1 #include <linux/config.h>
2 #include <linux/string.h>
3 #include <linux/kernel.h>
4 #include <linux/init.h>
5 #include <linux/module.h>
6 #include <linux/mod_devicetable.h>
7 #include <linux/slab.h>
10 #include <asm/of_device.h>
13 * of_match_device - Tell if an of_device structure has a matching
15 * @ids: array of of device match structures to search in
16 * @dev: the of device structure to match against
18 * Used by a driver to check whether an of_device present in the
19 * system is in its list of supported devices.
21 const struct of_device_id
*of_match_device(const struct of_device_id
*matches
,
22 const struct of_device
*dev
)
26 while (matches
->name
[0] || matches
->type
[0] || matches
->compatible
[0]) {
29 match
&= dev
->node
->name
30 && !strcmp(matches
->name
, dev
->node
->name
);
32 match
&= dev
->node
->type
33 && !strcmp(matches
->type
, dev
->node
->type
);
34 if (matches
->compatible
[0])
35 match
&= of_device_is_compatible(dev
->node
,
44 static int of_platform_bus_match(struct device
*dev
, struct device_driver
*drv
)
46 struct of_device
* of_dev
= to_of_device(dev
);
47 struct of_platform_driver
* of_drv
= to_of_platform_driver(drv
);
48 const struct of_device_id
* matches
= of_drv
->match_table
;
53 return of_match_device(matches
, of_dev
) != NULL
;
56 struct of_device
*of_dev_get(struct of_device
*dev
)
62 tmp
= get_device(&dev
->dev
);
64 return to_of_device(tmp
);
69 void of_dev_put(struct of_device
*dev
)
72 put_device(&dev
->dev
);
76 static int of_device_probe(struct device
*dev
)
79 struct of_platform_driver
*drv
;
80 struct of_device
*of_dev
;
81 const struct of_device_id
*match
;
83 drv
= to_of_platform_driver(dev
->driver
);
84 of_dev
= to_of_device(dev
);
91 match
= of_match_device(drv
->match_table
, of_dev
);
93 error
= drv
->probe(of_dev
, match
);
100 static int of_device_remove(struct device
*dev
)
102 struct of_device
* of_dev
= to_of_device(dev
);
103 struct of_platform_driver
* drv
= to_of_platform_driver(dev
->driver
);
105 if (dev
->driver
&& drv
->remove
)
110 static int of_device_suspend(struct device
*dev
, pm_message_t state
)
112 struct of_device
* of_dev
= to_of_device(dev
);
113 struct of_platform_driver
* drv
= to_of_platform_driver(dev
->driver
);
116 if (dev
->driver
&& drv
->suspend
)
117 error
= drv
->suspend(of_dev
, state
);
121 static int of_device_resume(struct device
* dev
)
123 struct of_device
* of_dev
= to_of_device(dev
);
124 struct of_platform_driver
* drv
= to_of_platform_driver(dev
->driver
);
127 if (dev
->driver
&& drv
->resume
)
128 error
= drv
->resume(of_dev
);
132 void __iomem
*of_ioremap(struct resource
*res
, unsigned long offset
, unsigned long size
, char *name
)
134 unsigned long ret
= res
->start
+ offset
;
136 if (!request_region(ret
, size
, name
))
139 return (void __iomem
*) ret
;
141 EXPORT_SYMBOL(of_ioremap
);
143 void of_iounmap(void __iomem
*base
, unsigned long size
)
145 release_region((unsigned long) base
, size
);
147 EXPORT_SYMBOL(of_iounmap
);
149 static int node_match(struct device
*dev
, void *data
)
151 struct of_device
*op
= to_of_device(dev
);
152 struct device_node
*dp
= data
;
154 return (op
->node
== dp
);
157 struct of_device
*of_find_device_by_node(struct device_node
*dp
)
159 struct device
*dev
= bus_find_device(&of_bus_type
, NULL
,
163 return to_of_device(dev
);
167 EXPORT_SYMBOL(of_find_device_by_node
);
170 struct bus_type isa_bus_type
= {
172 .match
= of_platform_bus_match
,
173 .probe
= of_device_probe
,
174 .remove
= of_device_remove
,
175 .suspend
= of_device_suspend
,
176 .resume
= of_device_resume
,
178 EXPORT_SYMBOL(isa_bus_type
);
180 struct bus_type ebus_bus_type
= {
182 .match
= of_platform_bus_match
,
183 .probe
= of_device_probe
,
184 .remove
= of_device_remove
,
185 .suspend
= of_device_suspend
,
186 .resume
= of_device_resume
,
188 EXPORT_SYMBOL(ebus_bus_type
);
192 struct bus_type sbus_bus_type
= {
194 .match
= of_platform_bus_match
,
195 .probe
= of_device_probe
,
196 .remove
= of_device_remove
,
197 .suspend
= of_device_suspend
,
198 .resume
= of_device_resume
,
200 EXPORT_SYMBOL(sbus_bus_type
);
203 struct bus_type of_bus_type
= {
205 .match
= of_platform_bus_match
,
206 .probe
= of_device_probe
,
207 .remove
= of_device_remove
,
208 .suspend
= of_device_suspend
,
209 .resume
= of_device_resume
,
211 EXPORT_SYMBOL(of_bus_type
);
213 static inline u64
of_read_addr(const u32
*cell
, int size
)
217 r
= (r
<< 32) | *(cell
++);
221 static void __init
get_cells(struct device_node
*dp
,
222 int *addrc
, int *sizec
)
225 *addrc
= of_n_addr_cells(dp
);
227 *sizec
= of_n_size_cells(dp
);
230 /* Max address size we deal with */
231 #define OF_MAX_ADDR_CELLS 4
235 const char *addr_prop_name
;
236 int (*match
)(struct device_node
*parent
);
237 void (*count_cells
)(struct device_node
*child
,
238 int *addrc
, int *sizec
);
239 int (*map
)(u32
*addr
, const u32
*range
,
240 int na
, int ns
, int pna
);
241 unsigned int (*get_flags
)(u32
*addr
);
245 * Default translator (generic bus)
248 static void of_bus_default_count_cells(struct device_node
*dev
,
249 int *addrc
, int *sizec
)
251 get_cells(dev
, addrc
, sizec
);
254 /* Make sure the least significant 64-bits are in-range. Even
255 * for 3 or 4 cell values it is a good enough approximation.
257 static int of_out_of_range(const u32
*addr
, const u32
*base
,
258 const u32
*size
, int na
, int ns
)
260 u64 a
= of_read_addr(addr
, na
);
261 u64 b
= of_read_addr(base
, na
);
266 b
+= of_read_addr(size
, ns
);
273 static int of_bus_default_map(u32
*addr
, const u32
*range
,
274 int na
, int ns
, int pna
)
276 u32 result
[OF_MAX_ADDR_CELLS
];
280 printk("of_device: Cannot handle size cells (%d) > 2.", ns
);
284 if (of_out_of_range(addr
, range
, range
+ na
+ pna
, na
, ns
))
287 /* Start with the parent range base. */
288 memcpy(result
, range
+ na
, pna
* 4);
290 /* Add in the child address offset. */
291 for (i
= 0; i
< na
; i
++)
292 result
[pna
- 1 - i
] +=
296 memcpy(addr
, result
, pna
* 4);
301 static unsigned int of_bus_default_get_flags(u32
*addr
)
303 return IORESOURCE_MEM
;
307 * PCI bus specific translator
310 static int of_bus_pci_match(struct device_node
*np
)
312 if (!strcmp(np
->type
, "pci") || !strcmp(np
->type
, "pciex")) {
313 /* Do not do PCI specific frobbing if the
314 * PCI bridge lacks a ranges property. We
315 * want to pass it through up to the next
316 * parent as-is, not with the PCI translate
317 * method which chops off the top address cell.
319 if (!of_find_property(np
, "ranges", NULL
))
328 static void of_bus_pci_count_cells(struct device_node
*np
,
329 int *addrc
, int *sizec
)
337 static int of_bus_pci_map(u32
*addr
, const u32
*range
,
338 int na
, int ns
, int pna
)
340 u32 result
[OF_MAX_ADDR_CELLS
];
343 /* Check address type match */
344 if ((addr
[0] ^ range
[0]) & 0x03000000)
347 if (of_out_of_range(addr
+ 1, range
+ 1, range
+ na
+ pna
,
351 /* Start with the parent range base. */
352 memcpy(result
, range
+ na
, pna
* 4);
354 /* Add in the child address offset, skipping high cell. */
355 for (i
= 0; i
< na
- 1; i
++)
356 result
[pna
- 1 - i
] +=
360 memcpy(addr
, result
, pna
* 4);
365 static unsigned int of_bus_pci_get_flags(u32
*addr
)
367 unsigned int flags
= 0;
370 switch((w
>> 24) & 0x03) {
372 flags
|= IORESOURCE_IO
;
373 case 0x02: /* 32 bits */
374 case 0x03: /* 64 bits */
375 flags
|= IORESOURCE_MEM
;
378 flags
|= IORESOURCE_PREFETCH
;
383 * SBUS bus specific translator
386 static int of_bus_sbus_match(struct device_node
*np
)
388 return !strcmp(np
->name
, "sbus") ||
389 !strcmp(np
->name
, "sbi");
392 static void of_bus_sbus_count_cells(struct device_node
*child
,
393 int *addrc
, int *sizec
)
401 static int of_bus_sbus_map(u32
*addr
, const u32
*range
, int na
, int ns
, int pna
)
403 return of_bus_default_map(addr
, range
, na
, ns
, pna
);
406 static unsigned int of_bus_sbus_get_flags(u32
*addr
)
408 return IORESOURCE_MEM
;
413 * Array of bus specific translators
416 static struct of_bus of_busses
[] = {
420 .addr_prop_name
= "assigned-addresses",
421 .match
= of_bus_pci_match
,
422 .count_cells
= of_bus_pci_count_cells
,
423 .map
= of_bus_pci_map
,
424 .get_flags
= of_bus_pci_get_flags
,
429 .addr_prop_name
= "reg",
430 .match
= of_bus_sbus_match
,
431 .count_cells
= of_bus_sbus_count_cells
,
432 .map
= of_bus_sbus_map
,
433 .get_flags
= of_bus_sbus_get_flags
,
438 .addr_prop_name
= "reg",
440 .count_cells
= of_bus_default_count_cells
,
441 .map
= of_bus_default_map
,
442 .get_flags
= of_bus_default_get_flags
,
446 static struct of_bus
*of_match_bus(struct device_node
*np
)
450 for (i
= 0; i
< ARRAY_SIZE(of_busses
); i
++)
451 if (!of_busses
[i
].match
|| of_busses
[i
].match(np
))
452 return &of_busses
[i
];
457 static int __init
build_one_resource(struct device_node
*parent
,
461 int na
, int ns
, int pna
)
467 ranges
= of_get_property(parent
, "ranges", &rlen
);
468 if (ranges
== NULL
|| rlen
== 0) {
469 u32 result
[OF_MAX_ADDR_CELLS
];
472 memset(result
, 0, pna
* 4);
473 for (i
= 0; i
< na
; i
++)
474 result
[pna
- 1 - i
] =
477 memcpy(addr
, result
, pna
* 4);
481 /* Now walk through the ranges */
483 rone
= na
+ pna
+ ns
;
484 for (; rlen
>= rone
; rlen
-= rone
, ranges
+= rone
) {
485 if (!bus
->map(addr
, ranges
, na
, ns
, pna
))
492 static int __init
use_1to1_mapping(struct device_node
*pp
)
496 /* If this is on the PMU bus, don't try to translate it even
497 * if a ranges property exists.
499 if (!strcmp(pp
->name
, "pmu"))
502 /* If we have a ranges property in the parent, use it. */
503 if (of_find_property(pp
, "ranges", NULL
) != NULL
)
506 /* If the parent is the dma node of an ISA bus, pass
507 * the translation up to the root.
509 if (!strcmp(pp
->name
, "dma"))
512 /* Similarly for Simba PCI bridges. */
513 model
= of_get_property(pp
, "model", NULL
);
514 if (model
&& !strcmp(model
, "SUNW,simba"))
520 static int of_resource_verbose
;
522 static void __init
build_device_resources(struct of_device
*op
,
523 struct device
*parent
)
525 struct of_device
*p_op
;
534 p_op
= to_of_device(parent
);
535 bus
= of_match_bus(p_op
->node
);
536 bus
->count_cells(op
->node
, &na
, &ns
);
538 preg
= of_get_property(op
->node
, bus
->addr_prop_name
, &num_reg
);
539 if (!preg
|| num_reg
== 0)
542 /* Convert to num-cells. */
545 /* Convert to num-entries. */
548 /* Prevent overruning the op->resources[] array. */
549 if (num_reg
> PROMREG_MAX
) {
550 printk(KERN_WARNING
"%s: Too many regs (%d), "
552 op
->node
->full_name
, num_reg
, PROMREG_MAX
);
553 num_reg
= PROMREG_MAX
;
556 for (index
= 0; index
< num_reg
; index
++) {
557 struct resource
*r
= &op
->resource
[index
];
558 u32 addr
[OF_MAX_ADDR_CELLS
];
559 u32
*reg
= (preg
+ (index
* ((na
+ ns
) * 4)));
560 struct device_node
*dp
= op
->node
;
561 struct device_node
*pp
= p_op
->node
;
563 u64 size
, result
= OF_BAD_ADDR
;
568 size
= of_read_addr(reg
+ na
, ns
);
569 flags
= bus
->get_flags(reg
);
571 memcpy(addr
, reg
, na
* 4);
573 if (use_1to1_mapping(pp
)) {
574 result
= of_read_addr(addr
, na
);
585 result
= of_read_addr(addr
, dna
);
589 pbus
= of_match_bus(pp
);
590 pbus
->count_cells(dp
, &pna
, &pns
);
592 if (build_one_resource(dp
, bus
, pbus
, addr
,
602 memset(r
, 0, sizeof(*r
));
604 if (of_resource_verbose
)
605 printk("%s reg[%d] -> %lx\n",
606 op
->node
->full_name
, index
,
609 if (result
!= OF_BAD_ADDR
) {
610 if (tlb_type
== hypervisor
)
611 result
&= 0x0fffffffffffffffUL
;
614 r
->end
= result
+ size
- 1;
620 r
->name
= op
->node
->name
;
624 static struct device_node
* __init
625 apply_interrupt_map(struct device_node
*dp
, struct device_node
*pp
,
626 u32
*imap
, int imlen
, u32
*imask
,
629 struct device_node
*cp
;
630 unsigned int irq
= *irq_p
;
636 bus
= of_match_bus(pp
);
637 bus
->count_cells(dp
, &na
, NULL
);
639 reg
= of_get_property(dp
, "reg", &num_reg
);
640 if (!reg
|| !num_reg
)
643 imlen
/= ((na
+ 3) * 4);
645 for (i
= 0; i
< imlen
; i
++) {
648 for (j
= 0; j
< na
; j
++) {
649 if ((reg
[j
] & imask
[j
]) != imap
[j
])
652 if (imap
[na
] == irq
) {
653 handle
= imap
[na
+ 1];
662 /* Psycho and Sabre PCI controllers can have 'interrupt-map'
663 * properties that do not include the on-board device
664 * interrupts. Instead, the device's 'interrupts' property
665 * is already a fully specified INO value.
667 * Handle this by deciding that, if we didn't get a
668 * match in the parent's 'interrupt-map', and the
669 * parent is an IRQ translater, then use the parent as
670 * our IRQ controller.
679 cp
= of_find_node_by_phandle(handle
);
684 static unsigned int __init
pci_irq_swizzle(struct device_node
*dp
,
685 struct device_node
*pp
,
688 struct linux_prom_pci_registers
*regs
;
689 unsigned int devfn
, slot
, ret
;
691 if (irq
< 1 || irq
> 4)
694 regs
= of_get_property(dp
, "reg", NULL
);
698 devfn
= (regs
->phys_hi
>> 8) & 0xff;
699 slot
= (devfn
>> 3) & 0x1f;
701 ret
= ((irq
- 1 + (slot
& 3)) & 3) + 1;
706 static int of_irq_verbose
;
708 static unsigned int __init
build_one_device_irq(struct of_device
*op
,
709 struct device
*parent
,
712 struct device_node
*dp
= op
->node
;
713 struct device_node
*pp
, *ip
;
714 unsigned int orig_irq
= irq
;
716 if (irq
== 0xffffffff)
720 irq
= dp
->irq_trans
->irq_build(dp
, irq
,
721 dp
->irq_trans
->data
);
724 printk("%s: direct translate %x --> %x\n",
725 dp
->full_name
, orig_irq
, irq
);
730 /* Something more complicated. Walk up to the root, applying
731 * interrupt-map or bus specific translations, until we hit
734 * If we hit a bus type or situation we cannot handle, we
735 * stop and assume that the original IRQ number was in a
736 * format which has special meaning to it's immediate parent.
744 imap
= of_get_property(pp
, "interrupt-map", &imlen
);
745 imsk
= of_get_property(pp
, "interrupt-map-mask", NULL
);
747 struct device_node
*iret
;
748 int this_orig_irq
= irq
;
750 iret
= apply_interrupt_map(dp
, pp
,
755 printk("%s: Apply [%s:%x] imap --> [%s:%x]\n",
757 pp
->full_name
, this_orig_irq
,
758 (iret
? iret
->full_name
: "NULL"), irq
);
763 if (iret
->irq_trans
) {
768 if (!strcmp(pp
->type
, "pci") ||
769 !strcmp(pp
->type
, "pciex")) {
770 unsigned int this_orig_irq
= irq
;
772 irq
= pci_irq_swizzle(dp
, pp
, irq
);
774 printk("%s: PCI swizzle [%s] "
777 pp
->full_name
, this_orig_irq
,
793 irq
= ip
->irq_trans
->irq_build(op
->node
, irq
,
794 ip
->irq_trans
->data
);
796 printk("%s: Apply IRQ trans [%s] %x --> %x\n",
797 op
->node
->full_name
, ip
->full_name
, orig_irq
, irq
);
802 static struct of_device
* __init
scan_one_device(struct device_node
*dp
,
803 struct device
*parent
)
805 struct of_device
*op
= kzalloc(sizeof(*op
), GFP_KERNEL
);
814 op
->clock_freq
= of_getintprop_default(dp
, "clock-frequency",
816 op
->portid
= of_getintprop_default(dp
, "upa-portid", -1);
817 if (op
->portid
== -1)
818 op
->portid
= of_getintprop_default(dp
, "portid", -1);
820 irq
= of_get_property(dp
, "interrupts", &len
);
822 memcpy(op
->irqs
, irq
, len
);
823 op
->num_irqs
= len
/ 4;
828 /* Prevent overruning the op->irqs[] array. */
829 if (op
->num_irqs
> PROMINTR_MAX
) {
830 printk(KERN_WARNING
"%s: Too many irqs (%d), "
832 dp
->full_name
, op
->num_irqs
, PROMINTR_MAX
);
833 op
->num_irqs
= PROMINTR_MAX
;
836 build_device_resources(op
, parent
);
837 for (i
= 0; i
< op
->num_irqs
; i
++)
838 op
->irqs
[i
] = build_one_device_irq(op
, parent
, op
->irqs
[i
]);
840 op
->dev
.parent
= parent
;
841 op
->dev
.bus
= &of_bus_type
;
843 strcpy(op
->dev
.bus_id
, "root");
845 strcpy(op
->dev
.bus_id
, dp
->path_component_name
);
847 if (of_device_register(op
)) {
848 printk("%s: Could not register of device.\n",
857 static void __init
scan_tree(struct device_node
*dp
, struct device
*parent
)
860 struct of_device
*op
= scan_one_device(dp
, parent
);
863 scan_tree(dp
->child
, &op
->dev
);
869 static void __init
scan_of_devices(void)
871 struct device_node
*root
= of_find_node_by_path("/");
872 struct of_device
*parent
;
874 parent
= scan_one_device(root
, NULL
);
878 scan_tree(root
->child
, &parent
->dev
);
881 static int __init
of_bus_driver_init(void)
885 err
= bus_register(&of_bus_type
);
888 err
= bus_register(&isa_bus_type
);
890 err
= bus_register(&ebus_bus_type
);
894 err
= bus_register(&sbus_bus_type
);
903 postcore_initcall(of_bus_driver_init
);
905 static int __init
of_debug(char *str
)
909 get_option(&str
, &val
);
911 of_resource_verbose
= 1;
917 __setup("of_debug=", of_debug
);
919 int of_register_driver(struct of_platform_driver
*drv
, struct bus_type
*bus
)
921 /* initialize common driver fields */
922 drv
->driver
.name
= drv
->name
;
923 drv
->driver
.bus
= bus
;
925 /* register with core */
926 return driver_register(&drv
->driver
);
929 void of_unregister_driver(struct of_platform_driver
*drv
)
931 driver_unregister(&drv
->driver
);
935 static ssize_t
dev_show_devspec(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
937 struct of_device
*ofdev
;
939 ofdev
= to_of_device(dev
);
940 return sprintf(buf
, "%s", ofdev
->node
->full_name
);
943 static DEVICE_ATTR(devspec
, S_IRUGO
, dev_show_devspec
, NULL
);
946 * of_release_dev - free an of device structure when all users of it are finished.
947 * @dev: device that's been disconnected
949 * Will be called only by the device core when all users of this of device are
952 void of_release_dev(struct device
*dev
)
954 struct of_device
*ofdev
;
956 ofdev
= to_of_device(dev
);
961 int of_device_register(struct of_device
*ofdev
)
965 BUG_ON(ofdev
->node
== NULL
);
967 rc
= device_register(&ofdev
->dev
);
971 rc
= device_create_file(&ofdev
->dev
, &dev_attr_devspec
);
973 device_unregister(&ofdev
->dev
);
978 void of_device_unregister(struct of_device
*ofdev
)
980 device_remove_file(&ofdev
->dev
, &dev_attr_devspec
);
981 device_unregister(&ofdev
->dev
);
984 struct of_device
* of_platform_device_create(struct device_node
*np
,
986 struct device
*parent
,
987 struct bus_type
*bus
)
989 struct of_device
*dev
;
991 dev
= kmalloc(sizeof(*dev
), GFP_KERNEL
);
994 memset(dev
, 0, sizeof(*dev
));
996 dev
->dev
.parent
= parent
;
998 dev
->dev
.release
= of_release_dev
;
1000 strlcpy(dev
->dev
.bus_id
, bus_id
, BUS_ID_SIZE
);
1002 if (of_device_register(dev
) != 0) {
1010 EXPORT_SYMBOL(of_match_device
);
1011 EXPORT_SYMBOL(of_register_driver
);
1012 EXPORT_SYMBOL(of_unregister_driver
);
1013 EXPORT_SYMBOL(of_device_register
);
1014 EXPORT_SYMBOL(of_device_unregister
);
1015 EXPORT_SYMBOL(of_dev_get
);
1016 EXPORT_SYMBOL(of_dev_put
);
1017 EXPORT_SYMBOL(of_platform_device_create
);
1018 EXPORT_SYMBOL(of_release_dev
);