From: Michal Simek <monstr@monstr.eu>
To: Michal Simek <michal.simek@xilinx.com>,
linux-kernel@vger.kernel.org, git@xilinx.com
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Jolly Shah <jolly.shah@xilinx.com>,
Manish Narani <manish.narani@xilinx.com>,
Rajan Vaja <rajan.vaja@xilinx.com>,
Ravi Patel <ravi.patel@xilinx.com>,
Sai Krishna Potthuri <lakshmi.sai.krishna.potthuri@xilinx.com>,
Tejas Patel <tejas.patel@xilinx.com>,
linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH] firmware: xilinx: Fix kernel-doc warnings
Date: Wed, 9 Dec 2020 15:11:56 +0100 [thread overview]
Message-ID: <6a875bc1-fa11-7638-51b6-25c65f5791ea@monstr.eu> (raw)
In-Reply-To: <e606233d15bfdc594535dd34eb85472b42f61830.1606832997.git.michal.simek@xilinx.com>
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@xilinx.com>
> ---
>
> 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
prev parent reply other threads:[~2020-12-09 14:13 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-01 14:29 [PATCH] firmware: xilinx: Fix kernel-doc warnings Michal Simek
2020-12-09 14:11 ` Michal Simek [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6a875bc1-fa11-7638-51b6-25c65f5791ea@monstr.eu \
--to=monstr@monstr.eu \
--cc=git@xilinx.com \
--cc=gregkh@linuxfoundation.org \
--cc=jolly.shah@xilinx.com \
--cc=lakshmi.sai.krishna.potthuri@xilinx.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=manish.narani@xilinx.com \
--cc=michal.simek@xilinx.com \
--cc=rajan.vaja@xilinx.com \
--cc=ravi.patel@xilinx.com \
--cc=tejas.patel@xilinx.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).