firmware: raspberrypi: Fix devm_rpi_firmware_get documentation

kbingham · ffainelli · commit a21ecc526283 · 2023-10-09T11:51:00.000-07:00
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: f663204 ("firmware: raspberrypi: Introduce devm_rpi_firmware_get()") Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Link: https://lore.kernel.org/r/20230925151812.142480-1-kieran.bingham+renesas@ideasonboard.com Signed-off-by: Florian Fainelli <florian.fainelli@broadcom.com>
diff --git 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.

Original file line number	Diff line number	Diff line change
`@@ -378,6 +378,7 @@ EXPORT_SYMBOL_GPL(rpi_firmware_get);`
`378`	`378`
`379`	`379`	`/**`
`380`	`380`	`* devm_rpi_firmware_get - Get pointer to rpi_firmware structure.`
	`381`	`+ * @dev: The firmware device structure`
`381`	`382`	`* @firmware_node: Pointer to the firmware Device Tree node.`
`382`	`383`	`*`
`383`	`384`	`* Returns NULL is the firmware device is not ready.`