[POWERPC] Rename prom_n_size_cells to of_n_size_cells
[deliverable/linux.git] / include / asm-powerpc / prom.h
CommitLineData
9b6b563c
PM
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>
a9b14973 20#include <linux/platform_device.h>
99ddef9b 21#include <asm/irq.h>
9b6b563c
PM
22#include <asm/atomic.h>
23
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,
29 * content */
30#define OF_DT_NOP 0x4 /* nop */
31#define OF_DT_END 0x9
32
33#define OF_DT_VERSION 0x10
34
35/*
36 * This is what gets passed to the kernel by prom_init or kexec
37 *
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)
43 *
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
47 * ends when size is 0
48 */
49struct boot_param_header
50{
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 */
0e0293c8
DG
62 /* version 17 fields below */
63 u32 dt_struct_size; /* size of the DT structure block */
9b6b563c
PM
64};
65
66
67
68typedef u32 phandle;
69typedef u32 ihandle;
70
9b6b563c
PM
71struct property {
72 char *name;
73 int length;
74 unsigned char *value;
75 struct property *next;
76};
77
78struct device_node {
a7f67bdf
JK
79 const char *name;
80 const char *type;
9b6b563c
PM
81 phandle node;
82 phandle linux_phandle;
9b6b563c
PM
83 char *full_name;
84
85 struct property *properties;
088186de 86 struct property *deadprops; /* removed properties */
9b6b563c
PM
87 struct device_node *parent;
88 struct device_node *child;
89 struct device_node *sibling;
90 struct device_node *next; /* next device of same type */
91 struct device_node *allnext; /* next in list of all nodes */
92 struct proc_dir_entry *pde; /* this node's proc directory */
93 struct kref kref;
94 unsigned long _flags;
95 void *data;
96};
97
98extern struct device_node *of_chosen;
99
100/* flag descriptions */
101#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
102
103#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
104#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
105
106#define HAVE_ARCH_DEVTREE_FIXUPS
107
108static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
109{
110 dn->pde = de;
111}
112
113
114/* OBSOLETE: Old style node lookup */
bf20a000
PM
115extern struct device_node *find_devices(const char *name);
116extern struct device_node *find_type_devices(const char *type);
117extern struct device_node *find_path_device(const char *path);
118extern struct device_node *find_compatible_devices(const char *type,
9b6b563c 119 const char *compat);
bf20a000 120extern struct device_node *find_all_nodes(void);
9b6b563c
PM
121
122/* New style node lookup */
123extern struct device_node *of_find_node_by_name(struct device_node *from,
124 const char *name);
e3385222
CH
125#define for_each_node_by_name(dn, name) \
126 for (dn = of_find_node_by_name(NULL, name); dn; \
127 dn = of_find_node_by_name(dn, name))
9b6b563c
PM
128extern struct device_node *of_find_node_by_type(struct device_node *from,
129 const char *type);
e3385222
CH
130#define for_each_node_by_type(dn, type) \
131 for (dn = of_find_node_by_type(NULL, type); dn; \
132 dn = of_find_node_by_type(dn, type))
9b6b563c
PM
133extern struct device_node *of_find_compatible_node(struct device_node *from,
134 const char *type, const char *compat);
135extern struct device_node *of_find_node_by_path(const char *path);
136extern struct device_node *of_find_node_by_phandle(phandle handle);
137extern struct device_node *of_find_all_nodes(struct device_node *prev);
138extern struct device_node *of_get_parent(const struct device_node *node);
139extern struct device_node *of_get_next_child(const struct device_node *node,
140 struct device_node *prev);
e2100efb 141extern struct property *of_find_property(const struct device_node *np,
ecaa8b0f
DB
142 const char *name,
143 int *lenp);
9b6b563c
PM
144extern struct device_node *of_node_get(struct device_node *node);
145extern void of_node_put(struct device_node *node);
146
3c726f8d 147/* For scanning the flat device-tree at boot time */
e8222502
BH
148extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
149 const char *uname, int depth,
150 void *data),
151 void *data);
152extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
153 unsigned long *size);
154extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
155extern unsigned long __init of_get_flat_dt_root(void);
3c726f8d 156
9b6b563c
PM
157/* For updating the device tree at runtime */
158extern void of_attach_node(struct device_node *);
159extern void of_detach_node(const struct device_node *);
160
161/* Other Prototypes */
162extern void finish_device_tree(void);
163extern void unflatten_device_tree(void);
164extern void early_init_devtree(void *);
7a92f74f 165extern int of_device_is_compatible(const struct device_node *device,
e2100efb 166 const char *);
7a92f74f 167#define device_is_compatible(d, c) of_device_is_compatible((d), (c))
9b6b563c 168extern int machine_is_compatible(const char *compat);
0e56efc7 169extern const void *of_get_property(const struct device_node *node,
e2100efb
BH
170 const char *name,
171 int *lenp);
0e56efc7 172#define get_property(a, b, c) of_get_property((a), (b), (c))
9b6b563c 173extern void print_properties(struct device_node *node);
a8bda5dd 174extern int of_n_addr_cells(struct device_node* np);
9213feea 175extern int of_n_size_cells(struct device_node* np);
9b6b563c
PM
176extern int prom_n_intr_cells(struct device_node* np);
177extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
183d0202 178extern int prom_add_property(struct device_node* np, struct property* prop);
088186de
DB
179extern int prom_remove_property(struct device_node *np, struct property *prop);
180extern int prom_update_property(struct device_node *np,
181 struct property *newprop,
182 struct property *oldprop);
9b6b563c 183
40ef8cbc 184#ifdef CONFIG_PPC32
9b6b563c
PM
185/*
186 * PCI <-> OF matching functions
187 * (XXX should these be here?)
188 */
189struct pci_bus;
190struct pci_dev;
191extern int pci_device_from_OF_node(struct device_node *node,
192 u8* bus, u8* devfn);
193extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
194extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
195extern void pci_create_OF_bus_map(void);
40ef8cbc
PM
196#endif
197
9b6b563c
PM
198extern struct resource *request_OF_resource(struct device_node* node,
199 int index, const char* name_postfix);
200extern int release_OF_resource(struct device_node* node, int index);
201
d2dd482b 202
d1405b86 203/*
d2dd482b
BH
204 * OF address retreival & translation
205 */
206
207
a4dc7ff0 208/* Helper to read a big number; size is in cells (not bytes) */
b5a1a9ab 209static inline u64 of_read_number(const u32 *cell, int size)
cc9fd71c
BH
210{
211 u64 r = 0;
212 while (size--)
213 r = (r << 32) | *(cell++);
214 return r;
215}
216
a4dc7ff0
PM
217/* Like of_read_number, but we want an unsigned long result */
218#ifdef CONFIG_PPC32
219static inline unsigned long of_read_ulong(const u32 *cell, int size)
220{
221 return cell[size-1];
222}
223#else
224#define of_read_ulong(cell, size) of_read_number(cell, size)
225#endif
226
d2dd482b 227/* Translate an OF address block into a CPU physical address
d1405b86
BH
228 */
229#define OF_BAD_ADDR ((u64)-1)
a7f67bdf 230extern u64 of_translate_address(struct device_node *np, const u32 *addr);
d1405b86 231
d2dd482b
BH
232/* Extract an address from a device, returns the region size and
233 * the address space flags too. The PCI version uses a BAR number
234 * instead of an absolute index
235 */
a7f67bdf 236extern const u32 *of_get_address(struct device_node *dev, int index,
d2dd482b 237 u64 *size, unsigned int *flags);
a7f67bdf 238extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
d2dd482b
BH
239 u64 *size, unsigned int *flags);
240
241/* Get an address as a resource. Note that if your address is
242 * a PIO address, the conversion will fail if the physical address
243 * can't be internally converted to an IO token with
244 * pci_address_to_pio(), that is because it's either called to early
245 * or it can't be matched to any host bridge IO space
246 */
247extern int of_address_to_resource(struct device_node *dev, int index,
248 struct resource *r);
249extern int of_pci_address_to_resource(struct device_node *dev, int bar,
250 struct resource *r);
d1405b86 251
d4ad66fa
JK
252/* Parse the ibm,dma-window property of an OF node into the busno, phys and
253 * size parameters.
254 */
a7f67bdf 255void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
d4ad66fa
JK
256 unsigned long *busno, unsigned long *phys, unsigned long *size);
257
b68239ee
ME
258extern void kdump_move_device_tree(void);
259
acf7d768
BH
260/* CPU OF node matching */
261struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
262
29cfe6f4
TT
263/* Get the MAC address */
264extern const void *of_get_mac_address(struct device_node *np);
cc9fd71c
BH
265
266/*
267 * OF interrupt mapping
268 */
269
270/* This structure is returned when an interrupt is mapped. The controller
271 * field needs to be put() after use
272 */
273
274#define OF_MAX_IRQ_SPEC 4 /* We handle specifiers of at most 4 cells */
275
276struct of_irq {
277 struct device_node *controller; /* Interrupt controller node */
278 u32 size; /* Specifier size */
279 u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
280};
281
40681b95 282/**
cc9fd71c
BH
283 * of_irq_map_init - Initialize the irq remapper
284 * @flags: flags defining workarounds to enable
285 *
286 * Some machines have bugs in the device-tree which require certain workarounds
287 * to be applied. Call this before any interrupt mapping attempts to enable
288 * those workarounds.
289 */
290#define OF_IMAP_OLDWORLD_MAC 0x00000001
291#define OF_IMAP_NO_PHANDLE 0x00000002
292
293extern void of_irq_map_init(unsigned int flags);
294
40681b95 295/**
cc9fd71c
BH
296 * of_irq_map_raw - Low level interrupt tree parsing
297 * @parent: the device interrupt parent
298 * @intspec: interrupt specifier ("interrupts" property of the device)
006b64de 299 * @ointsize: size of the passed in interrupt specifier
cc9fd71c
BH
300 * @addr: address specifier (start of "reg" property of the device)
301 * @out_irq: structure of_irq filled by this function
302 *
303 * Returns 0 on success and a negative number on error
304 *
305 * This function is a low-level interrupt tree walking function. It
306 * can be used to do a partial walk with synthetized reg and interrupts
307 * properties, for example when resolving PCI interrupts when no device
308 * node exist for the parent.
309 *
310 */
311
a7f67bdf 312extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
aa43f779 313 u32 ointsize, const u32 *addr,
cc9fd71c
BH
314 struct of_irq *out_irq);
315
316
40681b95 317/**
cc9fd71c
BH
318 * of_irq_map_one - Resolve an interrupt for a device
319 * @device: the device whose interrupt is to be resolved
320 * @index: index of the interrupt to resolve
321 * @out_irq: structure of_irq filled by this function
322 *
323 * This function resolves an interrupt, walking the tree, for a given
324 * device-tree node. It's the high level pendant to of_irq_map_raw().
325 * It also implements the workarounds for OldWolrd Macs.
326 */
327extern int of_irq_map_one(struct device_node *device, int index,
328 struct of_irq *out_irq);
329
40681b95 330/**
cc9fd71c
BH
331 * of_irq_map_pci - Resolve the interrupt for a PCI device
332 * @pdev: the device whose interrupt is to be resolved
333 * @out_irq: structure of_irq filled by this function
334 *
335 * This function resolves the PCI interrupt for a given PCI device. If a
336 * device-node exists for a given pci_dev, it will use normal OF tree
337 * walking. If not, it will implement standard swizzling and walk up the
338 * PCI tree until an device-node is found, at which point it will finish
339 * resolving using the OF tree walking.
340 */
341struct pci_dev;
342extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
343
66a91e9c 344static inline int of_irq_to_resource(struct device_node *dev, int index, struct resource *r)
a9b14973 345{
66a91e9c
AF
346 int irq = irq_of_parse_and_map(dev, index);
347
348 /* Only dereference the resource if both the
349 * resource and the irq are valid. */
350 if (r && irq != NO_IRQ) {
351 r->start = r->end = irq;
352 r->flags = IORESOURCE_IRQ;
353 }
354
355 return irq;
a9b14973
AF
356}
357
cc9fd71c 358
9b6b563c
PM
359#endif /* __KERNEL__ */
360#endif /* _POWERPC_PROM_H */
This page took 0.172335 seconds and 5 git commands to generate.