arch/powerpc/include/asm/prom.h

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