| Message ID | 20241216133404.540736-1-dlemoal@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | Krzysztof Wilczyński |
| Headers | show |
| Series | [v2] PCI: rockchip: Add missing fields descriptions for struct rockchip_pcie_ep | expand |
On Mon, Dec 16, 2024 at 10:34:04PM +0900, Damien Le Moal wrote: > 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. > > Reported-by: Bjorn Helgaas <helgaas@kernel.org> > 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 <dlemoal@kernel.org> Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org> - Mani > --- > Changes from v1: > - Addressed Manivannan's comments > > drivers/pci/controller/pcie-rockchip-ep.c | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/drivers/pci/controller/pcie-rockchip-ep.c b/drivers/pci/controller/pcie-rockchip-ep.c > index 1064b7b06cef..4f978a17fdbb 100644 > --- a/drivers/pci/controller/pcie-rockchip-ep.c > +++ b/drivers/pci/controller/pcie-rockchip-ep.c > @@ -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; > -- > 2.47.1 >
diff --git a/drivers/pci/controller/pcie-rockchip-ep.c b/drivers/pci/controller/pcie-rockchip-ep.c index 1064b7b06cef..4f978a17fdbb 100644 --- a/drivers/pci/controller/pcie-rockchip-ep.c +++ b/drivers/pci/controller/pcie-rockchip-ep.c @@ -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;
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. Reported-by: Bjorn Helgaas <helgaas@kernel.org> 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 <dlemoal@kernel.org> --- Changes from v1: - Addressed Manivannan's comments drivers/pci/controller/pcie-rockchip-ep.c | 4 ++++ 1 file changed, 4 insertions(+)