tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: dma-api: remove remnants of PCI DMA API

The wording sometimes suggests there are multiple functions for an
operation. This was in fact the case before PCI DMA API was removed, but
since there is only one API now, the documentation has become confusing.

To improve readability:

* Remove implicit references to the PCI DMA API (plurals, use of "both",
etc.)

* Where possible, refer to an actual function rather than a more generic
description of the operation.

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-4-ptesarik@suse.com

authored by

Petr Tesarik and committed by
Jonathan Corbet 6381b9d9 4d3c6bc1

+10 -15
+10 -15
Documentation/core-api/dma-api.rst
··· 53 53 consolidate your requests for coherent memory as much as possible. 54 54 The simplest way to do that is to use the dma_pool calls (see below). 55 55 56 - The flag parameter (dma_alloc_coherent() only) allows the caller to 57 - specify the ``GFP_`` flags (see kmalloc()) for the allocation (the 58 - implementation may choose to ignore flags that affect the location of 59 - the returned memory, like GFP_DMA). 56 + The flag parameter allows the caller to specify the ``GFP_`` flags (see 57 + kmalloc()) for the allocation (the implementation may ignore flags that affect 58 + the location of the returned memory, like GFP_DMA). 60 59 61 60 :: 62 61 ··· 63 64 dma_free_coherent(struct device *dev, size_t size, void *cpu_addr, 64 65 dma_addr_t dma_handle) 65 66 66 - Free a region of coherent memory you previously allocated. dev, 67 - size and dma_handle must all be the same as those passed into 68 - dma_alloc_coherent(). cpu_addr must be the virtual address returned by 69 - the dma_alloc_coherent(). 67 + Free a previously allocated region of coherent memory. dev, size and dma_handle 68 + must all be the same as those passed into dma_alloc_coherent(). cpu_addr must 69 + be the virtual address returned by dma_alloc_coherent(). 70 70 71 - Note that unlike their sibling allocation calls, these routines 72 - may only be called with IRQs enabled. 71 + Note that unlike the sibling allocation call, this routine may only be called 72 + with IRQs enabled. 73 73 74 74 75 75 Part Ib - Using small DMA-coherent buffers ··· 244 246 Maps a piece of processor virtual memory so it can be accessed by the 245 247 device and returns the DMA address of the memory. 246 248 247 - The direction for both APIs may be converted freely by casting. 248 - However the DMA API uses a strongly typed enumerator for its 249 - direction: 249 + The DMA API uses a strongly typed enumerator for its direction: 250 250 251 251 ======================= ============================================= 252 252 DMA_NONE no direction (used for debugging) ··· 321 325 enum dma_data_direction direction) 322 326 323 327 Unmaps the region previously mapped. All the parameters passed in 324 - must be identical to those passed in (and returned) by the mapping 325 - API. 328 + must be identical to those passed to (and returned by) dma_map_single(). 326 329 327 330 :: 328 331