Re: [PATCH v2 2/2] dma-buf-io: document dma_buf_io_init_map

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] dma-buf: incorrect documentation of map parameter direction
--

commit 1158f35d78a501cf423bc44ae35a1645c81c621d
Author: Pavel Begunkov <asml.silence@gmail.com>

dma-buf-io: document dma_buf_io_init_map
    
This commit adds a kerneldoc for dma_buf_io_init_map().

> diff --git a/drivers/dma-buf/dma-buf-io.c b/drivers/dma-buf/dma-buf-io.c
> index e432194a5dfc0..8440151de8600 100644
> --- a/drivers/dma-buf/dma-buf-io.c
> +++ b/drivers/dma-buf/dma-buf-io.c
> @@ -43,6 +43,18 @@ static void dma_buf_io_kill_map(struct dma_buf_io_ctx *ctx)
>  	dma_buf_io_map_release(map);
>  }
>  
> +/**
> + * dma_buf_io_init_map - Initialise the map.
> + * @ctx:	[in]	dma-buf I/O context the map is created for
> + * @map:	[in]	dma-buf I/O map

[Severity: Low]
Is the [in] annotation correct for the map parameter here? Since
dma_buf_io_init_map() initializes the internal fields of the map struct,
this functions as an output parameter. Should this be documented as [out]
or [in,out] instead?

> + * @sgt:	[in]	the backing scatter-gather table
> + *
> + * Importer's helper that initialises @map for the provided I/O context
> + * and scatter-gather table. The importer should call it once for each map
> + * on creation.
> + *
> + * Return: 0 on success, or a negative errno code otherwise.
> + */
>  int dma_buf_io_init_map(struct dma_buf_io_ctx *ctx, struct dma_buf_io_map *map,
>  			struct sg_table *sgt)

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/cover.1792144609.git.asml.silence@gmail.com?part=2