From: Muhammad Husaini Zulkifli <muhammad.husaini.zulkifli@intel.com>
To: ulf.hansson@linaro.org, michal.simek@xilinx.com,
linux-mmc@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org
Cc: adrian.hunter@intel.com, andriy.shevchenko@intel.com,
muhammad.husaini.zulkifli@intel.com
Subject: [PATCH v1 1/2] mmc: sdhci-of-arasan: Fixed kernel-doc format warning
Date: Mon, 11 Jan 2021 23:50:00 +0800 [thread overview]
Message-ID: <20210111155001.12307-2-muhammad.husaini.zulkifli@intel.com> (raw)
In-Reply-To: <20210111155001.12307-1-muhammad.husaini.zulkifli@intel.com>
Commit 36c6aadaae86 ("mmc: sdhci-of-arasan: Add support for Intel Keem Bay")
introduces syscon map sdhci_arasan_update_support64b(). Unfortunately,
kernel-doc format script tool has not been run before and causing warning
on the documentation style.
Below is the output when running the kernel-doc script tool:
drivers/mmc/host/sdhci-of-arasan.c:1388: warning: contents before sections
Let's fix this by using standard conventions kernel-doc format.
Fixes: 36c6aadaae86 ("mmc: sdhci-of-arasan: Add support for Intel Keem Bay")
Signed-off-by: Muhammad Husaini Zulkifli <muhammad.husaini.zulkifli@intel.com>
Acked-by: Andy Shevchenko <andriy.shevchenko@intel.com>
Acked-by: Adrian Hunter <adrian.hunter@intel.com>
---
drivers/mmc/host/sdhci-of-arasan.c | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/drivers/mmc/host/sdhci-of-arasan.c b/drivers/mmc/host/sdhci-of-arasan.c
index 4f3774bcda94..643313687b5e 100644
--- a/drivers/mmc/host/sdhci-of-arasan.c
+++ b/drivers/mmc/host/sdhci-of-arasan.c
@@ -1380,17 +1380,16 @@ static void sdhci_arasan_unregister_sdclk(struct device *dev)
/**
* sdhci_arasan_update_support64b - Set SUPPORT_64B (64-bit System Bus Support)
+ * @host: The sdhci_host
+ * @value: The value to write
*
* This should be set based on the System Address Bus.
* 0: the Core supports only 32-bit System Address Bus.
* 1: the Core supports 64-bit System Address Bus.
*
- * NOTES:
- * - For Keem Bay, it is required to clear this bit. Its default value is 1'b1.
- * Keem Bay does not support 64-bit access.
- *
- * @host: The sdhci_host
- * @value: The value to write
+ * NOTE:
+ * For Keem Bay, it is required to clear this bit. Its default value is 1'b1.
+ * Keem Bay does not support 64-bit access.
*/
static void sdhci_arasan_update_support64b(struct sdhci_host *host, u32 value)
{
--
2.17.1
next prev parent reply other threads:[~2021-01-11 15:52 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-11 15:49 [PATCH v1 0/2] mmc: sdhci-of-arasan: Fixed kernel-doc format warning Muhammad Husaini Zulkifli
2021-01-11 15:50 ` Muhammad Husaini Zulkifli [this message]
2021-01-11 15:50 ` [PATCH v1 2/2] mmc: sdhci-of-arasan: Change code style of mapping the syscon field Muhammad Husaini Zulkifli
2021-01-13 11:25 ` [PATCH v1 0/2] mmc: sdhci-of-arasan: Fixed kernel-doc format warning Ulf Hansson
2021-01-13 13:52 ` Zulkifli, Muhammad Husaini
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=20210111155001.12307-2-muhammad.husaini.zulkifli@intel.com \
--to=muhammad.husaini.zulkifli@intel.com \
--cc=adrian.hunter@intel.com \
--cc=andriy.shevchenko@intel.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mmc@vger.kernel.org \
--cc=michal.simek@xilinx.com \
--cc=ulf.hansson@linaro.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).