[POWERPC] Only offer CONFIG_BRIQ_PANEL if CONFIG_PPC_CHRP is enabled
[linux-2.6.git] / 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 property {
68         char    *name;
69         int     length;
70         unsigned char *value;
71         struct property *next;
72 };
73
74 struct device_node {
75         const char *name;
76         const char *type;
77         phandle node;
78         phandle linux_phandle;
79         char    *full_name;
80
81         struct  property *properties;
82         struct  property *deadprops; /* removed properties */
83         struct  device_node *parent;
84         struct  device_node *child;
85         struct  device_node *sibling;
86         struct  device_node *next;      /* next device of same type */
87         struct  device_node *allnext;   /* next in list of all nodes */
88         struct  proc_dir_entry *pde;    /* this node's proc directory */
89         struct  kref kref;
90         unsigned long _flags;
91         void    *data;
92 };
93
94 extern struct device_node *of_chosen;
95
96 /* flag descriptions */
97 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
98
99 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
100 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
101
102 #define HAVE_ARCH_DEVTREE_FIXUPS
103
104 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
105 {
106         dn->pde = de;
107 }
108
109
110 /* OBSOLETE: Old style node lookup */
111 extern struct device_node *find_devices(const char *name);
112 extern struct device_node *find_type_devices(const char *type);
113 extern struct device_node *find_path_device(const char *path);
114 extern struct device_node *find_compatible_devices(const char *type,
115                                                    const char *compat);
116 extern struct device_node *find_all_nodes(void);
117
118 /* New style node lookup */
119 extern struct device_node *of_find_node_by_name(struct device_node *from,
120         const char *name);
121 #define for_each_node_by_name(dn, name) \
122         for (dn = of_find_node_by_name(NULL, name); dn; \
123              dn = of_find_node_by_name(dn, name))
124 extern struct device_node *of_find_node_by_type(struct device_node *from,
125         const char *type);
126 #define for_each_node_by_type(dn, type) \
127         for (dn = of_find_node_by_type(NULL, type); dn; \
128              dn = of_find_node_by_type(dn, type))
129 extern struct device_node *of_find_compatible_node(struct device_node *from,
130         const char *type, const char *compat);
131 extern struct device_node *of_find_node_by_path(const char *path);
132 extern struct device_node *of_find_node_by_phandle(phandle handle);
133 extern struct device_node *of_find_all_nodes(struct device_node *prev);
134 extern struct device_node *of_get_parent(const struct device_node *node);
135 extern struct device_node *of_get_next_child(const struct device_node *node,
136                                              struct device_node *prev);
137 extern struct property *of_find_property(struct device_node *np,
138                                          const char *name,
139                                          int *lenp);
140 extern struct device_node *of_node_get(struct device_node *node);
141 extern void of_node_put(struct device_node *node);
142
143 /* For scanning the flat device-tree at boot time */
144 extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
145                                             const char *uname, int depth,
146                                             void *data),
147                                   void *data);
148 extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
149                                         unsigned long *size);
150 extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
151 extern unsigned long __init of_get_flat_dt_root(void);
152
153 /* For updating the device tree at runtime */
154 extern void of_attach_node(struct device_node *);
155 extern void of_detach_node(const struct device_node *);
156
157 /* Other Prototypes */
158 extern void finish_device_tree(void);
159 extern void unflatten_device_tree(void);
160 extern void early_init_devtree(void *);
161 extern int device_is_compatible(struct device_node *device, const char *);
162 extern int machine_is_compatible(const char *compat);
163 extern const void *get_property(struct device_node *node, const char *name,
164                 int *lenp);
165 extern void print_properties(struct device_node *node);
166 extern int prom_n_addr_cells(struct device_node* np);
167 extern int prom_n_size_cells(struct device_node* np);
168 extern int prom_n_intr_cells(struct device_node* np);
169 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
170 extern int prom_add_property(struct device_node* np, struct property* prop);
171 extern int prom_remove_property(struct device_node *np, struct property *prop);
172 extern int prom_update_property(struct device_node *np,
173                                 struct property *newprop,
174                                 struct property *oldprop);
175
176 #ifdef CONFIG_PPC32
177 /*
178  * PCI <-> OF matching functions
179  * (XXX should these be here?)
180  */
181 struct pci_bus;
182 struct pci_dev;
183 extern int pci_device_from_OF_node(struct device_node *node,
184                                    u8* bus, u8* devfn);
185 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
186 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
187 extern void pci_create_OF_bus_map(void);
188 #endif
189
190 extern struct resource *request_OF_resource(struct device_node* node,
191                                 int index, const char* name_postfix);
192 extern int release_OF_resource(struct device_node* node, int index);
193
194
195 /*
196  * OF address retreival & translation
197  */
198
199
200 /* Helper to read a big number */
201 static inline u64 of_read_number(const u32 *cell, int size)
202 {
203         u64 r = 0;
204         while (size--)
205                 r = (r << 32) | *(cell++);
206         return r;
207 }
208
209 /* Translate an OF address block into a CPU physical address
210  */
211 #define OF_BAD_ADDR     ((u64)-1)
212 extern u64 of_translate_address(struct device_node *np, const u32 *addr);
213
214 /* Extract an address from a device, returns the region size and
215  * the address space flags too. The PCI version uses a BAR number
216  * instead of an absolute index
217  */
218 extern const u32 *of_get_address(struct device_node *dev, int index,
219                            u64 *size, unsigned int *flags);
220 extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
221                                u64 *size, unsigned int *flags);
222
223 /* Get an address as a resource. Note that if your address is
224  * a PIO address, the conversion will fail if the physical address
225  * can't be internally converted to an IO token with
226  * pci_address_to_pio(), that is because it's either called to early
227  * or it can't be matched to any host bridge IO space
228  */
229 extern int of_address_to_resource(struct device_node *dev, int index,
230                                   struct resource *r);
231 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
232                                       struct resource *r);
233
234 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
235  * size parameters.
236  */
237 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
238                 unsigned long *busno, unsigned long *phys, unsigned long *size);
239
240 extern void kdump_move_device_tree(void);
241
242 /* CPU OF node matching */
243 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
244
245
246 /*
247  * OF interrupt mapping
248  */
249
250 /* This structure is returned when an interrupt is mapped. The controller
251  * field needs to be put() after use
252  */
253
254 #define OF_MAX_IRQ_SPEC          4 /* We handle specifiers of at most 4 cells */
255
256 struct of_irq {
257         struct device_node *controller; /* Interrupt controller node */
258         u32 size;                       /* Specifier size */
259         u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
260 };
261
262 /**
263  * of_irq_map_init - Initialize the irq remapper
264  * @flags:      flags defining workarounds to enable
265  *
266  * Some machines have bugs in the device-tree which require certain workarounds
267  * to be applied. Call this before any interrupt mapping attempts to enable
268  * those workarounds.
269  */
270 #define OF_IMAP_OLDWORLD_MAC    0x00000001
271 #define OF_IMAP_NO_PHANDLE      0x00000002
272
273 extern void of_irq_map_init(unsigned int flags);
274
275 /**
276  * of_irq_map_raw - Low level interrupt tree parsing
277  * @parent:     the device interrupt parent
278  * @intspec:    interrupt specifier ("interrupts" property of the device)
279  * @addr:       address specifier (start of "reg" property of the device)
280  * @out_irq:    structure of_irq filled by this function
281  *
282  * Returns 0 on success and a negative number on error
283  *
284  * This function is a low-level interrupt tree walking function. It
285  * can be used to do a partial walk with synthetized reg and interrupts
286  * properties, for example when resolving PCI interrupts when no device
287  * node exist for the parent.
288  *
289  */
290
291 extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
292                           const u32 *addr, struct of_irq *out_irq);
293
294
295 /**
296  * of_irq_map_one - Resolve an interrupt for a device
297  * @device:     the device whose interrupt is to be resolved
298  * @index:      index of the interrupt to resolve
299  * @out_irq:    structure of_irq filled by this function
300  *
301  * This function resolves an interrupt, walking the tree, for a given
302  * device-tree node. It's the high level pendant to of_irq_map_raw().
303  * It also implements the workarounds for OldWolrd Macs.
304  */
305 extern int of_irq_map_one(struct device_node *device, int index,
306                           struct of_irq *out_irq);
307
308 /**
309  * of_irq_map_pci - Resolve the interrupt for a PCI device
310  * @pdev:       the device whose interrupt is to be resolved
311  * @out_irq:    structure of_irq filled by this function
312  *
313  * This function resolves the PCI interrupt for a given PCI device. If a
314  * device-node exists for a given pci_dev, it will use normal OF tree
315  * walking. If not, it will implement standard swizzling and walk up the
316  * PCI tree until an device-node is found, at which point it will finish
317  * resolving using the OF tree walking.
318  */
319 struct pci_dev;
320 extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
321
322
323 #endif /* __KERNEL__ */
324 #endif /* _POWERPC_PROM_H */