[PATCH] virtio: document @vaddr in virtqueue_map_free_coherent kernel-doc comment

[PATCH] virtio: document @vaddr in virtqueue_map_free_coherent kernel-doc comment

[Sukrut Heroorkar]

Building with W=1 reports:
Warning: drivers/virtio/virtio_ring.c:3174 function parameter 'vaddr'
not described in 'virtqueue_map_free_coherent'

The @vaddr parameter was introduced when virtqueue_map_free_coherent
was added in order to provide map operations to virtio device, but it
was never documented. Document @vaddr to silence this warning.

Fixes: bee8c7c24b73 ("virtio: introduce map ops in virtio core")
Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
---
 drivers/virtio/virtio_ring.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/virtio/virtio_ring.c b/drivers/virtio/virtio_ring.c
index 7b6205253b46..d763060ff0f6 100644
--- a/drivers/virtio/virtio_ring.c
+++ b/drivers/virtio/virtio_ring.c
@@ -3166,6 +3166,7 @@ EXPORT_SYMBOL_GPL(virtqueue_map_alloc_coherent);
  * @vdev: the virtio device we are talking to
  * @map: metadata for performing mapping
  * @size: the size of the buffer
+ * @vaddr: virtual address of the buffer
  * @map_handle: the mapped address that needs to be freed
  *
  */
-- 
2.43.0

Re: [PATCH] virtio: document @vaddr in virtqueue_map_free_coherent kernel-doc comment

[Jason Wang]

On Wed, Oct 29, 2025 at 11:36 AM Sukrut Heroorkar <hsukrut3@gmail.com> wrote:
>
> Building with W=1 reports:
> Warning: drivers/virtio/virtio_ring.c:3174 function parameter 'vaddr'
> not described in 'virtqueue_map_free_coherent'
>
> The @vaddr parameter was introduced when virtqueue_map_free_coherent
> was added in order to provide map operations to virtio device, but it
> was never documented. Document @vaddr to silence this warning.
>
> Fixes: bee8c7c24b73 ("virtio: introduce map ops in virtio core")
> Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>

Acked-by: Jason Wang <jasowang@redhat.com>

Thanks

Re: [PATCH] virtio: document @vaddr in virtqueue_map_free_coherent kernel-doc comment

[Michael S. Tsirkin]

On Wed, Oct 29, 2025 at 09:05:58AM +0530, Sukrut Heroorkar wrote:
> Building with W=1 reports:
> Warning: drivers/virtio/virtio_ring.c:3174 function parameter 'vaddr'
> not described in 'virtqueue_map_free_coherent'
> 
> The @vaddr parameter was introduced when virtqueue_map_free_coherent
> was added in order to provide map operations to virtio device, but it
> was never documented. Document @vaddr to silence this warning.
> 
> Fixes: bee8c7c24b73 ("virtio: introduce map ops in virtio core")
> Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>

I picked a different version that fixed a couple of other
issues as well, but thanks!

> ---
>  drivers/virtio/virtio_ring.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/virtio/virtio_ring.c b/drivers/virtio/virtio_ring.c
> index 7b6205253b46..d763060ff0f6 100644
> --- a/drivers/virtio/virtio_ring.c
> +++ b/drivers/virtio/virtio_ring.c
> @@ -3166,6 +3166,7 @@ EXPORT_SYMBOL_GPL(virtqueue_map_alloc_coherent);
>   * @vdev: the virtio device we are talking to
>   * @map: metadata for performing mapping
>   * @size: the size of the buffer
> + * @vaddr: virtual address of the buffer
>   * @map_handle: the mapped address that needs to be freed
>   *
>   */
> -- 
> 2.43.0