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