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/types.h>
  19 #include <linux/proc_fs.h>
  20 #include <asm/atomic.h>
  21
  22 /* Definitions used by the flattened device tree */
  23 #define OF_DT_HEADER            0xd00dfeed      /* marker */
  24 #define OF_DT_BEGIN_NODE        0x1             /* Start of node, full name */
  25 #define OF_DT_END_NODE          0x2             /* End node */
  26 #define OF_DT_PROP              0x3             /* Property: name off, size,
  27                                                  * content */
  28 #define OF_DT_NOP               0x4             /* nop */
  29 #define OF_DT_END               0x9
  30
  31 #define OF_DT_VERSION           0x10
  32
  33 /*
  34  * This is what gets passed to the kernel by prom_init or kexec
  35  *
  36  * The dt struct contains the device tree structure, full pathes and
  37  * property contents. The dt strings contain a separate block with just
  38  * the strings for the property names, and is fully page aligned and
  39  * self contained in a page, so that it can be kept around by the kernel,
  40  * each property name appears only once in this page (cheap compression)
  41  *
  42  * the mem_rsvmap contains a map of reserved ranges of physical memory,
  43  * passing it here instead of in the device-tree itself greatly simplifies
  44  * the job of everybody. It's just a list of u64 pairs (base/size) that
  45  * ends when size is 0
  46  */
  47 struct boot_param_header
  48 {
  49         u32     magic;                  /* magic word OF_DT_HEADER */
  50         u32     totalsize;              /* total size of DT block */
  51         u32     off_dt_struct;          /* offset to structure */
  52         u32     off_dt_strings;         /* offset to strings */
  53         u32     off_mem_rsvmap;         /* offset to memory reserve map */
  54         u32     version;                /* format version */
  55         u32     last_comp_version;      /* last compatible version */
  56         /* version 2 fields below */
  57         u32     boot_cpuid_phys;        /* Physical CPU id we're booting on */
  58         /* version 3 fields below */
  59         u32     dt_strings_size;        /* size of the DT strings block */
  60 };
  61
  62
  63
  64 typedef u32 phandle;
  65 typedef u32 ihandle;
  66
  67 struct address_range {
  68         unsigned long space;
  69         unsigned long address;
  70         unsigned long size;
  71 };
  72
  73 struct interrupt_info {
  74         int     line;
  75         int     sense;          /* +ve/-ve logic, edge or level, etc. */
  76 };
  77
  78 struct pci_address {
  79         u32 a_hi;
  80         u32 a_mid;
  81         u32 a_lo;
  82 };
  83
  84 struct isa_address {
  85         u32 a_hi;
  86         u32 a_lo;
  87 };
  88
  89 struct isa_range {
  90         struct isa_address isa_addr;
  91         struct pci_address pci_addr;
  92         unsigned int size;
  93 };
  94
  95 struct reg_property {
  96         unsigned long address;
  97         unsigned long size;
  98 };
  99
 100 struct reg_property32 {
 101         unsigned int address;
 102         unsigned int size;
 103 };
 104
 105 struct reg_property64 {
 106         unsigned long address;
 107         unsigned long size;
 108 };
 109
 110 struct property {
 111         char    *name;
 112         int     length;
 113         unsigned char *value;
 114         struct property *next;
 115 };
 116
 117 struct device_node {
 118         char    *name;
 119         char    *type;
 120         phandle node;
 121         phandle linux_phandle;
 122         int     n_addrs;
 123         struct  address_range *addrs;
 124         int     n_intrs;
 125         struct  interrupt_info *intrs;
 126         char    *full_name;
 127
 128         struct  property *properties;
 129         struct  device_node *parent;
 130         struct  device_node *child;
 131         struct  device_node *sibling;
 132         struct  device_node *next;      /* next device of same type */
 133         struct  device_node *allnext;   /* next in list of all nodes */
 134         struct  proc_dir_entry *pde;    /* this node's proc directory */
 135         struct  kref kref;
 136         unsigned long _flags;
 137         void    *data;
 138 };
 139
 140 extern struct device_node *of_chosen;
 141
 142 /* flag descriptions */
 143 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
 144
 145 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 146 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 147
 148 #define HAVE_ARCH_DEVTREE_FIXUPS
 149
 150 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
 151 {
 152         dn->pde = de;
 153 }
 154
 155
 156 /* OBSOLETE: Old style node lookup */
 157 extern struct device_node *find_devices(const char *name);
 158 extern struct device_node *find_type_devices(const char *type);
 159 extern struct device_node *find_path_device(const char *path);
 160 extern struct device_node *find_compatible_devices(const char *type,
 161                                                    const char *compat);
 162 extern struct device_node *find_all_nodes(void);
 163
 164 /* New style node lookup */
 165 extern struct device_node *of_find_node_by_name(struct device_node *from,
 166         const char *name);
 167 extern struct device_node *of_find_node_by_type(struct device_node *from,
 168         const char *type);
 169 extern struct device_node *of_find_compatible_node(struct device_node *from,
 170         const char *type, const char *compat);
 171 extern struct device_node *of_find_node_by_path(const char *path);
 172 extern struct device_node *of_find_node_by_phandle(phandle handle);
 173 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 174 extern struct device_node *of_get_parent(const struct device_node *node);
 175 extern struct device_node *of_get_next_child(const struct device_node *node,
 176                                              struct device_node *prev);
 177 extern struct device_node *of_node_get(struct device_node *node);
 178 extern void of_node_put(struct device_node *node);
 179
 180 /* For updating the device tree at runtime */
 181 extern void of_attach_node(struct device_node *);
 182 extern void of_detach_node(const struct device_node *);
 183
 184 /* Other Prototypes */
 185 extern void finish_device_tree(void);
 186 extern void unflatten_device_tree(void);
 187 extern void early_init_devtree(void *);
 188 extern int device_is_compatible(struct device_node *device, const char *);
 189 extern int machine_is_compatible(const char *compat);
 190 extern unsigned char *get_property(struct device_node *node, const char *name,
 191                                    int *lenp);
 192 extern void print_properties(struct device_node *node);
 193 extern int prom_n_addr_cells(struct device_node* np);
 194 extern int prom_n_size_cells(struct device_node* np);
 195 extern int prom_n_intr_cells(struct device_node* np);
 196 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
 197 extern void prom_add_property(struct device_node* np, struct property* prop);
 198
 199 #ifdef CONFIG_PPC32
 200 /*
 201  * PCI <-> OF matching functions
 202  * (XXX should these be here?)
 203  */
 204 struct pci_bus;
 205 struct pci_dev;
 206 extern int pci_device_from_OF_node(struct device_node *node,
 207                                    u8* bus, u8* devfn);
 208 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
 209 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
 210 extern void pci_create_OF_bus_map(void);
 211 #endif
 212
 213 extern struct resource *request_OF_resource(struct device_node* node,
 214                                 int index, const char* name_postfix);
 215 extern int release_OF_resource(struct device_node* node, int index);
 216
 217 #endif /* __KERNEL__ */
 218 #endif /* _POWERPC_PROM_H */