drivers/of/of_private.h

   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 /**
  12  * struct alias_prop - Alias property in 'aliases' node
  13  * @link:       List node to link the structure in aliases_lookup list
  14  * @alias:      Alias property name
  15  * @np:         Pointer to device_node that the alias stands for
  16  * @id:         Index value from end of alias name
  17  * @stem:       Alias string without the index
  18  *
  19  * The structure represents one alias property of 'aliases' node as
  20  * an entry in aliases_lookup list.
  21  */
  22 struct alias_prop {
  23         struct list_head link;
  24         const char *alias;
  25         struct device_node *np;
  26         int id;
  27         char stem[0];
  28 };
  29
  30 extern struct mutex of_mutex;
  31 extern struct list_head aliases_lookup;
  32 extern struct kset *of_kset;
  33
  34 #if defined(CONFIG_OF_DYNAMIC)
  35 extern int of_property_notify(int action, struct device_node *np,
  36                               struct property *prop, struct property *old_prop);
  37 extern void of_node_release(struct kobject *kobj);
  38 extern int __of_changeset_apply_entries(struct of_changeset *ocs,
  39                                         int *ret_revert);
  40 extern int __of_changeset_apply_notify(struct of_changeset *ocs);
  41 extern int __of_changeset_revert_entries(struct of_changeset *ocs,
  42                                          int *ret_apply);
  43 extern int __of_changeset_revert_notify(struct of_changeset *ocs);
  44 #else /* CONFIG_OF_DYNAMIC */
  45 static inline int of_property_notify(int action, struct device_node *np,
  46                                      struct property *prop, struct property *old_prop)
  47 {
  48         return 0;
  49 }
  50 #endif /* CONFIG_OF_DYNAMIC */
  51
  52 #if defined(CONFIG_OF_KOBJ)
  53 int of_node_is_attached(struct device_node *node);
  54 int __of_add_property_sysfs(struct device_node *np, struct property *pp);
  55 void __of_remove_property_sysfs(struct device_node *np, struct property *prop);
  56 void __of_update_property_sysfs(struct device_node *np, struct property *newprop,
  57                 struct property *oldprop);
  58 int __of_attach_node_sysfs(struct device_node *np);
  59 void __of_detach_node_sysfs(struct device_node *np);
  60 #else
  61 static inline int __of_add_property_sysfs(struct device_node *np, struct property *pp)
  62 {
  63         return 0;
  64 }
  65 static inline void __of_remove_property_sysfs(struct device_node *np, struct property *prop) {}
  66 static inline void __of_update_property_sysfs(struct device_node *np,
  67                 struct property *newprop, struct property *oldprop) {}
  68 static inline int __of_attach_node_sysfs(struct device_node *np)
  69 {
  70         return 0;
  71 }
  72 static inline void __of_detach_node_sysfs(struct device_node *np) {}
  73 #endif
  74
  75 #if defined(CONFIG_OF_RESOLVE)
  76 int of_resolve_phandles(struct device_node *tree);
  77 #endif
  78
  79 #if defined(CONFIG_OF_DYNAMIC)
  80 void __of_free_phandle_cache_entry(phandle handle);
  81 #endif
  82
  83 #if defined(CONFIG_OF_OVERLAY)
  84 void of_overlay_mutex_lock(void);
  85 void of_overlay_mutex_unlock(void);
  86 int of_free_phandle_cache(void);
  87 void of_populate_phandle_cache(void);
  88 #else
  89 static inline void of_overlay_mutex_lock(void) {};
  90 static inline void of_overlay_mutex_unlock(void) {};
  91 #endif
  92
  93 #if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
  94 extern void __init unittest_unflatten_overlay_base(void);
  95 #else
  96 static inline void unittest_unflatten_overlay_base(void) {};
  97 #endif
  98
  99 extern void *__unflatten_device_tree(const void *blob,
 100                               struct device_node *dad,
 101                               struct device_node **mynodes,
 102                               void *(*dt_alloc)(u64 size, u64 align),
 103                               bool detached);
 104
 105 /**
 106  * General utilities for working with live trees.
 107  *
 108  * All functions with two leading underscores operate
 109  * without taking node references, so you either have to
 110  * own the devtree lock or work on detached trees only.
 111  */
 112 struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
 113 struct device_node *__of_node_dup(const struct device_node *np,
 114                                   const char *full_name);
 115
 116 struct device_node *__of_find_node_by_path(struct device_node *parent,
 117                                                 const char *path);
 118 struct device_node *__of_find_node_by_full_path(struct device_node *node,
 119                                                 const char *path);
 120
 121 extern const void *__of_get_property(const struct device_node *np,
 122                                      const char *name, int *lenp);
 123 extern int __of_add_property(struct device_node *np, struct property *prop);
 124 extern int __of_add_property_sysfs(struct device_node *np,
 125                 struct property *prop);
 126 extern int __of_remove_property(struct device_node *np, struct property *prop);
 127 extern void __of_remove_property_sysfs(struct device_node *np,
 128                 struct property *prop);
 129 extern int __of_update_property(struct device_node *np,
 130                 struct property *newprop, struct property **oldprop);
 131 extern void __of_update_property_sysfs(struct device_node *np,
 132                 struct property *newprop, struct property *oldprop);
 133
 134 extern int __of_attach_node_sysfs(struct device_node *np);
 135 extern void __of_detach_node(struct device_node *np);
 136 extern void __of_detach_node_sysfs(struct device_node *np);
 137
 138 extern void __of_sysfs_remove_bin_file(struct device_node *np,
 139                                        struct property *prop);
 140
 141 /* illegal phandle value (set when unresolved) */
 142 #define OF_PHANDLE_ILLEGAL      0xdeadbeef
 143
 144 /* iterators for transactions, used for overlays */
 145 /* forward iterator */
 146 #define for_each_transaction_entry(_oft, _te) \
 147         list_for_each_entry(_te, &(_oft)->te_list, node)
 148
 149 /* reverse iterator */
 150 #define for_each_transaction_entry_reverse(_oft, _te) \
 151         list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
 152
 153 #endif /* _LINUX_OF_PRIVATE_H */