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 #ifndef _ASM_MICROBLAZE_PROM_H
  16 #define _ASM_MICROBLAZE_PROM_H
  17 #ifdef __KERNEL__
  18
  19 /* Definitions used by the flattened device tree */
  20 #define OF_DT_HEADER            0xd00dfeed /* marker */
  21 #define OF_DT_BEGIN_NODE        0x1 /* Start of node, full name */
  22 #define OF_DT_END_NODE          0x2 /* End node */
  23 #define OF_DT_PROP              0x3 /* Property: name off, size, content */
  24 #define OF_DT_NOP               0x4 /* nop */
  25 #define OF_DT_END               0x9
  26
  27 #define OF_DT_VERSION           0x10
  28
  29 #ifndef __ASSEMBLY__
  30
  31 #include <linux/types.h>
  32 #include <linux/proc_fs.h>
  33 #include <linux/platform_device.h>
  34 #include <asm/irq.h>
  35 #include <asm/atomic.h>
  36
  37 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
  38 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
  39
  40 #define of_compat_cmp(s1, s2, l)        strncasecmp((s1), (s2), (l))
  41 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
  42 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
  43
  44 /*
  45  * This is what gets passed to the kernel by prom_init or kexec
  46  *
  47  * The dt struct contains the device tree structure, full pathes and
  48  * property contents. The dt strings contain a separate block with just
  49  * the strings for the property names, and is fully page aligned and
  50  * self contained in a page, so that it can be kept around by the kernel,
  51  * each property name appears only once in this page (cheap compression)
  52  *
  53  * the mem_rsvmap contains a map of reserved ranges of physical memory,
  54  * passing it here instead of in the device-tree itself greatly simplifies
  55  * the job of everybody. It's just a list of u64 pairs (base/size) that
  56  * ends when size is 0
  57  */
  58 struct boot_param_header {
  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 typedef u32 phandle;
  75 typedef u32 ihandle;
  76
  77 struct property {
  78         char    *name;
  79         int     length;
  80         void    *value;
  81         struct property *next;
  82 };
  83
  84 struct device_node {
  85         const char *name;
  86         const char *type;
  87         phandle node;
  88         phandle linux_phandle;
  89         char    *full_name;
  90
  91         struct  property *properties;
  92         struct  property *deadprops; /* removed properties */
  93         struct  device_node *parent;
  94         struct  device_node *child;
  95         struct  device_node *sibling;
  96         struct  device_node *next; /* next device of same type */
  97         struct  device_node *allnext; /* next in list of all nodes */
  98         struct  proc_dir_entry *pde; /* this node's proc directory */
  99         struct  kref kref;
 100         unsigned long _flags;
 101         void    *data;
 102 };
 103
 104 extern struct device_node *of_chosen;
 105
 106 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
 107 {
 108         return test_bit(flag, &n->_flags);
 109 }
 110
 111 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
 112 {
 113         set_bit(flag, &n->_flags);
 114 }
 115
 116 #define HAVE_ARCH_DEVTREE_FIXUPS
 117
 118 static inline void set_node_proc_entry(struct device_node *dn,
 119                                         struct proc_dir_entry *de)
 120 {
 121         dn->pde = de;
 122 }
 123
 124 extern struct device_node *allnodes;    /* temporary while merging */
 125 extern rwlock_t devtree_lock;   /* temporary while merging */
 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
 139                 of_flat_dt_is_compatible(unsigned long node, const char *name);
 140 extern unsigned long __init of_get_flat_dt_root(void);
 141
 142 /* For updating the device tree at runtime */
 143 extern void of_attach_node(struct device_node *);
 144 extern void of_detach_node(struct device_node *);
 145
 146 /* Other Prototypes */
 147 extern void finish_device_tree(void);
 148 extern void unflatten_device_tree(void);
 149 extern int early_uartlite_console(void);
 150 extern void early_init_devtree(void *);
 151 extern int machine_is_compatible(const char *compat);
 152 extern void print_properties(struct device_node *node);
 153 extern int prom_n_intr_cells(struct device_node *np);
 154 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
 155 extern int prom_add_property(struct device_node *np, struct property *prop);
 156 extern int prom_remove_property(struct device_node *np, struct property *prop);
 157 extern int prom_update_property(struct device_node *np,
 158                                 struct property *newprop,
 159                                 struct property *oldprop);
 160
 161 extern struct resource *request_OF_resource(struct device_node *node,
 162                                 int index, const char *name_postfix);
 163 extern int release_OF_resource(struct device_node *node, int index);
 164
 165 /*
 166  * OF address retreival & translation
 167  */
 168
 169 /* Helper to read a big number; size is in cells (not bytes) */
 170 static inline u64 of_read_number(const u32 *cell, int size)
 171 {
 172         u64 r = 0;
 173         while (size--)
 174                 r = (r << 32) | *(cell++);
 175         return r;
 176 }
 177
 178 /* Like of_read_number, but we want an unsigned long result */
 179 #define of_read_ulong(cell, size)       of_read_number(cell, size)
 180
 181 /* Translate an OF address block into a CPU physical address
 182  */
 183 extern u64 of_translate_address(struct device_node *np, const u32 *addr);
 184
 185 /* Extract an address from a device, returns the region size and
 186  * the address space flags too. The PCI version uses a BAR number
 187  * instead of an absolute index
 188  */
 189 extern const u32 *of_get_address(struct device_node *dev, int index,
 190                         u64 *size, unsigned int *flags);
 191 extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
 192                         u64 *size, unsigned int *flags);
 193
 194 /* Get an address as a resource. Note that if your address is
 195  * a PIO address, the conversion will fail if the physical address
 196  * can't be internally converted to an IO token with
 197  * pci_address_to_pio(), that is because it's either called to early
 198  * or it can't be matched to any host bridge IO space
 199  */
 200 extern int of_address_to_resource(struct device_node *dev, int index,
 201                                 struct resource *r);
 202 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
 203                                 struct resource *r);
 204
 205 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
 206  * size parameters.
 207  */
 208 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
 209                 unsigned long *busno, unsigned long *phys, unsigned long *size);
 210
 211 extern void kdump_move_device_tree(void);
 212
 213 /* CPU OF node matching */
 214 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
 215
 216 /* Get the MAC address */
 217 extern const void *of_get_mac_address(struct device_node *np);
 218
 219 /*
 220  * OF interrupt mapping
 221  */
 222
 223 /* This structure is returned when an interrupt is mapped. The controller
 224  * field needs to be put() after use
 225  */
 226
 227 #define OF_MAX_IRQ_SPEC         4 /* We handle specifiers of at most 4 cells */
 228
 229 struct of_irq {
 230         struct device_node *controller; /* Interrupt controller node */
 231         u32 size; /* Specifier size */
 232         u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
 233 };
 234
 235 /**
 236  * of_irq_map_init - Initialize the irq remapper
 237  * @flags:      flags defining workarounds to enable
 238  *
 239  * Some machines have bugs in the device-tree which require certain workarounds
 240  * to be applied. Call this before any interrupt mapping attempts to enable
 241  * those workarounds.
 242  */
 243 #define OF_IMAP_OLDWORLD_MAC    0x00000001
 244 #define OF_IMAP_NO_PHANDLE      0x00000002
 245
 246 extern void of_irq_map_init(unsigned int flags);
 247
 248 /**
 249  * of_irq_map_raw - Low level interrupt tree parsing
 250  * @parent:     the device interrupt parent
 251  * @intspec:    interrupt specifier ("interrupts" property of the device)
 252  * @ointsize:   size of the passed in interrupt specifier
 253  * @addr:       address specifier (start of "reg" property of the device)
 254  * @out_irq:    structure of_irq filled by this function
 255  *
 256  * Returns 0 on success and a negative number on error
 257  *
 258  * This function is a low-level interrupt tree walking function. It
 259  * can be used to do a partial walk with synthetized reg and interrupts
 260  * properties, for example when resolving PCI interrupts when no device
 261  * node exist for the parent.
 262  *
 263  */
 264
 265 extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
 266                         u32 ointsize, const u32 *addr,
 267                         struct of_irq *out_irq);
 268
 269 /**
 270  * of_irq_map_one - Resolve an interrupt for a device
 271  * @device:     the device whose interrupt is to be resolved
 272  * @index:      index of the interrupt to resolve
 273  * @out_irq:    structure of_irq filled by this function
 274  *
 275  * This function resolves an interrupt, walking the tree, for a given
 276  * device-tree node. It's the high level pendant to of_irq_map_raw().
 277  * It also implements the workarounds for OldWolrd Macs.
 278  */
 279 extern int of_irq_map_one(struct device_node *device, int index,
 280                         struct of_irq *out_irq);
 281
 282 /**
 283  * of_irq_map_pci - Resolve the interrupt for a PCI device
 284  * @pdev:       the device whose interrupt is to be resolved
 285  * @out_irq:    structure of_irq filled by this function
 286  *
 287  * This function resolves the PCI interrupt for a given PCI device. If a
 288  * device-node exists for a given pci_dev, it will use normal OF tree
 289  * walking. If not, it will implement standard swizzling and walk up the
 290  * PCI tree until an device-node is found, at which point it will finish
 291  * resolving using the OF tree walking.
 292  */
 293 struct pci_dev;
 294 extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
 295
 296 extern int of_irq_to_resource(struct device_node *dev, int index,
 297                         struct resource *r);
 298
 299 /**
 300  * of_iomap - Maps the memory mapped IO for a given device_node
 301  * @device:     the device whose io range will be mapped
 302  * @index:      index of the io range
 303  *
 304  * Returns a pointer to the mapped memory
 305  */
 306 extern void __iomem *of_iomap(struct device_node *device, int index);
 307
 308 /*
 309  * NB: This is here while we transition from using asm/prom.h
 310  * to linux/of.h
 311  */
 312 #include <linux/of.h>
 313
 314 #endif /* __ASSEMBLY__ */
 315 #endif /* __KERNEL__ */
 316 #endif /* _ASM_MICROBLAZE_PROM_H */