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

ptesarik · Jonathan Corbet · commit fc9a09956781 · 2025-07-01T13:55:37.000-06:00
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
diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst
@@ -97,6 +97,8 @@ DMA pools
 .. kernel-doc:: mm/dmapool.c
    :export:
 
+.. kernel-doc:: include/linux/dmapool.h
+
 More Memory Management Functions
 ================================
 
diff --git a/include/linux/dmapool.h b/include/linux/dmapool.h
@@ -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)
 {

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,14 @@ static inline struct dma_pool dma_pool_create(const char name,`
`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`	`{`