Re: [PATCH 18/40] drm/amd/display/dc/bios/bios_parser: Fix a whole bunch of legacy doc formatting

[Alex Deucher <alexdeucher@gmail.com>]

Applied.  Thanks!

Alex

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_parser.c:2588:16: warning: no previous prototype for ‘update_slot_layout_info’ [-Wmissing-prototypes]
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:2692:16: warning: no previous prototype for ‘get_bracket_layout_record’ [-Wmissing-prototypes]
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:925: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_spread_spectrum_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:925: warning: Function parameter or member 'signal' not described in 'bios_parser_get_spread_spectrum_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:925: warning: Function parameter or member 'index' not described in 'bios_parser_get_spread_spectrum_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:925: 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_parser.c:997: warning: Function parameter or member 'bp' not described in 'get_ss_info_from_tbl'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:997: warning: Function parameter or member 'id' not described in 'get_ss_info_from_tbl'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:997: warning: Function parameter or member 'ss_info' not described in 'get_ss_info_from_tbl'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1022: warning: Function parameter or member 'bp' not described in 'get_ss_info_from_internal_ss_info_tbl_V2_1'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1022: warning: Function parameter or member 'id' not described in 'get_ss_info_from_internal_ss_info_tbl_V2_1'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1022: warning: Function parameter or member 'info' not described in 'get_ss_info_from_internal_ss_info_tbl_V2_1'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1087: warning: Function parameter or member 'bp' not described in 'get_ss_info_from_ss_info_table'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1087: warning: Function parameter or member 'id' not described in 'get_ss_info_from_ss_info_table'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1087: warning: Function parameter or member 'ss_info' not described in 'get_ss_info_from_ss_info_table'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1469: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_encoder_cap_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1469: warning: Function parameter or member 'object_id' not described in 'bios_parser_get_encoder_cap_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1469: warning: Function parameter or member 'info' not described in 'bios_parser_get_encoder_cap_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1508: warning: Function parameter or member 'bp' not described in 'get_encoder_cap_record'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1508: warning: Function parameter or member 'object' not described in 'get_encoder_cap_record'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1566: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_ss_entry_number'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1566: warning: Function parameter or member 'signal' not described in 'bios_parser_get_ss_entry_number'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1619: warning: Function parameter or member 'bp' not described in 'get_ss_entry_number_from_ss_info_tbl'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1619: warning: Function parameter or member 'id' not described in 'get_ss_entry_number_from_ss_info_tbl'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1686: warning: Function parameter or member 'bp' not described in 'get_ss_entry_number'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1686: warning: Function parameter or member 'id' not described in 'get_ss_entry_number'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1705: warning: Function parameter or member 'bp' not described in 'get_ss_entry_number_from_internal_ss_info_tbl_v2_1'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1705: warning: Function parameter or member 'id' not described in 'get_ss_entry_number_from_internal_ss_info_tbl_v2_1'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1740: warning: Function parameter or member 'bp' not described in 'get_ss_entry_number_from_internal_ss_info_tbl_V3_1'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1740: warning: Function parameter or member 'id' not described in 'get_ss_entry_number_from_internal_ss_info_tbl_V3_1'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1783: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_gpio_pin_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1783: 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_parser.c:1783: warning: Function parameter or member 'info' not described in 'bios_parser_get_gpio_pin_info'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:2211: warning: Function parameter or member 'dcb' not described in 'bios_parser_set_scratch_critical_state'
>  drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:2211: 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: Lee Jones <lee.jones@linaro.org>
> Cc: amd-gfx@lists.freedesktop.org
> Cc: dri-devel@lists.freedesktop.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  .../gpu/drm/amd/display/dc/bios/bios_parser.c | 115 +++++++++---------
>  1 file changed, 56 insertions(+), 59 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/display/dc/bios/bios_parser.c b/drivers/gpu/drm/amd/display/dc/bios/bios_parser.c
> index f054c5872c619..d2654c50b0b20 100644
> --- a/drivers/gpu/drm/amd/display/dc/bios/bios_parser.c
> +++ b/drivers/gpu/drm/amd/display/dc/bios/bios_parser.c
> @@ -911,11 +911,11 @@ static enum bp_result get_ss_info_from_tbl(
>   * ver 2.1 can co-exist with SS_Info table. Expect ASIC_InternalSS_Info 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,
> @@ -985,10 +985,10 @@ static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1(
>   * There can not be more than 1 entry for  ASIC_InternalSS_Info Ver 2.1 or
>   * SS_Info.
>   *
> - * @param this
> - * @param id, spread sprectrum info index
> - * @param pSSinfo, sprectrum information structure,
> - * @return Bios parser result code
> + * @bp:      pointer to the BIOS parser
> + * @id:      spread sprectrum info index
> + * @ssinfo:  sprectrum information structure,
> + * return::  BIOS parser result code
>   */
>  static enum bp_result get_ss_info_from_tbl(
>         struct bios_parser *bp,
> @@ -1011,9 +1011,10 @@ static enum bp_result get_ss_info_from_tbl(
>   * from the VBIOS
>   * There will not be multiple entry for Ver 2.1
>   *
> - * @param id, spread sprectrum info index
> - * @param pSSinfo, sprectrum information structure,
> - * @return Bios parser result code
> + * @bp:    pointer to the Bios parser
> + * @id:    spread sprectrum info index
> + * @info:  sprectrum information structure,
> + * return: Bios parser result code
>   */
>  static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1(
>         struct bios_parser *bp,
> @@ -1076,9 +1077,10 @@ static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1(
>   * of entries that matches the id
>   * for, the SS_Info table, there should not be more than 1 entry match.
>   *
> - * @param [in] id, spread sprectrum id
> - * @param [out] pSSinfo, sprectrum information structure,
> - * @return Bios parser result code
> + * @bp:      pointer to the Bios parser
> + * @id:      spread sprectrum id
> + * @ss_info: sprectrum information structure,
> + * return:   Bios parser result code
>   */
>  static enum bp_result get_ss_info_from_ss_info_table(
>         struct bios_parser *bp,
> @@ -1451,16 +1453,14 @@ static enum bp_result get_embedded_panel_info_v1_3(
>  }
>
>  /**
> - * bios_parser_get_encoder_cap_info
> + * bios_parser_get_encoder_cap_info - get encoder capability
> + *                                    information of input object id
>   *
> - * @brief
> - *  Get encoder capability information of input object id
> - *
> - * @param object_id, Object id
> - * @param object_id, encoder cap information structure
> - *
> - * @return Bios parser result code
> + * @dcb:       pointer to the DC BIOS
> + * @object_id: object id
> + * @info:      encoder cap information structure
>   *
> + * return: Bios parser result code
>   */
>  static enum bp_result bios_parser_get_encoder_cap_info(
>         struct dc_bios *dcb,
> @@ -1490,17 +1490,12 @@ static enum bp_result bios_parser_get_encoder_cap_info(
>  }
>
>  /**
> - * get_encoder_cap_record
> - *
> - * @brief
> - *  Get encoder cap record for the object
> - *
> - * @param object, ATOM object
> + * get_encoder_cap_record - Get encoder cap record for the object
>   *
> - * @return atom encoder cap record
> - *
> - * @note
> - *  search all records to find the ATOM_ENCODER_CAP_RECORD_V2 record
> + * @bp:      pointer to the BIOS parser
> + * @object:  ATOM object
> + * return:   atom encoder cap record
> + * note:     search all records to find the ATOM_ENCODER_CAP_RECORD_V2 record
>   */
>  static ATOM_ENCODER_CAP_RECORD_V2 *get_encoder_cap_record(
>         struct bios_parser *bp,
> @@ -1557,8 +1552,9 @@ static uint32_t get_ss_entry_number_from_ss_info_tbl(
>   * Get Number of SpreadSpectrum Entry from the ASIC_InternalSS_Info table from
>   * the VBIOS that match the SSid (to be converted from signal)
>   *
> - * @param[in] signal, ASSignalType to be converted to SSid
> - * @return number of SS Entry that match the signal
> + * @dcb:    pointer to the DC BIOS
> + * @signal: ASSignalType to be converted to SSid
> + * return: number of SS Entry that match the signal
>   */
>  static uint32_t bios_parser_get_ss_entry_number(
>         struct dc_bios *dcb,
> @@ -1608,10 +1604,10 @@ static uint32_t bios_parser_get_ss_entry_number(
>   * get_ss_entry_number_from_ss_info_tbl
>   * Get Number of spread spectrum entry from the SS_Info table from the VBIOS.
>   *
> - * @note There can only be one entry for each id for SS_Info Table
> - *
> - * @param [in] id, spread spectrum id
> - * @return number of SS Entry that match the id
> + * @bp:  pointer to the BIOS parser
> + * @id:  spread spectrum id
> + * return: number of SS Entry that match the id
> + * note: There can only be one entry for each id for SS_Info Table
>   */
>  static uint32_t get_ss_entry_number_from_ss_info_tbl(
>         struct bios_parser *bp,
> @@ -1679,8 +1675,9 @@ static uint32_t get_ss_entry_number_from_ss_info_tbl(
>   * There can not be more than 1 entry for  ASIC_InternalSS_Info Ver 2.1 or
>   * SS_Info.
>   *
> - * @param id, spread sprectrum info index
> - * @return Bios parser result code
> + * @bp:    pointer to the BIOS parser
> + * @id:    spread sprectrum info index
> + * return: Bios parser result code
>   */
>  static uint32_t get_ss_entry_number(struct bios_parser *bp, uint32_t id)
>  {
> @@ -1696,8 +1693,9 @@ static uint32_t get_ss_entry_number(struct bios_parser *bp, uint32_t id)
>   * Ver 2.1 from the VBIOS
>   * There will not be multiple entry for Ver 2.1
>   *
> - * @param id, spread sprectrum info index
> - * @return number of SS Entry that match the id
> + * @bp:    pointer to the BIOS parser
> + * @id:    spread sprectrum info index
> + * return: number of SS Entry that match the id
>   */
>  static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_v2_1(
>         struct bios_parser *bp,
> @@ -1731,8 +1729,9 @@ static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_v2_1(
>   * Get Number of SpreadSpectrum Entry from the ASIC_InternalSS_Info table of
>   * the VBIOS that matches id
>   *
> - * @param[in]  id, spread sprectrum id
> - * @return number of SS Entry that match the id
> + * @bp:    pointer to the BIOS parser
> + * @id:    spread sprectrum id
> + * return: number of SS Entry that match the id
>   */
>  static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_V3_1(
>         struct bios_parser *bp,
> @@ -1767,10 +1766,11 @@ static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_V3_1(
>   * 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, to get the registerA
> @@ -2197,13 +2197,10 @@ static uint32_t get_support_mask_for_device_id(struct device_id device_id)
>  }
>
>  /**
> - * bios_parser_set_scratch_critical_state
> - *
> - * @brief
> - *  update critical state bit in VBIOS scratch register
> - *
> - * @param
> - *  bool - to set or reset state
> + * bios_parser_set_scratch_critical_state - update critical state
> + *                                          bit in VBIOS scratch register
> + * @dcb:    pointer to the DC BIOS
> + * @state:  set or reset state
>   */
>  static void bios_parser_set_scratch_critical_state(
>         struct dc_bios *dcb,
> @@ -2222,7 +2219,7 @@ static void bios_parser_set_scratch_critical_state(
>   * bios_parser *bp - [in]BIOS parser handler to get master data table
>   * integrated_info *info - [out] store and output integrated info
>   *
> - * @return
> + * return:
>   * enum bp_result - BP_RESULT_OK if information is available,
>   *                  BP_RESULT_BADBIOSTABLE otherwise.
>   */
> @@ -2372,7 +2369,7 @@ static enum bp_result get_integrated_info_v8(
>   * bios_parser *bp - [in]BIOS parser handler to get master data table
>   * integrated_info *info - [out] store and output integrated info
>   *
> - * @return
> + * return:
>   * enum bp_result - BP_RESULT_OK if information is available,
>   *                  BP_RESULT_BADBIOSTABLE otherwise.
>   */
> @@ -2509,7 +2506,7 @@ static enum bp_result get_integrated_info_v9(
>   * bios_parser *bp - [in]BIOS parser handler to get master data table
>   * integrated_info *info - [out] store and output integrated info
>   *
> - * @return
> + * return:
>   * enum bp_result - BP_RESULT_OK if information is available,
>   *                  BP_RESULT_BADBIOSTABLE otherwise.
>   */
> --
> 2.25.1
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel