mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning
@ 2025-04-03 20:38 Unnathi Chalicheemala
  2025-04-04 22:56 ` Konrad Dybcio
  2025-05-20  2:14 ` Bjorn Andersson
  0 siblings, 2 replies; 3+ messages in thread
From: Unnathi Chalicheemala @ 2025-04-03 20:38 UTC (permalink / raw)
  To: Bjorn Andersson, Konrad Dybcio
  Cc: linux-arm-msm, linux-kernel, quic_satyap, kernel, Jeff Johnson,
	Unnathi Chalicheemala

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>


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning
  2025-04-03 20:38 [PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning Unnathi Chalicheemala
@ 2025-04-04 22:56 ` Konrad Dybcio
  2025-05-20  2:14 ` Bjorn Andersson
  1 sibling, 0 replies; 3+ messages in thread
From: Konrad Dybcio @ 2025-04-04 22:56 UTC (permalink / raw)
  To: Unnathi Chalicheemala, Bjorn Andersson, Konrad Dybcio
  Cc: linux-arm-msm, linux-kernel, quic_satyap, kernel, Jeff Johnson

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning
  2025-04-03 20:38 [PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning Unnathi Chalicheemala
  2025-04-04 22:56 ` Konrad Dybcio
@ 2025-05-20  2:14 ` Bjorn Andersson
  1 sibling, 0 replies; 3+ messages in thread
From: Bjorn Andersson @ 2025-05-20  2:14 UTC (permalink / raw)
  To: Konrad Dybcio, Unnathi Chalicheemala
  Cc: linux-arm-msm, linux-kernel, quic_satyap, kernel, Jeff Johnson


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>

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-05-20  2:15 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-04-03 20:38 [PATCH] docs: firmware: qcom_scm: Fix kernel-doc warning Unnathi Chalicheemala
2025-04-04 22:56 ` Konrad Dybcio
2025-05-20  2:14 ` Bjorn Andersson

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®