From nobody Wed Feb 11 12:08:01 2026 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 E4C50C77B7D for ; Wed, 10 May 2023 12:23:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236959AbjEJMXW (ORCPT ); Wed, 10 May 2023 08:23:22 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59506 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236410AbjEJMXV (ORCPT ); Wed, 10 May 2023 08:23:21 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 294F3F1 for ; Wed, 10 May 2023 05:23:20 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id AB6D4611B1 for ; Wed, 10 May 2023 12:23:19 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id CD2EFC433D2; Wed, 10 May 2023 12:23:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1683721398; bh=bEGUHKTzdlZftwhhjnP2MSwCEbRLwRWKezd6xI8Mojs=; h=From:Date:Subject:To:Cc:From; b=KZpiGgaQ69doAghTtA5xJp9tSt57tzhV0t4Vttm2BLGcc3WnxTexvCXQFq1j97Pmj y5u8uaIQX7TF2utLFhZ73Wf9oWppgNGv0RBFMUqZ71xAM1BDrHWn6cvPVugPYCMx9X Af836cTXuzofmf17cj51S4iRvggMKIDi1FuFupwE4EeDeSKnXjTw2o2bzGYJT0prJH lkb1rI1MOpJwGH0lCJcch4KFWvN3cMI03HHRKUHi2OUj3dEo3mzB5r4H6KTwZR5AYd fYGKZs1tgRg5me+vvuCMFFmjk6dgvLhE3P4TP7Py9aBukCbYCJWhgL4Zp/zZqyYrnw 5OgLvgJ98lcqA== From: Simon Horman Date: Wed, 10 May 2023 14:23:12 +0200 Subject: [PATCH] virtio: Add missing documentation for structure fields MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20230510-virtio-kdoc-v1-1-d2b1824a9a2b@kernel.org> X-B4-Tracking: v=1; b=H4sIALCMW2QC/x2NQQqDMBAAvyJ7diEqjbVfkR5istZFScrGiiD5u 0uPMzDMBZmEKcOrukDo4MwpKjR1BX5x8UPIQRla03bm0Rg8WHZOuIbkMQzW0rOf+84QaDG5TDi Ji37RJv62TeVXaObzvxjfpdyGpcvFcgAAAA== To: "Michael S. Tsirkin" , Jason Wang , Xuan Zhuo Cc: virtualization@lists.linux-foundation.org, linux-kernel@vger.kernel.org, Simon Horman X-Mailer: b4 0.12.2 Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add missing documentation for the vqs_list_lock field of struct virtio_devi= ce, and the validate field of struct virtio_driver. ./scripts/kernel-doc says: .../virtio.h:131: warning: Function parameter or member 'vqs_list_lock' no= t described in 'virtio_device' .../virtio.h:192: warning: Function parameter or member 'validate' not des= cribed in 'virtio_driver' 2 warnings as Errors No functional changes intended. Signed-off-by: Simon Horman --- include/linux/virtio.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/linux/virtio.h b/include/linux/virtio.h index b93238db94e3..0b2b82ee3220 100644 --- a/include/linux/virtio.h +++ b/include/linux/virtio.h @@ -103,6 +103,7 @@ int virtqueue_resize(struct virtqueue *vq, u32 num, * @config_enabled: configuration change reporting enabled * @config_change_pending: configuration change reported while disabled * @config_lock: protects configuration change reporting + * @vqs_list_lock: protects @vqs. * @dev: underlying device. * @id: the device type identification (used to match it with a driver). * @config: the configuration ops for this device. @@ -160,6 +161,7 @@ size_t virtio_max_dma_size(const struct virtio_device *= vdev); * @feature_table_size: number of entries in the feature table array. * @feature_table_legacy: same as feature_table but when working in legacy= mode. * @feature_table_size_legacy: number of entries in feature table legacy a= rray. + * @validate: the function to call to vaidate features at probe time. * @probe: the function to call when a device is found. Returns 0 or -err= no. * @scan: optional function to call after successful probe; intended * for virtio-scsi to invoke a scan.