include/linux/of_fdt.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Definitions for working with the Flattened Device Tree data format
   4  *
   5  * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
   6  * benh@kernel.crashing.org
   7  */
   8
   9 #ifndef _LINUX_OF_FDT_H
  10 #define _LINUX_OF_FDT_H
  11
  12 #include <linux/types.h>
  13 #include <linux/init.h>
  14 #include <linux/errno.h>
  15
  16 /* Definitions used by the flattened device tree */
  17 #define OF_DT_HEADER            0xd00dfeed      /* marker */
  18
  19 #ifndef __ASSEMBLY__
  20
  21 #if defined(CONFIG_OF_FLATTREE)
  22
  23 struct device_node;
  24
  25 /* For scanning an arbitrary device-tree at any time */
  26 extern void *of_fdt_unflatten_tree(const unsigned long *blob,
  27                                    struct device_node *dad,
  28                                    struct device_node **mynodes);
  29
  30 /* TBD: Temporary export of fdt globals - remove when code fully merged */
  31 extern int __initdata dt_root_addr_cells;
  32 extern int __initdata dt_root_size_cells;
  33 extern void *initial_boot_params;
  34 extern phys_addr_t initial_boot_params_pa;
  35
  36 extern char __dtb_start[];
  37 extern char __dtb_end[];
  38
  39 /* Other Prototypes */
  40 extern u64 of_flat_dt_translate_address(unsigned long node);
  41 extern void of_fdt_limit_memory(int limit);
  42 #endif /* CONFIG_OF_FLATTREE */
  43
  44 #ifdef CONFIG_OF_EARLY_FLATTREE
  45 /* For scanning the flat device-tree at boot time */
  46 extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
  47                                      int depth, void *data),
  48                            void *data);
  49 extern int of_scan_flat_dt_subnodes(unsigned long node,
  50                                     int (*it)(unsigned long node,
  51                                               const char *uname,
  52                                               void *data),
  53                                     void *data);
  54 extern int of_get_flat_dt_subnode_by_name(unsigned long node,
  55                                           const char *uname);
  56 extern const void *of_get_flat_dt_prop(unsigned long node, const char *name,
  57                                        int *size);
  58 extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
  59 extern unsigned long of_get_flat_dt_root(void);
  60 extern uint32_t of_get_flat_dt_phandle(unsigned long node);
  61
  62 extern int early_init_dt_scan_chosen(char *cmdline);
  63 extern int early_init_dt_scan_memory(void);
  64 extern void early_init_dt_check_for_usable_mem_range(void);
  65 extern int early_init_dt_scan_chosen_stdout(void);
  66 extern void early_init_fdt_scan_reserved_mem(void);
  67 extern void early_init_fdt_reserve_self(void);
  68 extern void early_init_dt_add_memory_arch(u64 base, u64 size);
  69 extern u64 dt_mem_next_cell(int s, const __be32 **cellp);
  70
  71 /* Early flat tree scan hooks */
  72 extern int early_init_dt_scan_root(void);
  73
  74 extern bool early_init_dt_scan(void *dt_virt, phys_addr_t dt_phys);
  75 extern bool early_init_dt_verify(void *dt_virt, phys_addr_t dt_phys);
  76 extern void early_init_dt_scan_nodes(void);
  77
  78 extern const char *of_flat_dt_get_machine_name(void);
  79 extern const void *of_flat_dt_match_machine(const void *default_match,
  80                 const void * (*get_next_compat)(const char * const**));
  81
  82 /* Other Prototypes */
  83 extern void unflatten_device_tree(void);
  84 extern void unflatten_and_copy_device_tree(void);
  85 extern void early_init_devtree(void *);
  86 extern void early_get_first_memblock_info(void *, phys_addr_t *);
  87 #else /* CONFIG_OF_EARLY_FLATTREE */
  88 static inline void early_init_dt_check_for_usable_mem_range(void) {}
  89 static inline int early_init_dt_scan_chosen_stdout(void) { return -ENODEV; }
  90 static inline void early_init_fdt_scan_reserved_mem(void) {}
  91 static inline void early_init_fdt_reserve_self(void) {}
  92 static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
  93 static inline void unflatten_device_tree(void) {}
  94 static inline void unflatten_and_copy_device_tree(void) {}
  95 #endif /* CONFIG_OF_EARLY_FLATTREE */
  96
  97 #endif /* __ASSEMBLY__ */
  98 #endif /* _LINUX_OF_FDT_H */