Skip to contentSkip to conversation

PCI: hv: Document missing hv_pci_protocol_negotiation() parameter

PATCH Applied Krzysztof Wilczyński 3 participants 3 messages Sep 25, 2020 – Sep 28, 2020

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 PCI: hv: Document missing hv_pci_protocol_negotiation() parameter

Add missing documentation for the parameter "version" and "num_version" of the hv_pci_protocol_negotiation() function and resolve build time kernel-doc warnings:

drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter or member 'version' not described in 'hv_pci_protocol_negotiation'

drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter or member 'num_version' not described in 'hv_pci_protocol_negotiation'

No change to functionality intended.

---
 drivers/pci/controller/pci-hyperv.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/pci/controller/pci-hyperv.c +4 -1
index fc4c3a15e570..6102330e27e1 100644
@@ -2515,7 +2515,10 @@ static void hv_pci_onchannelcallback(void *context)
 
 /**
  * hv_pci_protocol_negotiation() - Set up protocol
- * @hdev:	VMBus's tracking struct for this root PCI bus
+ * @hdev:		VMBus's tracking struct for this root PCI bus.
+ * @version:		Array of supported channel protocol versions in
+ *			the order of probing - highest go first.
+ * @num_version:	Number of elements in the version array.
  *
  * This driver is intended to support running on Windows 10
  * (server) and later versions. It will not run on earlier
Signature · 1 line
2.28.0
Reviewed-by on v1 1/1
#1 lore raw

From: Krzysztof Wilczyński <[email protected]> Sent: Friday, September 25, 2020 4:48 PM

Quoted 40 lines

To: KY Srinivasan <[email protected]>
Cc: Haiyang Zhang <[email protected]>; Stephen Hemminger <[email protected]>; Wei Liu <[email protected]>; Bjorn Helgaas <[email protected]>; [email protected]; [email protected]
Subject: [PATCH] PCI: hv: Document missing hv_pci_protocol_negotiation() parameter

Add missing documentation for the parameter "version" and "num_version" of the hv_pci_protocol_negotiation() function and resolve build time kernel-doc warnings:

drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter or member 'version' not described in 'hv_pci_protocol_negotiation'

drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter or member 'num_version' not described in 'hv_pci_protocol_negotiation'

No change to functionality intended.

---
 drivers/pci/controller/pci-hyperv.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/pci/controller/pci-hyperv.c +4 -2
index fc4c3a15e570..6102330e27e1 100644
@@ -2515,7 +2515,10 @@ static void hv_pci_onchannelcallback(void *context)
 
 /**
  * hv_pci_protocol_negotiation() - Set up protocol
- * @hdev:	VMBus's tracking struct for this root PCI bus
+ * @hdev:		VMBus's tracking struct for this root PCI bus.
+ * @version:		Array of supported channel protocol versions in
+ *			the order of probing - highest go first.
+ * @num_version:	Number of elements in the version array.
  *
  * This driver is intended to support running on Windows 10
  * (server) and later versions. It will not run on earlier
--
Quoted 1 line

2.28.0

maintainer Applied
#2 lore raw
In reply to Krzysztof Wilczyński
Quoted 7 lines · Krzysztof Wilczyński

Add missing documentation for the parameter "version" and "num_version" of the hv_pci_protocol_negotiation() function and resolve build time kernel-doc warnings:

drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter or member 'version' not described in 'hv_pci_protocol_negotiation'

Quoted 6 lines

drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter or member 'num_version' not described in 'hv_pci_protocol_negotiation'

No change to functionality intended.

Applied to hyperv-next. Thanks.