]> www.infradead.org Git - users/jedix/linux-maple.git/commitdiff
PCI: endpoint: Fix pci_epc_map map_size kerneldoc string
authorRick Wertenbroek <rick.wertenbroek@gmail.com>
Thu, 14 Nov 2024 16:10:32 +0000 (17:10 +0100)
committerKrzysztof Wilczyński <kwilczynski@kernel.org>
Mon, 18 Nov 2024 17:18:21 +0000 (17:18 +0000)
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>
include/linux/pci-epc.h

index de8cc3658220bcc4ba49a60d24ef6e57b1b9b908..e818e3fdcded95ca053db074eb75484a2876ea6b 100644 (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