Message ID | 20250403-fix_scm_doc_warn-v1-1-9cd36345db77@oss.qualcomm.com |
---|---|
State | New |
Headers | show |
Series | docs: firmware: qcom_scm: Fix kernel-doc warning | expand |
On 4/3/25 10:38 PM, Unnathi Chalicheemala wrote: > Add description for members of qcom_scm_desc struct to avoid: > > drivers/firmware/qcom/qcom_scm.h:56: warning: Function parameter or struct > member 'svc' not described in 'qcom_scm_desc' > > drivers/firmware/qcom/qcom_scm.h:56: warning: Function parameter or struct > member 'cmd' not described in 'qcom_scm_desc' > > drivers/firmware/qcom/qcom_scm.h:56: warning: Function parameter or struct > member 'owner' not described in 'qcom_scm_desc' > > Signed-off-by: Unnathi Chalicheemala <unnathi.chalicheemala@oss.qualcomm.com> > --- Reviewed-by: Konrad Dybcio <konrad.dybcio@oss.qualcomm.com> Konrad
diff --git a/drivers/firmware/qcom/qcom_scm.h b/drivers/firmware/qcom/qcom_scm.h index 097369d38b84efbce5d672c4f36cc87373aac24b..3133d826f5fae8d135a8f03758173903a87e718b 100644 --- a/drivers/firmware/qcom/qcom_scm.h +++ b/drivers/firmware/qcom/qcom_scm.h @@ -44,8 +44,11 @@ enum qcom_scm_arg_types { /** * struct qcom_scm_desc + * @svc: Service identifier + * @cmd: Command identifier * @arginfo: Metadata describing the arguments in args[] * @args: The array of arguments for the secure syscall + * @owner: Owner identifier */ struct qcom_scm_desc { u32 svc;
Add description for members of qcom_scm_desc struct to avoid: drivers/firmware/qcom/qcom_scm.h:56: warning: Function parameter or struct member 'svc' not described in 'qcom_scm_desc' drivers/firmware/qcom/qcom_scm.h:56: warning: Function parameter or struct member 'cmd' not described in 'qcom_scm_desc' drivers/firmware/qcom/qcom_scm.h:56: warning: Function parameter or struct member 'owner' not described in 'qcom_scm_desc' Signed-off-by: Unnathi Chalicheemala <unnathi.chalicheemala@oss.qualcomm.com> --- drivers/firmware/qcom/qcom_scm.h | 3 +++ 1 file changed, 3 insertions(+) --- base-commit: 91e5bfe317d8f8471fbaa3e70cf66cae1314a516 change-id: 20250401-fix_scm_doc_warn-80d266cfc9b9 Best regards,