Received-SPF: pass (google.com: domain of linux-kernel+bounces-134190-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Yang Li <yang.lee@linux.alibaba.com>
To: linux@armlinux.org.uk
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org,
	Yang Li <yang.lee@linux.alibaba.com>
Subject: [PATCH -next] ARM: Add kernel-doc comments to ssp_read_word()
Date: Sun,  7 Apr 2024 14:08:14 +0800
Message-Id: <20240407060814.96307-1-yang.lee@linux.alibaba.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

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