dany/u-boot-megous
1
0
Fork 0
mirror of https://xff.cz/git/u-boot/ synced 2025-11-01 19:05:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: add include/dm/of*.h to the HTML documentation

Browse Source 
Correct Sphinx style comments in include/dm/ofnode.h
and add the device tree node API to the HTML documentation;
the ofnode functions are compatible with Live tree or with flat
device tree.

Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Patrick Delaunay
2022-01-12 10:53:49 +01:00
committed by Heinrich Schuchardt
parent 6de6a615f8
commit be74f71a67
6 changed files with 297 additions and 275 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
include/dm/of_access.h
View File

@@ -44,7 +44,7 @@ static inline void of_node_put(const struct device_node *np) { }
* which controls the given node.
*
* @np: Node pointer to check
* @return number of address cells this node uses
* Return: number of address cells this node uses
*/
int of_n_addr_cells(const struct device_node *np);
@@ -55,7 +55,7 @@ int of_n_addr_cells(const struct device_node *np);
* which controls the given node.
*
* @np: Node pointer to check
* @return number of size cells this node uses
* Return: number of size cells this node uses
*/
int of_n_size_cells(const struct device_node *np);
@@ -65,7 +65,7 @@ int of_n_size_cells(const struct device_node *np);
* This function matches fdt_address_cells().
*
* @np: Node pointer to check
* @return value of #address-cells property in this node, or 2 if none
* Return: value of #address-cells property in this node, or 2 if none
*/
int of_simple_addr_cells(const struct device_node *np);
@@ -75,7 +75,7 @@ int of_simple_addr_cells(const struct device_node *np);
* This function matches fdt_size_cells().
*
* @np: Node pointer to check
* @return value of #size-cells property in this node, or 2 if none
* Return: value of #size-cells property in this node, or 2 if none
*/
int of_simple_size_cells(const struct device_node *np);
@@ -85,7 +85,7 @@ int of_simple_size_cells(const struct device_node *np);
* @np: Pointer to device node holding property
* @name: Name of property
* @lenp: If non-NULL, returns length of property
* @return pointer to property, or NULL if not found
* Return: pointer to property, or NULL if not found
*/
struct property *of_find_property(const struct device_node *np,
const char *name, int *lenp);
@@ -98,7 +98,7 @@ struct property *of_find_property(const struct device_node *np,
* @np: Pointer to device node holding property
* @name: Name of property
* @lenp: If non-NULL, returns length of property
* @return pointer to property value, or NULL if not found
* Return: pointer to property value, or NULL if not found
*/
const void *of_get_property(const struct device_node *np, const char *name,
int *lenp);
@@ -110,7 +110,7 @@ const void *of_get_property(const struct device_node *np, const char *name,
* and read all the property with of_get_next_property_by_prop().
*
* @np: Pointer to device node
* @return pointer to property or NULL if not found
* Return: pointer to property or NULL if not found
*/
const struct property *of_get_first_property(const struct device_node *np);
@@ -122,7 +122,7 @@ const struct property *of_get_first_property(const struct device_node *np);
*
* @np: Pointer to device node
* @property: pointer of the current property
* @return pointer to next property or NULL if not found
* Return: pointer to next property or NULL if not found
*/
const struct property *of_get_next_property(const struct device_node *np,
const struct property *property);
@@ -132,11 +132,11 @@ const struct property *of_get_next_property(const struct device_node *np,
*
* Get value for the property identified by node and property pointer.
*
* @node: node to read
* @np: Pointer to device node
* @property: pointer of the property to read
* @propname: place to property name on success
* @name: place to property name on success
* @lenp: place to put length on success
* @return pointer to property value or NULL if error
* Return: pointer to property value or NULL if error
*/
const void *of_get_property_by_prop(const struct device_node *np,
const struct property *property,
@@ -145,7 +145,7 @@ const void *of_get_property_by_prop(const struct device_node *np,
/**
* of_device_is_compatible() - Check if the node matches given constraints
* @device: pointer to node
* @np: Pointer to device node
* @compat: required compatible string, NULL or "" for any match
* @type: required device_type value, NULL or "" for any match
* @name: required node name, NULL or "" for any match
@@ -154,7 +154,7 @@ const void *of_get_property_by_prop(const struct device_node *np,
* properties of the given @device. A constraints can be skipped by
* passing NULL or an empty string as the constraint.
*
* @return 0 for no match, and a positive integer on match. The return
* Return: 0 for no match, and a positive integer on match. The return
* value is a relative score with larger values indicating better
* matches. The score is weighted for the most specific compatible value
* to get the highest score. Matching type is next, followed by matching
@@ -179,9 +179,9 @@ int of_device_is_compatible(const struct device_node *np, const char *compat,
/**
* of_device_is_available() - check if a device is available for use
*
* @device: Node to check for availability
* @np: Pointer to device node to check for availability
*
* @return true if the status property is absent or set to "okay", false
* Return: true if the status property is absent or set to "okay", false
* otherwise
*/
bool of_device_is_available(const struct device_node *np);
@@ -189,8 +189,8 @@ bool of_device_is_available(const struct device_node *np);
/**
* of_get_parent() - Get a node's parent, if any
*
* @node: Node to check
* @eturns a node pointer, or NULL if none
* @np: Pointer to device node to check
* Return: a node pointer, or NULL if none
*/
struct device_node *of_get_parent(const struct device_node *np);
@@ -208,7 +208,7 @@ struct device_node *of_get_parent(const struct device_node *np);
* foo Valid alias
* foo/bar Valid alias + relative path
*
* @return a node pointer or NULL if not found
* Return: a node pointer or NULL if not found
*/
struct device_node *of_find_node_opts_by_path(const char *path,
const char **opts);
@@ -228,7 +228,7 @@ static inline struct device_node *of_find_node_by_path(const char *path)
* @type: The type string to match "device_type" or NULL to ignore
* @compatible: The string to match to one of the tokens in the device
* "compatible" list.
* @return node pointer or NULL if not found
* Return: node pointer or NULL if not found
*/
struct device_node *of_find_compatible_node(struct device_node *from,
const char *type, const char *compatible);
@@ -243,7 +243,7 @@ struct device_node *of_find_compatible_node(struct device_node *from,
* @propname: property name to check
* @propval: property value to search for
* @proplen: length of the value in propval
* @return node pointer or NULL if not found
* Return: node pointer or NULL if not found
*/
struct device_node *of_find_node_by_prop_value(struct device_node *from,
const char *propname,
@@ -254,7 +254,7 @@ struct device_node *of_find_node_by_prop_value(struct device_node *from,
*
* @handle: phandle of the node to find
*
* @return node pointer, or NULL if not found
* Return: node pointer, or NULL if not found
*/
struct device_node *of_find_node_by_phandle(phandle handle);
@@ -268,7 +268,7 @@ struct device_node *of_find_node_by_phandle(phandle handle);
* @propname: name of the property to be searched.
* @outp: pointer to return value, modified only if return value is 0.
*
* @return 0 on success, -EINVAL if the property does not exist,
* Return: 0 on success, -EINVAL if the property does not exist,
* -ENODATA if property does not have a value, and -EOVERFLOW if the
* property data isn't large enough.
*/
@@ -286,9 +286,10 @@ int of_read_u32(const struct device_node *np, const char *propname, u32 *outp);
* @index: index of the u32 in the list of values
* @outp: pointer to return value, modified only if return value is 0.
*
* @return 0 on success, -EINVAL if the property does not exist,
* -ENODATA if property does not have a value, and -EOVERFLOW if the
* property data isn't large enough.
* Return:
* 0 on success, -EINVAL if the property does not exist,
* -ENODATA if property does not have a value, and -EOVERFLOW if the
* property data isn't large enough.
*/
int of_read_u32_index(const struct device_node *np, const char *propname,
int index, u32 *outp);
@@ -303,9 +304,10 @@ int of_read_u32_index(const struct device_node *np, const char *propname,
* @propname: name of the property to be searched.
* @outp: pointer to return value, modified only if return value is 0.
*
* @return 0 on success, -EINVAL if the property does not exist,
* -ENODATA if property does not have a value, and -EOVERFLOW if the
* property data isn't large enough.
* Return:
* 0 on success, -EINVAL if the property does not exist,
* -ENODATA if property does not have a value, and -EOVERFLOW if the
* property data isn't large enough.
*/
int of_read_u64(const struct device_node *np, const char *propname, u64 *outp);
@@ -319,8 +321,9 @@ int of_read_u64(const struct device_node *np, const char *propname, u64 *outp);
* @propname: name of the property to be searched.
* @out_values: pointer to return value, modified only if return value is 0.
* @sz: number of array elements to read
* @return 0 on success, -EINVAL if the property does not exist, -ENODATA
* if property does not have a value, and -EOVERFLOW is longer than sz.
* Return:
* 0 on success, -EINVAL if the property does not exist, -ENODATA
* if property does not have a value, and -EOVERFLOW is longer than sz.
*/
int of_read_u32_array(const struct device_node *np, const char *propname,
u32 *out_values, size_t sz);
@@ -334,8 +337,9 @@ int of_read_u32_array(const struct device_node *np, const char *propname,
* @np: pointer to node containing string list property
* @propname: string list property name
* @string: pointer to string to search for in string list
* @return 0 on success, -EINVAL if the property does not exist, -ENODATA
* if property does not have a value, and -EOVERFLOW is longer than sz.
* Return:
* 0 on success, -EINVAL if the property does not exist, -ENODATA
* if property does not have a value, and -EOVERFLOW is longer than sz.
*/
int of_property_match_string(const struct device_node *np, const char *propname,
const char *string);
@@ -350,15 +354,17 @@ int of_property_read_string_helper(const struct device_node *np,
* @np: device node from which the property value is to be read.
* @propname: name of the property to be searched.
* @index: index of the string in the list of strings
* @out_string: pointer to null terminated return string, modified only if
* @output: pointer to null terminated return string, modified only if
* return value is 0.
*
* Search for a property in a device tree node and retrieve a null
* terminated string value (pointer to data, not a copy) in the list of strings
* contained in that property.
* Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
* property does not have a value, and -EILSEQ if the string is not
* null-terminated within the length of the property data.
*
* Return:
* 0 on success, -EINVAL if the property does not exist, -ENODATA if
* property does not have a value, and -EILSEQ if the string is not
* null-terminated within the length of the property data.
*
* The out_string pointer is modified only if a valid string can be decoded.
*/
@@ -377,10 +383,12 @@ static inline int of_property_read_string_index(const struct device_node *np,
* @propname: name of the property to be searched.
*
* Search for a property in a device tree node and retrieve the number of null
* terminated string contain in it. Returns the number of strings on
* success, -EINVAL if the property does not exist, -ENODATA if property
* does not have a value, and -EILSEQ if the string is not null-terminated
* within the length of the property data.
* terminated string contain in it.
*
* Return:
* the number of strings on success, -EINVAL if the property does not exist,
* -ENODATA if property does not have a value, and -EILSEQ if the string is
* not null-terminated within the length of the property data.
*/
static inline int of_property_count_strings(const struct device_node *np,
const char *propname)
@@ -395,8 +403,9 @@ static inline int of_property_count_strings(const struct device_node *np,
* @index: For properties holding a table of phandles, this is the index into
* the table
*
* Returns the device_node pointer with refcount incremented. Use
* of_node_put() on it when done.
* Return:
* the device_node pointer with refcount incremented. Use
* of_node_put() on it when done.
*/
struct device_node *of_parse_phandle(const struct device_node *np,
const char *phandle_name, int index);
@@ -410,10 +419,11 @@ struct device_node *of_parse_phandle(const struct device_node *np,
* @cells_count: Cell count to use if @cells_name is NULL
* @index: index of a phandle to parse out
* @out_args: optional pointer to output arguments structure (will be filled)
* @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
* @list_name does not exist, -EINVAL if a phandle was not found,
* @cells_name could not be found, the arguments were truncated or there
* were too many arguments.
* Return:
* 0 on success (with @out_args filled out if not NULL), -ENOENT if
* @list_name does not exist, -EINVAL if a phandle was not found,
* @cells_name could not be found, the arguments were truncated or there
* were too many arguments.
*
* This function is useful to parse lists of phandles and their arguments.
* Returns 0 on success and fills out_args, on error returns appropriate
@@ -424,17 +434,17 @@ struct device_node *of_parse_phandle(const struct device_node *np,
*
* Example:
*
* phandle1: node1 {
* #list-cells = <2>;
* }
* .. code-block::
*
* phandle2: node2 {
* #list-cells = <1>;
* }
*
* node3 {
* list = <&phandle1 1 2 &phandle2 3>;
* }
* phandle1: node1 {
* #list-cells = <2>;
* };
* phandle2: node2 {
* #list-cells = <1>;
* };
* node3 {
* list = <&phandle1 1 2 &phandle2 3>;
* };
*
* To get a device_node of the `node2' node you may call this:
* of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args);
@@ -451,14 +461,13 @@ int of_parse_phandle_with_args(const struct device_node *np,
* @list_name: property name that contains a list
* @cells_name: property name that specifies phandles' arguments count
* @cells_count: Cell count to use if @cells_name is NULL
* @return number of phandle found, -ENOENT if
* @list_name does not exist, -EINVAL if a phandle was not found,
* @cells_name could not be found, the arguments were truncated or there
* were too many arguments.
* Return:
* number of phandle found, -ENOENT if @list_name does not exist,
* -EINVAL if a phandle was not found, @cells_name could not be found,
* the arguments were truncated or there were too many arguments.
*
* Returns number of phandle found on success, on error returns appropriate
* errno value.
*
*/
int of_count_phandle_with_args(const struct device_node *np,
const char *list_name, const char *cells_name,
@@ -471,7 +480,7 @@ int of_count_phandle_with_args(const struct device_node *np,
* the lookup table with the properties. It returns the number of alias
* properties found, or an error code in case of failure.
*
* @return 9 if OK, -ENOMEM if not enough memory
* Return: 9 if OK, -ENOMEM if not enough memory
*/
int of_alias_scan(void);
@@ -483,7 +492,7 @@ int of_alias_scan(void);
*
* @np: Pointer to the given device_node
* @stem: Alias stem of the given device_node
* @return alias ID, if found, else -ENODEV
* Return: alias ID, if found, else -ENODEV
*/
int of_alias_get_id(const struct device_node *np, const char *stem);
@@ -493,14 +502,14 @@ int of_alias_get_id(const struct device_node *np, const char *stem);
*
* The function travels the lookup table to get the highest alias id for the
* given alias stem.
* @return alias ID, if found, else -1
* Return: alias ID, if found, else -1
*/
int of_alias_get_highest_id(const char *stem);
/**
* of_get_stdout() - Get node to use for stdout
*
* @return node referred to by stdout-path alias, or NULL if none
* Return: node referred to by stdout-path alias, or NULL if none
*/
struct device_node *of_get_stdout(void);