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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 2023-11-11 02:22, Tadeusz Struk wrote:
> From: Tadeusz Struk <tstruk@xxxxxxxxxx>
> 
> Update Documentation/driver-api/pci/p2pdma.rst doc to
> remove references to the obsolete pci_p2pdma_map_sg() function.
> 
> Fixes: 0d06132fc84b ("PCI/P2PDMA: Remove pci_p2pdma_[un]map_sg()")
> Cc: stable <stable@xxxxxxxxxx>
> Signed-off-by: Tadeusz Struk <tstruk@xxxxxxxxxx>
> ---
>  Documentation/driver-api/pci/p2pdma.rst | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)


> diff --git a/Documentation/driver-api/pci/p2pdma.rst b/Documentation/driver-api/pci/p2pdma.rst
> index 44deb52beeb4..9e54ee711b5c 100644
> --- a/Documentation/driver-api/pci/p2pdma.rst
> +++ b/Documentation/driver-api/pci/p2pdma.rst
> @@ -83,10 +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.
> +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 implementation
> +will do the right thing for the P2P capable memory.
>  
>  The client may also, optionally, make use of
>  :c:func:`is_pci_p2pdma_page()` to determine when to use the P2P mapping

Might make sense to rework this next paragraph as well seeing it
references the P2P mapping functions that no longer exist.

Thanks for cleaning up the documentation I forgot about!

Logan



[Index of Archives]     [DMA Engine]     [Linux Coverity]     [Linux USB]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Greybus]

  Powered by Linux