Commit f7e46d45 authored by Amit Vadhavana's avatar Amit Vadhavana Committed by Greg Kroah-Hartman
Browse files

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: default avatarAmit Vadhavana <av2082000@gmail.com>
Reviewed-by: default avatarRicardo B. Marliere <ricardo@marliere.net>
Signed-off-by: default avatarSrinivas Kandagatla <srinivas.kandagatla@linaro.org>
Link: https://lore.kernel.org/r/20240705080234.424587-2-srinivas.kandagatla@linaro.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent c66c0e7c

drivers/slimbus/stream.c

+5 −3
Original line number Diff line number Diff line
@@ -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},