PCI: endpoint: Fix pci_epc_map map_size kerneldoc string

Because some endpoint controllers have requirements on the alignment of
the controller physical memory address that must be used to map a RC PCI
address region, the map PCI start address is not necessarily the desired
PCI base address to be mapped. This can result in map_pci_addr being
lower than pci_addr as documented. This results in map_size covering the
range map_pci_addr..pci_addr+pci_size.

The old text had the pci_addr twice instead of map_pci_addr..pci_addr,
so replace the erroneous kerneldoc string to reflect the actual range.

Link: https://lore.kernel.org/r/20241114161032.3046202-1-rick.wertenbroek@gmail.com
Signed-off-by: Rick Wertenbroek <rick.wertenbroek@gmail.com>
Signed-off-by: Krzysztof Wilczyński <kwilczynski@kernel.org>
This commit is contained in:
Rick Wertenbroek 2024-11-14 17:10:32 +01:00 committed by Krzysztof Wilczyński
parent 688d2eb4c6
commit 28b6acd75e
No known key found for this signature in database
GPG Key ID: 7C64768D3DE334E7

View File

@ -40,7 +40,7 @@ pci_epc_interface_string(enum pci_epc_interface_type type)
* @map_pci_addr: RC PCI address used as the first address mapped (may be lower
* than @pci_addr)
* @map_size: size of the controller memory needed for mapping the RC PCI address
* range @pci_addr..@pci_addr+@pci_size
* range @map_pci_addr..@pci_addr+@pci_size
* @phys_base: base physical address of the allocated EPC memory for mapping the
* RC PCI address range
* @phys_addr: physical address at which @pci_addr is mapped