2024-04-07 06:13:48

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] ARM: Add kernel-doc comments to ssp_read_word()

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

Signed-off-by: Yang Li <[email protected]>
---
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