Commit 70fa0c30 authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Greg Kroah-Hartman
Browse files

device property: Document how to check for the property presence 



Currently it's unclear if one may or may not rely on the error codes
returned from the property getters to check for the property presence.
Clarify this by updating kernel-doc for fwnode_property_*() and
device_property_*() where it's applicable.

Reported-by: default avatarGuenter Roeck <linux@roeck-us.net>
Closes: https://lore.kernel.org/r/4b24f1f4-b395-467a-81b7-1334a2d48845@roeck-us.net


Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Link: https://patch.msgid.link/20260318142404.2526642-1-andriy.shevchenko@linux.intel.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 7215e455

drivers/base/property.c

+11 −3
Original line number Diff line number Diff line
@@ -38,6 +38,8 @@ EXPORT_SYMBOL_GPL(__dev_fwnode_const); 
 * @propname: Name of the property

 *

 * Check if property @propname is present in the device firmware description.

 * This function is the unambiguous way to check that given property is present

 * in the device firmware description.

 *

 * Return: true if property @propname is present. Otherwise, returns false.

 */
@@ -52,6 +54,10 @@ EXPORT_SYMBOL_GPL(device_property_present); 
 * @fwnode: Firmware node whose property to check

 * @propname: Name of the property

 *

 * Check if property @propname is present in the firmware node description.

 * This function is the unambiguous way to check that given property is present

 * in the firmware node description.

 *

 * Return: true if property @propname is present. Otherwise, returns false.

 */

bool fwnode_property_present(const struct fwnode_handle *fwnode,
@@ -75,9 +81,9 @@ EXPORT_SYMBOL_GPL(fwnode_property_present); 
 * @dev: Device whose property is being checked

 * @propname: Name of the property

 *

 * Return if property @propname is true or false in the device firmware description.

 * Use device_property_present() to check for the property presence.

 *

 * Return: true if property @propname is present. Otherwise, returns false.

 * Return: if property @propname is true or false in the device firmware description.

 */

bool device_property_read_bool(const struct device *dev, const char *propname)

{
@@ -90,7 +96,9 @@ EXPORT_SYMBOL_GPL(device_property_read_bool); 
 * @fwnode: Firmware node whose property to check

 * @propname: Name of the property

 *

 * Return if property @propname is true or false in the firmware description.

 * Use fwnode_property_present() to check for the property presence.

 *

 * Return: if property @propname is true or false in the firmware node description.

 */

bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,

			     const char *propname)