5 * Definitions for talking to the Open Firmware PROM on
6 * Power Macintosh computers.
8 * Copyright (C) 1996 Paul Mackerras.
10 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version
15 * 2 of the License, or (at your option) any later version.
17 #include <linux/proc_fs.h>
18 #include <asm/atomic.h>
20 #define PTRRELOC(x) ((typeof(x))((unsigned long)(x) - offset))
21 #define PTRUNRELOC(x) ((typeof(x))((unsigned long)(x) + offset))
22 #define RELOC(x) (*PTRRELOC(&(x)))
24 /* Definitions used by the flattened device tree */
25 #define OF_DT_HEADER 0xd00dfeed /* marker */
26 #define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
27 #define OF_DT_END_NODE 0x2 /* End node */
28 #define OF_DT_PROP 0x3 /* Property: name off, size,
30 #define OF_DT_NOP 0x4 /* nop */
33 #define OF_DT_VERSION 0x10
36 * This is what gets passed to the kernel by prom_init or kexec
38 * The dt struct contains the device tree structure, full pathes and
39 * property contents. The dt strings contain a separate block with just
40 * the strings for the property names, and is fully page aligned and
41 * self contained in a page, so that it can be kept around by the kernel,
42 * each property name appears only once in this page (cheap compression)
44 * the mem_rsvmap contains a map of reserved ranges of physical memory,
45 * passing it here instead of in the device-tree itself greatly simplifies
46 * the job of everybody. It's just a list of u64 pairs (base/size) that
49 struct boot_param_header
51 u32 magic; /* magic word OF_DT_HEADER */
52 u32 totalsize; /* total size of DT block */
53 u32 off_dt_struct; /* offset to structure */
54 u32 off_dt_strings; /* offset to strings */
55 u32 off_mem_rsvmap; /* offset to memory reserve map */
56 u32 version; /* format version */
57 u32 last_comp_version; /* last compatible version */
58 /* version 2 fields below */
59 u32 boot_cpuid_phys; /* Physical CPU id we're booting on */
60 /* version 3 fields below */
61 u32 dt_strings_size; /* size of the DT strings block */
69 struct address_range {
71 unsigned long address;
75 struct interrupt_info {
77 int sense; /* +ve/-ve logic, edge or level, etc. */
92 struct isa_address isa_addr;
93 struct pci_address pci_addr;
98 unsigned long address;
102 struct reg_property32 {
103 unsigned int address;
107 struct reg_property64 {
108 unsigned long address;
115 unsigned char *value;
116 struct property *next;
119 /* NOTE: the device_node contains PCI specific info for pci devices.
120 * This perhaps could be hung off the device_node with another struct,
121 * but for now it is directly in the node. The phb ptr is a good
122 * indication of a real PCI node. Other nodes leave these fields zeroed.
124 struct pci_controller;
131 phandle linux_phandle;
133 struct address_range *addrs;
135 struct interrupt_info *intrs;
138 /* PCI stuff probably doesn't belong here */
139 int busno; /* for pci devices */
140 int bussubno; /* for pci devices */
141 int devfn; /* for pci devices */
142 int eeh_mode; /* See eeh.h for possible EEH_MODEs */
144 int pci_ext_config_space; /* for pci devices */
145 struct pci_controller *phb; /* for pci devices */
146 struct iommu_table *iommu_table; /* for phb's or bridges */
148 struct property *properties;
149 struct device_node *parent;
150 struct device_node *child;
151 struct device_node *sibling;
152 struct device_node *next; /* next device of same type */
153 struct device_node *allnext; /* next in list of all nodes */
154 struct proc_dir_entry *pde; /* this node's proc directory */
156 unsigned long _flags;
159 extern struct device_node *of_chosen;
161 /* flag descriptions */
162 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
164 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
165 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
168 * Until 32-bit ppc can add proc_dir_entries to its device_node
169 * definition, we cannot refer to pde, name_link, and addr_link
170 * in arch-independent code.
172 #define HAVE_ARCH_DEVTREE_FIXUPS
174 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
180 /* OBSOLETE: Old stlye node lookup */
181 extern struct device_node *find_devices(const char *name);
182 extern struct device_node *find_type_devices(const char *type);
183 extern struct device_node *find_path_device(const char *path);
184 extern struct device_node *find_compatible_devices(const char *type,
186 extern struct device_node *find_all_nodes(void);
188 /* New style node lookup */
189 extern struct device_node *of_find_node_by_name(struct device_node *from,
191 extern struct device_node *of_find_node_by_type(struct device_node *from,
193 extern struct device_node *of_find_compatible_node(struct device_node *from,
194 const char *type, const char *compat);
195 extern struct device_node *of_find_node_by_path(const char *path);
196 extern struct device_node *of_find_node_by_phandle(phandle handle);
197 extern struct device_node *of_find_all_nodes(struct device_node *prev);
198 extern struct device_node *of_get_parent(const struct device_node *node);
199 extern struct device_node *of_get_next_child(const struct device_node *node,
200 struct device_node *prev);
201 extern struct device_node *of_node_get(struct device_node *node);
202 extern void of_node_put(struct device_node *node);
204 /* For updating the device tree at runtime */
205 extern void of_attach_node(struct device_node *);
206 extern void of_detach_node(const struct device_node *);
208 /* Other Prototypes */
209 extern unsigned long prom_init(unsigned long, unsigned long, unsigned long,
210 unsigned long, unsigned long);
211 extern void finish_device_tree(void);
212 extern int device_is_compatible(struct device_node *device, const char *);
213 extern int machine_is_compatible(const char *compat);
214 extern unsigned char *get_property(struct device_node *node, const char *name,
216 extern void print_properties(struct device_node *node);
217 extern int prom_n_addr_cells(struct device_node* np);
218 extern int prom_n_size_cells(struct device_node* np);
219 extern int prom_n_intr_cells(struct device_node* np);
220 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
221 extern void prom_add_property(struct device_node* np, struct property* prop);
223 #endif /* _PPC64_PROM_H */