Commit 7f3fefee authored by Matti Vaittinen's avatar Matti Vaittinen Committed by Rob Herring
Browse files

of: property: Fix documentation for out values 



Property fetching functions which return number of successfully fetched
properties should not state that out-values are only modified if 0 is
returned. Fix this. Also, "pointer to return value" is slightly suboptimal
phrase as "return value" commonly refers to value function returns (not via
arguments). Rather use "pointer to found values".

Signed-off-by: default avatarMatti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Reviewed-by: default avatarFrank Rowand <frowand.list@gmail.com>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent cc57d7da

drivers/of/property.c

+4 −4
Original line number Diff line number Diff line
@@ -164,7 +164,7 @@ EXPORT_SYMBOL_GPL(of_property_read_u64_index); 
 *

 * @np:		device node from which the property value is to be read.

 * @propname:	name of the property to be searched.

 * @out_values:	pointer to return value, modified only if return value is 0.

 * @out_values:	pointer to found values.

 * @sz_min:	minimum number of array elements to read

 * @sz_max:	maximum number of array elements to read, if zero there is no

 *		upper limit on the number of elements in the dts entry but only
@@ -212,7 +212,7 @@ EXPORT_SYMBOL_GPL(of_property_read_variable_u8_array); 
 *

 * @np:		device node from which the property value is to be read.

 * @propname:	name of the property to be searched.

 * @out_values:	pointer to return value, modified only if return value is 0.

 * @out_values:	pointer to found values.

 * @sz_min:	minimum number of array elements to read

 * @sz_max:	maximum number of array elements to read, if zero there is no

 *		upper limit on the number of elements in the dts entry but only
@@ -260,7 +260,7 @@ EXPORT_SYMBOL_GPL(of_property_read_variable_u16_array); 
 *

 * @np:		device node from which the property value is to be read.

 * @propname:	name of the property to be searched.

 * @out_values:	pointer to return value, modified only if return value is 0.

 * @out_values:	pointer to return found values.

 * @sz_min:	minimum number of array elements to read

 * @sz_max:	maximum number of array elements to read, if zero there is no

 *		upper limit on the number of elements in the dts entry but only
@@ -334,7 +334,7 @@ EXPORT_SYMBOL_GPL(of_property_read_u64); 
 *

 * @np:		device node from which the property value is to be read.

 * @propname:	name of the property to be searched.

 * @out_values:	pointer to return value, modified only if return value is 0.

 * @out_values:	pointer to found values.

 * @sz_min:	minimum number of array elements to read

 * @sz_max:	maximum number of array elements to read, if zero there is no

 *		upper limit on the number of elements in the dts entry but only

CRA Git | Maintained and supported by SUSTech CRA and CCSE