From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 11E67C19F2C for ; Tue, 16 Aug 2022 05:25:58 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229608AbiHPFZ4 (ORCPT ); Tue, 16 Aug 2022 01:25:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44074 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232435AbiHPFZJ (ORCPT ); Tue, 16 Aug 2022 01:25:09 -0400 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 427285E652 for ; Mon, 15 Aug 2022 14:56:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1660600599; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=8Mm/CnM1h4B5dRbBk+BycTCdz0sdSVv31NtnIHgtZL8=; b=dqYht2CceDK9W7sAaD6tdAs8w1AghhojsjWVr9n/FiK6/D0dFnFVwobYx005HsSg7rXrl7 rgbRy9gaI6yPxrM1CjEh5leHZCieZ+eC+Pg/P5JO3DDix27QN6JcYiHI3tmivxaCESKtx+ mGOhIbvNI1o6oUl1XYnZ7duo2KU+ClY= Received: from mail-wm1-f71.google.com (mail-wm1-f71.google.com [209.85.128.71]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_128_GCM_SHA256) id us-mta-1-XW565R4RNzOidoedcXqUUg-1; Mon, 15 Aug 2022 17:56:38 -0400 X-MC-Unique: XW565R4RNzOidoedcXqUUg-1 Received: by mail-wm1-f71.google.com with SMTP id i83-20020a1c3b56000000b003a534ec2570so166813wma.7 for ; Mon, 15 Aug 2022 14:56:38 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-transfer-encoding:content-disposition :mime-version:references:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc; bh=8Mm/CnM1h4B5dRbBk+BycTCdz0sdSVv31NtnIHgtZL8=; b=rNblxtbGoP5x9+/sAc29I8OmazO6QWSuVV+i+L3v5pI5hM0iNs0cDDcXiheXgZNPwK OsLpkyeC3g4yC2ifz7v3guUGvqQaqbjqVcFZYw/kCoGKAD3K/6ZsQeK4hbXd6IJCzXLf r/PxfdHmgoWws2jLkKAtG781LklqCFRKW4gQxJU+zXASPBsiNELXhq07YQFUdDq+6BGk UUabs72nrICNLhrd0SmW3WshHpUk1JhEbXH4TfmdZPKoPuDSF90t6RirGLncc5TBdOmC 6/PwH47o0TToZHrRoyb3yLNEPgkq5chdPip4rYH2QmuxWq2dadfmFOqP9wj7HTuKSnwO LsoQ== X-Gm-Message-State: ACgBeo3RTtHhUttIwjyCtI0Vip/wQfov3+jbtG+9hgcsLbC4jAfbC1zv RD2ZtUx3c8hMrOHFTK2K4IIYpjGs8TOrhkgK4Hqxj4c1lVRWD6ahg7Z7rY51jfPA6UA2BvPIAlY cNHnmh0EhoE9BskwA X-Received: by 2002:a5d:4646:0:b0:220:5c35:d4f2 with SMTP id j6-20020a5d4646000000b002205c35d4f2mr9776323wrs.475.1660600597083; Mon, 15 Aug 2022 14:56:37 -0700 (PDT) X-Google-Smtp-Source: AA6agR446rc1SI6gJKMPP11qXiQWWOXXuovFOjed61tFUBD5H8GPlv+4YWAmEn44A+sTFWCC57gMXw== X-Received: by 2002:a5d:4646:0:b0:220:5c35:d4f2 with SMTP id j6-20020a5d4646000000b002205c35d4f2mr9776312wrs.475.1660600596795; Mon, 15 Aug 2022 14:56:36 -0700 (PDT) Received: from redhat.com ([2.55.4.37]) by smtp.gmail.com with ESMTPSA id az34-20020a05600c602200b003a5e7435190sm8296828wmb.32.2022.08.15.14.56.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 Aug 2022 14:56:36 -0700 (PDT) Date: Mon, 15 Aug 2022 17:56:31 -0400 From: "Michael S. Tsirkin" To: linux-kernel@vger.kernel.org Cc: Xuan Zhuo , Jason Wang , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , virtualization@lists.linux-foundation.org, netdev@vger.kernel.org, Linus Torvalds , Jens Axboe , James Bottomley , "Martin K. Petersen" , Guenter Roeck , Greg KH , Ricardo =?iso-8859-1?Q?Ca=F1uelo?= , Cornelia Huck Subject: Re: [PATCH v2 1/1] virtio: kerneldocs fixes and enhancements Message-ID: <20220815175549-mutt-send-email-mst@kernel.org> References: <20220815215251.154451-1-mst@redhat.com> <20220815215251.154451-2-mst@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <20220815215251.154451-2-mst@redhat.com> Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org On Mon, Aug 15, 2022 at 05:53:24PM -0400, Michael S. Tsirkin wrote: > From: Ricardo Cañuelo > > Fix variable names in some kerneldocs, naming in others. > Add kerneldocs for struct vring_desc and vring_interrupt. > > Signed-off-by: Ricardo Cañuelo > Message-Id: <20220810094004.1250-2-ricardo.canuelo@collabora.com> > Signed-off-by: Michael S. Tsirkin > Reviewed-by: Cornelia Huck Ouch this got here by mistake. Just ignore this patch pls - it's already in my tree but does not belong in the patchset. > diff --git a/drivers/virtio/virtio_ring.c b/drivers/virtio/virtio_ring.c > index d66c8e6d0ef3..4620e9d79dde 100644 > --- a/drivers/virtio/virtio_ring.c > +++ b/drivers/virtio/virtio_ring.c > @@ -2426,6 +2426,14 @@ static inline bool more_used(const struct vring_virtqueue *vq) > return vq->packed_ring ? more_used_packed(vq) : more_used_split(vq); > } > > +/** > + * vring_interrupt - notify a virtqueue on an interrupt > + * @irq: the IRQ number (ignored) > + * @_vq: the struct virtqueue to notify > + * > + * Calls the callback function of @_vq to process the virtqueue > + * notification. > + */ > irqreturn_t vring_interrupt(int irq, void *_vq) > { > struct vring_virtqueue *vq = to_vvq(_vq); > diff --git a/include/linux/virtio.h b/include/linux/virtio.h > index a3f73bb6733e..dcab9c7e8784 100644 > --- a/include/linux/virtio.h > +++ b/include/linux/virtio.h > @@ -11,7 +11,7 @@ > #include > > /** > - * virtqueue - a queue to register buffers for sending or receiving. > + * struct virtqueue - a queue to register buffers for sending or receiving. > * @list: the chain of virtqueues for this device > * @callback: the function to call when buffers are consumed (can be NULL). > * @name: the name of this virtqueue (mainly for debugging) > @@ -97,7 +97,7 @@ int virtqueue_resize(struct virtqueue *vq, u32 num, > void (*recycle)(struct virtqueue *vq, void *buf)); > > /** > - * virtio_device - representation of a device using virtio > + * struct virtio_device - representation of a device using virtio > * @index: unique position on the virtio bus > * @failed: saved value for VIRTIO_CONFIG_S_FAILED bit (for restore) > * @config_enabled: configuration change reporting enabled > @@ -156,7 +156,7 @@ size_t virtio_max_dma_size(struct virtio_device *vdev); > list_for_each_entry(vq, &vdev->vqs, list) > > /** > - * virtio_driver - operations for a virtio I/O driver > + * struct virtio_driver - operations for a virtio I/O driver > * @driver: underlying device driver (populate name and owner). > * @id_table: the ids serviced by this driver. > * @feature_table: an array of feature numbers supported by this driver. > diff --git a/include/linux/virtio_config.h b/include/linux/virtio_config.h > index 36ec7be1f480..4b517649cfe8 100644 > --- a/include/linux/virtio_config.h > +++ b/include/linux/virtio_config.h > @@ -239,7 +239,7 @@ int virtio_find_vqs_ctx(struct virtio_device *vdev, unsigned nvqs, > > /** > * virtio_synchronize_cbs - synchronize with virtqueue callbacks > - * @vdev: the device > + * @dev: the virtio device > */ > static inline > void virtio_synchronize_cbs(struct virtio_device *dev) > @@ -258,7 +258,7 @@ void virtio_synchronize_cbs(struct virtio_device *dev) > > /** > * virtio_device_ready - enable vq use in probe function > - * @vdev: the device > + * @dev: the virtio device > * > * Driver must call this to use vqs in the probe function. > * > @@ -306,7 +306,7 @@ const char *virtio_bus_name(struct virtio_device *vdev) > /** > * virtqueue_set_affinity - setting affinity for a virtqueue > * @vq: the virtqueue > - * @cpu: the cpu no. > + * @cpu_mask: the cpu mask > * > * Pay attention the function are best-effort: the affinity hint may not be set > * due to config support, irq type and sharing. > diff --git a/include/uapi/linux/virtio_ring.h b/include/uapi/linux/virtio_ring.h > index 476d3e5c0fe7..f8c20d3de8da 100644 > --- a/include/uapi/linux/virtio_ring.h > +++ b/include/uapi/linux/virtio_ring.h > @@ -93,15 +93,21 @@ > #define VRING_USED_ALIGN_SIZE 4 > #define VRING_DESC_ALIGN_SIZE 16 > > -/* Virtio ring descriptors: 16 bytes. These can chain together via "next". */ > +/** > + * struct vring_desc - Virtio ring descriptors, > + * 16 bytes long. These can chain together via @next. > + * > + * @addr: buffer address (guest-physical) > + * @len: buffer length > + * @flags: descriptor flags > + * @next: index of the next descriptor in the chain, > + * if the VRING_DESC_F_NEXT flag is set. We chain unused > + * descriptors via this, too. > + */ > struct vring_desc { > - /* Address (guest-physical). */ > __virtio64 addr; > - /* Length. */ > __virtio32 len; > - /* The flags as indicated above. */ > __virtio16 flags; > - /* We chain unused descriptors via this, too */ > __virtio16 next; > }; > > -- > MST >