Skip to contentSkip to conversation

firmware_loader: describe 'module' parameter of firmware_upload_register()

PATCH In review Bagas Sanjaya 4 participants 4 messages May 2, 2022 – May 3, 2022

Subsystems (4)
Documentation Linux-next tree Driver core Firmware loader (request_firmware)
lore
Share & tools
lore

Bagas Sanjaya

author
#0 lore raw

PATCH 1/1 firmware_loader: describe 'module' parameter of firmware_upload_register()

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/[email protected]/ open here
Cc Stephen Rothwell <[email protected]>
Cc Russ Weight <[email protected]>
Cc Luis Chamberlain <[email protected]>
Cc Greg Kroah-Hartman <[email protected]>
Cc "Rafael J. Wysocki" <[email protected]>
Cc Linux Kernel Mailing List <[email protected]>
Cc Linux Next Mailing List <[email protected]>
Signed-off-by Bagas Sanjaya <[email protected]>

---
This patch is based on driver-core-next tree.

 drivers/base/firmware_loader/sysfs_upload.c | 1 +
 1 file changed, 1 insertion(+)
drivers/base/firmware_loader/sysfs_upload.c +1 -0
index 8cdcf3516c7e94..87044d52322aa2 100644
@@ -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

Signature · 1 line
An old man doll... just what I always wanted! - Clara
Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · Bagas Sanjaya

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.

Quoted 9 lines
Fixes 97730bbb242cde ("firmware_loader: Add firmware-upload support")
Link https://lore.kernel.org/linux-next/[email protected]/ open here
Cc Stephen Rothwell <[email protected]>
Cc Russ Weight <[email protected]>
Cc Luis Chamberlain <[email protected]>
Cc Greg Kroah-Hartman <[email protected]>
Cc "Rafael J. Wysocki" <[email protected]>
Cc Linux Kernel Mailing List <[email protected]>
Cc Linux Next Mailing List <[email protected]>
Reviewed-by Russ Weight <[email protected]>
Quoted 21 lines
Signed-off-by Bagas Sanjaya <[email protected]>

---
This patch is based on driver-core-next tree.

 drivers/base/firmware_loader/sysfs_upload.c | 1 +
 1 file changed, 1 insertion(+)
drivers/base/firmware_loader/sysfs_upload.c +1 -0
index 8cdcf3516c7e94..87044d52322aa2 100644
@@ -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

maintainer
#2 lore raw
In reply to Bagas Sanjaya
Quoted 9 lines · Bagas Sanjaya

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/[email protected]/ open here
Cc Stephen Rothwell <[email protected]>

This should be "Reported-by:" I'll fix it up when I apply it to my tree now, thanks.

greg k-h

maintainer Acked-by on v1 1/1
#3 lore raw
In reply to Bagas Sanjaya
Quoted 6 lines · Bagas Sanjaya

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.

Quoted 10 lines
Fixes 97730bbb242cde ("firmware_loader: Add firmware-upload support")
Link https://lore.kernel.org/linux-next/[email protected]/ open here
Cc Stephen Rothwell <[email protected]>
Cc Russ Weight <[email protected]>
Cc Luis Chamberlain <[email protected]>
Cc Greg Kroah-Hartman <[email protected]>
Cc "Rafael J. Wysocki" <[email protected]>
Cc Linux Kernel Mailing List <[email protected]>
Cc Linux Next Mailing List <[email protected]>
Signed-off-by Bagas Sanjaya <[email protected]>
Acked-by Luis Chamberlain <[email protected]>

Luis