From: "Krzysztof Wilczyński" <kw@linux.com>
To: Bjorn Helgaas <bhelgaas@google.com>
Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
Lukas Wunner <lukas@wunner.de>, Rob Herring <robh@kernel.org>,
Scott Branden <sbranden@broadcom.com>,
Scott Murray <scott@spiteful.org>,
Tom Joseph <tjoseph@cadence.com>,
bcm-kernel-feedback-list@broadcom.com,
linux-arm-kernel@lists.infradead.org, linux-pci@vger.kernel.org
Subject: [PATCH 3/5] PCI: cadence: Add missing kernel-doc for struct cdns_pcie members
Date: Sat, 3 Jul 2021 15:13:04 +0000 [thread overview]
Message-ID: <20210703151306.1922450-3-kw@linux.com> (raw)
In-Reply-To: <20210703151306.1922450-1-kw@linux.com>
Add missing documentation for the members "dev", "phy_count", "phy" and
"link" of the struct cdns_pcie, and also 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 | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/drivers/pci/controller/cadence/pcie-cadence.h b/drivers/pci/controller/cadence/pcie-cadence.h
index 254d2570f8c9..e118c650bbf9 100644
--- a/drivers/pci/controller/cadence/pcie-cadence.h
+++ b/drivers/pci/controller/cadence/pcie-cadence.h
@@ -263,8 +263,11 @@ 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
+ * @dev: the PCI device
* @is_rc: tell whether the PCIe controller mode is Root Complex or Endpoint.
- * @bus: In Root Complex mode, the bus number
+ * @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
*/
--
2.32.0
next prev parent reply other threads:[~2021-07-03 15:13 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-03 15:13 [PATCH 1/5] PCI: Fix kernel-doc formatting Krzysztof Wilczyński
2021-07-03 15:13 ` [PATCH 2/5] PCI: iproc: " Krzysztof Wilczyński
2021-07-03 15:13 ` Krzysztof Wilczyński [this message]
2021-07-03 15:13 ` [PATCH 4/5] PCI: hotplug: Fix kernel-doc formatting and add missing documentation Krzysztof Wilczyński
2021-07-03 15:13 ` [PATCH 5/5] PCI: endpoint: " Krzysztof Wilczyński
2021-07-06 16:22 ` [PATCH 1/5] PCI: Fix kernel-doc formatting 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=20210703151306.1922450-3-kw@linux.com \
--to=kw@linux.com \
--cc=bcm-kernel-feedback-list@broadcom.com \
--cc=bhelgaas@google.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-pci@vger.kernel.org \
--cc=lorenzo.pieralisi@arm.com \
--cc=lukas@wunner.de \
--cc=robh@kernel.org \
--cc=sbranden@broadcom.com \
--cc=scott@spiteful.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 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).