include/asm-powerpc/prom.h

   1 #ifndef _POWERPC_PROM_H
   2 #define _POWERPC_PROM_H
   3 #ifdef __KERNEL__
   4
   5 /*
   6  * Definitions for talking to the Open Firmware PROM on
   7  * Power Macintosh computers.
   8  *
   9  * Copyright (C) 1996-2005 Paul Mackerras.
  10  *
  11  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version
  16  * 2 of the License, or (at your option) any later version.
  17  */
  18 #include <linux/config.h>
  19 #include <linux/types.h>
  20 #include <linux/proc_fs.h>
  21 #include <asm/atomic.h>
  22
  23 /* Definitions used by the flattened device tree */
  24 #define OF_DT_HEADER            0xd00dfeed      /* marker */
  25 #define OF_DT_BEGIN_NODE        0x1             /* Start of node, full name */
  26 #define OF_DT_END_NODE          0x2             /* End node */
  27 #define OF_DT_PROP              0x3             /* Property: name off, size,
  28                                                  * content */
  29 #define OF_DT_NOP               0x4             /* nop */
  30 #define OF_DT_END               0x9
  31
  32 #define OF_DT_VERSION           0x10
  33
  34 /*
  35  * This is what gets passed to the kernel by prom_init or kexec
  36  *
  37  * The dt struct contains the device tree structure, full pathes and
  38  * property contents. The dt strings contain a separate block with just
  39  * the strings for the property names, and is fully page aligned and
  40  * self contained in a page, so that it can be kept around by the kernel,
  41  * each property name appears only once in this page (cheap compression)
  42  *
  43  * the mem_rsvmap contains a map of reserved ranges of physical memory,
  44  * passing it here instead of in the device-tree itself greatly simplifies
  45  * the job of everybody. It's just a list of u64 pairs (base/size) that
  46  * ends when size is 0
  47  */
  48 struct boot_param_header
  49 {
  50         u32     magic;                  /* magic word OF_DT_HEADER */
  51         u32     totalsize;              /* total size of DT block */
  52         u32     off_dt_struct;          /* offset to structure */
  53         u32     off_dt_strings;         /* offset to strings */
  54         u32     off_mem_rsvmap;         /* offset to memory reserve map */
  55         u32     version;                /* format version */
  56         u32     last_comp_version;      /* last compatible version */
  57         /* version 2 fields below */
  58         u32     boot_cpuid_phys;        /* Physical CPU id we're booting on */
  59         /* version 3 fields below */
  60         u32     dt_strings_size;        /* size of the DT strings block */
  61 };
  62
  63
  64
  65 typedef u32 phandle;
  66 typedef u32 ihandle;
  67
  68 struct interrupt_info {
  69         int     line;
  70         int     sense;          /* +ve/-ve logic, edge or level, etc. */
  71 };
  72
  73 struct property {
  74         char    *name;
  75         int     length;
  76         unsigned char *value;
  77         struct property *next;
  78 };
  79
  80 struct device_node {
  81         char    *name;
  82         char    *type;
  83         phandle node;
  84         phandle linux_phandle;
  85         int     n_intrs;
  86         struct  interrupt_info *intrs;
  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 /* flag descriptions */
 105 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
 106
 107 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 108 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 109
 110 #define HAVE_ARCH_DEVTREE_FIXUPS
 111
 112 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
 113 {
 114         dn->pde = de;
 115 }
 116
 117
 118 /* OBSOLETE: Old style node lookup */
 119 extern struct device_node *find_devices(const char *name);
 120 extern struct device_node *find_type_devices(const char *type);
 121 extern struct device_node *find_path_device(const char *path);
 122 extern struct device_node *find_compatible_devices(const char *type,
 123                                                    const char *compat);
 124 extern struct device_node *find_all_nodes(void);
 125
 126 /* New style node lookup */
 127 extern struct device_node *of_find_node_by_name(struct device_node *from,
 128         const char *name);
 129 #define for_each_node_by_name(dn, name) \
 130         for (dn = of_find_node_by_name(NULL, name); dn; \
 131              dn = of_find_node_by_name(dn, name))
 132 extern struct device_node *of_find_node_by_type(struct device_node *from,
 133         const char *type);
 134 #define for_each_node_by_type(dn, type) \
 135         for (dn = of_find_node_by_type(NULL, type); dn; \
 136              dn = of_find_node_by_type(dn, type))
 137 extern struct device_node *of_find_compatible_node(struct device_node *from,
 138         const char *type, const char *compat);
 139 extern struct device_node *of_find_node_by_path(const char *path);
 140 extern struct device_node *of_find_node_by_phandle(phandle handle);
 141 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 142 extern struct device_node *of_get_parent(const struct device_node *node);
 143 extern struct device_node *of_get_next_child(const struct device_node *node,
 144                                              struct device_node *prev);
 145 extern struct property *of_find_property(struct device_node *np,
 146                                          const char *name,
 147                                          int *lenp);
 148 extern struct device_node *of_node_get(struct device_node *node);
 149 extern void of_node_put(struct device_node *node);
 150
 151 /* For scanning the flat device-tree at boot time */
 152 extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
 153                                             const char *uname, int depth,
 154                                             void *data),
 155                                   void *data);
 156 extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
 157                                         unsigned long *size);
 158 extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
 159 extern unsigned long __init of_get_flat_dt_root(void);
 160
 161 /* For updating the device tree at runtime */
 162 extern void of_attach_node(struct device_node *);
 163 extern void of_detach_node(const struct device_node *);
 164
 165 /* Other Prototypes */
 166 extern void finish_device_tree(void);
 167 extern void unflatten_device_tree(void);
 168 extern void early_init_devtree(void *);
 169 extern int device_is_compatible(struct device_node *device, const char *);
 170 extern int machine_is_compatible(const char *compat);
 171 extern unsigned char *get_property(struct device_node *node, const char *name,
 172                                    int *lenp);
 173 extern void print_properties(struct device_node *node);
 174 extern int prom_n_addr_cells(struct device_node* np);
 175 extern int prom_n_size_cells(struct device_node* np);
 176 extern int prom_n_intr_cells(struct device_node* np);
 177 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
 178 extern int prom_add_property(struct device_node* np, struct property* prop);
 179 extern int prom_remove_property(struct device_node *np, struct property *prop);
 180 extern int prom_update_property(struct device_node *np,
 181                                 struct property *newprop,
 182                                 struct property *oldprop);
 183
 184 #ifdef CONFIG_PPC32
 185 /*
 186  * PCI <-> OF matching functions
 187  * (XXX should these be here?)
 188  */
 189 struct pci_bus;
 190 struct pci_dev;
 191 extern int pci_device_from_OF_node(struct device_node *node,
 192                                    u8* bus, u8* devfn);
 193 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
 194 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
 195 extern void pci_create_OF_bus_map(void);
 196 #endif
 197
 198 extern struct resource *request_OF_resource(struct device_node* node,
 199                                 int index, const char* name_postfix);
 200 extern int release_OF_resource(struct device_node* node, int index);
 201
 202
 203 /*
 204  * OF address retreival & translation
 205  */
 206
 207
 208 /* Translate an OF address block into a CPU physical address
 209  */
 210 #define OF_BAD_ADDR     ((u64)-1)
 211 extern u64 of_translate_address(struct device_node *np, u32 *addr);
 212
 213 /* Extract an address from a device, returns the region size and
 214  * the address space flags too. The PCI version uses a BAR number
 215  * instead of an absolute index
 216  */
 217 extern u32 *of_get_address(struct device_node *dev, int index,
 218                            u64 *size, unsigned int *flags);
 219 extern u32 *of_get_pci_address(struct device_node *dev, int bar_no,
 220                                u64 *size, unsigned int *flags);
 221
 222 /* Get an address as a resource. Note that if your address is
 223  * a PIO address, the conversion will fail if the physical address
 224  * can't be internally converted to an IO token with
 225  * pci_address_to_pio(), that is because it's either called to early
 226  * or it can't be matched to any host bridge IO space
 227  */
 228 extern int of_address_to_resource(struct device_node *dev, int index,
 229                                   struct resource *r);
 230 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
 231                                       struct resource *r);
 232
 233 extern void kdump_move_device_tree(void);
 234
 235 #endif /* __KERNEL__ */
 236 #endif /* _POWERPC_PROM_H */