[PATCH] firmware_loader: describe 'module' parameter of firmware_upload_register()

From: Bagas Sanjaya
Date: Mon May 02 2022 - 01:16:59 EST


Stephen Rothwell reported kernel-doc warning:

drivers/base/firmware_loader/sysfs_upload.c:285: warning: Function parameter or member 'module' not described in 'firmware_upload_register'

Fix the warning by describing the 'module' parameter.

Fixes: 97730bbb242cde ("firmware_loader: Add firmware-upload support")
Link: https://lore.kernel.org/linux-next/20220502083658.266d55f8@xxxxxxxxxxxxxxxx/
Cc: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
Cc: Russ Weight <russell.h.weight@xxxxxxxxx>
Cc: Luis Chamberlain <mcgrof@xxxxxxxxxx>
Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
Cc: "Rafael J. Wysocki" <rafael@xxxxxxxxxx>
Cc: Linux Kernel Mailing List <linux-kernel@xxxxxxxxxxxxxxx>
Cc: Linux Next Mailing List <linux-next@xxxxxxxxxxxxxxx>
Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
---
This patch is based on driver-core-next tree.

drivers/base/firmware_loader/sysfs_upload.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/base/firmware_loader/sysfs_upload.c b/drivers/base/firmware_loader/sysfs_upload.c
index 8cdcf3516c7e94..87044d52322aa2 100644
--- a/drivers/base/firmware_loader/sysfs_upload.c
+++ b/drivers/base/firmware_loader/sysfs_upload.c
@@ -266,6 +266,7 @@ int fw_upload_start(struct fw_sysfs *fw_sysfs)

/**
* firmware_upload_register() - register for the firmware upload sysfs API
+ * @module: kernel module of this device
* @parent: parent device instantiating firmware upload
* @name: firmware name to be associated with this device
* @ops: pointer to structure of firmware upload ops

base-commit: f8ae07f4b8bfde0f33761e1a1aaee45a4e85e9d6
--
An old man doll... just what I always wanted! - Clara