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