diff mbox series

[7/8] PCI: dwc: Remove surplus and document missing function parameters

Message ID 20210311001724.423356-7-kw@linux.com (mailing list archive)
State Accepted
Delegated to: Bjorn Helgaas
Headers show
Series [1/8] PCI: endpoint: Fix kernel-doc formatting and add missing documentation | expand

Commit Message

Krzysztof Wilczyński March 11, 2021, 12:17 a.m. UTC
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 mbox series

Patch

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