linux-kernel - Re: [PATCH] drm/amd/display: add kernel docs for dc_stream_forward_crc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <a2aed954-6d37-4380-8234-b4da1f6a91f0@amd.com>
Date:   Mon, 30 Oct 2023 09:59:26 -0600
From:   Rodrigo Siqueira Jordao <Rodrigo.Siqueira@....com>
To:     Sagar Vashnav <sagarvashnav72427@...il.com>,
        Harry Wentland <harry.wentland@....com>,
        Leo Li <sunpeng.li@....com>,
        Alex Deucher <alexander.deucher@....com>,
        Christian König <christian.koenig@....com>,
        "Pan, Xinhui" <Xinhui.Pan@....com>,
        David Airlie <airlied@...il.com>,
        Daniel Vetter <daniel@...ll.ch>, amd-gfx@...ts.freedesktop.org,
        dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] drm/amd/display: add kernel docs for
 dc_stream_forward_crc_window

Hi Sagar,

First of all, thanks for your patch.

On 10/25/23 08:04, Sagar Vashnav wrote:
> Add kernel documentation for the dc_stream_forward_crc_window
> 
> Signed-off-by: Sagar Vashnav <sagarvashnav72427@...il.com>
> ---
>   drivers/gpu/drm/amd/display/dc/core/dc.c | 13 +++++++++++++
>   1 file changed, 13 insertions(+)
> 
> diff --git a/drivers/gpu/drm/amd/display/dc/core/dc.c b/drivers/gpu/drm/amd/display/dc/core/dc.c
> index 1729fb727..5ab35e482 100644
> --- a/drivers/gpu/drm/amd/display/dc/core/dc.c
> +++ b/drivers/gpu/drm/amd/display/dc/core/dc.c
> @@ -528,6 +528,19 @@ dc_stream_forward_dmcu_crc_window(struct dmcu *dmcu,
>   		dmcu->funcs->forward_crc_window(dmcu, rect, mux_mapping);
>   }
>   
> +/**
> + * dc_stream_forward_crc_window() - Forward CRC window configuration to DMUB or DMCU.

Add an empty comment line between the summary and the parameter description.

> + * @stream: The stream state to forward CRC window configuration for.
> + * @rect: Pointer to the rectangle defining the CRC window coordinates.
> + * @is_stop: Flag indicating whether the CRC capture should be stopped.
> +

You need to add `*` in the above line.

> + * This function is responsible for forwarding the CRC window configuration
> + * for a given stream to either the DMUB or DMCU, depending on their availability.
> +

Same as my previous comment.

> + * Return:
> + * %true if the CRC window configuration was successfully forwarded;
> + * %false if the stream was not found or CRC forwarding is not supported.

Afaik, we don't use `%` in the kernel-doc. Maybe just use 'True' and 
'False'?

Thanks
Siqueira

> + */
>   bool
>   dc_stream_forward_crc_window(struct dc_stream_state *stream,
>   		struct rect *rect, bool is_stop)