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

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

authored by

Petr Tesarik and committed by
Jonathan Corbet
fc9a0995 6381b9d9

+10
+2
Documentation/core-api/mm-api.rst
··· 97 97 .. kernel-doc:: mm/dmapool.c 98 98 :export: 99 99 100 + .. kernel-doc:: include/linux/dmapool.h 101 + 100 102 More Memory Management Functions 101 103 ================================ 102 104
+8
include/linux/dmapool.h
··· 60 60 NUMA_NO_NODE); 61 61 } 62 62 63 + /** 64 + * dma_pool_zalloc - Get a zero-initialized block of DMA coherent memory. 65 + * @pool: dma pool that will produce the block 66 + * @mem_flags: GFP_* bitmask 67 + * @handle: pointer to dma address of block 68 + * 69 + * Same as dma_pool_alloc(), but the returned memory is zeroed. 70 + */ 63 71 static inline void *dma_pool_zalloc(struct dma_pool *pool, gfp_t mem_flags, 64 72 dma_addr_t *handle) 65 73 {