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