GitHub-Mirror/u-boot
2
0
Fork 0
mirror of https://github.com/Fishwaldo/u-boot.git synced 2025-03-21 06:31:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

dm: core: Fix up string-function documentation

Browse source 
The details for of_property_read_string_helper() and
ofnode_read_string_index() are a little inaccurate. Fix up the comments to
avoid confusion.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2021-10-23 17:26:06 -06:00
parent 8044318305
commit 32c6a8e1f8
2 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
drivers/core/of_access.c
View file

@ -581,7 +581,8 @@ int of_property_match_string(const struct device_node *np, const char *propname,
* @propname: name of the property to be searched. * @propname: name of the property to be searched.
* @out_strs: output array of string pointers. * @out_strs: output array of string pointers.
* @sz: number of array elements to read. * @sz: number of array elements to read.
* @skip: Number of strings to skip over at beginning of list. * @skip: Number of strings to skip over at beginning of list (cannot be
* negative)
* *
* Don't call this function directly. It is a utility helper for the * Don't call this function directly. It is a utility helper for the
* of_property_read_string*() family of functions. * of_property_read_string*() family of functions.

4
include/dm/ofnode.h
View file

@ -590,11 +590,11 @@ int ofnode_stringlist_search(ofnode node, const char *propname,
* *
* @node: node to check * @node: node to check
* @propname: name of the property containing the string list * @propname: name of the property containing the string list
* @index: index of the string to return * @index: index of the string to return (cannot be negative)
* @lenp: return location for the string length or an error code on failure * @lenp: return location for the string length or an error code on failure
* *
* @return: * @return:
* length of string, if found or -ve error value if not found * 0 if found or -ve error value if not found
*/ */
int ofnode_read_string_index(ofnode node, const char *propname, int index, int ofnode_read_string_index(ofnode node, const char *propname, int index,
const char **outp); const char **outp);