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 /* 4: version, 4: total size */
26 #define OF_DT_BEGIN_NODE 0x1 /* Start node: full name */
27 #define OF_DT_END_NODE 0x2 /* End node */
28 #define OF_DT_PROP 0x3 /* Property: name off, size, content */
31 #define OF_DT_VERSION 1
34 * This is what gets passed to the kernel by prom_init or kexec
36 * The dt struct contains the device tree structure, full pathes and
37 * property contents. The dt strings contain a separate block with just
38 * the strings for the property names, and is fully page aligned and
39 * self contained in a page, so that it can be kept around by the kernel,
40 * each property name appears only once in this page (cheap compression)
42 * the mem_rsvmap contains a map of reserved ranges of physical memory,
43 * passing it here instead of in the device-tree itself greatly simplifies
44 * the job of everybody. It's just a list of u64 pairs (base/size) that
47 struct boot_param_header
49 u32 magic; /* magic word OF_DT_HEADER */
50 u32 totalsize; /* total size of DT block */
51 u32 off_dt_struct; /* offset to structure */
52 u32 off_dt_strings; /* offset to strings */
53 u32 off_mem_rsvmap; /* offset to memory reserve map */
54 u32 version; /* format version */
55 u32 last_comp_version; /* last compatible version */
56 /* version 2 fields below */
57 u32 boot_cpuid_phys; /* Which physical CPU id we're booting on */
65 struct address_range {
67 unsigned long address;
71 struct interrupt_info {
73 int sense; /* +ve/-ve logic, edge or level, etc. */
88 struct isa_address isa_addr;
89 struct pci_address pci_addr;
94 unsigned long address;
98 struct reg_property32 {
103 struct reg_property64 {
104 unsigned long address;
111 unsigned char *value;
112 struct property *next;
115 /* NOTE: the device_node contains PCI specific info for pci devices.
116 * This perhaps could be hung off the device_node with another struct,
117 * but for now it is directly in the node. The phb ptr is a good
118 * indication of a real PCI node. Other nodes leave these fields zeroed.
120 struct pci_controller;
127 phandle linux_phandle;
129 struct address_range *addrs;
131 struct interrupt_info *intrs;
134 /* PCI stuff probably doesn't belong here */
135 int busno; /* for pci devices */
136 int bussubno; /* for pci devices */
137 int devfn; /* for pci devices */
138 int eeh_mode; /* See eeh.h for possible EEH_MODEs */
140 int pci_ext_config_space; /* for pci devices */
141 struct pci_controller *phb; /* for pci devices */
142 struct iommu_table *iommu_table; /* for phb's or bridges */
144 struct property *properties;
145 struct device_node *parent;
146 struct device_node *child;
147 struct device_node *sibling;
148 struct device_node *next; /* next device of same type */
149 struct device_node *allnext; /* next in list of all nodes */
150 struct proc_dir_entry *pde; /* this node's proc directory */
151 struct proc_dir_entry *name_link; /* name symlink */
152 struct proc_dir_entry *addr_link; /* addr symlink */
154 unsigned long _flags;
157 extern struct device_node *of_chosen;
159 /* flag descriptions */
160 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
162 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
163 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
166 * Until 32-bit ppc can add proc_dir_entries to its device_node
167 * definition, we cannot refer to pde, name_link, and addr_link
168 * in arch-independent code.
170 #define HAVE_ARCH_DEVTREE_FIXUPS
172 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
177 static void inline set_node_name_link(struct device_node *dn, struct proc_dir_entry *de)
182 static void inline set_node_addr_link(struct device_node *dn, struct proc_dir_entry *de)
187 /* OBSOLETE: Old stlye node lookup */
188 extern struct device_node *find_devices(const char *name);
189 extern struct device_node *find_type_devices(const char *type);
190 extern struct device_node *find_path_device(const char *path);
191 extern struct device_node *find_compatible_devices(const char *type,
193 extern struct device_node *find_all_nodes(void);
195 /* New style node lookup */
196 extern struct device_node *of_find_node_by_name(struct device_node *from,
198 extern struct device_node *of_find_node_by_type(struct device_node *from,
200 extern struct device_node *of_find_compatible_node(struct device_node *from,
201 const char *type, const char *compat);
202 extern struct device_node *of_find_node_by_path(const char *path);
203 extern struct device_node *of_find_node_by_phandle(phandle handle);
204 extern struct device_node *of_find_all_nodes(struct device_node *prev);
205 extern struct device_node *of_get_parent(const struct device_node *node);
206 extern struct device_node *of_get_next_child(const struct device_node *node,
207 struct device_node *prev);
208 extern struct device_node *of_node_get(struct device_node *node);
209 extern void of_node_put(struct device_node *node);
211 /* For updating the device tree at runtime */
212 extern void of_attach_node(struct device_node *);
213 extern void of_detach_node(const struct device_node *);
215 /* Other Prototypes */
216 extern unsigned long prom_init(unsigned long, unsigned long, unsigned long,
217 unsigned long, unsigned long);
218 extern void finish_device_tree(void);
219 extern int device_is_compatible(struct device_node *device, const char *);
220 extern int machine_is_compatible(const char *compat);
221 extern unsigned char *get_property(struct device_node *node, const char *name,
223 extern void print_properties(struct device_node *node);
224 extern int prom_n_addr_cells(struct device_node* np);
225 extern int prom_n_size_cells(struct device_node* np);
226 extern int prom_n_intr_cells(struct device_node* np);
227 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
228 extern void prom_add_property(struct device_node* np, struct property* prop);
230 #endif /* _PPC64_PROM_H */