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/of_fdt.h>
  21 #include <linux/proc_fs.h>
  22 #include <linux/platform_device.h>
  23 #include <asm/irq.h>
  24 #include <asm/atomic.h>
  25
  26 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
  27 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
  28
  29 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
  30 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
  31 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
  32
  33 extern struct device_node *of_chosen;
  34
  35 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
  36 {
  37         return test_bit(flag, &n->_flags);
  38 }
  39
  40 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
  41 {
  42         set_bit(flag, &n->_flags);
  43 }
  44
  45
  46 #define HAVE_ARCH_DEVTREE_FIXUPS
  47
  48 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
  49 {
  50         dn->pde = de;
  51 }
  52
  53
  54 extern struct device_node *of_find_all_nodes(struct device_node *prev);
  55 extern struct device_node *of_node_get(struct device_node *node);
  56 extern void of_node_put(struct device_node *node);
  57
  58 /* For scanning the flat device-tree at boot time */
  59 extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
  60                                             const char *uname, int depth,
  61                                             void *data),
  62                                   void *data);
  63 extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
  64                                         unsigned long *size);
  65 extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
  66 extern unsigned long __init of_get_flat_dt_root(void);
  67
  68 /* For updating the device tree at runtime */
  69 extern void of_attach_node(struct device_node *);
  70 extern void of_detach_node(struct device_node *);
  71
  72 /* Other Prototypes */
  73 extern void finish_device_tree(void);
  74 extern void unflatten_device_tree(void);
  75 extern void early_init_devtree(void *);
  76 extern int machine_is_compatible(const char *compat);
  77 extern void print_properties(struct device_node *node);
  78 extern int prom_n_intr_cells(struct device_node* np);
  79 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
  80 extern int prom_add_property(struct device_node* np, struct property* prop);
  81 extern int prom_remove_property(struct device_node *np, struct property *prop);
  82 extern int prom_update_property(struct device_node *np,
  83                                 struct property *newprop,
  84                                 struct property *oldprop);
  85
  86 #ifdef CONFIG_PPC32
  87 /*
  88  * PCI <-> OF matching functions
  89  * (XXX should these be here?)
  90  */
  91 struct pci_bus;
  92 struct pci_dev;
  93 extern int pci_device_from_OF_node(struct device_node *node,
  94                                    u8* bus, u8* devfn);
  95 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
  96 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
  97 extern void pci_create_OF_bus_map(void);
  98 #endif
  99
 100 extern struct resource *request_OF_resource(struct device_node* node,
 101                                 int index, const char* name_postfix);
 102 extern int release_OF_resource(struct device_node* node, int index);
 103
 104
 105 /*
 106  * OF address retreival & translation
 107  */
 108
 109
 110 /* Helper to read a big number; size is in cells (not bytes) */
 111 static inline u64 of_read_number(const u32 *cell, int size)
 112 {
 113         u64 r = 0;
 114         while (size--)
 115                 r = (r << 32) | *(cell++);
 116         return r;
 117 }
 118
 119 /* Like of_read_number, but we want an unsigned long result */
 120 #ifdef CONFIG_PPC32
 121 static inline unsigned long of_read_ulong(const u32 *cell, int size)
 122 {
 123         return cell[size-1];
 124 }
 125 #else
 126 #define of_read_ulong(cell, size)       of_read_number(cell, size)
 127 #endif
 128
 129 /* Translate an OF address block into a CPU physical address
 130  */
 131 extern u64 of_translate_address(struct device_node *np, const u32 *addr);
 132
 133 /* Translate a DMA address from device space to CPU space */
 134 extern u64 of_translate_dma_address(struct device_node *dev,
 135                                     const u32 *in_addr);
 136
 137 /* Extract an address from a device, returns the region size and
 138  * the address space flags too. The PCI version uses a BAR number
 139  * instead of an absolute index
 140  */
 141 extern const u32 *of_get_address(struct device_node *dev, int index,
 142                            u64 *size, unsigned int *flags);
 143 #ifdef CONFIG_PCI
 144 extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
 145                                u64 *size, unsigned int *flags);
 146 #else
 147 static inline const u32 *of_get_pci_address(struct device_node *dev,
 148                 int bar_no, u64 *size, unsigned int *flags)
 149 {
 150         return NULL;
 151 }
 152 #endif /* CONFIG_PCI */
 153
 154 /* Get an address as a resource. Note that if your address is
 155  * a PIO address, the conversion will fail if the physical address
 156  * can't be internally converted to an IO token with
 157  * pci_address_to_pio(), that is because it's either called to early
 158  * or it can't be matched to any host bridge IO space
 159  */
 160 extern int of_address_to_resource(struct device_node *dev, int index,
 161                                   struct resource *r);
 162 #ifdef CONFIG_PCI
 163 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
 164                                       struct resource *r);
 165 #else
 166 static inline int of_pci_address_to_resource(struct device_node *dev, int bar,
 167                 struct resource *r)
 168 {
 169         return -ENOSYS;
 170 }
 171 #endif /* CONFIG_PCI */
 172
 173 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
 174  * size parameters.
 175  */
 176 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
 177                 unsigned long *busno, unsigned long *phys, unsigned long *size);
 178
 179 extern void kdump_move_device_tree(void);
 180
 181 /* CPU OF node matching */
 182 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
 183
 184 /* cache lookup */
 185 struct device_node *of_find_next_cache_node(struct device_node *np);
 186
 187 /* Get the MAC address */
 188 extern const void *of_get_mac_address(struct device_node *np);
 189
 190 /*
 191  * OF interrupt mapping
 192  */
 193
 194 /* This structure is returned when an interrupt is mapped. The controller
 195  * field needs to be put() after use
 196  */
 197
 198 #define OF_MAX_IRQ_SPEC          4 /* We handle specifiers of at most 4 cells */
 199
 200 struct of_irq {
 201         struct device_node *controller; /* Interrupt controller node */
 202         u32 size;                       /* Specifier size */
 203         u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
 204 };
 205
 206 /**
 207  * of_irq_map_init - Initialize the irq remapper
 208  * @flags:      flags defining workarounds to enable
 209  *
 210  * Some machines have bugs in the device-tree which require certain workarounds
 211  * to be applied. Call this before any interrupt mapping attempts to enable
 212  * those workarounds.
 213  */
 214 #define OF_IMAP_OLDWORLD_MAC    0x00000001
 215 #define OF_IMAP_NO_PHANDLE      0x00000002
 216
 217 extern void of_irq_map_init(unsigned int flags);
 218
 219 /**
 220  * of_irq_map_raw - Low level interrupt tree parsing
 221  * @parent:     the device interrupt parent
 222  * @intspec:    interrupt specifier ("interrupts" property of the device)
 223  * @ointsize:   size of the passed in interrupt specifier
 224  * @addr:       address specifier (start of "reg" property of the device)
 225  * @out_irq:    structure of_irq filled by this function
 226  *
 227  * Returns 0 on success and a negative number on error
 228  *
 229  * This function is a low-level interrupt tree walking function. It
 230  * can be used to do a partial walk with synthetized reg and interrupts
 231  * properties, for example when resolving PCI interrupts when no device
 232  * node exist for the parent.
 233  *
 234  */
 235
 236 extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
 237                           u32 ointsize, const u32 *addr,
 238                           struct of_irq *out_irq);
 239
 240
 241 /**
 242  * of_irq_map_one - Resolve an interrupt for a device
 243  * @device:     the device whose interrupt is to be resolved
 244  * @index:      index of the interrupt to resolve
 245  * @out_irq:    structure of_irq filled by this function
 246  *
 247  * This function resolves an interrupt, walking the tree, for a given
 248  * device-tree node. It's the high level pendant to of_irq_map_raw().
 249  * It also implements the workarounds for OldWolrd Macs.
 250  */
 251 extern int of_irq_map_one(struct device_node *device, int index,
 252                           struct of_irq *out_irq);
 253
 254 /**
 255  * of_irq_map_pci - Resolve the interrupt for a PCI device
 256  * @pdev:       the device whose interrupt is to be resolved
 257  * @out_irq:    structure of_irq filled by this function
 258  *
 259  * This function resolves the PCI interrupt for a given PCI device. If a
 260  * device-node exists for a given pci_dev, it will use normal OF tree
 261  * walking. If not, it will implement standard swizzling and walk up the
 262  * PCI tree until an device-node is found, at which point it will finish
 263  * resolving using the OF tree walking.
 264  */
 265 struct pci_dev;
 266 extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
 267
 268 extern int of_irq_to_resource(struct device_node *dev, int index,
 269                         struct resource *r);
 270
 271 /**
 272  * of_iomap - Maps the memory mapped IO for a given device_node
 273  * @device:     the device whose io range will be mapped
 274  * @index:      index of the io range
 275  *
 276  * Returns a pointer to the mapped memory
 277  */
 278 extern void __iomem *of_iomap(struct device_node *device, int index);
 279
 280 #endif /* __KERNEL__ */
 281 #endif /* _POWERPC_PROM_H */