diff options
| author | Rob Herring (Arm) <robh@kernel.org> | 2025-01-09 13:42:06 -0600 |
|---|---|---|
| committer | Rob Herring (Arm) <robh@kernel.org> | 2025-01-13 17:47:29 -0600 |
| commit | c141ecc3cecd764799e17c8251026336cab86800 (patch) | |
| tree | af4f88f030989705b8911d543312a3baee606f09 /drivers/of | |
| parent | bb3914101f704a8282f65238d6b021d216efc608 (diff) | |
of: Warn when of_property_read_bool() is used on non-boolean properties
The use of of_property_read_bool() for non-boolean properties is
deprecated. The primary use of it was to test property presence, but
that has been replaced in favor of of_property_present(). With those
uses now fixed, add a warning to discourage new ones.
Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Link: https://lore.kernel.org/r/20250109-dt-type-warnings-v1-2-0150e32e716c@kernel.org
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
Diffstat (limited to 'drivers/of')
| -rw-r--r-- | drivers/of/property.c | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/drivers/of/property.c b/drivers/of/property.c index 2109515a3bc2..8577d659c162 100644 --- a/drivers/of/property.c +++ b/drivers/of/property.c @@ -32,6 +32,32 @@ #include "of_private.h" /** + * of_property_read_bool - Find a property + * @np: device node from which the property value is to be read. + * @propname: name of the property to be searched. + * + * Search for a boolean property in a device node. Usage on non-boolean + * property types is deprecated. + * + * Return: true if the property exists false otherwise. + */ +bool of_property_read_bool(const struct device_node *np, const char *propname) +{ + struct property *prop = of_find_property(np, propname, NULL); + + /* + * Boolean properties should not have a value. Testing for property + * presence should either use of_property_present() or just read the + * property value and check the returned error code. + */ + if (prop && prop->length) + pr_warn("%pOF: Read of boolean property '%s' with a value.\n", np, propname); + + return prop ? true : false; +} +EXPORT_SYMBOL(of_property_read_bool); + +/** * of_graph_is_present() - check graph's presence * @node: pointer to device_node containing graph port * |