linux-kernel - [PATCH -next] ARM: Add kernel-doc comments to ssp_read

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20240407060814.96307-1-yang.lee@linux.alibaba.com>
Date: Sun,  7 Apr 2024 14:08:14 +0800
From: Yang Li <yang.lee@...ux.alibaba.com>
To: linux@...linux.org.uk
Cc: linux-arm-kernel@...ts.infradead.org,
	linux-kernel@...r.kernel.org,
	Yang Li <yang.lee@...ux.alibaba.com>
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 <yang.lee@...ux.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