diff mbox series

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

Message ID 61ffcb5e87511dfa21af169efd04806101c48b8a.1680248888.git.geert+renesas@glider.be
State Accepted, archived
Headers show
Series of: address: Miscellaneous-improvements | expand

Checks

Context Check Description
robh/checkpatch success
robh/patch-applied fail build log

Commit Message

Geert Uytterhoeven March 31, 2023, 7:52 a.m. UTC 
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>
---
 drivers/of/address.c | 2 ++
 1 file changed, 2 insertions(+)

Comments

Rob Herring (Arm) April 3, 2023, 9:41 p.m. UTC | #1 
On Fri, 31 Mar 2023 09:52:28 +0200, Geert Uytterhoeven wrote:
> 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>
> ---
>  drivers/of/address.c | 2 ++
>  1 file changed, 2 insertions(+)
> 

Applied, thanks!
diff mbox series

Patch

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