Commit 80fbe537 authored by Lee Jones's avatar Lee Jones Committed by Alex Deucher

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 <harry.wentland@amd.com>
Cc: Leo Li <sunpeng.li@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: "Christian König" <christian.koenig@amd.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: amd-gfx@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent 61f02424
...@@ -284,20 +284,16 @@ static void dc_perf_trace_destroy(struct dc_perf_trace **perf_trace) ...@@ -284,20 +284,16 @@ static void dc_perf_trace_destroy(struct dc_perf_trace **perf_trace)
} }
/** /**
***************************************************************************** * dc_stream_adjust_vmin_vmax:
* Function: dc_stream_adjust_vmin_vmax
* *
* @brief * Looks up the pipe context of dc_stream_state and updates the
* Looks up the pipe context of dc_stream_state and updates the * vertical_total_min and vertical_total_max of the DRR, Dynamic Refresh
* vertical_total_min and vertical_total_max of the DRR, Dynamic Refresh * Rate, which is a power-saving feature that targets reducing panel
* Rate, which is a power-saving feature that targets reducing panel * refresh rate while the screen is static
* refresh rate while the screen is static
* *
* @param [in] dc: dc reference * @dc: dc reference
* @param [in] stream: Initial dc stream state * @stream: Initial dc stream state
* @param [in] adjust: Updated parameters for vertical_total_min and * @adjust: Updated parameters for vertical_total_min and vertical_total_max
* vertical_total_max
*****************************************************************************
*/ */
bool dc_stream_adjust_vmin_vmax(struct dc *dc, bool dc_stream_adjust_vmin_vmax(struct dc *dc,
struct dc_stream_state *stream, struct dc_stream_state *stream,
...@@ -355,6 +351,7 @@ bool dc_stream_get_crtc_position(struct dc *dc, ...@@ -355,6 +351,7 @@ bool dc_stream_get_crtc_position(struct dc *dc,
* @dc: DC Object * @dc: DC Object
* @stream: The stream to configure CRC on. * @stream: The stream to configure CRC on.
* @enable: Enable CRC if true, disable otherwise. * @enable: Enable CRC if true, disable otherwise.
* @crc_window: CRC window (x/y start/end) information
* @continuous: Capture CRC on every frame if true. Otherwise, only capture * @continuous: Capture CRC on every frame if true. Otherwise, only capture
* once. * once.
* *
...@@ -420,7 +417,9 @@ bool dc_stream_configure_crc(struct dc *dc, struct dc_stream_state *stream, ...@@ -420,7 +417,9 @@ bool dc_stream_configure_crc(struct dc *dc, struct dc_stream_state *stream,
* dc_stream_get_crc() - Get CRC values for the given stream. * dc_stream_get_crc() - Get CRC values for the given stream.
* @dc: DC object * @dc: DC object
* @stream: The DC stream state of the stream to get CRCs from. * @stream: The DC stream state of the stream to get CRCs from.
* @r_cr, g_y, b_cb: CRC values for the three channels are stored here. * @r_cr: CRC value for the first of the 3 channels stored here.
* @g_y: CRC value for the second of the 3 channels stored here.
* @b_cb: CRC value for the third of the 3 channels stored here.
* *
* dc_stream_configure_crc needs to be called beforehand to enable CRCs. * dc_stream_configure_crc needs to be called beforehand to enable CRCs.
* Return false if stream is not found, or if CRCs are not enabled. * Return false if stream is not found, or if CRCs are not enabled.
...@@ -2012,7 +2011,7 @@ static enum surface_update_type check_update_surfaces_for_stream( ...@@ -2012,7 +2011,7 @@ static enum surface_update_type check_update_surfaces_for_stream(
return overall_type; return overall_type;
} }
/** /*
* dc_check_update_surfaces_for_stream() - Determine update type (fast, med, or full) * dc_check_update_surfaces_for_stream() - Determine update type (fast, med, or full)
* *
* See :c:type:`enum surface_update_type <surface_update_type>` for explanation of update types * See :c:type:`enum surface_update_type <surface_update_type>` for explanation of update types
...@@ -2827,7 +2826,7 @@ enum dc_irq_source dc_interrupt_to_irq_source( ...@@ -2827,7 +2826,7 @@ enum dc_irq_source dc_interrupt_to_irq_source(
return dal_irq_service_to_irq_source(dc->res_pool->irqs, src_id, ext_id); return dal_irq_service_to_irq_source(dc->res_pool->irqs, src_id, ext_id);
} }
/** /*
* dc_interrupt_set() - Enable/disable an AMD hw interrupt source * dc_interrupt_set() - Enable/disable an AMD hw interrupt source
*/ */
bool dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable) bool dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable)
...@@ -2961,7 +2960,7 @@ static bool link_add_remote_sink_helper(struct dc_link *dc_link, struct dc_sink ...@@ -2961,7 +2960,7 @@ static bool link_add_remote_sink_helper(struct dc_link *dc_link, struct dc_sink
return true; return true;
} }
/** /*
* dc_link_add_remote_sink() - Create a sink and attach it to an existing link * dc_link_add_remote_sink() - Create a sink and attach it to an existing link
* *
* EDID length is in bytes * EDID length is in bytes
...@@ -3024,7 +3023,7 @@ struct dc_sink *dc_link_add_remote_sink( ...@@ -3024,7 +3023,7 @@ struct dc_sink *dc_link_add_remote_sink(
return NULL; return NULL;
} }
/** /*
* dc_link_remove_remote_sink() - Remove a remote sink from a dc_link * dc_link_remove_remote_sink() - Remove a remote sink from a dc_link
* *
* Note that this just removes the struct dc_sink - it doesn't * Note that this just removes the struct dc_sink - it doesn't
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment