arch/microblaze/include/asm/prom.h

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