[1/3] of: address: Document return value of of_address_to_resource()
Commit Message
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
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!
@@ -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