2023-03-29 12:42:36

by Conor Dooley

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

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 <[email protected]>
---
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 <[email protected]>
CC: Russ Weight <[email protected]>
CC: Greg Kroah-Hartman <[email protected]>
CC: Tianfei zhang <[email protected]>
CC: Luis Chamberlain <[email protected]>
CC: [email protected]
CC: [email protected]
---
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


2023-03-29 14:18:33

by Greg Kroah-Hartman

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

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 <[email protected]>
> ---
> >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 <[email protected]>
> CC: Russ Weight <[email protected]>
> CC: Greg Kroah-Hartman <[email protected]>
> CC: Tianfei zhang <[email protected]>
> CC: Luis Chamberlain <[email protected]>
> CC: [email protected]
> CC: [email protected]
> ---
> 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