Commit f8113000 authored by Kriish Sharma's avatar Kriish Sharma Committed by Michael S. Tsirkin
Browse files

virtio: fix kernel-doc for mapping/free_coherent functions 



Documentation build reported:

  WARNING: ./drivers/virtio/virtio_ring.c:3174 function parameter 'vaddr' not described in 'virtqueue_map_free_coherent'
  WARNING: ./drivers/virtio/virtio_ring.c:3308 expecting prototype for virtqueue_mapping_error(). Prototype was for virtqueue_map_mapping_error() instead

The kernel-doc block for virtqueue_map_free_coherent() omitted the @vaddr parameter, and
the kernel-doc header for virtqueue_map_mapping_error() used the wrong function name
(virtqueue_mapping_error) instead of the actual function name.

This change updates:

  - the function name in the comment to virtqueue_map_mapping_error()
  - adds the missing @vaddr description in the comment for virtqueue_map_free_coherent()

Fixes: b41cb3bc ("virtio: rename dma helpers")
Signed-off-by: default avatarKriish Sharma <kriish.sharma2006@gmail.com>
Reviewed-by: default avatarChaitanya Kulkarni <kch@nvidia.com>
Signed-off-by: default avatarMichael S. Tsirkin <mst@redhat.com>
Message-Id: <20251110202920.2250244-1-kriish.sharma2006@gmail.com>
parent e40b6abe

drivers/virtio/virtio_ring.c

+4 −3
Original line number Diff line number Diff line
@@ -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: the virtual address that needs to be freed

 * @map_handle: the mapped address that needs to be freed

 *

 */
@@ -3190,7 +3191,7 @@ EXPORT_SYMBOL_GPL(virtqueue_map_free_coherent); 
 * @dir: mapping direction

 * @attrs: mapping attributes

 *

 * Returns mapped address. Caller should check that by virtqueue_mapping_error().

 * Returns mapped address. Caller should check that by virtqueue_map_mapping_error().

 */

dma_addr_t virtqueue_map_page_attrs(const struct virtqueue *_vq,

				    struct page *page,
@@ -3249,7 +3250,7 @@ EXPORT_SYMBOL_GPL(virtqueue_unmap_page_attrs); 
 * The caller calls this to do dma mapping in advance. The DMA address can be

 * passed to this _vq when it is in pre-mapped mode.

 *

 * return mapped address. Caller should check that by virtqueue_mapping_error().

 * return mapped address. Caller should check that by virtqueue_map_mapping_error().

 */

dma_addr_t virtqueue_map_single_attrs(const struct virtqueue *_vq, void *ptr,

				      size_t size,
@@ -3299,7 +3300,7 @@ void virtqueue_unmap_single_attrs(const struct virtqueue *_vq, 
EXPORT_SYMBOL_GPL(virtqueue_unmap_single_attrs);



/**

 * virtqueue_mapping_error - check dma address

 * virtqueue_map_mapping_error - check dma address

 * @_vq: the struct virtqueue we're talking about.

 * @addr: DMA address

 *