From: "Krzysztof Wilczyński" <kw@linux.com>
To: Bjorn Helgaas <bhelgaas@google.com>
Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
Kishon Vijay Abraham I <kishon@ti.com>,
Tom Joseph <tjoseph@cadence.com>,
Murali Karicheri <m-karicheri2@ti.com>,
Rob Herring <robh@kernel.org>, Russell Currey <ruscur@russell.cc>,
"Oliver O'Halloran" <oohall@gmail.com>,
Geert Uytterhoeven <geert+renesas@glider.be>,
Arnd Bergmann <arnd@arndb.de>,
Krzysztof Kozlowski <krzk@kernel.org>,
Kunihiko Hayashi <hayashi.kunihiko@socionext.com>,
Sean V Kelley <sean.v.kelley@intel.com>,
Qiuxu Zhuo <qiuxu.zhuo@intel.com>,
Jay Fang <f.fangjian@huawei.com>,
linux-pci@vger.kernel.org
Subject: [PATCH 7/8] PCI: dwc: Remove surplus and document missing function parameters
Date: Thu, 11 Mar 2021 00:17:23 +0000 [thread overview]
Message-ID: <20210311001724.423356-7-kw@linux.com> (raw)
In-Reply-To: <20210311001724.423356-1-kw@linux.com>
Add missing documentation for the parameters "ks_pcie", "bus"
and "pci" of the ks_pcie_set_dbi_mode(), ks_pcie_clear_dbi_mode(),
ks_pcie_v3_65_add_bus() and ks_pcie_link_up() functions and resolve
build time warnings related to kernel-doc:
drivers/pci/controller/dwc/pci-keystone.c:356: warning: Function
parameter or member 'ks_pcie' not described in 'ks_pcie_set_dbi_mode'
drivers/pci/controller/dwc/pci-keystone.c:375: warning: Function
parameter or member 'ks_pcie' not described in
'ks_pcie_clear_dbi_mode'
drivers/pci/controller/dwc/pci-keystone.c:456: warning: Function
parameter or member 'bus' not described in 'ks_pcie_v3_65_add_bus'
drivers/pci/controller/dwc/pci-keystone.c:493: warning: Function
parameter or member 'pci' not described in 'ks_pcie_link_up'
drivers/pci/controller/dwc/pci-keystone.c:615: warning: Excess
function parameter 'irq' description in 'ks_pcie_legacy_irq_handler'
No change to functionality intended.
Signed-off-by: Krzysztof Wilczyński <kw@linux.com>
---
drivers/pci/controller/dwc/pci-keystone.c | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/drivers/pci/controller/dwc/pci-keystone.c b/drivers/pci/controller/dwc/pci-keystone.c
index 53aa35cb3a49..6745e69b7020 100644
--- a/drivers/pci/controller/dwc/pci-keystone.c
+++ b/drivers/pci/controller/dwc/pci-keystone.c
@@ -346,8 +346,9 @@ static const struct irq_domain_ops ks_pcie_legacy_irq_domain_ops = {
};
/**
- * ks_pcie_set_dbi_mode() - Set DBI mode to access overlaid BAR mask
- * registers
+ * ks_pcie_set_dbi_mode() - Set DBI mode to access overlaid BAR mask registers
+ * @ks_pcie: A pointer to the keystone_pcie structure which holds the KeyStone
+ * PCIe host controller driver information.
*
* Since modification of dbi_cs2 involves different clock domain, read the
* status back to ensure the transition is complete.
@@ -367,6 +368,8 @@ static void ks_pcie_set_dbi_mode(struct keystone_pcie *ks_pcie)
/**
* ks_pcie_clear_dbi_mode() - Disable DBI mode
+ * @ks_pcie: A pointer to the keystone_pcie structure which holds the KeyStone
+ * PCIe host controller driver information.
*
* Since modification of dbi_cs2 involves different clock domain, read the
* status back to ensure the transition is complete.
@@ -449,6 +452,7 @@ static struct pci_ops ks_child_pcie_ops = {
/**
* ks_pcie_v3_65_add_bus() - keystone add_bus post initialization
+ * @bus: A pointer to the PCI bus structure.
*
* This sets BAR0 to enable inbound access for MSI_IRQ register
*/
@@ -488,6 +492,8 @@ static struct pci_ops ks_pcie_ops = {
/**
* ks_pcie_link_up() - Check if link up
+ * @pci: A pointer to the dw_pcie structure which holds the DesignWare PCIe host
+ * controller driver information.
*/
static int ks_pcie_link_up(struct dw_pcie *pci)
{
@@ -605,7 +611,6 @@ static void ks_pcie_msi_irq_handler(struct irq_desc *desc)
/**
* ks_pcie_legacy_irq_handler() - Handle legacy interrupt
- * @irq: IRQ line for legacy interrupts
* @desc: Pointer to irq descriptor
*
* Traverse through pending legacy interrupts and invoke handler for each. Also
--
2.30.1
next prev parent reply other threads:[~2021-03-11 0:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-11 0:17 [PATCH 1/8] PCI: endpoint: Fix kernel-doc formatting and add missing documentation Krzysztof Wilczyński
2021-03-11 0:17 ` [PATCH 2/8] PCI/AER: Update functions names in the kernel-doc Krzysztof Wilczyński
2021-03-11 0:17 ` [PATCH 3/8] PCI/PME: Update function name " Krzysztof Wilczyński
2021-03-11 0:17 ` [PATCH 4/8] PCI/ATS: " Krzysztof Wilczyński
2021-03-11 0:17 ` [PATCH 5/8] PCI: " Krzysztof Wilczyński
2021-03-11 0:17 ` [PATCH 6/8] PCI: j721e: Fix a non-compliant kernel-doc Krzysztof Wilczyński
2021-03-11 0:17 ` Krzysztof Wilczyński [this message]
2021-03-11 0:17 ` [PATCH 8/8] PCI: of: Fix kernel-doc formatting and add missing documentation Krzysztof Wilczyński
2021-03-11 23:38 ` [PATCH 1/8] PCI: endpoint: " Bjorn Helgaas
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=20210311001724.423356-7-kw@linux.com \
--to=kw@linux.com \
--cc=arnd@arndb.de \
--cc=bhelgaas@google.com \
--cc=f.fangjian@huawei.com \
--cc=geert+renesas@glider.be \
--cc=hayashi.kunihiko@socionext.com \
--cc=kishon@ti.com \
--cc=krzk@kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=lorenzo.pieralisi@arm.com \
--cc=m-karicheri2@ti.com \
--cc=oohall@gmail.com \
--cc=qiuxu.zhuo@intel.com \
--cc=robh@kernel.org \
--cc=ruscur@russell.cc \
--cc=sean.v.kelley@intel.com \
--cc=tjoseph@cadence.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).