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