LXR linux/include/linux/of

   1/*
   2 * Definitions for working with the Flattened Device Tree data format
   3 *
   4 * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
   5 * benh@kernel.crashing.org
   6 *
   7 * This program is free software; you can redistribute it and/or
   8 * modify it under the terms of the GNU General Public License
   9 * version 2 as published by the Free Software Foundation.
  10 */
  11
  12#ifndef _LINUX_OF_FDT_H
  13#define _LINUX_OF_FDT_H
  14
  15#include <linux/types.h>
  16#include <linux/init.h>
  17#include <linux/errno.h>
  18
  19/* Definitions used by the flattened device tree */
  20#define OF_DT_HEADER            0xd00dfeed      /* marker */
  21
  22#ifndef __ASSEMBLY__
  23
  24#if defined(CONFIG_OF_FLATTREE)
  25
  26struct device_node;
  27
  28/* For scanning an arbitrary device-tree at any time */
  29extern char *of_fdt_get_string(const void *blob, u32 offset);
  30extern void *of_fdt_get_property(const void *blob,
  31                                 unsigned long node,
  32                                 const char *name,
  33                                 int *size);
  34extern bool of_fdt_is_big_endian(const void *blob,
  35                                 unsigned long node);
  36extern int of_fdt_match(const void *blob, unsigned long node,
  37                        const char *const *compat);
  38extern void *of_fdt_unflatten_tree(const unsigned long *blob,
  39                                   struct device_node *dad,
  40                                   struct device_node **mynodes);
  41
  42/* TBD: Temporary export of fdt globals - remove when code fully merged */
  43extern int __initdata dt_root_addr_cells;
  44extern int __initdata dt_root_size_cells;
  45extern void *initial_boot_params;
  46
  47extern char __dtb_start[];
  48extern char __dtb_end[];
  49
  50/* For scanning the flat device-tree at boot time */
  51extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
  52                                     int depth, void *data),
  53                           void *data);
  54extern int of_scan_flat_dt_subnodes(unsigned long node,
  55                                    int (*it)(unsigned long node,
  56                                              const char *uname,
  57                                              void *data),
  58                                    void *data);
  59extern int of_get_flat_dt_subnode_by_name(unsigned long node,
  60                                          const char *uname);
  61extern const void *of_get_flat_dt_prop(unsigned long node, const char *name,
  62                                       int *size);
  63extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
  64extern int of_flat_dt_match(unsigned long node, const char *const *matches);
  65extern unsigned long of_get_flat_dt_root(void);
  66extern int of_get_flat_dt_size(void);
  67extern uint32_t of_get_flat_dt_phandle(unsigned long node);
  68
  69extern int early_init_dt_scan_chosen(unsigned long node, const char *uname,
  70                                     int depth, void *data);
  71extern int early_init_dt_scan_memory(unsigned long node, const char *uname,
  72                                     int depth, void *data);
  73extern int early_init_dt_scan_chosen_stdout(void);
  74extern void early_init_fdt_scan_reserved_mem(void);
  75extern void early_init_fdt_reserve_self(void);
  76extern void early_init_dt_add_memory_arch(u64 base, u64 size);
  77extern int early_init_dt_mark_hotplug_memory_arch(u64 base, u64 size);
  78extern int early_init_dt_reserve_memory_arch(phys_addr_t base, phys_addr_t size,
  79                                             bool no_map);
  80extern void * early_init_dt_alloc_memory_arch(u64 size, u64 align);
  81extern u64 dt_mem_next_cell(int s, const __be32 **cellp);
  82
  83/* Early flat tree scan hooks */
  84extern int early_init_dt_scan_root(unsigned long node, const char *uname,
  85                                   int depth, void *data);
  86
  87extern bool early_init_dt_scan(void *params);
  88extern bool early_init_dt_verify(void *params);
  89extern void early_init_dt_scan_nodes(void);
  90
  91extern const char *of_flat_dt_get_machine_name(void);
  92extern const void *of_flat_dt_match_machine(const void *default_match,
  93                const void * (*get_next_compat)(const char * const**));
  94
  95/* Other Prototypes */
  96extern void unflatten_device_tree(void);
  97extern void unflatten_and_copy_device_tree(void);
  98extern void early_init_devtree(void *);
  99extern void early_get_first_memblock_info(void *, phys_addr_t *);
 100extern u64 of_flat_dt_translate_address(unsigned long node);
 101extern void of_fdt_limit_memory(int limit);
 102#else /* CONFIG_OF_FLATTREE */
 103static inline int early_init_dt_scan_chosen_stdout(void) { return -ENODEV; }
 104static inline void early_init_fdt_scan_reserved_mem(void) {}
 105static inline void early_init_fdt_reserve_self(void) {}
 106static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
 107static inline void unflatten_device_tree(void) {}
 108static inline void unflatten_and_copy_device_tree(void) {}
 109#endif /* CONFIG_OF_FLATTREE */
 110
 111#endif /* __ASSEMBLY__ */
 112#endif /* _LINUX_OF_FDT_H */
 113