Re: [PATCH 06/37] drm/vkms/vkms_composer: Fix a few different kerneldoc formatting

From: Randy Dunlap
Date: Mon Mar 20 2023 - 20:09:18 EST




On 3/20/23 16:46, Melissa Wen wrote:
> On 03/17, Lee Jones wrote:
>> Fixes the following W=1 kernel build warning(s):
>>
>> drivers/gpu/drm/vkms/vkms_composer.c:41: warning: Function parameter or member 'frame_info' not described in 'pre_mul_alpha_blend'
>> drivers/gpu/drm/vkms/vkms_composer.c:41: warning: Excess function parameter 'src_frame_info' description in 'pre_mul_alpha_blend'
>> drivers/gpu/drm/vkms/vkms_composer.c:72: warning: Cannot understand * @wb_frame_info: The writeback frame buffer metadata
>>
>> Cc: Rodrigo Siqueira <rodrigosiqueiramelo@xxxxxxxxx>
>> Cc: Melissa Wen <melissa.srw@xxxxxxxxx>
>> Cc: Haneen Mohammed <hamohammed.sa@xxxxxxxxx>
>> Cc: Daniel Vetter <daniel@xxxxxxxx>
>> Cc: David Airlie <airlied@xxxxxxxxx>
>> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
>> Signed-off-by: Lee Jones <lee@xxxxxxxxxx>
>> ---
>> drivers/gpu/drm/vkms/vkms_composer.c | 6 ++++--
>> 1 file changed, 4 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/gpu/drm/vkms/vkms_composer.c b/drivers/gpu/drm/vkms/vkms_composer.c
>> index 8e53fa80742b2..41668eedf4272 100644
>> --- a/drivers/gpu/drm/vkms/vkms_composer.c
>> +++ b/drivers/gpu/drm/vkms/vkms_composer.c
>> @@ -22,7 +22,7 @@ static u16 pre_mul_blend_channel(u16 src, u16 dst, u16 alpha)
>>
>> /**
>> * pre_mul_alpha_blend - alpha blending equation
>> - * @src_frame_info: source framebuffer's metadata
>> + * @frame_info: source framebuffer's metadata
>> * @stage_buffer: The line with the pixels from src_plane
>> * @output_buffer: A line buffer that receives all the blends output
>> *
>> @@ -69,11 +69,13 @@ static void fill_background(const struct pixel_argb_u16 *background_color,
>> }
>>
>> /**
>> - * @wb_frame_info: The writeback frame buffer metadata
>> + * blend
> As we are already here:
> * blend - blend pixels from a given row and calculate crc

* blend: blend pixels from a given row and calculate CRC

preferably.

> Reviewed-by: Melissa Wen <mwen@xxxxxxxxxx>
>
>> + * @wb: The writeback frame buffer metadata
>> * @crtc_state: The crtc state
>> * @crc32: The crc output of the final frame
>> * @output_buffer: A buffer of a row that will receive the result of the blend(s)
>> * @stage_buffer: The line with the pixels from plane being blend to the output
>> + * @row_size: Size of memory taken up by row data (line_width * pixel_size)
>> *
>> * This function blends the pixels (Using the `pre_mul_alpha_blend`)
>> * from all planes, calculates the crc32 of the output from the former step,
>> --
>> 2.40.0.rc1.284.g88254d51c5-goog
>>

--
~Randy