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 <linux/platform_device.h> 21#include <asm/irq.h> 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 */ 62 /* version 17 fields below */ 63 u32 dt_struct_size; /* size of the DT structure block */ 64}; 65 66 67 68typedef u32 phandle; 69typedef u32 ihandle; 70 71struct property { 72 char *name; 73 int length; 74 void *value; 75 struct property *next; 76}; 77 78struct device_node { 79 const char *name; 80 const char *type; 81 phandle node; 82 phandle linux_phandle; 83 char *full_name; 84 85 struct property *properties; 86 struct property *deadprops; /* removed properties */ 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/* New style node lookup */ 115extern struct device_node *of_find_node_by_name(struct device_node *from, 116 const char *name); 117#define for_each_node_by_name(dn, name) \ 118 for (dn = of_find_node_by_name(NULL, name); dn; \ 119 dn = of_find_node_by_name(dn, name)) 120extern struct device_node *of_find_node_by_type(struct device_node *from, 121 const char *type); 122#define for_each_node_by_type(dn, type) \ 123 for (dn = of_find_node_by_type(NULL, type); dn; \ 124 dn = of_find_node_by_type(dn, type)) 125extern struct device_node *of_find_compatible_node(struct device_node *from, 126 const char *type, const char *compat); 127extern struct device_node *of_find_node_by_path(const char *path); 128extern struct device_node *of_find_node_by_phandle(phandle handle); 129extern struct device_node *of_find_all_nodes(struct device_node *prev); 130extern struct device_node *of_get_parent(const struct device_node *node); 131extern struct device_node *of_get_next_child(const struct device_node *node, 132 struct device_node *prev); 133extern struct property *of_find_property(const struct device_node *np, 134 const char *name, 135 int *lenp); 136extern struct device_node *of_node_get(struct device_node *node); 137extern void of_node_put(struct device_node *node); 138 139/* For scanning the flat device-tree at boot time */ 140extern int __init of_scan_flat_dt(int (*it)(unsigned long node, 141 const char *uname, int depth, 142 void *data), 143 void *data); 144extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name, 145 unsigned long *size); 146extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name); 147extern unsigned long __init of_get_flat_dt_root(void); 148 149/* For updating the device tree at runtime */ 150extern void of_attach_node(struct device_node *); 151extern void of_detach_node(const struct device_node *); 152 153/* Other Prototypes */ 154extern void finish_device_tree(void); 155extern void unflatten_device_tree(void); 156extern void early_init_devtree(void *); 157extern int of_device_is_compatible(const struct device_node *device, 158 const char *); 159#define device_is_compatible(d, c) of_device_is_compatible((d), (c)) 160extern int machine_is_compatible(const char *compat); 161extern const void *of_get_property(const struct device_node *node, 162 const char *name, 163 int *lenp); 164#define get_property(a, b, c) of_get_property((a), (b), (c)) 165extern void print_properties(struct device_node *node); 166extern int of_n_addr_cells(struct device_node* np); 167extern int of_n_size_cells(struct device_node* np); 168extern int prom_n_intr_cells(struct device_node* np); 169extern void prom_get_irq_senses(unsigned char *senses, int off, int max); 170extern int prom_add_property(struct device_node* np, struct property* prop); 171extern int prom_remove_property(struct device_node *np, struct property *prop); 172extern int prom_update_property(struct device_node *np, 173 struct property *newprop, 174 struct property *oldprop); 175 176#ifdef CONFIG_PPC32 177struct pci_bus; 178struct pci_dev; 179extern int pci_device_from_OF_node(struct device_node *node, 180 u8* bus, u8* devfn); 181extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int); 182extern struct device_node* pci_device_to_OF_node(struct pci_dev *); 183extern void pci_create_OF_bus_map(void); 184#endif 185 186extern struct resource *request_OF_resource(struct device_node* node, 187 int index, const char* name_postfix); 188extern int release_OF_resource(struct device_node* node, int index); 189 190 191/* 192 * OF address retreival & translation 193 */ 194 195 196/* Helper to read a big number; size is in cells (not bytes) */ 197static inline u64 of_read_number(const u32 *cell, int size) 198{ 199 u64 r = 0; 200 while (size--) 201 r = (r << 32) | *(cell++); 202 return r; 203} 204 205/* Like of_read_number, but we want an unsigned long result */ 206#ifdef CONFIG_PPC32 207static inline unsigned long of_read_ulong(const u32 *cell, int size) 208{ 209 return cell[size-1]; 210} 211#else 212#define of_read_ulong(cell, size) of_read_number(cell, size) 213#endif 214 215/* Translate an OF address block into a CPU physical address 216 */ 217#define OF_BAD_ADDR ((u64)-1) 218extern u64 of_translate_address(struct device_node *np, const u32 *addr); 219 220/* Extract an address from a device, returns the region size and 221 * the address space flags too. The PCI version uses a BAR number 222 * instead of an absolute index 223 */ 224extern const u32 *of_get_address(struct device_node *dev, int index, 225 u64 *size, unsigned int *flags); 226extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no, 227 u64 *size, unsigned int *flags); 228 229/* Get an address as a resource. Note that if your address is 230 * a PIO address, the conversion will fail if the physical address 231 * can't be internally converted to an IO token with 232 * pci_address_to_pio(), that is because it's either called to early 233 * or it can't be matched to any host bridge IO space 234 */ 235extern int of_address_to_resource(struct device_node *dev, int index, 236 struct resource *r); 237extern int of_pci_address_to_resource(struct device_node *dev, int bar, 238 struct resource *r); 239 240/* Parse the ibm,dma-window property of an OF node into the busno, phys and 241 * size parameters. 242 */ 243void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop, 244 unsigned long *busno, unsigned long *phys, unsigned long *size); 245 246extern void kdump_move_device_tree(void); 247 248/* CPU OF node matching */ 249struct device_node *of_get_cpu_node(int cpu, unsigned int *thread); 250 251/* Get the MAC address */ 252extern const void *of_get_mac_address(struct device_node *np); 253 254/* 255 * OF interrupt mapping 256 */ 257 258/* This structure is returned when an interrupt is mapped. The controller 259 * field needs to be put() after use 260 */ 261 262#define OF_MAX_IRQ_SPEC 4 /* We handle specifiers of at most 4 cells */ 263 264struct of_irq { 265 struct device_node *controller; /* Interrupt controller node */ 266 u32 size; /* Specifier size */ 267 u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */ 268}; 269 270/** 271 * of_irq_map_init - Initialize the irq remapper 272 * @flags: flags defining workarounds to enable 273 * 274 * Some machines have bugs in the device-tree which require certain workarounds 275 * to be applied. Call this before any interrupt mapping attempts to enable 276 * those workarounds. 277 */ 278#define OF_IMAP_OLDWORLD_MAC 0x00000001 279#define OF_IMAP_NO_PHANDLE 0x00000002 280 281extern void of_irq_map_init(unsigned int flags); 282 283/** 284 * of_irq_map_raw - Low level interrupt tree parsing 285 * @parent: the device interrupt parent 286 * @intspec: interrupt specifier ("interrupts" property of the device) 287 * @ointsize: size of the passed in interrupt specifier 288 * @addr: address specifier (start of "reg" property of the device) 289 * @out_irq: structure of_irq filled by this function 290 * 291 * Returns 0 on success and a negative number on error 292 * 293 * This function is a low-level interrupt tree walking function. It 294 * can be used to do a partial walk with synthetized reg and interrupts 295 * properties, for example when resolving PCI interrupts when no device 296 * node exist for the parent. 297 * 298 */ 299 300extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec, 301 u32 ointsize, const u32 *addr, 302 struct of_irq *out_irq); 303 304 305/** 306 * of_irq_map_one - Resolve an interrupt for a device 307 * @device: the device whose interrupt is to be resolved 308 * @index: index of the interrupt to resolve 309 * @out_irq: structure of_irq filled by this function 310 * 311 * This function resolves an interrupt, walking the tree, for a given 312 * device-tree node. It's the high level pendant to of_irq_map_raw(). 313 * It also implements the workarounds for OldWolrd Macs. 314 */ 315extern int of_irq_map_one(struct device_node *device, int index, 316 struct of_irq *out_irq); 317 318/** 319 * of_irq_map_pci - Resolve the interrupt for a PCI device 320 * @pdev: the device whose interrupt is to be resolved 321 * @out_irq: structure of_irq filled by this function 322 * 323 * This function resolves the PCI interrupt for a given PCI device. If a 324 * device-node exists for a given pci_dev, it will use normal OF tree 325 * walking. If not, it will implement standard swizzling and walk up the 326 * PCI tree until an device-node is found, at which point it will finish 327 * resolving using the OF tree walking. 328 */ 329struct pci_dev; 330extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq); 331 332extern int of_irq_to_resource(struct device_node *dev, int index, 333 struct resource *r); 334 335/** 336 * of_iomap - Maps the memory mapped IO for a given device_node 337 * @device: the device whose io range will be mapped 338 * @index: index of the io range 339 * 340 * Returns a pointer to the mapped memory 341 */ 342extern void __iomem *of_iomap(struct device_node *device, int index); 343 344#endif /* __KERNEL__ */ 345#endif /* _POWERPC_PROM_H */ 346