Pileus Git - ~andy/linux/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 #ifdef CONFIG_OF
  26
  27 typedef u32 phandle;
  28 typedef u32 ihandle;
  29
  30 struct property {
  31         char    *name;
  32         int     length;
  33         void    *value;
  34         struct property *next;
  35         unsigned long _flags;
  36         unsigned int unique_id;
  37 };
  38
  39 #if defined(CONFIG_SPARC)
  40 struct of_irq_controller;
  41 #endif
  42
  43 struct device_node {
  44         const char *name;
  45         const char *type;
  46         phandle phandle;
  47         char    *full_name;
  48
  49         struct  property *properties;
  50         struct  property *deadprops;    /* removed properties */
  51         struct  device_node *parent;
  52         struct  device_node *child;
  53         struct  device_node *sibling;
  54         struct  device_node *next;      /* next device of same type */
  55         struct  device_node *allnext;   /* next in list of all nodes */
  56         struct  proc_dir_entry *pde;    /* this node's proc directory */
  57         struct  kref kref;
  58         unsigned long _flags;
  59         void    *data;
  60 #if defined(CONFIG_SPARC)
  61         char    *path_component_name;
  62         unsigned int unique_id;
  63         struct of_irq_controller *irq_trans;
  64 #endif
  65 };
  66
  67 /* Pointer for first entry in chain of all nodes. */
  68 extern struct device_node *allnodes;
  69
  70 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
  71 {
  72         return test_bit(flag, &n->_flags);
  73 }
  74
  75 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
  76 {
  77         set_bit(flag, &n->_flags);
  78 }
  79
  80 extern struct device_node *of_find_all_nodes(struct device_node *prev);
  81
  82 #if defined(CONFIG_SPARC)
  83 /* Dummy ref counting routines - to be implemented later */
  84 static inline struct device_node *of_node_get(struct device_node *node)
  85 {
  86         return node;
  87 }
  88 static inline void of_node_put(struct device_node *node)
  89 {
  90 }
  91
  92 #else
  93 extern struct device_node *of_node_get(struct device_node *node);
  94 extern void of_node_put(struct device_node *node);
  95 #endif
  96
  97 /*
  98  * OF address retreival & translation
  99  */
 100
 101 /* Helper to read a big number; size is in cells (not bytes) */
 102 static inline u64 of_read_number(const __be32 *cell, int size)
 103 {
 104         u64 r = 0;
 105         while (size--)
 106                 r = (r << 32) | be32_to_cpu(*(cell++));
 107         return r;
 108 }
 109
 110 /* Like of_read_number, but we want an unsigned long result */
 111 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
 112 {
 113         /* toss away upper bits if unsigned long is smaller than u64 */
 114         return of_read_number(cell, size);
 115 }
 116
 117 #include <asm/prom.h>
 118
 119 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
 120 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
 121 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
 122 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
 123 #endif
 124
 125 /* Default string compare functions, Allow arch asm/prom.h to override */
 126 #if !defined(of_compat_cmp)
 127 #define of_compat_cmp(s1, s2, l)        strncasecmp((s1), (s2), (l))
 128 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
 129 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
 130 #endif
 131
 132 /* flag descriptions */
 133 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 134 #define OF_DETACHED     2 /* node has been detached from the device tree */
 135
 136 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 137 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 138
 139 #define OF_BAD_ADDR     ((u64)-1)
 140
 141 extern struct device_node *of_find_node_by_name(struct device_node *from,
 142         const char *name);
 143 #define for_each_node_by_name(dn, name) \
 144         for (dn = of_find_node_by_name(NULL, name); dn; \
 145              dn = of_find_node_by_name(dn, name))
 146 extern struct device_node *of_find_node_by_type(struct device_node *from,
 147         const char *type);
 148 #define for_each_node_by_type(dn, type) \
 149         for (dn = of_find_node_by_type(NULL, type); dn; \
 150              dn = of_find_node_by_type(dn, type))
 151 extern struct device_node *of_find_compatible_node(struct device_node *from,
 152         const char *type, const char *compat);
 153 #define for_each_compatible_node(dn, type, compatible) \
 154         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 155              dn = of_find_compatible_node(dn, type, compatible))
 156 extern struct device_node *of_find_matching_node(struct device_node *from,
 157         const struct of_device_id *matches);
 158 #define for_each_matching_node(dn, matches) \
 159         for (dn = of_find_matching_node(NULL, matches); dn; \
 160              dn = of_find_matching_node(dn, matches))
 161 extern struct device_node *of_find_node_by_path(const char *path);
 162 extern struct device_node *of_find_node_by_phandle(phandle handle);
 163 extern struct device_node *of_get_parent(const struct device_node *node);
 164 extern struct device_node *of_get_next_parent(struct device_node *node);
 165 extern struct device_node *of_get_next_child(const struct device_node *node,
 166                                              struct device_node *prev);
 167 #define for_each_child_of_node(parent, child) \
 168         for (child = of_get_next_child(parent, NULL); child != NULL; \
 169              child = of_get_next_child(parent, child))
 170
 171 extern struct device_node *of_find_node_with_property(
 172         struct device_node *from, const char *prop_name);
 173 #define for_each_node_with_property(dn, prop_name) \
 174         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 175              dn = of_find_node_with_property(dn, prop_name))
 176
 177 extern struct property *of_find_property(const struct device_node *np,
 178                                          const char *name,
 179                                          int *lenp);
 180 extern int of_device_is_compatible(const struct device_node *device,
 181                                    const char *);
 182 extern int of_device_is_available(const struct device_node *device);
 183 extern const void *of_get_property(const struct device_node *node,
 184                                 const char *name,
 185                                 int *lenp);
 186 extern int of_n_addr_cells(struct device_node *np);
 187 extern int of_n_size_cells(struct device_node *np);
 188 extern const struct of_device_id *of_match_node(
 189         const struct of_device_id *matches, const struct device_node *node);
 190 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 191 extern struct device_node *of_parse_phandle(struct device_node *np,
 192                                             const char *phandle_name,
 193                                             int index);
 194 extern int of_parse_phandles_with_args(struct device_node *np,
 195         const char *list_name, const char *cells_name, int index,
 196         struct device_node **out_node, const void **out_args);
 197
 198 extern int of_machine_is_compatible(const char *compat);
 199
 200 extern int prom_add_property(struct device_node* np, struct property* prop);
 201 extern int prom_remove_property(struct device_node *np, struct property *prop);
 202 extern int prom_update_property(struct device_node *np,
 203                                 struct property *newprop,
 204                                 struct property *oldprop);
 205
 206 #if defined(CONFIG_OF_DYNAMIC)
 207 /* For updating the device tree at runtime */
 208 extern void of_attach_node(struct device_node *);
 209 extern void of_detach_node(struct device_node *);
 210 #endif
 211
 212 #endif /* CONFIG_OF */
 213 #endif /* _LINUX_OF_H */