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 [thread overview]
Message-ID: <20240407060814.96307-1-yang.lee@linux.alibaba.com> (raw)
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
reply other threads:[~2024-04-07 6:13 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240407060814.96307-1-yang.lee@linux.alibaba.com \
--to=yang.lee@linux.alibaba.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox