PCI: rockchip: Add missing fields descriptions for struct rockchip_pcie_ep
PATCH v2 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.
---
Changes from v1:
- Addressed Manivannan's comments
drivers/pci/controller/pcie-rockchip-ep.c | 4 ++++ 1 file changed, 4 insertions(+)
drivers/pci/controller/pcie-rockchip-ep.c +4 -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 the PERST# signal. +* @perst_asserted: True if the PERST# signal was asserted. +* @link_up: True if the PCI link is up. +* @link_training: Work item to execute PCI link training. */ struct rockchip_pcie_ep {struct rockchip_pcie rockchip;
Signature · 1 line
2.47.1
Quoted 8 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'
Quoted 7 lines
Avoid these warnings by adding the missing field descriptions in struct
rockchip_pcie_epkdoc comment.Reported-by Bjorn Helgaas <[email protected]>Fixes a7137cbf6bd5 ("PCI: rockchip-ep: Handle PERST# signal in EP mode")Fixes bd6e61df4b2e ("PCI: rockchip-ep: Improve link training")Signed-off-by Damien Le Moal <[email protected]>
- Mani
Quoted 25 lines
---
Changes from v1:
- Addressed Manivannan's commentsdrivers/pci/controller/pcie-rockchip-ep.c | 4 ++++ 1 file changed, 4 insertions(+)drivers/pci/controller/pcie-rockchip-ep.c +4
-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 the PERST# signal. +* @perst_asserted: True if the PERST# signal was asserted. +* @link_up: True if the PCI link is up. +* @link_training: Work item to execute PCI link training. */ struct rockchip_pcie_ep {struct rockchip_pcie rockchip;Signature · 1 line
2.47.1
Signature · 1 line
மணிவண்ணன் சதாசிவம்
Krzysztof Wilczyński
AppliedHello,
Quoted 10 lines
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_epkdoc comment.
Applied to controller/rockchip, thank you!
[01/01] PCI: rockchip: Add missing fields descriptions for struct rockchip_pcie_ep
https://git.kernel.org/pci/pci/c/220bd83f9da1 Krzysztof