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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20230329123425.4177084-1-conor.dooley@microchip.com>
Date:   Wed, 29 Mar 2023 13:34:26 +0100
From:   Conor Dooley <conor.dooley@...rochip.com>
To:     <corbet@....net>
CC:     <conor@...nel.org>, <conor.dooley@...rochip.com>,
        Russ Weight <russell.h.weight@...el.com>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Tianfei zhang <tianfei.zhang@...el.com>,
        "Luis Chamberlain" <mcgrof@...nel.org>,
        <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>
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 <conor.dooley@...rochip.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@....net>
CC: Russ Weight <russell.h.weight@...el.com>
CC: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
CC: Tianfei zhang <tianfei.zhang@...el.com>
CC: Luis Chamberlain <mcgrof@...nel.org>
CC: linux-doc@...r.kernel.org
CC: linux-kernel@...r.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