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 address_range
{
70 unsigned long address
;
74 struct interrupt_info
{
76 int sense
; /* +ve/-ve logic, edge or level, etc. */
91 struct isa_address isa_addr
;
92 struct pci_address pci_addr
;
97 unsigned long address
;
101 struct reg_property32
{
102 unsigned int address
;
106 struct reg_property64
{
114 unsigned char *value
;
115 struct property
*next
;
122 phandle linux_phandle
;
124 struct address_range
*addrs
;
126 struct interrupt_info
*intrs
;
129 struct property
*properties
;
130 struct device_node
*parent
;
131 struct device_node
*child
;
132 struct device_node
*sibling
;
133 struct device_node
*next
; /* next device of same type */
134 struct device_node
*allnext
; /* next in list of all nodes */
135 struct proc_dir_entry
*pde
; /* this node's proc directory */
137 unsigned long _flags
;
141 extern struct device_node
*of_chosen
;
143 /* flag descriptions */
144 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
146 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
147 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
149 #define HAVE_ARCH_DEVTREE_FIXUPS
151 static inline void set_node_proc_entry(struct device_node
*dn
, struct proc_dir_entry
*de
)
157 /* OBSOLETE: Old style node lookup */
158 extern struct device_node
*find_devices(const char *name
);
159 extern struct device_node
*find_type_devices(const char *type
);
160 extern struct device_node
*find_path_device(const char *path
);
161 extern struct device_node
*find_compatible_devices(const char *type
,
163 extern struct device_node
*find_all_nodes(void);
165 /* New style node lookup */
166 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
168 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
170 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
171 const char *type
, const char *compat
);
172 extern struct device_node
*of_find_node_by_path(const char *path
);
173 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
174 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
175 extern struct device_node
*of_get_parent(const struct device_node
*node
);
176 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
177 struct device_node
*prev
);
178 extern struct device_node
*of_node_get(struct device_node
*node
);
179 extern void of_node_put(struct device_node
*node
);
181 /* For scanning the flat device-tree at boot time */
182 int __init
of_scan_flat_dt(int (*it
)(unsigned long node
,
183 const char *uname
, int depth
,
186 void* __init
of_get_flat_dt_prop(unsigned long node
, const char *name
,
187 unsigned long *size
);
189 /* For updating the device tree at runtime */
190 extern void of_attach_node(struct device_node
*);
191 extern void of_detach_node(const struct device_node
*);
193 /* Other Prototypes */
194 extern void finish_device_tree(void);
195 extern void unflatten_device_tree(void);
196 extern void early_init_devtree(void *);
197 extern int device_is_compatible(struct device_node
*device
, const char *);
198 extern int machine_is_compatible(const char *compat
);
199 extern unsigned char *get_property(struct device_node
*node
, const char *name
,
201 extern void print_properties(struct device_node
*node
);
202 extern int prom_n_addr_cells(struct device_node
* np
);
203 extern int prom_n_size_cells(struct device_node
* np
);
204 extern int prom_n_intr_cells(struct device_node
* np
);
205 extern void prom_get_irq_senses(unsigned char *senses
, int off
, int max
);
206 extern int prom_add_property(struct device_node
* np
, struct property
* prop
);
210 * PCI <-> OF matching functions
211 * (XXX should these be here?)
215 extern int pci_device_from_OF_node(struct device_node
*node
,
217 extern struct device_node
* pci_busdev_to_OF_node(struct pci_bus
*, int);
218 extern struct device_node
* pci_device_to_OF_node(struct pci_dev
*);
219 extern void pci_create_OF_bus_map(void);
222 extern struct resource
*request_OF_resource(struct device_node
* node
,
223 int index
, const char* name_postfix
);
224 extern int release_OF_resource(struct device_node
* node
, int index
);
227 * Address translation function(s)
229 #define OF_BAD_ADDR ((u64)-1)
230 extern u64
of_translate_address(struct device_node
*np
, u32
*addr
);
231 extern u32
*of_get_address(struct device_node
*dev
, int index
, u64
*size
);
232 extern u32
*of_get_pci_address(struct device_node
*dev
, int bar_no
, u64
*size
);
235 #endif /* __KERNEL__ */
236 #endif /* _POWERPC_PROM_H */