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