Re: [PATCH 22/40] drm/amd/display/dc/bios/bios_parser2: Fix some formatting issues and missing parameter docs

[Alex Deucher <alexdeucher@gmail.com>]

On Fri, Jan 8, 2021 at 3:15 PM Lee Jones <lee.jones@linaro.org> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:501: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_gpio_pin_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:501: warning: Function parameter or member 'gpio_id' not described in 'bios_parser_get_gpio_pin_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:501: warning: Function parameter or member 'info' not described in 'bios_parser_get_gpio_pin_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:815: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_spread_spectrum_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:815: warning: Function parameter or member 'signal' not described in 'bios_parser_get_spread_spectrum_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:815: warning: Function parameter or member 'index' not described in 'bios_parser_get_spread_spectrum_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:815: warning: Function parameter or member 'ss_info' not described in 'bios_parser_get_spread_spectrum_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:1210: warning: Function parameter or member 'dcb' not described in 'bios_parser_set_scratch_critical_state'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:1210: warning: Function parameter or member 'state' not described in 'bios_parser_set_scratch_critical_state'
>
> 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: Lee Jones <lee.jones@linaro.org>

Applied.  Thanks!

Alex


> ---
>  .../drm/amd/display/dc/bios/bios_parser2.c    | 29 +++++++++----------
>  1 file changed, 14 insertions(+), 15 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/display/dc/bios/bios_parser2.c b/drivers/gpu/drm/amd/display/dc/bios/bios_parser2.c
> index 670c265838178..9f9fda3118d1f 100644
> --- a/drivers/gpu/drm/amd/display/dc/bios/bios_parser2.c
> +++ b/drivers/gpu/drm/amd/display/dc/bios/bios_parser2.c
> @@ -485,10 +485,11 @@ static struct atom_hpd_int_record *get_hpd_record(
>   * bios_parser_get_gpio_pin_info
>   * Get GpioPin information of input gpio id
>   *
> - * @param gpio_id, GPIO ID
> - * @param info, GpioPin information structure
> - * @return Bios parser result code
> - * @note
> + * @dcb:     pointer to the DC BIOS
> + * @gpio_id: GPIO ID
> + * @info:    GpioPin information structure
> + * return: Bios parser result code
> + * note:
>   *  to get the GPIO PIN INFO, we need:
>   *  1. get the GPIO_ID from other object table, see GetHPDInfo()
>   *  2. in DATA_TABLE.GPIO_Pin_LUT, search all records,
> @@ -801,11 +802,11 @@ static enum bp_result get_ss_info_v4_2(
>   * ver 3.1,
>   * there is only one entry for each signal /ss id.  However, there is
>   * no planning of supporting multiple spread Sprectum entry for EverGreen
> - * @param [in] this
> - * @param [in] signal, ASSignalType to be converted to info index
> - * @param [in] index, number of entries that match the converted info index
> - * @param [out] ss_info, sprectrum information structure,
> - * @return Bios parser result code
> + * @dcb:     pointer to the DC BIOS
> + * @signal:  ASSignalType to be converted to info index
> + * @index:   number of entries that match the converted info index
> + * @ss_info: sprectrum information structure,
> + * return: Bios parser result code
>   */
>  static enum bp_result bios_parser_get_spread_spectrum_info(
>         struct dc_bios *dcb,
> @@ -1196,13 +1197,11 @@ static bool bios_parser_is_accelerated_mode(
>  }
>
>  /**
> - * bios_parser_set_scratch_critical_state
> + * bios_parser_set_scratch_critical_state - update critical state bit
> + *                                          in VBIOS scratch register
>   *
> - * @brief
> - *  update critical state bit in VBIOS scratch register
> - *
> - * @param
> - *  bool - to set or reset state
> + * @dcb:   pointer to the DC BIO
> + * @state: set or reset state
>   */
>  static void bios_parser_set_scratch_critical_state(
>         struct dc_bios *dcb,
> --
> 2.25.1
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel