tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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: b41cb3bcf67f ("virtio: rename dma helpers")
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
Message-Id: <20251110202920.2250244-1-kriish.sharma2006@gmail.com>

authored by

Kriish Sharma and committed by
Michael S. Tsirkin f8113000 e40b6abe

+4 -3
+4 -3
drivers/virtio/virtio_ring.c
··· 3166 3166 * @vdev: the virtio device we are talking to 3167 3167 * @map: metadata for performing mapping 3168 3168 * @size: the size of the buffer 3169 + * @vaddr: the virtual address that needs to be freed 3169 3170 * @map_handle: the mapped address that needs to be freed 3170 3171 * 3171 3172 */ ··· 3191 3190 * @dir: mapping direction 3192 3191 * @attrs: mapping attributes 3193 3192 * 3194 - * Returns mapped address. Caller should check that by virtqueue_mapping_error(). 3193 + * Returns mapped address. Caller should check that by virtqueue_map_mapping_error(). 3195 3194 */ 3196 3195 dma_addr_t virtqueue_map_page_attrs(const struct virtqueue *_vq, 3197 3196 struct page *page, ··· 3250 3249 * The caller calls this to do dma mapping in advance. The DMA address can be 3251 3250 * passed to this _vq when it is in pre-mapped mode. 3252 3251 * 3253 - * return mapped address. Caller should check that by virtqueue_mapping_error(). 3252 + * return mapped address. Caller should check that by virtqueue_map_mapping_error(). 3254 3253 */ 3255 3254 dma_addr_t virtqueue_map_single_attrs(const struct virtqueue *_vq, void *ptr, 3256 3255 size_t size, ··· 3300 3299 EXPORT_SYMBOL_GPL(virtqueue_unmap_single_attrs); 3301 3300 3302 3301 /** 3303 - * virtqueue_mapping_error - check dma address 3302 + * virtqueue_map_mapping_error - check dma address 3304 3303 * @_vq: the struct virtqueue we're talking about. 3305 3304 * @addr: DMA address 3306 3305 *