Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-12-26 21:02:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

drivers/of: Improve documentation for match_string

Browse Source 
The description of the function now explicitly states that it's
an *exact* match for the given string (i.e. not a submatch). It also
better states all the possible return values.

Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>
Link: https://lore.kernel.org/r/20240911204938.9172-1-mikisabate@gmail.com
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
This commit is contained in:
Miquel Sabaté Solà 2024-09-11 22:49:38 +02:00 committed by Rob Herring (Arm)
parent 69b860034c
commit 6417edb5d1
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
drivers/of/property.c
View File

@ -452,12 +452,17 @@ EXPORT_SYMBOL_GPL(of_property_read_string);
/** /**
* of_property_match_string() - Find string in a list and return index * of_property_match_string() - Find string in a list and return index
* @np: pointer to node containing string list property * @np: pointer to the node containing the string list property
* @propname: string list property name * @propname: string list property name
* @string: pointer to string to search for in string list * @string: pointer to the string to search for in the string list
* *
* This function searches a string list property and returns the index * Search for an exact match of string in a device node property which is a
* of a specific string value. * string of lists.
*
* Return: the index of the first occurrence of the string on success, -EINVAL
* if the property does not exist, -ENODATA if the property does not have a
* value, and -EILSEQ if the string is not null-terminated within the length of
* the property data.
*/ */
int of_property_match_string(const struct device_node *np, const char *propname, int of_property_match_string(const struct device_node *np, const char *propname,
const char *string) const char *string)