[PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning

Unnathi Chalicheemala posted 1 patch 10 months, 1 week ago
drivers/firmware/qcom/qcom_scm.h | 3 +++
1 file changed, 3 insertions(+)
[PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning
Posted by Unnathi Chalicheemala 10 months, 1 week ago
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(+)

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;

---
base-commit: 91e5bfe317d8f8471fbaa3e70cf66cae1314a516
change-id: 20250401-fix_scm_doc_warn-80d266cfc9b9

Best regards,
-- 
Unnathi Chalicheemala <unnathi.chalicheemala@oss.qualcomm.com>
Re: [PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning
Posted by Bjorn Andersson 8 months, 3 weeks ago
On Thu, 03 Apr 2025 13:38:24 -0700, 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'
> 
> [...]

Applied, thanks!

[1/1] docs: firmware: qcom_scm: Fix kernel-doc warning
      commit: 936badf282388be78094e55bd5e2c96f86635e48

Best regards,
-- 
Bjorn Andersson <andersson@kernel.org>
Re: [PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning
Posted by Konrad Dybcio 10 months, 1 week ago
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