docs: dma-api: clarify DMA addressing limitations
authorPetr Tesarik <ptesarik@suse.com>
Fri, 27 Jun 2025 10:10:13 +0000 (12:10 +0200)
committerJonathan Corbet <corbet@lwn.net>
Tue, 1 Jul 2025 19:56:05 +0000 (13:56 -0600)
commitfaa7c7ebd8ac89faaedbea7dbe4491de14dbcfe1
tree3463e8929b050e1a4bcd9b0bf6605492a66fc602
parent61043d0995eeb01950ff61555dee07be44c07bbd
docs: dma-api: clarify DMA addressing limitations

Move the description of DMA mask from the documentation of dma_map_single()
to Part Ic - DMA addressing limitations and improve the wording.

Explain when a mask setting function may fail, and do not repeat this
explanation for each individual function.

Clarify which device parameters are updated by each mask setting function.

Signed-off-by: Petr Tesarik <ptesarik@suse.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Marek Szyprowski <m.szyprowski@samsung.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250627101015.1600042-7-ptesarik@suse.com
Documentation/core-api/dma-api.rst