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