[PATCH] PCI: endpoint: Fix pci_epc_map map_size doc string

[PATCH] PCI: endpoint: Fix pci_epc_map map_size doc string

[Rick Wertenbroek]

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 doc string had pci_addr twice instead of map_pci_addr..pci_addr.
Replace the erroneous doc string to reflect the actual range.

Signed-off-by: Rick Wertenbroek <rick.wertenbroek@gmail.com>
---
 include/linux/pci-epc.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/pci-epc.h b/include/linux/pci-epc.h
index de8cc3658220..e818e3fdcded 100644
--- a/include/linux/pci-epc.h
+++ b/include/linux/pci-epc.h
@@ -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
-- 
2.25.1

Re: [PATCH] PCI: endpoint: Fix pci_epc_map map_size doc string

[Krzysztof Wilczyński]

Hello,

> 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 doc string had pci_addr twice instead of map_pci_addr..pci_addr.
> Replace the erroneous doc string to reflect the actual range.

Applied to endpoint, thank you!

[01/01] PCI: endpoint: Fix pci_epc_map map_size kerneldoc string
        https://git.kernel.org/pci/pci/c/36b25d04a9fe

	Krzysztof