PCI: rockchip: Add missing fields descriptions for struct rockchip_pcie_ep
authorDamien Le Moal <dlemoal@kernel.org>
Mon, 16 Dec 2024 13:34:04 +0000 (22:34 +0900)
committerBjorn Helgaas <bhelgaas@google.com>
Mon, 13 Jan 2025 20:45:41 +0000 (14:45 -0600)
commitfd46bc0e0bb3c6607363bd23f2b3c2a73dc75d66
tree34385f5eddd5e35686a71a123ab3559526f04de8
parent40384c840ea1944d7c5a392e8975ed088ecf0b37
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: a7137cbf6bd5 ("PCI: rockchip-ep: Handle PERST# signal in EP mode")
Fixes: bd6e61df4b2e ("PCI: rockchip-ep: Improve link training")
Link: https://lore.kernel.org/r/20241216133404.540736-1-dlemoal@kernel.org
Reported-by: Bjorn Helgaas <helgaas@kernel.org>
Signed-off-by: Damien Le Moal <dlemoal@kernel.org>
Signed-off-by: Krzysztof WilczyƄski <kwilczynski@kernel.org>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
drivers/pci/controller/pcie-rockchip-ep.c