firmware: arm_scmi: Provide a missing function param description
authorSudeep Holla <sudeep.holla@arm.com>
Thu, 9 Jul 2020 15:31:55 +0000 (16:31 +0100)
committerSudeep Holla <sudeep.holla@arm.com>
Mon, 13 Jul 2020 08:40:21 +0000 (09:40 +0100)
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'

Link: https://lore.kernel.org/r/20200709153155.22573-1-sudeep.holla@arm.com
Reported-by: kbuild test robot <lkp@intel.com>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
drivers/firmware/arm_scmi/smc.c

index 49bc4b0..a1537d1 100644 (file)
@@ -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
  */