lkml.org 
[lkml]   [2020]   [Jul]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH 3/8] ASoC: samsung: pcm: fix kernel-doc
From
Date
On 7/3/20 1:47 PM, Sylwester Nawrocki wrote:
> 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@linux.intel.com>
>> ---
>> 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@samsung.com>

I wasn't really happy with the lame comments I added for pclk and cclk,
thanks for suggesting a better wording. Will fix in a v2.

\
 
 \ /
  Last update: 2020-07-06 17:04    [W:0.042 / U:1.780 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site