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 8/8] PCI: of: Fix kernel-doc formatting and add missing documentation Date: Thu, 11 Mar 2021 00:17:24 +0000 [thread overview] Message-ID: <20210311001724.423356-8-kw@linux.com> (raw) In-Reply-To: <20210311001724.423356-1-kw@linux.com> Fix kernel-doc formatting and add missing documentation for the "node" parameter of the of_get_pci_domain_nr() and of_pci_get_max_link_speed() functions, and resolve build time warnings related to kernel-doc: drivers/pci/of.c:202: warning: expecting prototype for This function will try to obtain the host bridge domain number by(). Prototype was for of_get_pci_domain_nr() instead drivers/pci/of.c:597: warning: expecting prototype for This function will try to find the limitation of link speed by finding(). Prototype was for of_pci_get_max_link_speed() instead No change to functionality intended. Signed-off-by: Krzysztof Wilczyński <kw@linux.com> --- drivers/pci/of.c | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/drivers/pci/of.c b/drivers/pci/of.c index 5ea472ae22ac..da5b414d585a 100644 --- a/drivers/pci/of.c +++ b/drivers/pci/of.c @@ -190,10 +190,18 @@ int of_pci_parse_bus_range(struct device_node *node, struct resource *res) EXPORT_SYMBOL_GPL(of_pci_parse_bus_range); /** - * This function will try to obtain the host bridge domain number by - * finding a property called "linux,pci-domain" of the given device node. + * of_get_pci_domain_nr - Find the host bridge domain number + * of the given device node. + * @node: Device tree node with the domain information. * - * @node: device tree node with the domain information + * This function will try to obtain the host bridge domain number by finding + * a property called "linux,pci-domain" of the given device node. + * + * Return: + * * > 0 - On success, an associated domain number. + * * -EINVAL - The property "linux,pci-domain" does not exist. + * * -ENODATA - The linux,pci-domain" property does not have value. + * * -EOVERFLOW - Invalid "linux,pci-domain" property value. * * Returns the associated domain number from DT in the range [0-0xffff], or * a negative value if the required property is not found. @@ -585,10 +593,16 @@ int devm_of_pci_bridge_init(struct device *dev, struct pci_host_bridge *bridge) #endif /* CONFIG_PCI */ /** + * of_pci_get_max_link_speed - Find the maximum link speed of the given device node. + * @node: Device tree node with the maximum link speed information. + * * This function will try to find the limitation of link speed by finding * a property called "max-link-speed" of the given device node. * - * @node: device tree node with the max link speed information + * Return: + * * > 0 - On success, a maximum link speed. + * * -EINVAL - Invalid "max-link-speed" property value, or failure to access + * the property of the device tree node. * * Returns the associated max link speed from DT, or a negative value if the * required property is not found or is invalid. -- 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: " 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 ` [PATCH 7/8] PCI: dwc: Remove surplus and document missing function parameters Krzysztof Wilczyński 2021-03-11 0:17 ` Krzysztof Wilczyński [this message] 2021-03-11 23:38 ` [PATCH 1/8] PCI: endpoint: Fix kernel-doc formatting and add missing documentation 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-8-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 \ --subject='Re: [PATCH 8/8] PCI: of: Fix kernel-doc formatting and add missing documentation' \ /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
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).