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/mod_devicetable.h>
  21
  22 #include <asm/prom.h>
  23
  24 /* flag descriptions */
  25 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
  26 #define OF_DETACHED     2 /* node has been detached from the device tree */
  27
  28 #define OF_BAD_ADDR     ((u64)-1)
  29
  30 extern struct device_node *of_find_node_by_name(struct device_node *from,
  31         const char *name);
  32 #define for_each_node_by_name(dn, name) \
  33         for (dn = of_find_node_by_name(NULL, name); dn; \
  34              dn = of_find_node_by_name(dn, name))
  35 extern struct device_node *of_find_node_by_type(struct device_node *from,
  36         const char *type);
  37 #define for_each_node_by_type(dn, type) \
  38         for (dn = of_find_node_by_type(NULL, type); dn; \
  39              dn = of_find_node_by_type(dn, type))
  40 extern struct device_node *of_find_compatible_node(struct device_node *from,
  41         const char *type, const char *compat);
  42 #define for_each_compatible_node(dn, type, compatible) \
  43         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
  44              dn = of_find_compatible_node(dn, type, compatible))
  45 extern struct device_node *of_find_matching_node(struct device_node *from,
  46         const struct of_device_id *matches);
  47 #define for_each_matching_node(dn, matches) \
  48         for (dn = of_find_matching_node(NULL, matches); dn; \
  49              dn = of_find_matching_node(dn, matches))
  50 extern struct device_node *of_find_node_by_path(const char *path);
  51 extern struct device_node *of_find_node_by_phandle(phandle handle);
  52 extern struct device_node *of_get_parent(const struct device_node *node);
  53 extern struct device_node *of_get_next_parent(struct device_node *node);
  54 extern struct device_node *of_get_next_child(const struct device_node *node,
  55                                              struct device_node *prev);
  56 #define for_each_child_of_node(parent, child) \
  57         for (child = of_get_next_child(parent, NULL); child != NULL; \
  58              child = of_get_next_child(parent, child))
  59
  60 extern struct device_node *of_find_node_with_property(
  61         struct device_node *from, const char *prop_name);
  62 #define for_each_node_with_property(dn, prop_name) \
  63         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
  64              dn = of_find_node_with_property(dn, prop_name))
  65
  66 extern struct property *of_find_property(const struct device_node *np,
  67                                          const char *name,
  68                                          int *lenp);
  69 extern int of_device_is_compatible(const struct device_node *device,
  70                                    const char *);
  71 extern int of_device_is_available(const struct device_node *device);
  72 extern const void *of_get_property(const struct device_node *node,
  73                                 const char *name,
  74                                 int *lenp);
  75 extern int of_n_addr_cells(struct device_node *np);
  76 extern int of_n_size_cells(struct device_node *np);
  77 extern const struct of_device_id *of_match_node(
  78         const struct of_device_id *matches, const struct device_node *node);
  79 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
  80 extern struct device_node *of_parse_phandle(struct device_node *np,
  81                                             const char *phandle_name,
  82                                             int index);
  83 extern int of_parse_phandles_with_args(struct device_node *np,
  84         const char *list_name, const char *cells_name, int index,
  85         struct device_node **out_node, const void **out_args);
  86
  87 #endif /* _LINUX_OF_H */