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 address_range {
  69         unsigned long space;
  70         unsigned long address;
  71         unsigned long size;
  72 };
  73
  74 struct interrupt_info {
  75         int     line;
  76         int     sense;          /* +ve/-ve logic, edge or level, etc. */
  77 };
  78
  79 struct pci_address {
  80         u32 a_hi;
  81         u32 a_mid;
  82         u32 a_lo;
  83 };
  84
  85 struct isa_address {
  86         u32 a_hi;
  87         u32 a_lo;
  88 };
  89
  90 struct isa_range {
  91         struct isa_address isa_addr;
  92         struct pci_address pci_addr;
  93         unsigned int size;
  94 };
  95
  96 struct reg_property {
  97         unsigned long address;
  98         unsigned long size;
  99 };
 100
 101 struct reg_property32 {
 102         unsigned int address;
 103         unsigned int size;
 104 };
 105
 106 struct reg_property64 {
 107         u64 address;
 108         u64 size;
 109 };
 110
 111 struct property {
 112         char    *name;
 113         int     length;
 114         unsigned char *value;
 115         struct property *next;
 116 };
 117
 118 struct device_node {
 119         char    *name;
 120         char    *type;
 121         phandle node;
 122         phandle linux_phandle;
 123         int     n_addrs;
 124         struct  address_range *addrs;
 125         int     n_intrs;
 126         struct  interrupt_info *intrs;
 127         char    *full_name;
 128
 129         struct  property *properties;
 130         struct  device_node *parent;
 131         struct  device_node *child;
 132         struct  device_node *sibling;
 133         struct  device_node *next;      /* next device of same type */
 134         struct  device_node *allnext;   /* next in list of all nodes */
 135         struct  proc_dir_entry *pde;    /* this node's proc directory */
 136         struct  kref kref;
 137         unsigned long _flags;
 138         void    *data;
 139 };
 140
 141 extern struct device_node *of_chosen;
 142
 143 /* flag descriptions */
 144 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
 145
 146 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 147 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 148
 149 #define HAVE_ARCH_DEVTREE_FIXUPS
 150
 151 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
 152 {
 153         dn->pde = de;
 154 }
 155
 156
 157 /* OBSOLETE: Old style node lookup */
 158 extern struct device_node *find_devices(const char *name);
 159 extern struct device_node *find_type_devices(const char *type);
 160 extern struct device_node *find_path_device(const char *path);
 161 extern struct device_node *find_compatible_devices(const char *type,
 162                                                    const char *compat);
 163 extern struct device_node *find_all_nodes(void);
 164
 165 /* New style node lookup */
 166 extern struct device_node *of_find_node_by_name(struct device_node *from,
 167         const char *name);
 168 extern struct device_node *of_find_node_by_type(struct device_node *from,
 169         const char *type);
 170 extern struct device_node *of_find_compatible_node(struct device_node *from,
 171         const char *type, const char *compat);
 172 extern struct device_node *of_find_node_by_path(const char *path);
 173 extern struct device_node *of_find_node_by_phandle(phandle handle);
 174 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 175 extern struct device_node *of_get_parent(const struct device_node *node);
 176 extern struct device_node *of_get_next_child(const struct device_node *node,
 177                                              struct device_node *prev);
 178 extern struct device_node *of_node_get(struct device_node *node);
 179 extern void of_node_put(struct device_node *node);
 180
 181 /* For scanning the flat device-tree at boot time */
 182 int __init of_scan_flat_dt(int (*it)(unsigned long node,
 183                                      const char *uname, int depth,
 184                                      void *data),
 185                            void *data);
 186 void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
 187                                  unsigned long *size);
 188
 189 /* For updating the device tree at runtime */
 190 extern void of_attach_node(struct device_node *);
 191 extern void of_detach_node(const struct device_node *);
 192
 193 /* Other Prototypes */
 194 extern void finish_device_tree(void);
 195 extern void unflatten_device_tree(void);
 196 extern void early_init_devtree(void *);
 197 extern int device_is_compatible(struct device_node *device, const char *);
 198 extern int machine_is_compatible(const char *compat);
 199 extern unsigned char *get_property(struct device_node *node, const char *name,
 200                                    int *lenp);
 201 extern void print_properties(struct device_node *node);
 202 extern int prom_n_addr_cells(struct device_node* np);
 203 extern int prom_n_size_cells(struct device_node* np);
 204 extern int prom_n_intr_cells(struct device_node* np);
 205 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
 206 extern int prom_add_property(struct device_node* np, struct property* prop);
 207
 208 #ifdef CONFIG_PPC32
 209 /*
 210  * PCI <-> OF matching functions
 211  * (XXX should these be here?)
 212  */
 213 struct pci_bus;
 214 struct pci_dev;
 215 extern int pci_device_from_OF_node(struct device_node *node,
 216                                    u8* bus, u8* devfn);
 217 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
 218 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
 219 extern void pci_create_OF_bus_map(void);
 220 #endif
 221
 222 extern struct resource *request_OF_resource(struct device_node* node,
 223                                 int index, const char* name_postfix);
 224 extern int release_OF_resource(struct device_node* node, int index);
 225
 226 #endif /* __KERNEL__ */
 227 #endif /* _POWERPC_PROM_H */