Re: [PATCH v4 01/19] drm/msm: Import adreno_snapshot.h

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] drm/msm/adreno: malformed kernel-doc comments in adreno_snapshot.h
--

commit 4b4f4543f019fd5896ff1aace169bcf52f15975d
Author: Rob Clark <robin.clark@oss.qualcomm.com>

drm/msm: Import adreno_snapshot.h

This commit imports adreno_snapshot.h based on downstream kgsl_snapshot.h for
use with gen8 devcoredump support.

> diff --git a/drivers/gpu/drm/msm/adreno/adreno_snapshot.h b/drivers/gpu/drm/msm/adreno/adreno_snapshot.h
> new file mode 100644
> index 0000000000000..f9956e0bc1d5f
> --- /dev/null
> +++ b/drivers/gpu/drm/msm/adreno/adreno_snapshot.h
> @@ -0,0 +1,321 @@

[ ... ]

> +/**
> + * enum trace_buffer_source - Bits to identify the source block of trace buffer information
> + * GX_DBGC : Signals captured from GX block
> + * CX_DBGC : Signals captured from CX block
> + */
> +enum trace_buffer_source {
> +	GX_DBGC = 1,
> +	CX_DBGC = 2,
> +};
> +
> +/**
> + * adreno_snapshot_trace_buffer: Header Information for the tracebuffer in snapshot.
> + */
> +struct adreno_snapshot_trace_buffer {
> +	/** @dbgc_ctrl: Identify source for trace */
> +	__u16 dbgc_ctrl;
> +	/** @dbgc_ctrl: Identify source for trace */
> +	__u16 segment;

[Severity: Low]
This isn't a bug, but there are a few kernel-doc formatting issues here when
running scripts/kernel-doc on drivers/gpu/drm/msm/adreno/adreno_snapshot.h:

1. In enum trace_buffer_source, should GX_DBGC and CX_DBGC have the leading @
prefix (@GX_DBGC: and @CX_DBGC:) so scripts/kernel-doc recognizes the
enumerator descriptions?

2. In the comment header for struct adreno_snapshot_trace_buffer, should it
begin with "struct adreno_snapshot_trace_buffer -" so scripts/kernel-doc does
not parse it as a function prototype?

3. Inside struct adreno_snapshot_trace_buffer, the inline kernel-doc comment
above the segment field repeats @dbgc_ctrl instead of documenting @segment.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261030211928.45761-1-robin.clark@oss.qualcomm.com?part=1