Commit fd46bc0e authored by Damien Le Moal's avatar Damien Le Moal Committed by Bjorn Helgaas
Browse files

PCI: rockchip: Add missing fields descriptions for struct rockchip_pcie_ep 

When compiling the Rockchip endpoint driver with -W=1, the following
warnings can be seen in the output:

  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'

Fix these warnings by adding the missing field descriptions in
struct rockchip_pcie_ep kernel-doc comment.

Fixes: a7137cbf ("PCI: rockchip-ep: Handle PERST# signal in EP mode")
Fixes: bd6e61df ("PCI: rockchip-ep: Improve link training")
Link: https://lore.kernel.org/r/20241216133404.540736-1-dlemoal@kernel.org


Reported-by: default avatarBjorn Helgaas <helgaas@kernel.org>
Signed-off-by: default avatarDamien Le Moal <dlemoal@kernel.org>
Signed-off-by: default avatarKrzysztof Wilczyński <kwilczynski@kernel.org>
Signed-off-by: default avatarBjorn Helgaas <bhelgaas@google.com>
Reviewed-by: default avatarManivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
parent 40384c84

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

+4 −0
Original line number Diff line number Diff line
@@ -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;