linux-kernel - [PATCH] PCI: endpoint: pci-epf-vntb: fix doc warnings in pci-epf-vntb.c

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20221214062617.2210218-1-yangyingliang@huawei.com>
Date:   Wed, 14 Dec 2022 14:26:17 +0800
From:   Yang Yingliang <yangyingliang@...wei.com>
To:     <linux-pci@...r.kernel.org>, <linux-kernel@...r.kernel.org>
CC:     <jdmason@...zu.us>, <dave.jiang@...el.com>, <allenbh@...il.com>,
        <lpieralisi@...nel.org>, <kw@...ux.com>, <mani@...nel.org>,
        <kishon@...nel.org>, <bhelgaas@...gle.com>, <helgaas@...nel.org>,
        <Frank.Li@....com>
Subject: [PATCH] PCI: endpoint: pci-epf-vntb: fix doc warnings in pci-epf-vntb.c

Fix the following make W=1 warnings:

  drivers/pci/endpoint/functions/pci-epf-vntb.c:338: warning: Function parameter or member 'ntb' not described in 'epf_ntb_config_sspad_bar_clear'
  drivers/pci/endpoint/functions/pci-epf-vntb.c:338: warning: Excess function parameter 'ntb_epc' description in 'epf_ntb_config_sspad_bar_clear'
  drivers/pci/endpoint/functions/pci-epf-vntb.c:645: warning: Function parameter or member 'num_mws' not described in 'epf_ntb_mw_bar_clear'

Fixes: 8e4bfbe644a6 ("PCI: endpoint: pci-epf-vntb: fix error handle in epf_ntb_mw_bar_init()")
Fixes: e35f56bb0330 ("PCI: endpoint: Support NTB transfer between RC and EP")
Signed-off-by: Yang Yingliang <yangyingliang@...wei.com>
---
 drivers/pci/endpoint/functions/pci-epf-vntb.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/pci/endpoint/functions/pci-epf-vntb.c b/drivers/pci/endpoint/functions/pci-epf-vntb.c
index 0ea85e1d292e..9e3a21c9debe 100644
--- a/drivers/pci/endpoint/functions/pci-epf-vntb.c
+++ b/drivers/pci/endpoint/functions/pci-epf-vntb.c
@@ -321,7 +321,7 @@ static void epf_ntb_cmd_handler(struct work_struct *work)
 
 /**
  * epf_ntb_config_sspad_bar_clear() - Clear Config + Self scratchpad BAR
- * @ntb_epc: EPC associated with one of the HOST which holds peer's outbound
+ * @ntb: EPC associated with one of the HOST which holds peer's outbound
  *	     address.
  *
  * Clear BAR0 of EP CONTROLLER 1 which contains the HOST1's config and
@@ -640,6 +640,7 @@ static int epf_ntb_mw_bar_init(struct epf_ntb *ntb)
 /**
  * epf_ntb_mw_bar_clear() - Clear Memory window BARs
  * @ntb: NTB device that facilitates communication between HOST and vHOST
+ * @num_mws: the number of Memory window BARs that to be cleared
  */
 static void epf_ntb_mw_bar_clear(struct epf_ntb *ntb, int num_mws)
 {
-- 
2.25.1