linux/include/linux/of.h
<<
>>
Prefs
   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/errno.h>
  21#include <linux/kref.h>
  22#include <linux/mod_devicetable.h>
  23#include <linux/spinlock.h>
  24#include <linux/topology.h>
  25
  26#include <asm/byteorder.h>
  27#include <asm/errno.h>
  28
  29typedef u32 phandle;
  30typedef u32 ihandle;
  31
  32struct property {
  33        char    *name;
  34        int     length;
  35        void    *value;
  36        struct property *next;
  37        unsigned long _flags;
  38        unsigned int unique_id;
  39};
  40
  41#if defined(CONFIG_SPARC)
  42struct of_irq_controller;
  43#endif
  44
  45struct device_node {
  46        const char *name;
  47        const char *type;
  48        phandle phandle;
  49        char    *full_name;
  50
  51        struct  property *properties;
  52        struct  property *deadprops;    /* removed properties */
  53        struct  device_node *parent;
  54        struct  device_node *child;
  55        struct  device_node *sibling;
  56        struct  device_node *next;      /* next device of same type */
  57        struct  device_node *allnext;   /* next in list of all nodes */
  58        struct  proc_dir_entry *pde;    /* this node's proc directory */
  59        struct  kref kref;
  60        unsigned long _flags;
  61        void    *data;
  62#if defined(CONFIG_SPARC)
  63        char    *path_component_name;
  64        unsigned int unique_id;
  65        struct of_irq_controller *irq_trans;
  66#endif
  67};
  68
  69#define MAX_PHANDLE_ARGS 8
  70struct of_phandle_args {
  71        struct device_node *np;
  72        int args_count;
  73        uint32_t args[MAX_PHANDLE_ARGS];
  74};
  75
  76#ifdef CONFIG_OF_DYNAMIC
  77extern struct device_node *of_node_get(struct device_node *node);
  78extern void of_node_put(struct device_node *node);
  79#else /* CONFIG_OF_DYNAMIC */
  80/* Dummy ref counting routines - to be implemented later */
  81static inline struct device_node *of_node_get(struct device_node *node)
  82{
  83        return node;
  84}
  85static inline void of_node_put(struct device_node *node) { }
  86#endif /* !CONFIG_OF_DYNAMIC */
  87
  88#ifdef CONFIG_OF
  89
  90/* Pointer for first entry in chain of all nodes. */
  91extern struct device_node *allnodes;
  92extern struct device_node *of_chosen;
  93extern struct device_node *of_aliases;
  94extern rwlock_t devtree_lock;
  95
  96static inline bool of_have_populated_dt(void)
  97{
  98        return allnodes != NULL;
  99}
 100
 101static inline bool of_node_is_root(const struct device_node *node)
 102{
 103        return node && (node->parent == NULL);
 104}
 105
 106static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
 107{
 108        return test_bit(flag, &n->_flags);
 109}
 110
 111static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
 112{
 113        set_bit(flag, &n->_flags);
 114}
 115
 116extern struct device_node *of_find_all_nodes(struct device_node *prev);
 117
 118/*
 119 * OF address retrieval & translation
 120 */
 121
 122/* Helper to read a big number; size is in cells (not bytes) */
 123static inline u64 of_read_number(const __be32 *cell, int size)
 124{
 125        u64 r = 0;
 126        while (size--)
 127                r = (r << 32) | be32_to_cpu(*(cell++));
 128        return r;
 129}
 130
 131/* Like of_read_number, but we want an unsigned long result */
 132static inline unsigned long of_read_ulong(const __be32 *cell, int size)
 133{
 134        /* toss away upper bits if unsigned long is smaller than u64 */
 135        return of_read_number(cell, size);
 136}
 137
 138#include <asm/prom.h>
 139
 140/* Default #address and #size cells.  Allow arch asm/prom.h to override */
 141#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
 142#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
 143#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
 144#endif
 145
 146/* Default string compare functions, Allow arch asm/prom.h to override */
 147#if !defined(of_compat_cmp)
 148#define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
 149#define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
 150#define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
 151#endif
 152
 153/* flag descriptions */
 154#define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 155#define OF_DETACHED     2 /* node has been detached from the device tree */
 156
 157#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 158#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 159
 160#define OF_BAD_ADDR     ((u64)-1)
 161
 162static inline const char* of_node_full_name(struct device_node *np)
 163{
 164        return np ? np->full_name : "<no-node>";
 165}
 166
 167extern struct device_node *of_find_node_by_name(struct device_node *from,
 168        const char *name);
 169#define for_each_node_by_name(dn, name) \
 170        for (dn = of_find_node_by_name(NULL, name); dn; \
 171             dn = of_find_node_by_name(dn, name))
 172extern struct device_node *of_find_node_by_type(struct device_node *from,
 173        const char *type);
 174#define for_each_node_by_type(dn, type) \
 175        for (dn = of_find_node_by_type(NULL, type); dn; \
 176             dn = of_find_node_by_type(dn, type))
 177extern struct device_node *of_find_compatible_node(struct device_node *from,
 178        const char *type, const char *compat);
 179#define for_each_compatible_node(dn, type, compatible) \
 180        for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 181             dn = of_find_compatible_node(dn, type, compatible))
 182extern struct device_node *of_find_matching_node(struct device_node *from,
 183        const struct of_device_id *matches);
 184#define for_each_matching_node(dn, matches) \
 185        for (dn = of_find_matching_node(NULL, matches); dn; \
 186             dn = of_find_matching_node(dn, matches))
 187extern struct device_node *of_find_node_by_path(const char *path);
 188extern struct device_node *of_find_node_by_phandle(phandle handle);
 189extern struct device_node *of_get_parent(const struct device_node *node);
 190extern struct device_node *of_get_next_parent(struct device_node *node);
 191extern struct device_node *of_get_next_child(const struct device_node *node,
 192                                             struct device_node *prev);
 193extern struct device_node *of_get_next_available_child(
 194        const struct device_node *node, struct device_node *prev);
 195
 196#define for_each_child_of_node(parent, child) \
 197        for (child = of_get_next_child(parent, NULL); child != NULL; \
 198             child = of_get_next_child(parent, child))
 199
 200#define for_each_available_child_of_node(parent, child) \
 201        for (child = of_get_next_available_child(parent, NULL); child != NULL; \
 202             child = of_get_next_available_child(parent, child))
 203
 204static inline int of_get_child_count(const struct device_node *np)
 205{
 206        struct device_node *child;
 207        int num = 0;
 208
 209        for_each_child_of_node(np, child)
 210                num++;
 211
 212        return num;
 213}
 214
 215extern struct device_node *of_find_node_with_property(
 216        struct device_node *from, const char *prop_name);
 217#define for_each_node_with_property(dn, prop_name) \
 218        for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 219             dn = of_find_node_with_property(dn, prop_name))
 220
 221extern struct property *of_find_property(const struct device_node *np,
 222                                         const char *name,
 223                                         int *lenp);
 224extern int of_property_read_u32_array(const struct device_node *np,
 225                                      const char *propname,
 226                                      u32 *out_values,
 227                                      size_t sz);
 228extern int of_property_read_u64(const struct device_node *np,
 229                                const char *propname, u64 *out_value);
 230
 231extern int of_property_read_string(struct device_node *np,
 232                                   const char *propname,
 233                                   const char **out_string);
 234extern int of_property_read_string_index(struct device_node *np,
 235                                         const char *propname,
 236                                         int index, const char **output);
 237extern int of_property_match_string(struct device_node *np,
 238                                    const char *propname,
 239                                    const char *string);
 240extern int of_property_count_strings(struct device_node *np,
 241                                     const char *propname);
 242extern int of_device_is_compatible(const struct device_node *device,
 243                                   const char *);
 244extern int of_device_is_available(const struct device_node *device);
 245extern const void *of_get_property(const struct device_node *node,
 246                                const char *name,
 247                                int *lenp);
 248#define for_each_property_of_node(dn, pp) \
 249        for (pp = dn->properties; pp != NULL; pp = pp->next)
 250
 251extern int of_n_addr_cells(struct device_node *np);
 252extern int of_n_size_cells(struct device_node *np);
 253extern const struct of_device_id *of_match_node(
 254        const struct of_device_id *matches, const struct device_node *node);
 255extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 256extern struct device_node *of_parse_phandle(struct device_node *np,
 257                                            const char *phandle_name,
 258                                            int index);
 259extern int of_parse_phandle_with_args(struct device_node *np,
 260        const char *list_name, const char *cells_name, int index,
 261        struct of_phandle_args *out_args);
 262
 263extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
 264extern int of_alias_get_id(struct device_node *np, const char *stem);
 265
 266extern int of_machine_is_compatible(const char *compat);
 267
 268extern int prom_add_property(struct device_node* np, struct property* prop);
 269extern int prom_remove_property(struct device_node *np, struct property *prop);
 270extern int prom_update_property(struct device_node *np,
 271                                struct property *newprop);
 272
 273#if defined(CONFIG_OF_DYNAMIC)
 274/* For updating the device tree at runtime */
 275extern void of_attach_node(struct device_node *);
 276extern void of_detach_node(struct device_node *);
 277#endif
 278
 279#define of_match_ptr(_ptr)      (_ptr)
 280
 281/*
 282 * struct property *prop;
 283 * const __be32 *p;
 284 * u32 u;
 285 *
 286 * of_property_for_each_u32(np, "propname", prop, p, u)
 287 *         printk("U32 value: %x\n", u);
 288 */
 289const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
 290                               u32 *pu);
 291#define of_property_for_each_u32(np, propname, prop, p, u)      \
 292        for (prop = of_find_property(np, propname, NULL),       \
 293                p = of_prop_next_u32(prop, NULL, &u);           \
 294                p;                                              \
 295                p = of_prop_next_u32(prop, p, &u))
 296
 297/*
 298 * struct property *prop;
 299 * const char *s;
 300 *
 301 * of_property_for_each_string(np, "propname", prop, s)
 302 *         printk("String value: %s\n", s);
 303 */
 304const char *of_prop_next_string(struct property *prop, const char *cur);
 305#define of_property_for_each_string(np, propname, prop, s)      \
 306        for (prop = of_find_property(np, propname, NULL),       \
 307                s = of_prop_next_string(prop, NULL);            \
 308                s;                                              \
 309                s = of_prop_next_string(prop, s))
 310
 311#else /* CONFIG_OF */
 312
 313static inline const char* of_node_full_name(struct device_node *np)
 314{
 315        return "<no-node>";
 316}
 317
 318static inline bool of_have_populated_dt(void)
 319{
 320        return false;
 321}
 322
 323#define for_each_child_of_node(parent, child) \
 324        while (0)
 325
 326static inline int of_get_child_count(const struct device_node *np)
 327{
 328        return 0;
 329}
 330
 331static inline int of_device_is_compatible(const struct device_node *device,
 332                                          const char *name)
 333{
 334        return 0;
 335}
 336
 337static inline struct property *of_find_property(const struct device_node *np,
 338                                                const char *name,
 339                                                int *lenp)
 340{
 341        return NULL;
 342}
 343
 344static inline struct device_node *of_find_compatible_node(
 345                                                struct device_node *from,
 346                                                const char *type,
 347                                                const char *compat)
 348{
 349        return NULL;
 350}
 351
 352static inline int of_property_read_u32_array(const struct device_node *np,
 353                                             const char *propname,
 354                                             u32 *out_values, size_t sz)
 355{
 356        return -ENOSYS;
 357}
 358
 359static inline int of_property_read_string(struct device_node *np,
 360                                          const char *propname,
 361                                          const char **out_string)
 362{
 363        return -ENOSYS;
 364}
 365
 366static inline int of_property_read_string_index(struct device_node *np,
 367                                                const char *propname, int index,
 368                                                const char **out_string)
 369{
 370        return -ENOSYS;
 371}
 372
 373static inline int of_property_count_strings(struct device_node *np,
 374                                            const char *propname)
 375{
 376        return -ENOSYS;
 377}
 378
 379static inline const void *of_get_property(const struct device_node *node,
 380                                const char *name,
 381                                int *lenp)
 382{
 383        return NULL;
 384}
 385
 386static inline int of_property_read_u64(const struct device_node *np,
 387                                       const char *propname, u64 *out_value)
 388{
 389        return -ENOSYS;
 390}
 391
 392static inline int of_property_match_string(struct device_node *np,
 393                                           const char *propname,
 394                                           const char *string)
 395{
 396        return -ENOSYS;
 397}
 398
 399static inline struct device_node *of_parse_phandle(struct device_node *np,
 400                                                   const char *phandle_name,
 401                                                   int index)
 402{
 403        return NULL;
 404}
 405
 406static inline int of_parse_phandle_with_args(struct device_node *np,
 407                                             const char *list_name,
 408                                             const char *cells_name,
 409                                             int index,
 410                                             struct of_phandle_args *out_args)
 411{
 412        return -ENOSYS;
 413}
 414
 415static inline int of_alias_get_id(struct device_node *np, const char *stem)
 416{
 417        return -ENOSYS;
 418}
 419
 420static inline int of_machine_is_compatible(const char *compat)
 421{
 422        return 0;
 423}
 424
 425#define of_match_ptr(_ptr)      NULL
 426#define of_match_node(_matches, _node)  NULL
 427#define of_property_for_each_u32(np, propname, prop, p, u) \
 428        while (0)
 429#define of_property_for_each_string(np, propname, prop, s) \
 430        while (0)
 431#endif /* CONFIG_OF */
 432
 433#ifndef of_node_to_nid
 434static inline int of_node_to_nid(struct device_node *np)
 435{
 436        return numa_node_id();
 437}
 438
 439#define of_node_to_nid of_node_to_nid
 440#endif
 441
 442/**
 443 * of_property_read_bool - Findfrom a property
 444 * @np:         device node from which the property value is to be read.
 445 * @propname:   name of the property to be searched.
 446 *
 447 * Search for a property in a device node.
 448 * Returns true if the property exist false otherwise.
 449 */
 450static inline bool of_property_read_bool(const struct device_node *np,
 451                                         const char *propname)
 452{
 453        struct property *prop = of_find_property(np, propname, NULL);
 454
 455        return prop ? true : false;
 456}
 457
 458static inline int of_property_read_u32(const struct device_node *np,
 459                                       const char *propname,
 460                                       u32 *out_value)
 461{
 462        return of_property_read_u32_array(np, propname, out_value, 1);
 463}
 464
 465#endif /* _LINUX_OF_H */
 466
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.