docs: dma-api: add a kernel-doc comment for dma_pool_zalloc()

Document the dma_pool_zalloc() wrapper.

Signed-off-by: Petr Tesarik <ptesarik@suse.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Marek Szyprowski <m.szyprowski@samsung.com>
[jc: fixed up dma_pool_alloc() reference in dmapool.h]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250627101015.1600042-5-ptesarik@suse.com
This commit is contained in:
Petr Tesarik
2025-06-27 12:10:11 +02:00
committed by Jonathan Corbet
parent 6381b9d940
commit fc9a099567
2 changed files with 10 additions and 0 deletions

View File

@@ -97,6 +97,8 @@ DMA pools
.. kernel-doc:: mm/dmapool.c
:export:
.. kernel-doc:: include/linux/dmapool.h
More Memory Management Functions
================================

View File

@@ -60,6 +60,14 @@ static inline struct dma_pool *dma_pool_create(const char *name,
NUMA_NO_NODE);
}
/**
* dma_pool_zalloc - Get a zero-initialized block of DMA coherent memory.
* @pool: dma pool that will produce the block
* @mem_flags: GFP_* bitmask
* @handle: pointer to dma address of block
*
* Same as dma_pool_alloc(), but the returned memory is zeroed.
*/
static inline void *dma_pool_zalloc(struct dma_pool *pool, gfp_t mem_flags,
dma_addr_t *handle)
{