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 #include <asm/io.h>
  24
  25 /* Definitions used by the flattened device tree */
  26 #define OF_DT_HEADER            0xd00dfeed      /* marker */
  27 #define OF_DT_BEGIN_NODE        0x1             /* Start of node, full name */
  28 #define OF_DT_END_NODE          0x2             /* End node */
  29 #define OF_DT_PROP              0x3             /* Property: name off, size,
  30                                                  * content */
  31 #define OF_DT_NOP               0x4             /* nop */
  32 #define OF_DT_END               0x9
  33
  34 #define OF_DT_VERSION           0x10
  35
  36 /*
  37  * This is what gets passed to the kernel by prom_init or kexec
  38  *
  39  * The dt struct contains the device tree structure, full pathes and
  40  * property contents. The dt strings contain a separate block with just
  41  * the strings for the property names, and is fully page aligned and
  42  * self contained in a page, so that it can be kept around by the kernel,
  43  * each property name appears only once in this page (cheap compression)
  44  *
  45  * the mem_rsvmap contains a map of reserved ranges of physical memory,
  46  * passing it here instead of in the device-tree itself greatly simplifies
  47  * the job of everybody. It's just a list of u64 pairs (base/size) that
  48  * ends when size is 0
  49  */
  50 struct boot_param_header
  51 {
  52         u32     magic;                  /* magic word OF_DT_HEADER */
  53         u32     totalsize;              /* total size of DT block */
  54         u32     off_dt_struct;          /* offset to structure */
  55         u32     off_dt_strings;         /* offset to strings */
  56         u32     off_mem_rsvmap;         /* offset to memory reserve map */
  57         u32     version;                /* format version */
  58         u32     last_comp_version;      /* last compatible version */
  59         /* version 2 fields below */
  60         u32     boot_cpuid_phys;        /* Physical CPU id we're booting on */
  61         /* version 3 fields below */
  62         u32     dt_strings_size;        /* size of the DT strings block */
  63         /* version 17 fields below */
  64         u32     dt_struct_size;         /* size of the DT structure block */
  65 };
  66
  67
  68
  69 typedef u32 phandle;
  70 typedef u32 ihandle;
  71
  72 struct property {
  73         char    *name;
  74         int     length;
  75         void    *value;
  76         struct property *next;
  77 };
  78
  79 struct device_node {
  80         const char *name;
  81         const char *type;
  82         phandle node;
  83         phandle linux_phandle;
  84         char    *full_name;
  85
  86         struct  property *properties;
  87         struct  property *deadprops; /* removed properties */
  88         struct  device_node *parent;
  89         struct  device_node *child;
  90         struct  device_node *sibling;
  91         struct  device_node *next;      /* next device of same type */
  92         struct  device_node *allnext;   /* next in list of all nodes */
  93         struct  proc_dir_entry *pde;    /* this node's proc directory */
  94         struct  kref kref;
  95         unsigned long _flags;
  96         void    *data;
  97 };
  98
  99 extern struct device_node *of_chosen;
 100
 101 /* flag descriptions */
 102 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
 103
 104 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 105 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 106
 107 #define HAVE_ARCH_DEVTREE_FIXUPS
 108
 109 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
 110 {
 111         dn->pde = de;
 112 }
 113
 114
 115 /* OBSOLETE: Old style node lookup */
 116 extern struct device_node *find_devices(const char *name);
 117 extern struct device_node *find_type_devices(const char *type);
 118 extern struct device_node *find_path_device(const char *path);
 119 extern struct device_node *find_compatible_devices(const char *type,
 120                                                    const char *compat);
 121 extern struct device_node *find_all_nodes(void);
 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 extern struct device_node *of_find_node_by_path(const char *path);
 137 extern struct device_node *of_find_node_by_phandle(phandle handle);
 138 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 139 extern struct device_node *of_get_parent(const struct device_node *node);
 140 extern struct device_node *of_get_next_child(const struct device_node *node,
 141                                              struct device_node *prev);
 142 extern struct property *of_find_property(const struct device_node *np,
 143                                          const char *name,
 144                                          int *lenp);
 145 extern struct device_node *of_node_get(struct device_node *node);
 146 extern void of_node_put(struct device_node *node);
 147
 148 /* For scanning the flat device-tree at boot time */
 149 extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
 150                                             const char *uname, int depth,
 151                                             void *data),
 152                                   void *data);
 153 extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
 154                                         unsigned long *size);
 155 extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
 156 extern unsigned long __init of_get_flat_dt_root(void);
 157
 158 /* For updating the device tree at runtime */
 159 extern void of_attach_node(struct device_node *);
 160 extern void of_detach_node(const struct device_node *);
 161
 162 /* Other Prototypes */
 163 extern void finish_device_tree(void);
 164 extern void unflatten_device_tree(void);
 165 extern void early_init_devtree(void *);
 166 extern int of_device_is_compatible(const struct device_node *device,
 167                                 const char *);
 168 #define device_is_compatible(d, c)      of_device_is_compatible((d), (c))
 169 extern int machine_is_compatible(const char *compat);
 170 extern const void *of_get_property(const struct device_node *node,
 171                                 const char *name,
 172                                 int *lenp);
 173 #define get_property(a, b, c)   of_get_property((a), (b), (c))
 174 extern void print_properties(struct device_node *node);
 175 extern int of_n_addr_cells(struct device_node* np);
 176 extern int of_n_size_cells(struct device_node* np);
 177 extern int prom_n_intr_cells(struct device_node* np);
 178 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
 179 extern int prom_add_property(struct device_node* np, struct property* prop);
 180 extern int prom_remove_property(struct device_node *np, struct property *prop);
 181 extern int prom_update_property(struct device_node *np,
 182                                 struct property *newprop,
 183                                 struct property *oldprop);
 184
 185 #ifdef CONFIG_PPC32
 186 /*
 187  * PCI <-> OF matching functions
 188  * (XXX should these be here?)
 189  */
 190 struct pci_bus;
 191 struct pci_dev;
 192 extern int pci_device_from_OF_node(struct device_node *node,
 193                                    u8* bus, u8* devfn);
 194 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
 195 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
 196 extern void pci_create_OF_bus_map(void);
 197 #endif
 198
 199 extern struct resource *request_OF_resource(struct device_node* node,
 200                                 int index, const char* name_postfix);
 201 extern int release_OF_resource(struct device_node* node, int index);
 202
 203
 204 /*
 205  * OF address retreival & translation
 206  */
 207
 208
 209 /* Helper to read a big number; size is in cells (not bytes) */
 210 static inline u64 of_read_number(const u32 *cell, int size)
 211 {
 212         u64 r = 0;
 213         while (size--)
 214                 r = (r << 32) | *(cell++);
 215         return r;
 216 }
 217
 218 /* Like of_read_number, but we want an unsigned long result */
 219 #ifdef CONFIG_PPC32
 220 static inline unsigned long of_read_ulong(const u32 *cell, int size)
 221 {
 222         return cell[size-1];
 223 }
 224 #else
 225 #define of_read_ulong(cell, size)       of_read_number(cell, size)
 226 #endif
 227
 228 /* Translate an OF address block into a CPU physical address
 229  */
 230 #define OF_BAD_ADDR     ((u64)-1)
 231 extern u64 of_translate_address(struct device_node *np, const u32 *addr);
 232
 233 /* Extract an address from a device, returns the region size and
 234  * the address space flags too. The PCI version uses a BAR number
 235  * instead of an absolute index
 236  */
 237 extern const u32 *of_get_address(struct device_node *dev, int index,
 238                            u64 *size, unsigned int *flags);
 239 extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
 240                                u64 *size, unsigned int *flags);
 241
 242 /* Get an address as a resource. Note that if your address is
 243  * a PIO address, the conversion will fail if the physical address
 244  * can't be internally converted to an IO token with
 245  * pci_address_to_pio(), that is because it's either called to early
 246  * or it can't be matched to any host bridge IO space
 247  */
 248 extern int of_address_to_resource(struct device_node *dev, int index,
 249                                   struct resource *r);
 250 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
 251                                       struct resource *r);
 252
 253 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
 254  * size parameters.
 255  */
 256 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
 257                 unsigned long *busno, unsigned long *phys, unsigned long *size);
 258
 259 extern void kdump_move_device_tree(void);
 260
 261 /* CPU OF node matching */
 262 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
 263
 264 /* Get the MAC address */
 265 extern const void *of_get_mac_address(struct device_node *np);
 266
 267 /*
 268  * OF interrupt mapping
 269  */
 270
 271 /* This structure is returned when an interrupt is mapped. The controller
 272  * field needs to be put() after use
 273  */
 274
 275 #define OF_MAX_IRQ_SPEC          4 /* We handle specifiers of at most 4 cells */
 276
 277 struct of_irq {
 278         struct device_node *controller; /* Interrupt controller node */
 279         u32 size;                       /* Specifier size */
 280         u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
 281 };
 282
 283 /**
 284  * of_irq_map_init - Initialize the irq remapper
 285  * @flags:      flags defining workarounds to enable
 286  *
 287  * Some machines have bugs in the device-tree which require certain workarounds
 288  * to be applied. Call this before any interrupt mapping attempts to enable
 289  * those workarounds.
 290  */
 291 #define OF_IMAP_OLDWORLD_MAC    0x00000001
 292 #define OF_IMAP_NO_PHANDLE      0x00000002
 293
 294 extern void of_irq_map_init(unsigned int flags);
 295
 296 /**
 297  * of_irq_map_raw - Low level interrupt tree parsing
 298  * @parent:     the device interrupt parent
 299  * @intspec:    interrupt specifier ("interrupts" property of the device)
 300  * @ointsize:   size of the passed in interrupt specifier
 301  * @addr:       address specifier (start of "reg" property of the device)
 302  * @out_irq:    structure of_irq filled by this function
 303  *
 304  * Returns 0 on success and a negative number on error
 305  *
 306  * This function is a low-level interrupt tree walking function. It
 307  * can be used to do a partial walk with synthetized reg and interrupts
 308  * properties, for example when resolving PCI interrupts when no device
 309  * node exist for the parent.
 310  *
 311  */
 312
 313 extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
 314                           u32 ointsize, const u32 *addr,
 315                           struct of_irq *out_irq);
 316
 317
 318 /**
 319  * of_irq_map_one - Resolve an interrupt for a device
 320  * @device:     the device whose interrupt is to be resolved
 321  * @index:      index of the interrupt to resolve
 322  * @out_irq:    structure of_irq filled by this function
 323  *
 324  * This function resolves an interrupt, walking the tree, for a given
 325  * device-tree node. It's the high level pendant to of_irq_map_raw().
 326  * It also implements the workarounds for OldWolrd Macs.
 327  */
 328 extern int of_irq_map_one(struct device_node *device, int index,
 329                           struct of_irq *out_irq);
 330
 331 /**
 332  * of_irq_map_pci - Resolve the interrupt for a PCI device
 333  * @pdev:       the device whose interrupt is to be resolved
 334  * @out_irq:    structure of_irq filled by this function
 335  *
 336  * This function resolves the PCI interrupt for a given PCI device. If a
 337  * device-node exists for a given pci_dev, it will use normal OF tree
 338  * walking. If not, it will implement standard swizzling and walk up the
 339  * PCI tree until an device-node is found, at which point it will finish
 340  * resolving using the OF tree walking.
 341  */
 342 struct pci_dev;
 343 extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
 344
 345 static inline int of_irq_to_resource(struct device_node *dev, int index, struct resource *r)
 346 {
 347         int irq = irq_of_parse_and_map(dev, index);
 348
 349         /* Only dereference the resource if both the
 350          * resource and the irq are valid. */
 351         if (r && irq != NO_IRQ) {
 352                 r->start = r->end = irq;
 353                 r->flags = IORESOURCE_IRQ;
 354         }
 355
 356         return irq;
 357 }
 358
 359 static inline void __iomem *of_iomap(struct device_node *np, int index)
 360 {
 361         struct resource res;
 362
 363         if (of_address_to_resource(np, index, &res))
 364                 return NULL;
 365
 366         return ioremap(res.start, 1 + res.end - res.start);
 367 }
 368
 369
 370 #endif /* __KERNEL__ */
 371 #endif /* _POWERPC_PROM_H */