diff options
| author | Amit Vadhavana <av2082000@gmail.com> | 2024-07-05 09:02:34 +0100 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2024-07-05 10:13:04 +0200 |
| commit | f7e46d45c597fa083e266252392908f3ea0e7ef4 (patch) | |
| tree | bdee80f01b618bc0e191734a2f93eb4d41ae8803 /drivers/slimbus | |
| parent | c66c0e7c511cde3f129af4792751074905fc248a (diff) | |
| download | lwn-f7e46d45c597fa083e266252392908f3ea0e7ef4.tar.gz lwn-f7e46d45c597fa083e266252392908f3ea0e7ef4.zip | |
slimbus: Fix struct and documentation alignment in stream.c
The placement of the `segdist_codes` array documentation was corrected
to conform with kernel documentation guidelines. The `@segdist_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@gmail.com>
Reviewed-by: Ricardo B. Marliere <ricardo@marliere.net>
Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Link: https://lore.kernel.org/r/20240705080234.424587-2-srinivas.kandagatla@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/slimbus')
| -rw-r--r-- | drivers/slimbus/stream.c | 8 |
1 files 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}, |