Re: [PATCH] firmware: xilinx: Fix kernel-doc warnings

[Michal Simek]

On 01. 12. 20 15:29, Michal Simek wrote:
> kernel-doc is reporting some style issues. The patch is fixing them.
> 
> Signed-off-by: Michal Simek <michal.simek@xxxxxxxxxx>
> ---
> 
>  drivers/firmware/xilinx/zynqmp.c | 46 ++++++++++++++++----------------
>  1 file changed, 23 insertions(+), 23 deletions(-)
> 
> diff --git a/drivers/firmware/xilinx/zynqmp.c b/drivers/firmware/xilinx/zynqmp.c
> index d6f12c89c6f3..ddf8e4e72584 100644
> --- a/drivers/firmware/xilinx/zynqmp.c
> +++ b/drivers/firmware/xilinx/zynqmp.c
> @@ -585,13 +585,13 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_get_pll_frac_data);
>  /**
>   * zynqmp_pm_set_sd_tapdelay() -  Set tap delay for the SD device
>   *
> - * @node_id	Node ID of the device
> - * @type	Type of tap delay to set (input/output)
> - * @value	Value to set fot the tap delay
> + * @node_id:	Node ID of the device
> + * @type:	Type of tap delay to set (input/output)
> + * @value:	Value to set fot the tap delay
>   *
>   * This function sets input/output tap delay for the SD device.
>   *
> - * @return	Returns status, either success or error+reason
> + * Return:	Returns status, either success or error+reason
>   */
>  int zynqmp_pm_set_sd_tapdelay(u32 node_id, u32 type, u32 value)
>  {
> @@ -603,12 +603,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_set_sd_tapdelay);
>  /**
>   * zynqmp_pm_sd_dll_reset() - Reset DLL logic
>   *
> - * @node_id	Node ID of the device
> - * @type	Reset type
> + * @node_id:	Node ID of the device
> + * @type:	Reset type
>   *
>   * This function resets DLL logic for the SD device.
>   *
> - * @return	Returns status, either success or error+reason
> + * Return:	Returns status, either success or error+reason
>   */
>  int zynqmp_pm_sd_dll_reset(u32 node_id, u32 type)
>  {
> @@ -619,12 +619,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_sd_dll_reset);
>  
>  /**
>   * zynqmp_pm_write_ggs() - PM API for writing global general storage (ggs)
> - * @index	GGS register index
> - * @value	Register value to be written
> + * @index:	GGS register index
> + * @value:	Register value to be written
>   *
>   * This function writes value to GGS register.
>   *
> - * @return      Returns status, either success or error+reason
> + * Return:      Returns status, either success or error+reason
>   */
>  int zynqmp_pm_write_ggs(u32 index, u32 value)
>  {
> @@ -635,12 +635,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_write_ggs);
>  
>  /**
>   * zynqmp_pm_write_ggs() - PM API for reading global general storage (ggs)
> - * @index	GGS register index
> - * @value	Register value to be written
> + * @index:	GGS register index
> + * @value:	Register value to be written
>   *
>   * This function returns GGS register value.
>   *
> - * @return      Returns status, either success or error+reason
> + * Return:	Returns status, either success or error+reason
>   */
>  int zynqmp_pm_read_ggs(u32 index, u32 *value)
>  {
> @@ -652,12 +652,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_read_ggs);
>  /**
>   * zynqmp_pm_write_pggs() - PM API for writing persistent global general
>   *			     storage (pggs)
> - * @index	PGGS register index
> - * @value	Register value to be written
> + * @index:	PGGS register index
> + * @value:	Register value to be written
>   *
>   * This function writes value to PGGS register.
>   *
> - * @return      Returns status, either success or error+reason
> + * Return:	Returns status, either success or error+reason
>   */
>  int zynqmp_pm_write_pggs(u32 index, u32 value)
>  {
> @@ -669,12 +669,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_write_pggs);
>  /**
>   * zynqmp_pm_write_pggs() - PM API for reading persistent global general
>   *			     storage (pggs)
> - * @index	PGGS register index
> - * @value	Register value to be written
> + * @index:	PGGS register index
> + * @value:	Register value to be written
>   *
>   * This function returns PGGS register value.
>   *
> - * @return      Returns status, either success or error+reason
> + * Return:	Returns status, either success or error+reason
>   */
>  int zynqmp_pm_read_pggs(u32 index, u32 *value)
>  {
> @@ -685,12 +685,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_read_pggs);
>  
>  /**
>   * zynqmp_pm_set_boot_health_status() - PM API for setting healthy boot status
> - * @value	Status value to be written
> + * @value:	Status value to be written
>   *
>   * This function sets healthy bit value to indicate boot health status
>   * to firmware.
>   *
> - * @return      Returns status, either success or error+reason
> + * Return:	Returns status, either success or error+reason
>   */
>  int zynqmp_pm_set_boot_health_status(u32 value)
>  {
> @@ -899,10 +899,10 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_pinctrl_set_config);
>   * zynqmp_pm_init_finalize() - PM call to inform firmware that the caller
>   *			       master has initialized its own power management
>   *
> + * Return: Returns status, either success or error+reason
> + *
>   * This API function is to be used for notify the power management controller
>   * about the completed power management initialization.
> - *
> - * Return: Returns status, either success or error+reason
>   */
>  int zynqmp_pm_init_finalize(void)
>  {
> 

Applied.

Thanks,
Michal

-- 
Michal Simek, Ing. (M.Eng), OpenPGP -> KeyID: FE3D1F91
w: www.monstr.eu p: +42-0-721842854
Maintainer of Linux kernel - Xilinx Microblaze
Maintainer of Linux kernel - Xilinx Zynq ARM and ZynqMP ARM64 SoCs
U-Boot custodian - Xilinx Microblaze/Zynq/ZynqMP/Versal SoCs