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