diff mbox series

[v2] Documentation: PCI/P2PDMA: Remove reference to pci_p2pdma_map_sg()

Message ID 20231113180325.444692-1-tstruk@gmail.com (mailing list archive)
State Accepted
Delegated to: Bjorn Helgaas
Headers show
Series [v2] Documentation: PCI/P2PDMA: Remove reference to pci_p2pdma_map_sg() | expand

Commit Message

Tadeusz Struk Nov. 13, 2023, 6:03 p.m. UTC 
From: Tadeusz Struk <tstruk@gigaio.com>

Update Documentation/driver-api/pci/p2pdma.rst doc and
remove references to obsolete p2pdma mapping functions.

Fixes: 0d06132fc84b ("PCI/P2PDMA: Remove pci_p2pdma_[un]map_sg()")
Cc: stable <stable@kernel.org>
Signed-off-by: Tadeusz Struk <tstruk@gigaio.com>
----

v2: Dropped a section that talks about using is_pci_p2pdma_page()
    function by the client. Suggested by Logan.
---
 Documentation/driver-api/pci/p2pdma.rst | 16 +++-------------
 1 file changed, 3 insertions(+), 13 deletions(-)

Comments

Logan Gunthorpe Nov. 13, 2023, 6:04 p.m. UTC | #1 
On 2023-11-13 11:03, Tadeusz Struk wrote:
> From: Tadeusz Struk <tstruk@gigaio.com>
> 
> Update Documentation/driver-api/pci/p2pdma.rst doc and
> remove references to obsolete p2pdma mapping functions.
> 
> Fixes: 0d06132fc84b ("PCI/P2PDMA: Remove pci_p2pdma_[un]map_sg()")
> Cc: stable <stable@kernel.org>
> Signed-off-by: Tadeusz Struk <tstruk@gigaio.com>

Looks good to me, thanks!

Reviewed-by: Logan Gunthorpe <logang@deltatee.com>

Logan
Bjorn Helgaas Nov. 20, 2023, 10:07 p.m. UTC | #2 
From: Bjorn Helgaas <bhelgaas@google.com>


On Mon, 13 Nov 2023 19:03:25 +0100, Tadeusz Struk wrote:
> Update Documentation/driver-api/pci/p2pdma.rst doc and
> remove references to obsolete p2pdma mapping functions.
> 
> Fixes: 0d06132fc84b ("PCI/P2PDMA: Remove pci_p2pdma_[un]map_sg()")
> Cc: stable <stable@kernel.org>
> Signed-off-by: Tadeusz Struk <tstruk@gigaio.com>
> ----
> 
> [...]

Applied to "p2pdma" for v6.8, thanks!

[1/1] Documentation: PCI/P2PDMA: Remove reference to pci_p2pdma_map_sg()
      commit: 9a000a72af75886e5de13f4edef7f0d788622e7d

Best regards,
diff mbox series

Patch

diff --git a/Documentation/driver-api/pci/p2pdma.rst b/Documentation/driver-api/pci/p2pdma.rst
index 44deb52beeb4..44efed79d908 100644
--- a/Documentation/driver-api/pci/p2pdma.rst
+++ b/Documentation/driver-api/pci/p2pdma.rst
@@ -83,19 +83,9 @@  this to include other types of resources like doorbells.
 Client Drivers
 --------------
 
-A client driver typically only has to conditionally change its DMA map
-routine to use the mapping function :c:func:`pci_p2pdma_map_sg()` instead
-of the usual :c:func:`dma_map_sg()` function. Memory mapped in this
-way does not need to be unmapped.
-
-The client may also, optionally, make use of
-:c:func:`is_pci_p2pdma_page()` to determine when to use the P2P mapping
-functions and when to use the regular mapping functions. In some
-situations, it may be more appropriate to use a flag to indicate a
-given request is P2P memory and map appropriately. It is important to
-ensure that struct pages that back P2P memory stay out of code that
-does not have support for them as other code may treat the pages as
-regular memory which may not be appropriate.
+A client driver only has to use the mapping API :c:func:`dma_map_sg()`
+and :c:func:`dma_unmap_sg()` functions, as usual, and the implementaion
+will do the right thing for the P2P capable memory.
 
 
 Orchestrator Drivers