[v2] update DMA API documentation

[PATCH v2 0/8] update DMA API documentation

Posted by Petr Tesarik 3 months, 1 week ago

A few documentation updates:

* remove outdated and confusing parts
* reduce duplicates
* update streaming DMA API expectations

Changes from v1:

* move DMA Pools to dma-api.rst
* improve streaming DMA addressing constraints

Petr Tesarik (8):
  docs: dma-api: use "DMA API" consistently throughout the document
  docs: dma-api: replace consistent with coherent
  docs: dma-api: remove remnants of PCI DMA API
  docs: dma-api: add a kernel-doc comment for dma_pool_zalloc()
  docs: dma-api: remove duplicate description of the DMA pool API
  docs: dma-api: clarify DMA addressing limitations
  docs: dma-api: update streaming DMA physical address constraints
  docs: dma-api: clean up documentation of dma_map_sg()

 Documentation/core-api/dma-api-howto.rst |  36 ++---
 Documentation/core-api/dma-api.rst       | 191 ++++++++---------------
 Documentation/core-api/mm-api.rst        |   6 -
 include/linux/dmapool.h                  |   8 +
 mm/dmapool.c                             |   6 +-
 5 files changed, 97 insertions(+), 150 deletions(-)

-- 
2.49.0

Re: [PATCH v2 0/8] update DMA API documentation

Posted by Jonathan Corbet 3 months, 1 week ago

Petr Tesarik <ptesarik@suse.com> writes:

> A few documentation updates:
>
> * remove outdated and confusing parts
> * reduce duplicates
> * update streaming DMA API expectations
>
> Changes from v1:
>
> * move DMA Pools to dma-api.rst
> * improve streaming DMA addressing constraints
>
> Petr Tesarik (8):
>   docs: dma-api: use "DMA API" consistently throughout the document
>   docs: dma-api: replace consistent with coherent
>   docs: dma-api: remove remnants of PCI DMA API
>   docs: dma-api: add a kernel-doc comment for dma_pool_zalloc()
>   docs: dma-api: remove duplicate description of the DMA pool API
>   docs: dma-api: clarify DMA addressing limitations
>   docs: dma-api: update streaming DMA physical address constraints
>   docs: dma-api: clean up documentation of dma_map_sg()

OK, I have applied these - thanks.

jon

Re: [PATCH v2 0/8] update DMA API documentation

Posted by Marek Szyprowski 3 months, 1 week ago

On 27.06.2025 12:10, Petr Tesarik wrote:
> A few documentation updates:
>
> * remove outdated and confusing parts
> * reduce duplicates
> * update streaming DMA API expectations

Thanks for this cleanup and documentation clarification! Feel free to 
add for the whole patchset:

Acked-by: Marek Szyprowski <m.szyprowski@samsung.com>


> Changes from v1:
>
> * move DMA Pools to dma-api.rst
> * improve streaming DMA addressing constraints
>
> Petr Tesarik (8):
>    docs: dma-api: use "DMA API" consistently throughout the document
>    docs: dma-api: replace consistent with coherent
>    docs: dma-api: remove remnants of PCI DMA API
>    docs: dma-api: add a kernel-doc comment for dma_pool_zalloc()
>    docs: dma-api: remove duplicate description of the DMA pool API
>    docs: dma-api: clarify DMA addressing limitations
>    docs: dma-api: update streaming DMA physical address constraints
>    docs: dma-api: clean up documentation of dma_map_sg()
>
>   Documentation/core-api/dma-api-howto.rst |  36 ++---
>   Documentation/core-api/dma-api.rst       | 191 ++++++++---------------
>   Documentation/core-api/mm-api.rst        |   6 -
>   include/linux/dmapool.h                  |   8 +
>   mm/dmapool.c                             |   6 +-
>   5 files changed, 97 insertions(+), 150 deletions(-)
>
Best regards
-- 
Marek Szyprowski, PhD
Samsung R&D Institute Poland