[PATCH] docs: driver-api: firmware_loader: fix missing argument in usage example

[PATCH] docs: driver-api: firmware_loader: fix missing argument in usage example

[Conor Dooley]

By the time firmware-upload support landed in commit 97730bbb242c
("firmware_loader: Add firmware-upload support"), the arguments for
firmware_upload_register() had changed, and while this is automagically
represented in the kernel doc bits, the usage example was not kept in
sync.
Add the missing argument as per the driver.

Fixes: 97730bbb242c ("firmware_loader: Add firmware-upload support")
Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
---
From skimming the threads adding this stuff, looks like THIS_MODULE was
always needed, so either I'm missing something or the doc stuff wasn't
matching in any of the submitted versions.

CC: Jonathan Corbet <corbet@lwn.net>
CC: Russ Weight <russell.h.weight@intel.com>
CC: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
CC: Tianfei zhang <tianfei.zhang@intel.com>
CC: Luis Chamberlain <mcgrof@kernel.org>
CC: linux-doc@vger.kernel.org
CC: linux-kernel@vger.kernel.org
---
 Documentation/driver-api/firmware/fw_upload.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/driver-api/firmware/fw_upload.rst b/Documentation/driver-api/firmware/fw_upload.rst
index 76922591e446..edf1d0c5e7c3 100644
--- a/Documentation/driver-api/firmware/fw_upload.rst
+++ b/Documentation/driver-api/firmware/fw_upload.rst
@@ -57,7 +57,8 @@ function calls firmware_upload_unregister() such as::
 		len = (truncate) ? truncate - fw_name : strlen(fw_name);
 		sec->fw_name = kmemdup_nul(fw_name, len, GFP_KERNEL);
 
-		fwl = firmware_upload_register(sec->dev, sec->fw_name, &m10bmc_ops, sec);
+		fwl = firmware_upload_register(THIS_MODULE, sec->dev, sec->fw_name,
+					       &m10bmc_ops, sec);
 		if (IS_ERR(fwl)) {
 			dev_err(sec->dev, "Firmware Upload driver failed to start\n");
 			kfree(sec->fw_name);
-- 
2.39.2

Re: [PATCH] docs: driver-api: firmware_loader: fix missing argument in usage example

[Greg Kroah-Hartman]

On Wed, Mar 29, 2023 at 01:34:26PM +0100, Conor Dooley wrote:
> By the time firmware-upload support landed in commit 97730bbb242c
> ("firmware_loader: Add firmware-upload support"), the arguments for
> firmware_upload_register() had changed, and while this is automagically
> represented in the kernel doc bits, the usage example was not kept in
> sync.
> Add the missing argument as per the driver.
> 
> Fixes: 97730bbb242c ("firmware_loader: Add firmware-upload support")
> Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
> ---
> >From skimming the threads adding this stuff, looks like THIS_MODULE was
> always needed, so either I'm missing something or the doc stuff wasn't
> matching in any of the submitted versions.
> 
> CC: Jonathan Corbet <corbet@lwn.net>
> CC: Russ Weight <russell.h.weight@intel.com>
> CC: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> CC: Tianfei zhang <tianfei.zhang@intel.com>
> CC: Luis Chamberlain <mcgrof@kernel.org>
> CC: linux-doc@vger.kernel.org
> CC: linux-kernel@vger.kernel.org
> ---
>  Documentation/driver-api/firmware/fw_upload.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/driver-api/firmware/fw_upload.rst b/Documentation/driver-api/firmware/fw_upload.rst
> index 76922591e446..edf1d0c5e7c3 100644
> --- a/Documentation/driver-api/firmware/fw_upload.rst
> +++ b/Documentation/driver-api/firmware/fw_upload.rst
> @@ -57,7 +57,8 @@ function calls firmware_upload_unregister() such as::
>  		len = (truncate) ? truncate - fw_name : strlen(fw_name);
>  		sec->fw_name = kmemdup_nul(fw_name, len, GFP_KERNEL);
>  
> -		fwl = firmware_upload_register(sec->dev, sec->fw_name, &m10bmc_ops, sec);
> +		fwl = firmware_upload_register(THIS_MODULE, sec->dev, sec->fw_name,
> +					       &m10bmc_ops, sec);

Good catch.  As this touches the firmware documentation, I can take it
in my tree, thanks!

greg k-h