Commit 6417edb5 authored by Miquel Sabaté Solà's avatar Miquel Sabaté Solà Committed by Rob Herring (Arm)
Browse files

drivers/of: Improve documentation for match_string 



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: default avatarMiquel Sabaté Solà <mikisabate@gmail.com>
Link: https://lore.kernel.org/r/20240911204938.9172-1-mikisabate@gmail.com


Signed-off-by: default avatarRob Herring (Arm) <robh@kernel.org>
parent 69b86003

drivers/of/property.c

+9 −4
Original line number Diff line number Diff line
@@ -452,12 +452,17 @@ EXPORT_SYMBOL_GPL(of_property_read_string); 


/**

 * 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

 * @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

 * of a specific string value.

 * Search for an exact match of string in a device node property which is a

 * 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,

			     const char *string)