Messages in this thread | | | Date | Mon, 30 Oct 2023 09:59:26 -0600 | Subject | Re: [PATCH] drm/amd/display: add kernel docs for dc_stream_forward_crc_window | From | Rodrigo Siqueira Jordao <> |
| |
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@gmail.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)
| |