diff mbox series

firmware: arm_scmi: Provide a missing function param description

Message ID 20200709153155.22573-1-sudeep.holla@arm.com (mailing list archive)
State Mainlined
Commit a4ee9d0194c24509333caaeba894ca017e5942c8
Headers show
Series firmware: arm_scmi: Provide a missing function param description | expand

Commit Message

Sudeep Holla July 9, 2020, 3:31 p.m. UTC
gcc as well as clang now produce warnings for missing kerneldoc function
parameter.

Fix the following W=1 kernel build warning:

drivers/firmware/arm_scmi/smc.c:32:
 warning: Function parameter or member 'shmem_lock' not described in 'scmi_smc'

Reported-by: kbuild test robot <lkp@intel.com>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
---
 drivers/firmware/arm_scmi/smc.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Sudeep Holla July 13, 2020, 1 p.m. UTC | #1
On Thu, 9 Jul 2020 16:31:55 +0100, Sudeep Holla wrote:
> gcc as well as clang now produce warnings for missing kerneldoc function
> parameter.
>
> Fix the following W=1 kernel build warning:
>
> drivers/firmware/arm_scmi/smc.c:32:
>  warning: Function parameter or member 'shmem_lock' not described in 'scmi_smc'

Applied to sudeep.holla/linux (for-next/scmi), thanks!

[1/1] firmware: arm_scmi: Provide a missing function param description
      https://git.kernel.org/sudeep.holla/c/a4ee9d0194

--
Regards,
Sudeep
diff mbox series

Patch

diff --git a/drivers/firmware/arm_scmi/smc.c b/drivers/firmware/arm_scmi/smc.c
index 49bc4b0e8428..a1537d123e38 100644
--- a/drivers/firmware/arm_scmi/smc.c
+++ b/drivers/firmware/arm_scmi/smc.c
@@ -21,6 +21,7 @@ 
  *
  * @cinfo: SCMI channel info
  * @shmem: Transmit/Receive shared memory area
+ * @shmem_lock: Lock to protect access to Tx/Rx shared memory area
  * @func_id: smc/hvc call function id
  */