of: address: Document return value of of_address_to_resource()
authorGeert Uytterhoeven <geert+renesas@glider.be>
Fri, 31 Mar 2023 07:52:28 +0000 (09:52 +0200)
committerRob Herring <robh@kernel.org>
Tue, 4 Apr 2023 17:12:13 +0000 (12:12 -0500)
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@glider.be>
Link: https://lore.kernel.org/r/61ffcb5e87511dfa21af169efd04806101c48b8a.1680248888.git.geert+renesas@glider.be
Signed-off-by: Rob Herring <robh@kernel.org>
drivers/of/address.c

index 4c0b169ef9bfba69558d39db21fb46643b17c90b..3fda1f33e09cb64ec3267f8e350f4004d142b6ca 100644 (file)
@@ -879,6 +879,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