linux-pm.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzk@kernel.org>
To: Florian Fainelli <f.fainelli@gmail.com>,
	Ray Jui <rjui@broadcom.com>,
	Scott Branden <sbranden@broadcom.com>,
	bcm-kernel-feedback-list@broadcom.com,
	Russell King <linux@armlinux.org.uk>,
	Catalin Marinas <catalin.marinas@arm.com>,
	Will Deacon <will@kernel.org>,
	Krzysztof Kozlowski <krzk@kernel.org>,
	Markus Mayer <mmayer@broadcom.com>, Roger Quadros <rogerq@ti.com>,
	Tony Lindgren <tony@atomide.com>,
	Vladimir Zapolskiy <vz@mleia.com>, Kukjin Kim <kgene@kernel.org>,
	Lukasz Luba <lukasz.luba@arm.com>,
	linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, linux-omap@vger.kernel.org,
	linux-samsung-soc@vger.kernel.org, linux-pm@vger.kernel.org
Cc: Olof Johansson <olof@lixom.net>, Arnd Bergmann <arnd@arndb.de>
Subject: [PATCH 04/16] memory: omap-gpmc: Correct kerneldoc
Date: Fri, 24 Jul 2020 20:23:16 +0200	[thread overview]
Message-ID: <20200724182328.3348-5-krzk@kernel.org> (raw)
In-Reply-To: <20200724182328.3348-1-krzk@kernel.org>

Use proper kerneldoc to fix GCC warnings like:

    drivers/memory/omap-gpmc.c:299: warning: Function parameter or member 'cs' not described in 'gpmc_get_clk_period'
    drivers/memory/omap-gpmc.c:432: warning: Excess function parameter 'ma' description in 'get_gpmc_timing_reg'

Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
---
 drivers/memory/omap-gpmc.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/memory/omap-gpmc.c b/drivers/memory/omap-gpmc.c
index 2675ea4e37fe..c91a021ac421 100644
--- a/drivers/memory/omap-gpmc.c
+++ b/drivers/memory/omap-gpmc.c
@@ -289,8 +289,8 @@ static unsigned long gpmc_get_fclk_period(void)
 
 /**
  * gpmc_get_clk_period - get period of selected clock domain in ps
- * @cs Chip Select Region.
- * @cd Clock Domain.
+ * @cs: Chip Select Region.
+ * @cd: Clock Domain.
  *
  * GPMC_CS_CONFIG1 GPMCFCLKDIVIDER for cs has to be setup
  * prior to calling this function with GPMC_CD_CLK.
@@ -409,7 +409,7 @@ static void gpmc_cs_bool_timings(int cs, const struct gpmc_bool_timings *p)
  * @reg:     GPMC_CS_CONFIGn register offset.
  * @st_bit:  Start Bit
  * @end_bit: End Bit. Must be >= @st_bit.
- * @ma:x     Maximum parameter value (before optional @shift).
+ * @max:     Maximum parameter value (before optional @shift).
  *           If 0, maximum is as high as @st_bit and @end_bit allow.
  * @name:    DTS node name, w/o "gpmc,"
  * @cd:      Clock Domain of timing parameter.
@@ -1134,7 +1134,7 @@ static struct gpmc_nand_ops nand_ops = {
 
 /**
  * gpmc_omap_get_nand_ops - Get the GPMC NAND interface
- * @regs: the GPMC NAND register map exclusive for NAND use.
+ * @reg: the GPMC NAND register map exclusive for NAND use.
  * @cs: GPMC chip select number on which the NAND sits. The
  *      register map returned will be specific to this chip select.
  *
-- 
2.17.1


  parent reply	other threads:[~2020-07-24 18:24 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-24 18:23 [PATCH 00/16] memory: Further cleanups Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 01/16] memory: bt1-l2-ctl: Add blank lines after declarations Krzysztof Kozlowski
2020-07-27  8:16   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 02/16] memory: mvebu-devbus: Add missing braces to all arms of if statement Krzysztof Kozlowski
2020-07-27  8:16   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 03/16] memory: mvebu-devbus: Align with open parenthesis Krzysztof Kozlowski
2020-07-27  8:16   ` Krzysztof Kozlowski
2020-07-24 18:23 ` Krzysztof Kozlowski [this message]
2020-07-27  8:16   ` [PATCH 04/16] memory: omap-gpmc: Correct kerneldoc Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 05/16] memory: omap-gpmc: Enclose macro argument usage in parenthesis Krzysztof Kozlowski
2020-07-27  8:16   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 06/16] memory: omap-gpmc: Use 'unsigned int' for consistency Krzysztof Kozlowski
2020-07-27  8:15   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 07/16] memory: omap-gpmc: Correct white space issues Krzysztof Kozlowski
2020-07-27  8:15   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [RFT 08/16] memory: omap-gpmc: Use WARN() instead of BUG() on wrong free Krzysztof Kozlowski
2020-08-17 18:36   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 09/16] memory: omap-gpmc: Fix language typo Krzysztof Kozlowski
2020-07-27  8:15   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 10/16] memory: omap-gpmc: Consistently use !res for NULL checks Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 11/16] memory: brcmstb_dpfe: Fix language typo Krzysztof Kozlowski
2020-07-24 18:38   ` Florian Fainelli
2020-07-27  8:14     ` Krzysztof Kozlowski
2020-07-24 18:23 ` [RFT 12/16] memory: brcmstb_dpfe: Add separate entry for compile test Krzysztof Kozlowski
2020-07-24 18:40   ` Florian Fainelli
2020-07-24 18:42     ` Krzysztof Kozlowski
2020-08-17 18:38     ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 13/16] memory: of: Correct kerneldoc Krzysztof Kozlowski
2020-07-27  8:09   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 14/16] memory: pl172: Enclose macro argument usage in parenthesis Krzysztof Kozlowski
2020-07-27  8:09   ` Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 15/16] memory: samsung: exynos-srom: Correct alignment Krzysztof Kozlowski
2020-07-24 18:23 ` [PATCH 16/16] memory: samsung: exynos5422-dmc: Correct white space issues Krzysztof Kozlowski
2020-08-18  8:22   ` Lukasz Luba

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=20200724182328.3348-5-krzk@kernel.org \
    --to=krzk@kernel.org \
    --cc=arnd@arndb.de \
    --cc=bcm-kernel-feedback-list@broadcom.com \
    --cc=catalin.marinas@arm.com \
    --cc=f.fainelli@gmail.com \
    --cc=kgene@kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-omap@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=linux-samsung-soc@vger.kernel.org \
    --cc=linux@armlinux.org.uk \
    --cc=lukasz.luba@arm.com \
    --cc=mmayer@broadcom.com \
    --cc=olof@lixom.net \
    --cc=rjui@broadcom.com \
    --cc=rogerq@ti.com \
    --cc=sbranden@broadcom.com \
    --cc=tony@atomide.com \
    --cc=vz@mleia.com \
    --cc=will@kernel.org \
    /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).