From: "Krzysztof Wilczyński" <kw@linux.com>
To: Tom Joseph <tjoseph@cadence.com>
Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
Rob Herring <robh@kernel.org>,
Bjorn Helgaas <bhelgaas@google.com>,
linux-pci@vger.kernel.org
Subject: [PATCH] PCI: cadence: Remove surplus and document missing struct members
Date: Fri, 2 Jul 2021 21:26:50 +0000 [thread overview]
Message-ID: <20210702212650.1661227-1-kw@linux.com> (raw)
Add missing documentation for the members "dev", "phy_count", "phy" and
"link" of the struct cdns_pcie, and remove surplus member "bus".
Thus resolve build time warnings related to kernel-doc:
drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'dev' not described in 'cdns_pcie'
drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'phy_count' not described in 'cdns_pcie'
drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'phy' not described in 'cdns_pcie'
drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'link' not described in 'cdns_pcie'
No change to functionality intended.
Signed-off-by: Krzysztof Wilczyński <kw@linux.com>
---
drivers/pci/controller/cadence/pcie-cadence.h | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/drivers/pci/controller/cadence/pcie-cadence.h b/drivers/pci/controller/cadence/pcie-cadence.h
index 254d2570f8c9..5577fefce4f1 100644
--- a/drivers/pci/controller/cadence/pcie-cadence.h
+++ b/drivers/pci/controller/cadence/pcie-cadence.h
@@ -260,13 +260,18 @@ struct cdns_pcie_ops {
};
/**
- * struct cdns_pcie - private data for Cadence PCIe controller drivers
- * @reg_base: IO mapped register base
- * @mem_res: start/end offsets in the physical system memory to map PCI accesses
- * @is_rc: tell whether the PCIe controller mode is Root Complex or Endpoint.
- * @bus: In Root Complex mode, the bus number
- * @ops: Platform specific ops to control various inputs from Cadence PCIe
- * wrapper
+ * struct cdns_pcie - Private data for Cadence PCIe controller drivers.
+ * @reg_base: IO mapped register base.
+ * @mem_res: Start/end offsets in the physical system memory to map PCI
+ * accesses.
+ * @dev: The PCI device.
+ * @is_rc: Tell whether the PCIe controller mode is Root Complex or
+ * Endpoint.
+ * @phy_count: Number of supported PHY devices.
+ * @phy: List of pointers to specific PHY control blocks.
+ * @link: List of pointers to corresponding device link representations.
+ * @ops: Platform specific ops to control various inputs from Cadence
+ * PCIe wrapper.
*/
struct cdns_pcie {
void __iomem *reg_base;
--
2.32.0
reply other threads:[~2021-07-02 21:26 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20210702212650.1661227-1-kw@linux.com \
--to=kw@linux.com \
--cc=bhelgaas@google.com \
--cc=linux-pci@vger.kernel.org \
--cc=lorenzo.pieralisi@arm.com \
--cc=robh@kernel.org \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.