1 #ifndef _POWERPC_PROM_H
2 #define _POWERPC_PROM_H
6 * Definitions for talking to the Open Firmware PROM on
7 * Power Macintosh computers.
9 * Copyright (C) 1996-2005 Paul Mackerras.
11 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
18 #include <linux/config.h>
19 #include <linux/types.h>
20 #include <linux/proc_fs.h>
21 #include <asm/atomic.h>
23 /* Definitions used by the flattened device tree */
24 #define OF_DT_HEADER 0xd00dfeed /* marker */
25 #define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
26 #define OF_DT_END_NODE 0x2 /* End node */
27 #define OF_DT_PROP 0x3 /* Property: name off, size,
29 #define OF_DT_NOP 0x4 /* nop */
32 #define OF_DT_VERSION 0x10
35 * This is what gets passed to the kernel by prom_init or kexec
37 * The dt struct contains the device tree structure, full pathes and
38 * property contents. The dt strings contain a separate block with just
39 * the strings for the property names, and is fully page aligned and
40 * self contained in a page, so that it can be kept around by the kernel,
41 * each property name appears only once in this page (cheap compression)
43 * the mem_rsvmap contains a map of reserved ranges of physical memory,
44 * passing it here instead of in the device-tree itself greatly simplifies
45 * the job of everybody. It's just a list of u64 pairs (base/size) that
48 struct boot_param_header
50 u32 magic; /* magic word OF_DT_HEADER */
51 u32 totalsize; /* total size of DT block */
52 u32 off_dt_struct; /* offset to structure */
53 u32 off_dt_strings; /* offset to strings */
54 u32 off_mem_rsvmap; /* offset to memory reserve map */
55 u32 version; /* format version */
56 u32 last_comp_version; /* last compatible version */
57 /* version 2 fields below */
58 u32 boot_cpuid_phys; /* Physical CPU id we're booting on */
59 /* version 3 fields below */
60 u32 dt_strings_size; /* size of the DT strings block */
68 struct interrupt_info {
70 int sense; /* +ve/-ve logic, edge or level, etc. */
77 struct property *next;
84 phandle linux_phandle;
86 struct interrupt_info *intrs;
89 struct property *properties;
90 struct device_node *parent;
91 struct device_node *child;
92 struct device_node *sibling;
93 struct device_node *next; /* next device of same type */
94 struct device_node *allnext; /* next in list of all nodes */
95 struct proc_dir_entry *pde; /* this node's proc directory */
101 extern struct device_node *of_chosen;
103 /* flag descriptions */
104 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
106 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
107 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
109 #define HAVE_ARCH_DEVTREE_FIXUPS
111 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
117 /* OBSOLETE: Old style node lookup */
118 extern struct device_node *find_devices(const char *name);
119 extern struct device_node *find_type_devices(const char *type);
120 extern struct device_node *find_path_device(const char *path);
121 extern struct device_node *find_compatible_devices(const char *type,
123 extern struct device_node *find_all_nodes(void);
125 /* New style node lookup */
126 extern struct device_node *of_find_node_by_name(struct device_node *from,
128 extern struct device_node *of_find_node_by_type(struct device_node *from,
130 extern struct device_node *of_find_compatible_node(struct device_node *from,
131 const char *type, const char *compat);
132 extern struct device_node *of_find_node_by_path(const char *path);
133 extern struct device_node *of_find_node_by_phandle(phandle handle);
134 extern struct device_node *of_find_all_nodes(struct device_node *prev);
135 extern struct device_node *of_get_parent(const struct device_node *node);
136 extern struct device_node *of_get_next_child(const struct device_node *node,
137 struct device_node *prev);
138 extern struct device_node *of_node_get(struct device_node *node);
139 extern void of_node_put(struct device_node *node);
141 /* For scanning the flat device-tree at boot time */
142 int __init of_scan_flat_dt(int (*it)(unsigned long node,
143 const char *uname, int depth,
146 void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
147 unsigned long *size);
149 /* For updating the device tree at runtime */
150 extern void of_attach_node(struct device_node *);
151 extern void of_detach_node(const struct device_node *);
153 /* Other Prototypes */
154 extern void finish_device_tree(void);
155 extern void unflatten_device_tree(void);
156 extern void early_init_devtree(void *);
157 extern int device_is_compatible(struct device_node *device, const char *);
158 extern int machine_is_compatible(const char *compat);
159 extern unsigned char *get_property(struct device_node *node, const char *name,
161 extern void print_properties(struct device_node *node);
162 extern int prom_n_addr_cells(struct device_node* np);
163 extern int prom_n_size_cells(struct device_node* np);
164 extern int prom_n_intr_cells(struct device_node* np);
165 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
166 extern int prom_add_property(struct device_node* np, struct property* prop);
170 * PCI <-> OF matching functions
171 * (XXX should these be here?)
175 extern int pci_device_from_OF_node(struct device_node *node,
177 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
178 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
179 extern void pci_create_OF_bus_map(void);
182 extern struct resource *request_OF_resource(struct device_node* node,
183 int index, const char* name_postfix);
184 extern int release_OF_resource(struct device_node* node, int index);
188 * OF address retreival & translation
192 /* Translate an OF address block into a CPU physical address
194 #define OF_BAD_ADDR ((u64)-1)
195 extern u64 of_translate_address(struct device_node *np, u32 *addr);
197 /* Extract an address from a device, returns the region size and
198 * the address space flags too. The PCI version uses a BAR number
199 * instead of an absolute index
201 extern u32 *of_get_address(struct device_node *dev, int index,
202 u64 *size, unsigned int *flags);
203 extern u32 *of_get_pci_address(struct device_node *dev, int bar_no,
204 u64 *size, unsigned int *flags);
206 /* Get an address as a resource. Note that if your address is
207 * a PIO address, the conversion will fail if the physical address
208 * can't be internally converted to an IO token with
209 * pci_address_to_pio(), that is because it's either called to early
210 * or it can't be matched to any host bridge IO space
212 extern int of_address_to_resource(struct device_node *dev, int index,
214 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
217 #endif /* __KERNEL__ */
218 #endif /* _POWERPC_PROM_H */