Re: [PATCH 3/8] ASoC: samsung: pcm: fix kernel-doc

From: Sylwester Nawrocki
Date: Fri Jul 03 2020 - 14:47:28 EST


On 02.07.2020 18:58, Pierre-Louis Bossart wrote:
> Fix W=1 warnings - missing fields in structure
>
> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@xxxxxxxxxxxxxxx>
> ---
> sound/soc/samsung/pcm.c | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/sound/soc/samsung/pcm.c b/sound/soc/samsung/pcm.c
> index a5b1a12b3496..86eefbc89e9e 100644
> --- a/sound/soc/samsung/pcm.c
> +++ b/sound/soc/samsung/pcm.c
> @@ -104,8 +104,13 @@

Thank you for the patch, I have some suggestions to improve the comments.

> /**
> * struct s3c_pcm_info - S3C PCM Controller information
> + * @lock: Spin lock

@lock: Spin lock to serialize access to the device registers and @idle_clk

> * @dev: The parent device passed to use from the probe.
> * @regs: The pointer to the device register block.
> + * @sclk_per_fs: number of sclk per frame sync
> + * @idleclk: Whether to keep PCMSCLK enabled even when idle(no active xfer)

How about adding space before the opening parenthesis?

> + * @pclk: the pclk pointer

@pclk: the PCLK_PCM (pcm) clock pointer

> + * @cclk: the clck pointer

@cclk: the SCLK_AUDIO (audio-bus) clock pointer

> * @dma_playback: DMA information for playback channel.
> * @dma_capture: DMA information for capture channel.
> */

With above changes feel free to add:
Reviewed-by: Sylwester Nawrocki <s.nawrocki@xxxxxxxxxxx>

--
Thanks,
Sylwester