1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 #ifndef _LINUX_OF_PRIVATE_H 3 #define _LINUX_OF_PRIVATE_H 4 /* 5 * Private symbols used by OF support code 6 * 7 * Paul Mackerras August 1996. 8 * Copyright (C) 1996-2005 Paul Mackerras. 9 */ 10 11 #define FDT_ALIGN_SIZE 8 12 #define MAX_RESERVED_REGIONS 64 13 14 /** 15 * struct alias_prop - Alias property in 'aliases' node 16 * @link: List node to link the structure in aliases_lookup list 17 * @alias: Alias property name 18 * @np: Pointer to device_node that the alias stands for 19 * @id: Index value from end of alias name 20 * @stem: Alias string without the index 21 * 22 * The structure represents one alias property of 'aliases' node as 23 * an entry in aliases_lookup list. 24 */ 25 struct alias_prop { 26 struct list_head link; 27 const char *alias; 28 struct device_node *np; 29 int id; 30 char stem[]; 31 }; 32 33 #if defined(CONFIG_SPARC) 34 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 2 35 #else 36 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1 37 #endif 38 39 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1 40 41 extern struct mutex of_mutex; 42 extern raw_spinlock_t devtree_lock; 43 extern struct list_head aliases_lookup; 44 extern struct kset *of_kset; 45 46 #if defined(CONFIG_OF_DYNAMIC) 47 extern int of_property_notify(int action, struct device_node *np, 48 struct property *prop, struct property *old_prop); 49 extern void of_node_release(struct kobject *kobj); 50 extern int __of_changeset_apply_entries(struct of_changeset *ocs, 51 int *ret_revert); 52 extern int __of_changeset_apply_notify(struct of_changeset *ocs); 53 extern int __of_changeset_revert_entries(struct of_changeset *ocs, 54 int *ret_apply); 55 extern int __of_changeset_revert_notify(struct of_changeset *ocs); 56 #else /* CONFIG_OF_DYNAMIC */ 57 static inline int of_property_notify(int action, struct device_node *np, 58 struct property *prop, struct property *old_prop) 59 { 60 return 0; 61 } 62 #endif /* CONFIG_OF_DYNAMIC */ 63 64 #if defined(CONFIG_OF_DYNAMIC) && defined(CONFIG_OF_ADDRESS) 65 void of_platform_register_reconfig_notifier(void); 66 #else 67 static inline void of_platform_register_reconfig_notifier(void) { } 68 #endif 69 70 #if defined(CONFIG_OF_KOBJ) 71 int of_node_is_attached(const struct device_node *node); 72 int __of_add_property_sysfs(struct device_node *np, struct property *pp); 73 void __of_remove_property_sysfs(struct device_node *np, const struct property *prop); 74 void __of_update_property_sysfs(struct device_node *np, struct property *newprop, 75 const struct property *oldprop); 76 int __of_attach_node_sysfs(struct device_node *np); 77 void __of_detach_node_sysfs(struct device_node *np); 78 #else 79 static inline int __of_add_property_sysfs(struct device_node *np, struct property *pp) 80 { 81 return 0; 82 } 83 static inline void __of_remove_property_sysfs(struct device_node *np, const struct property *prop) {} 84 static inline void __of_update_property_sysfs(struct device_node *np, 85 struct property *newprop, const struct property *oldprop) {} 86 static inline int __of_attach_node_sysfs(struct device_node *np) 87 { 88 return 0; 89 } 90 static inline void __of_detach_node_sysfs(struct device_node *np) {} 91 #endif 92 93 #if defined(CONFIG_OF_RESOLVE) 94 int of_resolve_phandles(struct device_node *tree); 95 #endif 96 97 void __of_phandle_cache_inv_entry(phandle handle); 98 99 #if defined(CONFIG_OF_OVERLAY) 100 void of_overlay_mutex_lock(void); 101 void of_overlay_mutex_unlock(void); 102 #else 103 static inline void of_overlay_mutex_lock(void) {}; 104 static inline void of_overlay_mutex_unlock(void) {}; 105 #endif 106 107 #if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY) 108 extern void __init unittest_unflatten_overlay_base(void); 109 #else 110 static inline void unittest_unflatten_overlay_base(void) {}; 111 #endif 112 113 extern void *__unflatten_device_tree(const void *blob, 114 struct device_node *dad, 115 struct device_node **mynodes, 116 void *(*dt_alloc)(u64 size, u64 align), 117 bool detached); 118 119 /** 120 * General utilities for working with live trees. 121 * 122 * All functions with two leading underscores operate 123 * without taking node references, so you either have to 124 * own the devtree lock or work on detached trees only. 125 */ 126 struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags); 127 void __of_prop_free(struct property *prop); 128 struct device_node *__of_node_dup(const struct device_node *np, 129 const char *full_name); 130 131 struct device_node *__of_find_node_by_path(const struct device_node *parent, 132 const char *path); 133 struct device_node *__of_find_node_by_full_path(struct device_node *node, 134 const char *path); 135 136 extern const void *__of_get_property(const struct device_node *np, 137 const char *name, int *lenp); 138 extern int __of_add_property(struct device_node *np, struct property *prop); 139 extern int __of_remove_property(struct device_node *np, struct property *prop); 140 extern int __of_update_property(struct device_node *np, 141 struct property *newprop, struct property **oldprop); 142 143 extern void __of_detach_node(struct device_node *np); 144 145 extern void __of_sysfs_remove_bin_file(struct device_node *np, 146 const struct property *prop); 147 148 /* illegal phandle value (set when unresolved) */ 149 #define OF_PHANDLE_ILLEGAL 0xdeadbeef 150 151 /* iterators for transactions, used for overlays */ 152 /* forward iterator */ 153 #define for_each_transaction_entry(_oft, _te) \ 154 list_for_each_entry(_te, &(_oft)->te_list, node) 155 156 /* reverse iterator */ 157 #define for_each_transaction_entry_reverse(_oft, _te) \ 158 list_for_each_entry_reverse(_te, &(_oft)->te_list, node) 159 160 extern int of_bus_n_addr_cells(struct device_node *np); 161 extern int of_bus_n_size_cells(struct device_node *np); 162 163 const __be32 *of_irq_parse_imap_parent(const __be32 *imap, int len, 164 struct of_phandle_args *out_irq); 165 166 struct bus_dma_region; 167 #if defined(CONFIG_OF_ADDRESS) && defined(CONFIG_HAS_DMA) 168 int of_dma_get_range(struct device_node *np, 169 const struct bus_dma_region **map); 170 struct device_node *__of_get_dma_parent(const struct device_node *np); 171 #else 172 static inline int of_dma_get_range(struct device_node *np, 173 const struct bus_dma_region **map) 174 { 175 return -ENODEV; 176 } 177 static inline struct device_node *__of_get_dma_parent(const struct device_node *np) 178 { 179 return of_get_parent(np); 180 } 181 #endif 182 183 int fdt_scan_reserved_mem(void); 184 void __init fdt_scan_reserved_mem_reg_nodes(void); 185 186 bool of_fdt_device_is_available(const void *blob, unsigned long node); 187 188 #endif /* _LINUX_OF_PRIVATE_H */ 189