Re: [PATCH 06/34] drm/amd/pm/powerplay/hwmgr/vega10_hwmgr: Kernel-doc headers must contain function names

[Alex Deucher]

Applied.  Thanks!

On Wed, May 26, 2021 at 4:47 AM Lee Jones <lee.jones@xxxxxxxxxx> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:547: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:603: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:629: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:1006: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:1155: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:1608: warning: expecting prototype for Populates single SMC GFXSCLK structure using the provided engine clock(). Prototype was for vega10_populate_single_gfx_level() instead
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:1663: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:1713: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:1862: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:2546: warning: expecting prototype for Initializes the SMC table and uploads it(). Prototype was for vega10_init_smc_table() instead
>  drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_hwmgr.c:2922: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>
> Cc: Evan Quan <evan.quan@xxxxxxx>
> Cc: Alex Deucher <alexander.deucher@xxxxxxx>
> Cc: "Christian König" <christian.koenig@xxxxxxx>
> Cc: David Airlie <airlied@xxxxxxxx>
> Cc: Daniel Vetter <daniel@xxxxxxxx>
> Cc: amd-gfx@xxxxxxxxxxxxxxxxxxxxx
> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> ---
>  .../drm/amd/pm/powerplay/hwmgr/vega10_hwmgr.c | 26 +++++++++++--------
>  1 file changed, 15 insertions(+), 11 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega10_hwmgr.c b/drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega10_hwmgr.c
> index 31c61ac3bd5e1..25979106fd255 100644
> --- a/drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega10_hwmgr.c
> +++ b/drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega10_hwmgr.c
> @@ -544,7 +544,7 @@ static int vega10_get_socclk_for_voltage_evv(struct pp_hwmgr *hwmgr,
>
>  #define ATOM_VIRTUAL_VOLTAGE_ID0             0xff01
>  /**
> - * Get Leakage VDDC based on leakage ID.
> + * vega10_get_evv_voltages - Get Leakage VDDC based on leakage ID.
>   *
>   * @hwmgr:  the address of the powerplay hardware manager.
>   * return:  always 0.
> @@ -600,7 +600,7 @@ static int vega10_get_evv_voltages(struct pp_hwmgr *hwmgr)
>  }
>
>  /**
> - * Change virtual leakage voltage to actual value.
> + * vega10_patch_with_vdd_leakage - Change virtual leakage voltage to actual value.
>   *
>   * @hwmgr:         the address of the powerplay hardware manager.
>   * @voltage:       pointer to changing voltage
> @@ -626,7 +626,7 @@ static void vega10_patch_with_vdd_leakage(struct pp_hwmgr *hwmgr,
>  }
>
>  /**
> - * Patch voltage lookup table by EVV leakages.
> + * vega10_patch_lookup_table_with_leakage - Patch voltage lookup table by EVV leakages.
>   *
>   * @hwmgr:         the address of the powerplay hardware manager.
>   * @lookup_table:  pointer to voltage lookup table
> @@ -1003,7 +1003,7 @@ static int vega10_setup_asic_task(struct pp_hwmgr *hwmgr)
>  }
>
>  /**
> - * Remove repeated voltage values and create table with unique values.
> + * vega10_trim_voltage_table - Remove repeated voltage values and create table with unique values.
>   *
>   * @hwmgr:      the address of the powerplay hardware manager.
>   * @vol_table:  the pointer to changing voltage table
> @@ -1152,7 +1152,7 @@ static void vega10_trim_voltage_table_to_fit_state_table(
>  }
>
>  /**
> - * Create Voltage Tables.
> + * vega10_construct_voltage_tables - Create Voltage Tables.
>   *
>   * @hwmgr:  the address of the powerplay hardware manager.
>   * return:  always 0
> @@ -1595,7 +1595,8 @@ static int vega10_populate_smc_link_levels(struct pp_hwmgr *hwmgr)
>  }
>
>  /**
> - * Populates single SMC GFXSCLK structure using the provided engine clock
> + * vega10_populate_single_gfx_level - Populates single SMC GFXSCLK structure
> + *                                    using the provided engine clock
>   *
>   * @hwmgr:      the address of the hardware manager
>   * @gfx_clock:  the GFX clock to use to populate the structure.
> @@ -1660,7 +1661,8 @@ static int vega10_populate_single_gfx_level(struct pp_hwmgr *hwmgr,
>  }
>
>  /**
> - * Populates single SMC SOCCLK structure using the provided clock.
> + * vega10_populate_single_soc_level - Populates single SMC SOCCLK structure
> + *                                    using the provided clock.
>   *
>   * @hwmgr:     the address of the hardware manager.
>   * @soc_clock: the SOC clock to use to populate the structure.
> @@ -1710,7 +1712,8 @@ static int vega10_populate_single_soc_level(struct pp_hwmgr *hwmgr,
>  }
>
>  /**
> - * Populates all SMC SCLK levels' structure based on the trimmed allowed dpm engine clock states
> + * vega10_populate_all_graphic_levels - Populates all SMC SCLK levels' structure
> + *                                      based on the trimmed allowed dpm engine clock states
>   *
>   * @hwmgr:      the address of the hardware manager
>   */
> @@ -1859,7 +1862,8 @@ static int vega10_populate_single_memory_level(struct pp_hwmgr *hwmgr,
>  }
>
>  /**
> - * Populates all SMC MCLK levels' structure based on the trimmed allowed dpm memory clock states.
> + * vega10_populate_all_memory_levels - Populates all SMC MCLK levels' structure
> + *                                     based on the trimmed allowed dpm memory clock states.
>   *
>   * @hwmgr:  the address of the hardware manager.
>   * return:   PP_Result_OK on success.
> @@ -2537,7 +2541,7 @@ static void vega10_check_dpm_table_updated(struct pp_hwmgr *hwmgr)
>  }
>
>  /**
> - * Initializes the SMC table and uploads it
> + * vega10_init_smc_table - Initializes the SMC table and uploads it
>   *
>   * @hwmgr:  the address of the powerplay hardware manager.
>   * return:  always 0
> @@ -2919,7 +2923,7 @@ static int vega10_stop_dpm(struct pp_hwmgr *hwmgr, uint32_t bitmap)
>  }
>
>  /**
> - * Tell SMC to enabled the supported DPMs.
> + * vega10_start_dpm - Tell SMC to enabled the supported DPMs.
>   *
>   * @hwmgr:   the address of the powerplay hardware manager.
>   * @bitmap:  bitmap for the features to enabled.
> --
> 2.31.1
>