SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/of.h

   1 #ifndef _LINUX_OF_H
   2 #define _LINUX_OF_H
   3 /*
   4  * Definitions for talking to the Open Firmware PROM on
   5  * Power Macintosh and other computers.
   6  *
   7  * Copyright (C) 1996-2005 Paul Mackerras.
   8  *
   9  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
  10  * Updates for SPARC64 by David S. Miller
  11  * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, 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/bitops.h>
  20 #include <linux/kref.h>
  21 #include <linux/mod_devicetable.h>
  22
  23 #include <asm/byteorder.h>
  24
  25 typedef u32 phandle;
  26 typedef u32 ihandle;
  27
  28 struct property {
  29         char    *name;
  30         int     length;
  31         void    *value;
  32         struct property *next;
  33         unsigned long _flags;
  34         unsigned int unique_id;
  35 };
  36
  37 #if defined(CONFIG_SPARC)
  38 struct of_irq_controller;
  39 #endif
  40
  41 struct device_node {
  42         const char *name;
  43         const char *type;
  44         phandle phandle;
  45         char    *full_name;
  46
  47         struct  property *properties;
  48         struct  property *deadprops;    /* removed properties */
  49         struct  device_node *parent;
  50         struct  device_node *child;
  51         struct  device_node *sibling;
  52         struct  device_node *next;      /* next device of same type */
  53         struct  device_node *allnext;   /* next in list of all nodes */
  54         struct  proc_dir_entry *pde;    /* this node's proc directory */
  55         struct  kref kref;
  56         unsigned long _flags;
  57         void    *data;
  58 #if defined(CONFIG_SPARC)
  59         char    *path_component_name;
  60         unsigned int unique_id;
  61         struct of_irq_controller *irq_trans;
  62 #endif
  63 };
  64
  65 /* Pointer for first entry in chain of all nodes. */
  66 extern struct device_node *allnodes;
  67
  68 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
  69 {
  70         return test_bit(flag, &n->_flags);
  71 }
  72
  73 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
  74 {
  75         set_bit(flag, &n->_flags);
  76 }
  77
  78 extern struct device_node *of_find_all_nodes(struct device_node *prev);
  79
  80 #if defined(CONFIG_SPARC)
  81 /* Dummy ref counting routines - to be implemented later */
  82 static inline struct device_node *of_node_get(struct device_node *node)
  83 {
  84         return node;
  85 }
  86 static inline void of_node_put(struct device_node *node)
  87 {
  88 }
  89
  90 #else
  91 extern struct device_node *of_node_get(struct device_node *node);
  92 extern void of_node_put(struct device_node *node);
  93 #endif
  94
  95 /*
  96  * OF address retreival & translation
  97  */
  98
  99 /* Helper to read a big number; size is in cells (not bytes) */
 100 static inline u64 of_read_number(const __be32 *cell, int size)
 101 {
 102         u64 r = 0;
 103         while (size--)
 104                 r = (r << 32) | be32_to_cpu(*(cell++));
 105         return r;
 106 }
 107
 108 /* Like of_read_number, but we want an unsigned long result */
 109 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
 110 {
 111         /* toss away upper bits if unsigned long is smaller than u64 */
 112         return of_read_number(cell, size);
 113 }
 114
 115 #include <asm/prom.h>
 116
 117 /* flag descriptions */
 118 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 119 #define OF_DETACHED     2 /* node has been detached from the device tree */
 120
 121 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 122 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 123
 124 #define OF_BAD_ADDR     ((u64)-1)
 125
 126 extern struct device_node *of_find_node_by_name(struct device_node *from,
 127         const char *name);
 128 #define for_each_node_by_name(dn, name) \
 129         for (dn = of_find_node_by_name(NULL, name); dn; \
 130              dn = of_find_node_by_name(dn, name))
 131 extern struct device_node *of_find_node_by_type(struct device_node *from,
 132         const char *type);
 133 #define for_each_node_by_type(dn, type) \
 134         for (dn = of_find_node_by_type(NULL, type); dn; \
 135              dn = of_find_node_by_type(dn, type))
 136 extern struct device_node *of_find_compatible_node(struct device_node *from,
 137         const char *type, const char *compat);
 138 #define for_each_compatible_node(dn, type, compatible) \
 139         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 140              dn = of_find_compatible_node(dn, type, compatible))
 141 extern struct device_node *of_find_matching_node(struct device_node *from,
 142         const struct of_device_id *matches);
 143 #define for_each_matching_node(dn, matches) \
 144         for (dn = of_find_matching_node(NULL, matches); dn; \
 145              dn = of_find_matching_node(dn, matches))
 146 extern struct device_node *of_find_node_by_path(const char *path);
 147 extern struct device_node *of_find_node_by_phandle(phandle handle);
 148 extern struct device_node *of_get_parent(const struct device_node *node);
 149 extern struct device_node *of_get_next_parent(struct device_node *node);
 150 extern struct device_node *of_get_next_child(const struct device_node *node,
 151                                              struct device_node *prev);
 152 #define for_each_child_of_node(parent, child) \
 153         for (child = of_get_next_child(parent, NULL); child != NULL; \
 154              child = of_get_next_child(parent, child))
 155
 156 extern struct device_node *of_find_node_with_property(
 157         struct device_node *from, const char *prop_name);
 158 #define for_each_node_with_property(dn, prop_name) \
 159         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 160              dn = of_find_node_with_property(dn, prop_name))
 161
 162 extern struct property *of_find_property(const struct device_node *np,
 163                                          const char *name,
 164                                          int *lenp);
 165 extern int of_device_is_compatible(const struct device_node *device,
 166                                    const char *);
 167 extern int of_device_is_available(const struct device_node *device);
 168 extern const void *of_get_property(const struct device_node *node,
 169                                 const char *name,
 170                                 int *lenp);
 171 extern int of_n_addr_cells(struct device_node *np);
 172 extern int of_n_size_cells(struct device_node *np);
 173 extern const struct of_device_id *of_match_node(
 174         const struct of_device_id *matches, const struct device_node *node);
 175 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 176 extern struct device_node *of_parse_phandle(struct device_node *np,
 177                                             const char *phandle_name,
 178                                             int index);
 179 extern int of_parse_phandles_with_args(struct device_node *np,
 180         const char *list_name, const char *cells_name, int index,
 181         struct device_node **out_node, const void **out_args);
 182
 183 #if defined(CONFIG_OF_DYNAMIC)
 184 /* For updating the device tree at runtime */
 185 extern void of_attach_node(struct device_node *);
 186 extern void of_detach_node(struct device_node *);
 187 #endif
 188
 189 #endif /* _LINUX_OF_H */