Re: [PATCH 20/30] drm/amd/display/dc/core/dc: Fix a bunch of documentation misdemeanours
On Wed, Jan 13, 2021 at 3:08 AM Lee Jones wrote: > > Fixes the following W=1 kernel build warning(s): > > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:287: warning: Cannot > understand > * > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:366: warning: Function > parameter or member 'crc_window' not described in 'dc_stream_configure_crc' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function > parameter or member 'r_cr' not described in 'dc_stream_get_crc' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function > parameter or member 'g_y' not described in 'dc_stream_get_crc' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function > parameter or member 'b_cb' not described in 'dc_stream_get_crc' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function > parameter or member 'dc' not described in > 'dc_check_update_surfaces_for_stream' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function > parameter or member 'updates' not described in > 'dc_check_update_surfaces_for_stream' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function > parameter or member 'surface_count' not described in > 'dc_check_update_surfaces_for_stream' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function > parameter or member 'stream_update' not described in > 'dc_check_update_surfaces_for_stream' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function > parameter or member 'stream_status' not described in > 'dc_check_update_surfaces_for_stream' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function > parameter or member 'dc' not described in 'dc_interrupt_set' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function > parameter or member 'src' not described in 'dc_interrupt_set' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function > parameter or member 'enable' not described in 'dc_interrupt_set' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function > parameter or member 'link' not described in 'dc_link_add_remote_sink' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function > parameter or member 'edid' not described in 'dc_link_add_remote_sink' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function > parameter or member 'len' not described in 'dc_link_add_remote_sink' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function > parameter or member 'init_data' not described in 'dc_link_add_remote_sink' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3022: warning: Function > parameter or member 'link' not described in 'dc_link_remove_remote_sink' > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3022: warning: Function > parameter or member 'sink' not described in 'dc_link_remove_remote_sink' > > Cc: Harry Wentland > Cc: Leo Li > Cc: Alex Deucher > Cc: "Christian König" > Cc: David Airlie > Cc: Daniel Vetter > Cc: amd-...@lists.freedesktop.org > Cc: dri-devel@lists.freedesktop.org > Signed-off-by: Lee Jones Applied. Thanks! Alex > --- > drivers/gpu/drm/amd/display/dc/core/dc.c | 33 > 1 file changed, 16 insertions(+), 17 deletions(-) > > diff --git a/drivers/gpu/drm/amd/display/dc/core/dc.c > b/drivers/gpu/drm/amd/display/dc/core/dc.c > index 0a07e608485ff..3ee3978fae977 100644 > --- a/drivers/gpu/drm/amd/display/dc/core/dc.c > +++ b/drivers/gpu/drm/amd/display/dc/core/dc.c > @@ -284,20 +284,16 @@ static void dc_perf_trace_destroy(struct dc_perf_trace > **perf_trace) > } > > /** > - > * > - * Function: dc_stream_adjust_vmin_vmax > + * dc_stream_adjust_vmin_vmax: > * > - * @brief > - * Looks up the pipe context of dc_stream_state and updates the > - * vertical_total_min and vertical_total_max of the DRR, Dynamic Refresh > - * Rate, which is a power-saving feature that targets reducing panel > - * refresh rate while the screen is static > + * Looks up the pipe context of dc_stream_state and updates the > + * vertical_total_min and vertical_total_max of the DRR, Dynamic Refresh > + * Rate, which is a power-saving feature that targets reducing panel > + * refresh rate while the screen is static > * > - * @param [in] dc: dc reference > - * @param [in] stream: Initial dc stream state > - * @param [in] adjust: Updated parameters for vertical_total_min and > - * vertical_total_max > - > * > + * @dc: dc reference > + * @stream: Initial dc stream state > + * @adjust: Updated parameters for vertical_total_min and vertical_total_max > */ > bool dc_stream_adjust_vmin_
[PATCH 20/30] drm/amd/display/dc/core/dc: Fix a bunch of documentation misdemeanours
Fixes the following W=1 kernel build warning(s): drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:287: warning: Cannot understand * drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:366: warning: Function parameter or member 'crc_window' not described in 'dc_stream_configure_crc' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function parameter or member 'r_cr' not described in 'dc_stream_get_crc' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function parameter or member 'g_y' not described in 'dc_stream_get_crc' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function parameter or member 'b_cb' not described in 'dc_stream_get_crc' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'dc' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'updates' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'surface_count' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'stream_update' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'stream_status' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function parameter or member 'dc' not described in 'dc_interrupt_set' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function parameter or member 'src' not described in 'dc_interrupt_set' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function parameter or member 'enable' not described in 'dc_interrupt_set' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function parameter or member 'link' not described in 'dc_link_add_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function parameter or member 'edid' not described in 'dc_link_add_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function parameter or member 'len' not described in 'dc_link_add_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function parameter or member 'init_data' not described in 'dc_link_add_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3022: warning: Function parameter or member 'link' not described in 'dc_link_remove_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3022: warning: Function parameter or member 'sink' not described in 'dc_link_remove_remote_sink' Cc: Harry Wentland Cc: Leo Li Cc: Alex Deucher Cc: "Christian König" Cc: David Airlie Cc: Daniel Vetter Cc: amd-...@lists.freedesktop.org Cc: dri-devel@lists.freedesktop.org Signed-off-by: Lee Jones --- drivers/gpu/drm/amd/display/dc/core/dc.c | 33 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/drivers/gpu/drm/amd/display/dc/core/dc.c b/drivers/gpu/drm/amd/display/dc/core/dc.c index 0a07e608485ff..3ee3978fae977 100644 --- a/drivers/gpu/drm/amd/display/dc/core/dc.c +++ b/drivers/gpu/drm/amd/display/dc/core/dc.c @@ -284,20 +284,16 @@ static void dc_perf_trace_destroy(struct dc_perf_trace **perf_trace) } /** - * - * Function: dc_stream_adjust_vmin_vmax + * dc_stream_adjust_vmin_vmax: * - * @brief - * Looks up the pipe context of dc_stream_state and updates the - * vertical_total_min and vertical_total_max of the DRR, Dynamic Refresh - * Rate, which is a power-saving feature that targets reducing panel - * refresh rate while the screen is static + * Looks up the pipe context of dc_stream_state and updates the + * vertical_total_min and vertical_total_max of the DRR, Dynamic Refresh + * Rate, which is a power-saving feature that targets reducing panel + * refresh rate while the screen is static * - * @param [in] dc: dc reference - * @param [in] stream: Initial dc stream state - * @param [in] adjust: Updated parameters for vertical_total_min and - * vertical_total_max - * + * @dc: dc reference + * @stream: Initial dc stream state + * @adjust: Updated parameters for vertical_total_min and vertical_total_max */ bool dc_stream_adjust_vmin_vmax(struct dc *dc, struct dc_stream_state *stream, @@ -355,6 +351,7 @@ bool dc_stream_get_crtc_position(struct dc *dc, * @dc: DC Object * @stream: The stream to configure CRC on. * @enable: Enable CRC if true, disable otherwise. + * @crc_window:
