Merge branch 'release' of git://git.kernel.org/pub/scm/linux/kernel/git/lenb/linux...
[linux-2.6] / include / asm-powerpc / prom.h
1 #ifndef _POWERPC_PROM_H
2 #define _POWERPC_PROM_H
3 #ifdef __KERNEL__
4
5 /*
6  * Definitions for talking to the Open Firmware PROM on
7  * Power Macintosh computers.
8  *
9  * Copyright (C) 1996-2005 Paul Mackerras.
10  *
11  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
12  *
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.
17  */
18 #include <linux/types.h>
19 #include <linux/proc_fs.h>
20 #include <asm/atomic.h>
21
22 /* Definitions used by the flattened device tree */
23 #define OF_DT_HEADER            0xd00dfeed      /* marker */
24 #define OF_DT_BEGIN_NODE        0x1             /* Start of node, full name */
25 #define OF_DT_END_NODE          0x2             /* End node */
26 #define OF_DT_PROP              0x3             /* Property: name off, size,
27                                                  * content */
28 #define OF_DT_NOP               0x4             /* nop */
29 #define OF_DT_END               0x9
30
31 #define OF_DT_VERSION           0x10
32
33 /*
34  * This is what gets passed to the kernel by prom_init or kexec
35  *
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)
41  *
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
45  * ends when size is 0
46  */
47 struct boot_param_header
48 {
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;        /* Physical CPU id we're booting on */
58         /* version 3 fields below */
59         u32     dt_strings_size;        /* size of the DT strings block */
60 };
61
62
63
64 typedef u32 phandle;
65 typedef u32 ihandle;
66
67 struct interrupt_info {
68         int     line;
69         int     sense;          /* +ve/-ve logic, edge or level, etc. */
70 };
71
72 struct property {
73         char    *name;
74         int     length;
75         unsigned char *value;
76         struct property *next;
77 };
78
79 struct device_node {
80         char    *name;
81         char    *type;
82         phandle node;
83         phandle linux_phandle;
84         int     n_intrs;
85         struct  interrupt_info *intrs;
86         char    *full_name;
87
88         struct  property *properties;
89         struct  property *deadprops; /* removed 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 */
96         struct  kref kref;
97         unsigned long _flags;
98         void    *data;
99 };
100
101 extern struct device_node *of_chosen;
102
103 /* flag descriptions */
104 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
105
106 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
107 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
108
109 #define HAVE_ARCH_DEVTREE_FIXUPS
110
111 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
112 {
113         dn->pde = de;
114 }
115
116
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,
122                                                    const char *compat);
123 extern struct device_node *find_all_nodes(void);
124
125 /* New style node lookup */
126 extern struct device_node *of_find_node_by_name(struct device_node *from,
127         const char *name);
128 #define for_each_node_by_name(dn, name) \
129         for (dn = of_find_node_by_name(NULL, name); dn; \
130              dn = of_find_node_by_name(dn, name))
131 extern struct device_node *of_find_node_by_type(struct device_node *from,
132         const char *type);
133 #define for_each_node_by_type(dn, type) \
134         for (dn = of_find_node_by_type(NULL, type); dn; \
135              dn = of_find_node_by_type(dn, type))
136 extern struct device_node *of_find_compatible_node(struct device_node *from,
137         const char *type, const char *compat);
138 extern struct device_node *of_find_node_by_path(const char *path);
139 extern struct device_node *of_find_node_by_phandle(phandle handle);
140 extern struct device_node *of_find_all_nodes(struct device_node *prev);
141 extern struct device_node *of_get_parent(const struct device_node *node);
142 extern struct device_node *of_get_next_child(const struct device_node *node,
143                                              struct device_node *prev);
144 extern struct property *of_find_property(struct device_node *np,
145                                          const char *name,
146                                          int *lenp);
147 extern struct device_node *of_node_get(struct device_node *node);
148 extern void of_node_put(struct device_node *node);
149
150 /* For scanning the flat device-tree at boot time */
151 extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
152                                             const char *uname, int depth,
153                                             void *data),
154                                   void *data);
155 extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
156                                         unsigned long *size);
157 extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
158 extern unsigned long __init of_get_flat_dt_root(void);
159
160 /* For updating the device tree at runtime */
161 extern void of_attach_node(struct device_node *);
162 extern void of_detach_node(const struct device_node *);
163
164 /* Other Prototypes */
165 extern void finish_device_tree(void);
166 extern void unflatten_device_tree(void);
167 extern void early_init_devtree(void *);
168 extern int device_is_compatible(struct device_node *device, const char *);
169 extern int machine_is_compatible(const char *compat);
170 extern unsigned char *get_property(struct device_node *node, const char *name,
171                                    int *lenp);
172 extern void print_properties(struct device_node *node);
173 extern int prom_n_addr_cells(struct device_node* np);
174 extern int prom_n_size_cells(struct device_node* np);
175 extern int prom_n_intr_cells(struct device_node* np);
176 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
177 extern int prom_add_property(struct device_node* np, struct property* prop);
178 extern int prom_remove_property(struct device_node *np, struct property *prop);
179 extern int prom_update_property(struct device_node *np,
180                                 struct property *newprop,
181                                 struct property *oldprop);
182
183 #ifdef CONFIG_PPC32
184 /*
185  * PCI <-> OF matching functions
186  * (XXX should these be here?)
187  */
188 struct pci_bus;
189 struct pci_dev;
190 extern int pci_device_from_OF_node(struct device_node *node,
191                                    u8* bus, u8* devfn);
192 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
193 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
194 extern void pci_create_OF_bus_map(void);
195 #endif
196
197 extern struct resource *request_OF_resource(struct device_node* node,
198                                 int index, const char* name_postfix);
199 extern int release_OF_resource(struct device_node* node, int index);
200
201
202 /*
203  * OF address retreival & translation
204  */
205
206
207 /* Translate an OF address block into a CPU physical address
208  */
209 #define OF_BAD_ADDR     ((u64)-1)
210 extern u64 of_translate_address(struct device_node *np, u32 *addr);
211
212 /* Extract an address from a device, returns the region size and
213  * the address space flags too. The PCI version uses a BAR number
214  * instead of an absolute index
215  */
216 extern u32 *of_get_address(struct device_node *dev, int index,
217                            u64 *size, unsigned int *flags);
218 extern u32 *of_get_pci_address(struct device_node *dev, int bar_no,
219                                u64 *size, unsigned int *flags);
220
221 /* Get an address as a resource. Note that if your address is
222  * a PIO address, the conversion will fail if the physical address
223  * can't be internally converted to an IO token with
224  * pci_address_to_pio(), that is because it's either called to early
225  * or it can't be matched to any host bridge IO space
226  */
227 extern int of_address_to_resource(struct device_node *dev, int index,
228                                   struct resource *r);
229 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
230                                       struct resource *r);
231
232 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
233  * size parameters.
234  */
235 void of_parse_dma_window(struct device_node *dn, unsigned char *dma_window_prop,
236                 unsigned long *busno, unsigned long *phys, unsigned long *size);
237
238 extern void kdump_move_device_tree(void);
239
240 /* CPU OF node matching */
241 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
242
243 #endif /* __KERNEL__ */
244 #endif /* _POWERPC_PROM_H */