diff mbox series

[-next] ARM: Add kernel-doc comments to ssp_read_word()

Message ID 20240407060814.96307-1-yang.lee@linux.alibaba.com (mailing list archive)
State New, archived
Headers show
Series [-next] ARM: Add kernel-doc comments to ssp_read_word() | expand

Commit Message

Yang Li April 7, 2024, 6:08 a.m. UTC 
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 mbox series

Patch

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.
  *