diff mbox series

firmware: raspberrypi: Fix devm_rpi_firmware_get documentation

Message ID 20230925151812.142480-1-kieran.bingham+renesas@ideasonboard.com (mailing list archive)
State New, archived
Headers show
Series firmware: raspberrypi: Fix devm_rpi_firmware_get documentation | expand

Commit Message

Kieran Bingham Sept. 25, 2023, 3:18 p.m. UTC 
From: Kieran Bingham <kieran.bingham@ideasonboard.com>

The function documentation for devm_rpi_firmware_get() was missing
a description for the dev parameter.

Provide it and clear the warning produced here.

Fixes: f663204c9a1f ("firmware: raspberrypi: Introduce devm_rpi_firmware_get()")
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com>
---
 drivers/firmware/raspberrypi.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Florian Fainelli Oct. 2, 2023, 11:23 p.m. UTC | #1 
From: Florian Fainelli <f.fainelli@gmail.com>

On Mon, 25 Sep 2023 16:18:11 +0100, Kieran Bingham <kieran.bingham+renesas@ideasonboard.com> wrote:
> From: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> The function documentation for devm_rpi_firmware_get() was missing
> a description for the dev parameter.
> 
> Provide it and clear the warning produced here.
> 
> Fixes: f663204c9a1f ("firmware: raspberrypi: Introduce devm_rpi_firmware_get()")
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> Signed-off-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com>
> ---

Applied to https://github.com/Broadcom/stblinux/commits/drivers/next, thanks!
--
Florian
diff mbox series

Patch

diff --git a/drivers/firmware/raspberrypi.c b/drivers/firmware/raspberrypi.c
index f66efaa5196d..4cd290a60fba 100644
--- a/drivers/firmware/raspberrypi.c
+++ b/drivers/firmware/raspberrypi.c
@@ -378,6 +378,7 @@  EXPORT_SYMBOL_GPL(rpi_firmware_get);
 
 /**
  * devm_rpi_firmware_get - Get pointer to rpi_firmware structure.
+ * @dev:              The firmware device structure
  * @firmware_node:    Pointer to the firmware Device Tree node.
  *
  * Returns NULL is the firmware device is not ready.