Skip to contentSkip to conversation

PCI: rockchip: Add missing fields descriptions for struct rockchip_pcie_ep

PATCH Superseded Damien Le Moal 2 participants 2 messages Dec 15, 2024 – Dec 16, 2024

Subsystems (4)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 PCI: rockchip: Add missing fields descriptions for struct rockchip_pcie_ep

When compiling the rockchip endpoint driver with -W=1, gcc output the following warnings:

drivers/pci/controller/pcie-rockchip-ep.c:59: warning: Function parameter or struct member 'perst_irq' not described in 'rockchip_pcie_ep' drivers/pci/controller/pcie-rockchip-ep.c:59: warning: Function parameter or struct member 'perst_asserted' not described in 'rockchip_pcie_ep' drivers/pci/controller/pcie-rockchip-ep.c:59: warning: Function parameter or struct member 'link_up' not described in 'rockchip_pcie_ep' drivers/pci/controller/pcie-rockchip-ep.c:59: warning: Function parameter or struct member 'link_training' not described in 'rockchip_pcie_ep'

Avoid these warnings by adding the missing field descriptions in struct rockchip_pcie_ep kdoc comment.

Fixes a7137cbf6bd5 ("PCI: rockchip-ep: Handle PERST# signal in EP mode")
Fixes bd6e61df4b2e ("PCI: rockchip-ep: Improve link training")
---
 drivers/pci/controller/pcie-rockchip-ep.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/pci/controller/pcie-rockchip-ep.c +4 -0
index 1064b7b06cef..36b868530769 100644
@@ -40,6 +40,10 @@
  * @irq_pci_fn: the latest PCI function that has updated the mapping of
  *		the MSI/INTX IRQ dedicated outbound region.
  * @irq_pending: bitmask of asserted INTX IRQs.
+ * @perst_irq: IRQ used for perst# signal.
+ * @perst_asserted: perst# signal state (true if perst# was asserted).
+ * @link_up: PCI link state (true if the link is up).
+ * @link_training: Work item to execute link training.
  */
 struct rockchip_pcie_ep {
 	struct rockchip_pcie	rockchip;
Signature · 1 line
2.47.1
#1 lore raw
Quoted 24 lines · Damien Le Moal

When compiling the rockchip endpoint driver with -W=1, gcc output the following warnings:

drivers/pci/controller/pcie-rockchip-ep.c:59: warning: Function parameter or struct member 'perst_irq' not described in 'rockchip_pcie_ep' drivers/pci/controller/pcie-rockchip-ep.c:59: warning: Function parameter or struct member 'perst_asserted' not described in 'rockchip_pcie_ep' drivers/pci/controller/pcie-rockchip-ep.c:59: warning: Function parameter or struct member 'link_up' not described in 'rockchip_pcie_ep' drivers/pci/controller/pcie-rockchip-ep.c:59: warning: Function parameter or struct member 'link_training' not described in 'rockchip_pcie_ep'

Avoid these warnings by adding the missing field descriptions in struct rockchip_pcie_ep kdoc comment.

Fixes a7137cbf6bd5 ("PCI: rockchip-ep: Handle PERST# signal in EP mode")
Fixes bd6e61df4b2e ("PCI: rockchip-ep: Improve link training")
---
 drivers/pci/controller/pcie-rockchip-ep.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/pci/controller/pcie-rockchip-ep.c +0 -0
index 1064b7b06cef..36b868530769 100644

drivers/pci/controller/pcie-rockchip-ep.c line 43

Quoted 4 lines
drivers/pci/controller/pcie-rockchip-ep.c +1 -0
@@ -40,6 +40,10 @@
  * @irq_pci_fn: the latest PCI function that has updated the mapping of
  *		the MSI/INTX IRQ dedicated outbound region.
  * @irq_pending: bitmask of asserted INTX IRQs.
+ * @perst_irq: IRQ used for perst# signal.

s/perst#/PERST#

here and below

drivers/pci/controller/pcie-rockchip-ep.c line 45

Quoted 2 lines
drivers/pci/controller/pcie-rockchip-ep.c +2 -0
+ * @perst_asserted: perst# signal state (true if perst# was asserted).
+ * @link_up: PCI link state (true if the link is up).

This is not holding PCIe link state, but just indication of whether link is up or not. So how about:

@link_up: True if link is up

- Mani

Signature · 1 line
மணிவண்ணன் சதாசிவம்