nagai/kernel
3
0
Fork 0
forked from mirrors/linux
Code Pull requests Activity

of: dynamic: add lifecycle docbook info to node creation functions

Browse source 
The existing docbook comments for the functions related to creating
a devicetree node do not explain the reference count of a newly
created node, how decrementing the reference count to zero will
free the associated memory, and the caller's responsibility to
call of_node_put() on the node.  Explain what happens when the
reference count is decremented to zero.

Signed-off-by: Frank Rowand <frowand.list@gmail.com>
Link: https://lore.kernel.org/r/20230213185702.395776-8-frowand.list@gmail.com
Signed-off-by: Rob Herring <robh@kernel.org>
This commit is contained in:
Frank Rowand 2023-02-13 12:57:02 -06:00 committed by Rob Herring
parent ec0b7e24d5
commit d9194e009e
2 changed files with 13 additions and 1 deletions
repo.diff.show_diff_stats Download patch file Download diff file Expand all files Collapse all files

3
drivers/of/dynamic.c
View file

@ -443,7 +443,8 @@ struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags)
* another node. The node data are dynamically allocated and all the node * another node. The node data are dynamically allocated and all the node
* flags have the OF_DYNAMIC & OF_DETACHED bits set. * flags have the OF_DYNAMIC & OF_DETACHED bits set.
* *
* Return: The newly allocated node or NULL on out of memory error. * Return: The newly allocated node or NULL on out of memory error. Use
* of_node_put() on it when done to free the memory allocated for it.
*/ */
struct device_node *__of_node_dup(const struct device_node *np, struct device_node *__of_node_dup(const struct device_node *np,
const char *full_name) const char *full_name)

11
include/linux/of.h
View file

@ -100,6 +100,17 @@ struct of_reconfig_data {
struct property *old_prop; struct property *old_prop;
}; };
/**
* of_node_init - initialize a devicetree node
* @node: Pointer to device node that has been created by kzalloc()
* @phandle_name: Name of property holding a phandle value
*
* On return the device_node refcount is set to one. Use of_node_put()
* on @node when done to free the memory allocated for it. If the node
* is NOT a dynamic node the memory will not be freed. The decision of
* whether to free the memory will be done by node->release(), which is
* of_node_release().
*/
/* initialize a node */ /* initialize a node */
extern const struct kobj_type of_node_ktype; extern const struct kobj_type of_node_ktype;
extern const struct fwnode_operations of_fwnode_ops; extern const struct fwnode_operations of_fwnode_ops;