linux-arm-kernel.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
* [PATCH -next] ARM: Add kernel-doc comments to ssp_read_word()
@ 2024-04-07  6:08 Yang Li
  0 siblings, 0 replies; only message in thread
From: Yang Li @ 2024-04-07  6:08 UTC (permalink / raw)
  To: linux; +Cc: linux-arm-kernel, linux-kernel, Yang Li

This commit adds kernel-doc style comments with complete parameter
descriptions for the function ssp_read_word().

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 arch/arm/mach-sa1100/ssp.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/arch/arm/mach-sa1100/ssp.c b/arch/arm/mach-sa1100/ssp.c
index 613fd767afcf..3c97e372bdc4 100644
--- a/arch/arm/mach-sa1100/ssp.c
+++ b/arch/arm/mach-sa1100/ssp.c
@@ -73,6 +73,8 @@ int ssp_write_word(u16 data)
 /**
  * ssp_read_word - read a word from the SSP port
  *
+ * @data: Pointer to the 16-bit buffer where the read data should be stored.
+ *
  * Wait for a data word in the SSP receive FIFO, and return the
  * received data.  Data is LSB justified.
  *
-- 
2.20.1.7.g153144c


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2024-04-07  6:08 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-04-07  6:08 [PATCH -next] ARM: Add kernel-doc comments to ssp_read_word() Yang Li

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).