[PATCH 1/3] of: address: Document return value of of_address_to_resource()

From: Geert Uytterhoeven
Date: Fri Mar 31 2023 - 03:53:43 EST


Add the missing return value documentation to the linuxdoc comment block
for the of_address_to_resource() function.

Signed-off-by: Geert Uytterhoeven <geert+renesas@xxxxxxxxx>
---
drivers/of/address.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/drivers/of/address.c b/drivers/of/address.c
index 4c5c3b7ab99449f2..6312b10885e85864 100644
--- a/drivers/of/address.c
+++ b/drivers/of/address.c
@@ -882,6 +882,8 @@ static int __of_address_to_resource(struct device_node *dev, int index, int bar_
* @index: Index into the array
* @r: Pointer to resource array
*
+ * Returns -EINVAL if the range cannot be converted to resource.
+ *
* Note that if your address is a PIO address, the conversion will fail if
* the physical address can't be internally converted to an IO token with
* pci_address_to_pio(), that is because it's either called too early or it
--
2.34.1