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