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 #define LONG_LSW(X) (((unsigned long)X) & 0xffffffff)
  25 #define LONG_MSW(X) (((unsigned long)X) >> 32)
  26
  27 /* Definitions used by the flattened device tree */
  28 #define OF_DT_HEADER            0xd00dfeed      /* 4: version, 4: total size */
  29 #define OF_DT_BEGIN_NODE        0x1             /* Start node: full name */
  30 #define OF_DT_END_NODE          0x2             /* End node */
  31 #define OF_DT_PROP              0x3             /* Property: name off, size, content */
  32 #define OF_DT_END               0x9
  33
  34 #define OF_DT_VERSION           1
  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;        /* Which physical CPU id we're booting on */
  61 };
  62
  63
  64
  65 typedef u32 phandle;
  66 typedef u32 ihandle;
  67 typedef u32 phandle32;
  68 typedef u32 ihandle32;
  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 of_tce_table {
  99         phandle node;
 100         unsigned long base;
 101         unsigned long size;
 102 };
 103 extern struct of_tce_table of_tce_table[];
 104
 105 struct reg_property {
 106         unsigned long address;
 107         unsigned long size;
 108 };
 109
 110 struct reg_property32 {
 111         unsigned int address;
 112         unsigned int size;
 113 };
 114
 115 struct reg_property64 {
 116         unsigned long address;
 117         unsigned long size;
 118 };
 119
 120 struct reg_property_pmac {
 121         unsigned int address_hi;
 122         unsigned int address_lo;
 123         unsigned int size;
 124 };
 125
 126 struct translation_property {
 127         unsigned long virt;
 128         unsigned long size;
 129         unsigned long phys;
 130         unsigned int flags;
 131 };
 132
 133 struct property {
 134         char    *name;
 135         int     length;
 136         unsigned char *value;
 137         struct property *next;
 138 };
 139
 140 /* NOTE: the device_node contains PCI specific info for pci devices.
 141  * This perhaps could be hung off the device_node with another struct,
 142  * but for now it is directly in the node.  The phb ptr is a good
 143  * indication of a real PCI node.  Other nodes leave these fields zeroed.
 144  */
 145 struct pci_controller;
 146 struct iommu_table;
 147
 148 struct device_node {
 149         char    *name;
 150         char    *type;
 151         phandle node;
 152         phandle linux_phandle;
 153         int     n_addrs;
 154         struct  address_range *addrs;
 155         int     n_intrs;
 156         struct  interrupt_info *intrs;
 157         char    *full_name;
 158
 159         /* PCI stuff probably doesn't belong here */
 160         int     busno;                  /* for pci devices */
 161         int     bussubno;               /* for pci devices */
 162         int     devfn;                  /* for pci devices */
 163 #define DN_STATUS_BIST_FAILED (1<<0)
 164         int     status;                 /* Current device status (non-zero is bad) */
 165         int     eeh_mode;               /* See eeh.h for possible EEH_MODEs */
 166         int     eeh_config_addr;
 167         struct  pci_controller *phb;    /* for pci devices */
 168         struct  iommu_table *iommu_table;       /* for phb's or bridges */
 169
 170         struct  property *properties;
 171         struct  device_node *parent;
 172         struct  device_node *child;
 173         struct  device_node *sibling;
 174         struct  device_node *next;      /* next device of same type */
 175         struct  device_node *allnext;   /* next in list of all nodes */
 176         struct  proc_dir_entry *pde;       /* this node's proc directory */
 177         struct  proc_dir_entry *name_link; /* name symlink */
 178         struct  proc_dir_entry *addr_link; /* addr symlink */
 179         atomic_t _users;                 /* reference count */
 180         unsigned long _flags;
 181 };
 182
 183 extern struct device_node *of_chosen;
 184
 185 /* flag descriptions */
 186 #define OF_STALE   0 /* node is slated for deletion */
 187 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
 188
 189 #define OF_IS_STALE(x) test_bit(OF_STALE, &x->_flags)
 190 #define OF_MARK_STALE(x) set_bit(OF_STALE, &x->_flags)
 191 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 192 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 193
 194 /*
 195  * Until 32-bit ppc can add proc_dir_entries to its device_node
 196  * definition, we cannot refer to pde, name_link, and addr_link
 197  * in arch-independent code.
 198  */
 199 #define HAVE_ARCH_DEVTREE_FIXUPS
 200
 201 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
 202 {
 203         dn->pde = de;
 204 }
 205
 206 static void inline set_node_name_link(struct device_node *dn, struct proc_dir_entry *de)
 207 {
 208         dn->name_link = de;
 209 }
 210
 211 static void inline set_node_addr_link(struct device_node *dn, struct proc_dir_entry *de)
 212 {
 213         dn->addr_link = de;
 214 }
 215
 216 /* OBSOLETE: Old stlye node lookup */
 217 extern struct device_node *find_devices(const char *name);
 218 extern struct device_node *find_type_devices(const char *type);
 219 extern struct device_node *find_path_device(const char *path);
 220 extern struct device_node *find_compatible_devices(const char *type,
 221                                                    const char *compat);
 222 extern struct device_node *find_all_nodes(void);
 223
 224 /* New style node lookup */
 225 extern struct device_node *of_find_node_by_name(struct device_node *from,
 226         const char *name);
 227 extern struct device_node *of_find_node_by_type(struct device_node *from,
 228         const char *type);
 229 extern struct device_node *of_find_compatible_node(struct device_node *from,
 230         const char *type, const char *compat);
 231 extern struct device_node *of_find_node_by_path(const char *path);
 232 extern struct device_node *of_find_node_by_phandle(phandle handle);
 233 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 234 extern struct device_node *of_get_parent(const struct device_node *node);
 235 extern struct device_node *of_get_next_child(const struct device_node *node,
 236                                              struct device_node *prev);
 237 extern struct device_node *of_node_get(struct device_node *node);
 238 extern void of_node_put(struct device_node *node);
 239
 240 /* For updating the device tree at runtime */
 241 extern int of_add_node(const char *path, struct property *proplist);
 242 extern int of_remove_node(struct device_node *np);
 243
 244 /* Other Prototypes */
 245 extern unsigned long prom_init(unsigned long, unsigned long, unsigned long,
 246         unsigned long, unsigned long);
 247 extern void relocate_nodes(void);
 248 extern void finish_device_tree(void);
 249 extern int device_is_compatible(struct device_node *device, const char *);
 250 extern int machine_is_compatible(const char *compat);
 251 extern unsigned char *get_property(struct device_node *node, const char *name,
 252                                    int *lenp);
 253 extern void print_properties(struct device_node *node);
 254 extern int prom_n_addr_cells(struct device_node* np);
 255 extern int prom_n_size_cells(struct device_node* np);
 256 extern int prom_n_intr_cells(struct device_node* np);
 257 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
 258 extern void prom_add_property(struct device_node* np, struct property* prop);
 259
 260 #endif /* _PPC64_PROM_H */