| Message ID | 20211230141245.29444-1-yang.lee@linux.alibaba.com |
|---|---|
| State | Accepted |
| Commit | a5d32f6d2e59a654036d5a4f59d9202302b23388 |
| Headers | show |
| Series | [-next,RESEND] firmware: qcom: scm: Fix some kernel-doc comments | expand |
On Thu, 30 Dec 2021 22:12:45 +0800, Yang Li wrote: > Fix qcom_scm_call(), qcom_scm_call_atomic, > and qcom_scm_cpu_power_down() kernel-doc comment to remove > remove warnings found by running scripts/kernel-doc, which > is caused by using 'make W=1'. > drivers/firmware/qcom_scm.c:191: warning: Function parameter or member > 'res' not described in 'qcom_scm_call' > drivers/firmware/qcom_scm.c:191: warning: Excess function parameter > 'svc_id' description in 'qcom_scm_call' > drivers/firmware/qcom_scm.c:191: warning: Excess function parameter > 'cmd_id' description in 'qcom_scm_call' > drivers/firmware/qcom_scm.c:219: warning: Excess function parameter > 'svc_id' description in 'qcom_scm_call_atomic' > drivers/firmware/qcom_scm.c:219: warning: Excess function parameter > 'cmd_id' description in 'qcom_scm_call_atomic' > drivers/firmware/qcom_scm.c:360: warning: Function parameter or member > 'flags' not described in 'qcom_scm_cpu_power_down' > > [...] Applied, thanks! [1/1] firmware: qcom: scm: Fix some kernel-doc comments commit: a5d32f6d2e59a654036d5a4f59d9202302b23388 Best regards,
diff --git a/drivers/firmware/qcom_scm.c b/drivers/firmware/qcom_scm.c index 7db8066b19fd..9a699e2f7544 100644 --- a/drivers/firmware/qcom_scm.c +++ b/drivers/firmware/qcom_scm.c @@ -179,9 +179,8 @@ static enum qcom_scm_convention __get_convention(void) /** * qcom_scm_call() - Invoke a syscall in the secure world * @dev: device - * @svc_id: service identifier - * @cmd_id: command identifier * @desc: Descriptor structure containing arguments and return values + * @res: Structure containing results from SMC/HVC call * * Sends a command to the SCM and waits for the command to finish processing. * This should *only* be called in pre-emptible context. @@ -205,8 +204,6 @@ static int qcom_scm_call(struct device *dev, const struct qcom_scm_desc *desc, /** * qcom_scm_call_atomic() - atomic variation of qcom_scm_call() * @dev: device - * @svc_id: service identifier - * @cmd_id: command identifier * @desc: Descriptor structure containing arguments and return values * @res: Structure containing results from SMC/HVC call * @@ -350,7 +347,7 @@ EXPORT_SYMBOL(qcom_scm_set_cold_boot_addr); /** * qcom_scm_cpu_power_down() - Power down the cpu - * @flags - Flags to flush cache + * @flags: Flags to flush cache * * This is an end point to power down cpu. If there was a pending interrupt, * the control would return from this function, otherwise, the cpu jumps to the
Fix qcom_scm_call(), qcom_scm_call_atomic, and qcom_scm_cpu_power_down() kernel-doc comment to remove remove warnings found by running scripts/kernel-doc, which is caused by using 'make W=1'. drivers/firmware/qcom_scm.c:191: warning: Function parameter or member 'res' not described in 'qcom_scm_call' drivers/firmware/qcom_scm.c:191: warning: Excess function parameter 'svc_id' description in 'qcom_scm_call' drivers/firmware/qcom_scm.c:191: warning: Excess function parameter 'cmd_id' description in 'qcom_scm_call' drivers/firmware/qcom_scm.c:219: warning: Excess function parameter 'svc_id' description in 'qcom_scm_call_atomic' drivers/firmware/qcom_scm.c:219: warning: Excess function parameter 'cmd_id' description in 'qcom_scm_call_atomic' drivers/firmware/qcom_scm.c:360: warning: Function parameter or member 'flags' not described in 'qcom_scm_cpu_power_down' Reported-by: Abaci Robot <abaci@linux.alibaba.com> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> --- drivers/firmware/qcom_scm.c | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-)