[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <5a997777-fd14-40e1-919b-2e61a6e8d570@infradead.org>
Date: Sat, 28 Jun 2025 12:04:04 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Petr Tesarik <ptesarik@...e.com>, Jonathan Corbet <corbet@....net>,
Robin Murphy <robin.murphy@....com>,
Marek Szyprowski <m.szyprowski@...sung.com>
Cc: Andrew Morton <akpm@...ux-foundation.org>, Keith Busch
<kbusch@...nel.org>, Jens Axboe <axboe@...nel.dk>,
Bagas Sanjaya <bagasdotme@...il.com>,
"open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
open list <linux-kernel@...r.kernel.org>,
"open list:MEMORY MANAGEMENT" <linux-mm@...ck.org>
Subject: Re: [PATCH v2 4/8] docs: dma-api: add a kernel-doc comment for
dma_pool_zalloc()
On 6/27/25 3:10 AM, Petr Tesarik wrote:
> Document the dma_pool_zalloc() wrapper.
>
> Signed-off-by: Petr Tesarik <ptesarik@...e.com>
> ---
> Documentation/core-api/mm-api.rst | 2 ++
> include/linux/dmapool.h | 8 ++++++++
> 2 files changed, 10 insertions(+)
>
> diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst
> index af8151db88b28..a61766328ac06 100644
> --- 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
> index 06c4de602b2f3..c0c7717d3ae7b 100644
> --- 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.
* Same as dma_pool_alloc(), but ...
'@' is for function arguments.
With that change:
Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>
Thanks.
> + */
> static inline void *dma_pool_zalloc(struct dma_pool *pool, gfp_t mem_flags,
> dma_addr_t *handle)
> {
--
~Randy
Powered by blists - more mailing lists