Skip to contentSkip to conversation

drivers/of: Improve documentation on match string

PATCH In review Miquel Sabaté Solà 2 participants 3 messages Sep 10, 2024 – Sep 11, 2024 Device tree

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drivers/of: Improve documentation on 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.

Moreover, this commit also makes sure that -ENODATA is returned if prop->length is zero, just like it's done in other functions such as 'of_property_read_string'.

---
 drivers/of/property.c | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)
drivers/of/property.c +10 -5
index 164d77cb9445..1ff51d93178f 100644
@@ -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
+ * list of strings.
+ *
+ * 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)
@@ -469,7 +474,7 @@ int of_property_match_string(const struct device_node *np, const char *propname,
 
 	if (!prop)
 		return -EINVAL;
-	if (!prop->value)
+	if (!prop->value || !prop->length)
 		return -ENODATA;
 
 	p = prop->value;

--
2.46.0

maintainer
#1 lore raw
Quoted 7 lines · Miquel Sabaté Solà

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.

Moreover, this commit also makes sure that -ENODATA is returned if prop->length is zero, just like it's done in other functions such as 'of_property_read_string'.

'also' in a commit message is a sign this should be 2 commits. However, more below.

Quoted 33 lines
---
 drivers/of/property.c | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)
drivers/of/property.c +9 -4
index 164d77cb9445..1ff51d93178f 100644
@@ -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
+ * list of strings.
+ *
+ * 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)

drivers/of/property.c int of_property_match_string(const struct device_node *np, const char *propname, · line 477

Quoted 5 lines
drivers/of/property.c +1 -1
@@ -469,7 +474,7 @@ int of_property_match_string(const struct device_node *np, const char *propname,
 
 	if (!prop)
 		return -EINVAL;
-	if (!prop->value)
+	if (!prop->value || !prop->length)

This is redundant. If length is 0, then 'end' will be equal to p and we'll return -ENODATA.

Quoted 6 lines
drivers/of/property.c +0 -1
 		return -ENODATA;
 
 	p = prop->value;
--

2.46.0

#2 lore raw
Quoted 46 lines · Rob Herring
Quoted 7 lines · Miquel Sabaté Solà

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.

Moreover, this commit also makes sure that -ENODATA is returned if prop->length is zero, just like it's done in other functions such as 'of_property_read_string'.

'also' in a commit message is a sign this should be 2 commits. However, more below.

Quoted 34 lines
---
 drivers/of/property.c | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)
drivers/of/property.c +9 -4
index 164d77cb9445..1ff51d93178f 100644
@@ -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
+ * list of strings.
+ *
+ * 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)
@@ -469,7 +474,7 @@ int of_property_match_string(const struct device_node *np, const char *propname,
 
Quoted 8 lines

drivers/of/property.c int of_property_match_string(const struct device_node *np, const char *propname, · line 477

Quoted 4 lines
drivers/of/property.c +1 -1
 	if (!prop)
 		return -EINVAL;
-	if (!prop->value)
+	if (!prop->value || !prop->length)

This is redundant. If length is 0, then 'end' will be equal to p and we'll return -ENODATA.

Yikes, I missed it... You are totally right, sorry about that.

Quoted 6 lines
Quoted 6 lines
drivers/of/property.c +0 -1
 		return -ENODATA;
 
 	p = prop->value;
--

2.46.0

Thanks for the review. I will submit a new version of the patch just with the documentation part.

Thanks!
Miquel