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 #define HAVE_ARCH_DEVTREE_FIXUPS
  36
  37 /* For updating the device tree at runtime */
  38 extern void of_attach_node(struct device_node *);
  39 extern void of_detach_node(struct device_node *);
  40
  41 /* Other Prototypes */
  42 extern void finish_device_tree(void);
  43 extern void unflatten_device_tree(void);
  44 extern void early_init_devtree(void *);
  45 extern int machine_is_compatible(const char *compat);
  46 extern void print_properties(struct device_node *node);
  47 extern int prom_n_intr_cells(struct device_node* np);
  48 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
  49 extern int prom_add_property(struct device_node* np, struct property* prop);
  50 extern int prom_remove_property(struct device_node *np, struct property *prop);
  51 extern int prom_update_property(struct device_node *np,
  52                                 struct property *newprop,
  53                                 struct property *oldprop);
  54
  55 #ifdef CONFIG_PPC32
  56 /*
  57  * PCI <-> OF matching functions
  58  * (XXX should these be here?)
  59  */
  60 struct pci_bus;
  61 struct pci_dev;
  62 extern int pci_device_from_OF_node(struct device_node *node,
  63                                    u8* bus, u8* devfn);
  64 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
  65 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
  66 extern void pci_create_OF_bus_map(void);
  67 #endif
  68
  69 extern struct resource *request_OF_resource(struct device_node* node,
  70                                 int index, const char* name_postfix);
  71 extern int release_OF_resource(struct device_node* node, int index);
  72
  73
  74 /*
  75  * OF address retreival & translation
  76  */
  77
  78 /* Translate an OF address block into a CPU physical address
  79  */
  80 extern u64 of_translate_address(struct device_node *np, const u32 *addr);
  81
  82 /* Translate a DMA address from device space to CPU space */
  83 extern u64 of_translate_dma_address(struct device_node *dev,
  84                                     const u32 *in_addr);
  85
  86 /* Extract an address from a device, returns the region size and
  87  * the address space flags too. The PCI version uses a BAR number
  88  * instead of an absolute index
  89  */
  90 extern const u32 *of_get_address(struct device_node *dev, int index,
  91                            u64 *size, unsigned int *flags);
  92 #ifdef CONFIG_PCI
  93 extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
  94                                u64 *size, unsigned int *flags);
  95 #else
  96 static inline const u32 *of_get_pci_address(struct device_node *dev,
  97                 int bar_no, u64 *size, unsigned int *flags)
  98 {
  99         return NULL;
 100 }
 101 #endif /* CONFIG_PCI */
 102
 103 /* Get an address as a resource. Note that if your address is
 104  * a PIO address, the conversion will fail if the physical address
 105  * can't be internally converted to an IO token with
 106  * pci_address_to_pio(), that is because it's either called to early
 107  * or it can't be matched to any host bridge IO space
 108  */
 109 extern int of_address_to_resource(struct device_node *dev, int index,
 110                                   struct resource *r);
 111 #ifdef CONFIG_PCI
 112 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
 113                                       struct resource *r);
 114 #else
 115 static inline int of_pci_address_to_resource(struct device_node *dev, int bar,
 116                 struct resource *r)
 117 {
 118         return -ENOSYS;
 119 }
 120 #endif /* CONFIG_PCI */
 121
 122 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
 123  * size parameters.
 124  */
 125 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
 126                 unsigned long *busno, unsigned long *phys, unsigned long *size);
 127
 128 extern void kdump_move_device_tree(void);
 129
 130 /* CPU OF node matching */
 131 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
 132
 133 /* cache lookup */
 134 struct device_node *of_find_next_cache_node(struct device_node *np);
 135
 136 /* Get the MAC address */
 137 extern const void *of_get_mac_address(struct device_node *np);
 138
 139 /*
 140  * OF interrupt mapping
 141  */
 142
 143 /* This structure is returned when an interrupt is mapped. The controller
 144  * field needs to be put() after use
 145  */
 146
 147 #define OF_MAX_IRQ_SPEC          4 /* We handle specifiers of at most 4 cells */
 148
 149 struct of_irq {
 150         struct device_node *controller; /* Interrupt controller node */
 151         u32 size;                       /* Specifier size */
 152         u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
 153 };
 154
 155 /**
 156  * of_irq_map_init - Initialize the irq remapper
 157  * @flags:      flags defining workarounds to enable
 158  *
 159  * Some machines have bugs in the device-tree which require certain workarounds
 160  * to be applied. Call this before any interrupt mapping attempts to enable
 161  * those workarounds.
 162  */
 163 #define OF_IMAP_OLDWORLD_MAC    0x00000001
 164 #define OF_IMAP_NO_PHANDLE      0x00000002
 165
 166 extern void of_irq_map_init(unsigned int flags);
 167
 168 /**
 169  * of_irq_map_raw - Low level interrupt tree parsing
 170  * @parent:     the device interrupt parent
 171  * @intspec:    interrupt specifier ("interrupts" property of the device)
 172  * @ointsize:   size of the passed in interrupt specifier
 173  * @addr:       address specifier (start of "reg" property of the device)
 174  * @out_irq:    structure of_irq filled by this function
 175  *
 176  * Returns 0 on success and a negative number on error
 177  *
 178  * This function is a low-level interrupt tree walking function. It
 179  * can be used to do a partial walk with synthetized reg and interrupts
 180  * properties, for example when resolving PCI interrupts when no device
 181  * node exist for the parent.
 182  *
 183  */
 184
 185 extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
 186                           u32 ointsize, const u32 *addr,
 187                           struct of_irq *out_irq);
 188
 189
 190 /**
 191  * of_irq_map_one - Resolve an interrupt for a device
 192  * @device:     the device whose interrupt is to be resolved
 193  * @index:      index of the interrupt to resolve
 194  * @out_irq:    structure of_irq filled by this function
 195  *
 196  * This function resolves an interrupt, walking the tree, for a given
 197  * device-tree node. It's the high level pendant to of_irq_map_raw().
 198  * It also implements the workarounds for OldWolrd Macs.
 199  */
 200 extern int of_irq_map_one(struct device_node *device, int index,
 201                           struct of_irq *out_irq);
 202
 203 /**
 204  * of_irq_map_pci - Resolve the interrupt for a PCI device
 205  * @pdev:       the device whose interrupt is to be resolved
 206  * @out_irq:    structure of_irq filled by this function
 207  *
 208  * This function resolves the PCI interrupt for a given PCI device. If a
 209  * device-node exists for a given pci_dev, it will use normal OF tree
 210  * walking. If not, it will implement standard swizzling and walk up the
 211  * PCI tree until an device-node is found, at which point it will finish
 212  * resolving using the OF tree walking.
 213  */
 214 struct pci_dev;
 215 extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
 216
 217 extern int of_irq_to_resource(struct device_node *dev, int index,
 218                         struct resource *r);
 219
 220 /**
 221  * of_iomap - Maps the memory mapped IO for a given device_node
 222  * @device:     the device whose io range will be mapped
 223  * @index:      index of the io range
 224  *
 225  * Returns a pointer to the mapped memory
 226  */
 227 extern void __iomem *of_iomap(struct device_node *device, int index);
 228
 229 #endif /* __KERNEL__ */
 230 #endif /* _POWERPC_PROM_H */