include/asm-ppc64/prom.h

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