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[];
  28 };
  29
  30 #if defined(CONFIG_SPARC)
  31 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 2
  32 #else
  33 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
  34 #endif
  35
  36 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
  37
  38 extern struct mutex of_mutex;
  39 extern struct list_head aliases_lookup;
  40 extern struct kset *of_kset;
  41
  42 #if defined(CONFIG_OF_DYNAMIC)
  43 extern int of_property_notify(int action, struct device_node *np,
  44                               struct property *prop, struct property *old_prop);
  45 extern void of_node_release(struct kobject *kobj);
  46 extern int __of_changeset_apply_entries(struct of_changeset *ocs,
  47                                         int *ret_revert);
  48 extern int __of_changeset_apply_notify(struct of_changeset *ocs);
  49 extern int __of_changeset_revert_entries(struct of_changeset *ocs,
  50                                          int *ret_apply);
  51 extern int __of_changeset_revert_notify(struct of_changeset *ocs);
  52 #else /* CONFIG_OF_DYNAMIC */
  53 static inline int of_property_notify(int action, struct device_node *np,
  54                                      struct property *prop, struct property *old_prop)
  55 {
  56         return 0;
  57 }
  58 #endif /* CONFIG_OF_DYNAMIC */
  59
  60 #if defined(CONFIG_OF_KOBJ)
  61 int of_node_is_attached(struct device_node *node);
  62 int __of_add_property_sysfs(struct device_node *np, struct property *pp);
  63 void __of_remove_property_sysfs(struct device_node *np, struct property *prop);
  64 void __of_update_property_sysfs(struct device_node *np, struct property *newprop,
  65                 struct property *oldprop);
  66 int __of_attach_node_sysfs(struct device_node *np);
  67 void __of_detach_node_sysfs(struct device_node *np);
  68 #else
  69 static inline int __of_add_property_sysfs(struct device_node *np, struct property *pp)
  70 {
  71         return 0;
  72 }
  73 static inline void __of_remove_property_sysfs(struct device_node *np, struct property *prop) {}
  74 static inline void __of_update_property_sysfs(struct device_node *np,
  75                 struct property *newprop, struct property *oldprop) {}
  76 static inline int __of_attach_node_sysfs(struct device_node *np)
  77 {
  78         return 0;
  79 }
  80 static inline void __of_detach_node_sysfs(struct device_node *np) {}
  81 #endif
  82
  83 #if defined(CONFIG_OF_RESOLVE)
  84 int of_resolve_phandles(struct device_node *tree);
  85 #endif
  86
  87 void __of_phandle_cache_inv_entry(phandle handle);
  88
  89 #if defined(CONFIG_OF_OVERLAY)
  90 void of_overlay_mutex_lock(void);
  91 void of_overlay_mutex_unlock(void);
  92 #else
  93 static inline void of_overlay_mutex_lock(void) {};
  94 static inline void of_overlay_mutex_unlock(void) {};
  95 #endif
  96
  97 #if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
  98 extern void __init unittest_unflatten_overlay_base(void);
  99 #else
 100 static inline void unittest_unflatten_overlay_base(void) {};
 101 #endif
 102
 103 extern void *__unflatten_device_tree(const void *blob,
 104                               struct device_node *dad,
 105                               struct device_node **mynodes,
 106                               void *(*dt_alloc)(u64 size, u64 align),
 107                               bool detached);
 108
 109 /**
 110  * General utilities for working with live trees.
 111  *
 112  * All functions with two leading underscores operate
 113  * without taking node references, so you either have to
 114  * own the devtree lock or work on detached trees only.
 115  */
 116 struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
 117 struct device_node *__of_node_dup(const struct device_node *np,
 118                                   const char *full_name);
 119
 120 struct device_node *__of_find_node_by_path(struct device_node *parent,
 121                                                 const char *path);
 122 struct device_node *__of_find_node_by_full_path(struct device_node *node,
 123                                                 const char *path);
 124
 125 extern const void *__of_get_property(const struct device_node *np,
 126                                      const char *name, int *lenp);
 127 extern int __of_add_property(struct device_node *np, struct property *prop);
 128 extern int __of_add_property_sysfs(struct device_node *np,
 129                 struct property *prop);
 130 extern int __of_remove_property(struct device_node *np, struct property *prop);
 131 extern void __of_remove_property_sysfs(struct device_node *np,
 132                 struct property *prop);
 133 extern int __of_update_property(struct device_node *np,
 134                 struct property *newprop, struct property **oldprop);
 135 extern void __of_update_property_sysfs(struct device_node *np,
 136                 struct property *newprop, struct property *oldprop);
 137
 138 extern int __of_attach_node_sysfs(struct device_node *np);
 139 extern void __of_detach_node(struct device_node *np);
 140 extern void __of_detach_node_sysfs(struct device_node *np);
 141
 142 extern void __of_sysfs_remove_bin_file(struct device_node *np,
 143                                        struct property *prop);
 144
 145 /* illegal phandle value (set when unresolved) */
 146 #define OF_PHANDLE_ILLEGAL      0xdeadbeef
 147
 148 /* iterators for transactions, used for overlays */
 149 /* forward iterator */
 150 #define for_each_transaction_entry(_oft, _te) \
 151         list_for_each_entry(_te, &(_oft)->te_list, node)
 152
 153 /* reverse iterator */
 154 #define for_each_transaction_entry_reverse(_oft, _te) \
 155         list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
 156
 157 extern int of_bus_n_addr_cells(struct device_node *np);
 158 extern int of_bus_n_size_cells(struct device_node *np);
 159
 160 struct bus_dma_region;
 161 #if defined(CONFIG_OF_ADDRESS) && defined(CONFIG_HAS_DMA)
 162 int of_dma_get_range(struct device_node *np,
 163                 const struct bus_dma_region **map);
 164 #else
 165 static inline int of_dma_get_range(struct device_node *np,
 166                 const struct bus_dma_region **map)
 167 {
 168         return -ENODEV;
 169 }
 170 #endif
 171
 172 #endif /* _LINUX_OF_PRIVATE_H */