[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <20240705074045.418836-3-srinivas.kandagatla@linaro.org>
Date: Fri, 5 Jul 2024 08:40:40 +0100
From: srinivas.kandagatla@...aro.org
To: gregkh@...uxfoundation.org
Cc: linux-kernel@...r.kernel.org,
Amit Vadhavana <av2082000@...il.com>,
"Ricardo B . Marliere" <ricardo@...liere.net>,
Srinivas Kandagatla <srinivas.kandagatla@...aro.org>
Subject: [PATCH 1/1] slimbus: Fix struct and documentation alignment in stream.c
From: Amit Vadhavana <av2082000@...il.com>
The placement of the `segdist_codes` array documentation was corrected
to conform with kernel documentation guidelines. The `@...dist_codes`
was placed incorrectly within the struct `segdist_code` documentation
block, which led to a potential misinterpretation of the code structure.
The `segdist_codes` array documentation was moved outside the struct
block, and a separate comment block was provided for it. This change
ensures that clarity and proper alignment with kernel documentation
standards are maintained.
A kernel-doc warning was addressed:
./drivers/slimbus/stream.c:49: warning: Excess struct member 'segdist_codes' description in 'segdist_code'
Signed-off-by: Amit Vadhavana <av2082000@...il.com>
Reviewed-by: Ricardo B. Marliere <ricardo@...liere.net>
Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@...aro.org>
---
drivers/slimbus/stream.c | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c
index 1d6b38657917..863ab3075d7e 100644
--- a/drivers/slimbus/stream.c
+++ b/drivers/slimbus/stream.c
@@ -18,15 +18,17 @@
* and the first slot of the next consecutive Segment.
* @segdist_code: Segment Distribution Code SD[11:0]
* @seg_offset_mask: Segment offset mask in SD[11:0]
- * @segdist_codes: List of all possible Segmet Distribution codes.
*/
-static const struct segdist_code {
+struct segdist_code {
int ratem;
int seg_interval;
int segdist_code;
u32 seg_offset_mask;
-} segdist_codes[] = {
+};
+
+/* segdist_codes - List of all possible Segment Distribution codes. */
+static const struct segdist_code segdist_codes[] = {
{1, 1536, 0x200, 0xdff},
{2, 768, 0x100, 0xcff},
{4, 384, 0x080, 0xc7f},
--
2.25.1
Powered by blists - more mailing lists