linux-kernel - [PATCH] virtio: document @vaddr in virtqueue_map_free

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20251029033559.83145-1-hsukrut3@gmail.com>
Date: Wed, 29 Oct 2025 09:05:58 +0530
From: Sukrut Heroorkar <hsukrut3@...il.com>
To: "Michael S. Tsirkin" <mst@...hat.com>,
	Jason Wang <jasowang@...hat.com>,
	Xuan Zhuo <xuanzhuo@...ux.alibaba.com>,
	Eugenio Pérez <eperezma@...hat.com>,
	virtualization@...ts.linux.dev (open list:VIRTIO CORE AND NET DRIVERS),
	linux-kernel@...r.kernel.org (open list)
Cc: shuah@...nel.org,
	david.hunter.linux@...il.com,
	Sukrut Heroorkar <hsukrut3@...il.com>
Subject: [PATCH] virtio: document @vaddr in virtqueue_map_free_coherent kernel-doc comment

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@...il.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