From patchwork Fri Dec 22 05:25:21 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 182543 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp859133dyi; Thu, 21 Dec 2023 21:26:01 -0800 (PST) X-Google-Smtp-Source: AGHT+IEATlfN6J7v4qgap2iLHVe+ulXGaTQaBYdsgpDRP3lBy0kzMMGjIBHWkTQxDX/jGROtBsCP X-Received: by 2002:a05:6402:22c3:b0:554:595:9805 with SMTP id dm3-20020a05640222c300b0055405959805mr300691edb.74.1703222761758; Thu, 21 Dec 2023 21:26:01 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703222761; cv=none; d=google.com; s=arc-20160816; b=g/6woU8s/9u42gWX9p/deeUWPgb+zhAaWVUhyPA2g/5goECOst9ByNpOK5q1rF2Xz/ h5csMCCP0aRaqQBd/qGfpeAQ4ca8QSPA8DXBpUBCIblDkQ3O5az0BwK0K1T9bVI4vnaB Yak/ur5G8dX2G7mMVWlmYTK1Enw1mwoEQKg4cxilPOs5FpNbMq8GuWiK5vxjKMKq03Be U2CNVVjSwgCR1Qht0/UmnxCaHWoGpRtezJzv54JBIf1ujZ5WFEsHj11cJkS3o05slxHY Gc8lOU6ppu86/X+ZvEhL8fiDn4wfvqb1g3wRxVI5XuCLzDcULNUbrn2bVIKPcyhC1YYB oqdQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=NcgjXN95RsDAjlsvl0lPtlflx+Yff9K/qAsTAqvV9q4=; fh=fZ0/Cw+xoRxI3Qielm39cPIAeEqmtcSUTkwOIQBAkI0=; b=yX3itrBDaeF7DlGYgJNmLUtg8B61uZEl1ylnfkAIqhkHENGiCUinaX1yUdVqEFlofl jDxyRQB6JXAm1atorDnsuN7Lg2FqTuJqZL9+pVJhfrDjPaNcQ3cBchRFG4sZ3ZJBUVLX UYSBuZ77ISUUMsxa/BMiPFgTMu31Ih+MHX1de5u6xNKR13WEOmlrqj0LmpW+embhlX9P YTaBrUZNoejK00nsylKeZd+Ma/GF+ERgw8hCJEKsn2g/AHvgLEbPNnXbjiIFqpiNETNu +4Xy0qbLDdvRwT+praSmYWdFo60RVZgb2lHyj4E4WAXsQHGjnCLIXIOOKbHBzw9zrLfp vQkg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Ib0tjcY5; spf=pass (google.com: domain of linux-kernel+bounces-9365-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-9365-ouuuleilei=gmail.com@vger.kernel.org" Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id q6-20020a056402518600b00553366d0746si1545771edd.439.2023.12.21.21.26.01 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Dec 2023 21:26:01 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-9365-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Ib0tjcY5; spf=pass (google.com: domain of linux-kernel+bounces-9365-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-9365-ouuuleilei=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id E35D91F22D35 for ; Fri, 22 Dec 2023 05:26:00 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id B519EC12D; Fri, 22 Dec 2023 05:25:27 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="Ib0tjcY5" X-Original-To: linux-kernel@vger.kernel.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 722216120 for ; Fri, 22 Dec 2023 05:25:22 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=NcgjXN95RsDAjlsvl0lPtlflx+Yff9K/qAsTAqvV9q4=; b=Ib0tjcY5MpF4PWKRkRejF/bvZv i08sfXeqCuXE22jRpC3ZJw+Izi3HZdADzRbVrtQj8vo3rgbTLCGtCPRzl8p16l6n9lf85xCJZhJEL x8Ll8zdf6jY79f19MAtSyRst12Urun4k8BNu2u2rj5f8CeHP1GLLkdlkBoPPJKK3O2RAWL3gbdfl7 nrSe5aoAJBt7wTUxyIGMX5vWyabfK0iALpCUJa1RI43EEWR7kpMHvRezXD1gP5NZApK5HborMixFF fvFHSYuGKCkM2UAoHzsJwk0j/rC5A6NcVHHIctMIPsWiHT3U6INVUHQBaun64aNdl7DBUxo6sph5h RH5NAezg==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rGY2E-004y0F-0B; Fri, 22 Dec 2023 05:25:22 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Hans de Goede , Arnd Bergmann , Greg Kroah-Hartman Subject: [PATCH 3/3] virt: vbox: utils: fix all kernel-doc warnings Date: Thu, 21 Dec 2023 21:25:21 -0800 Message-ID: <20231222052521.14333-3-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20231222052521.14333-1-rdunlap@infradead.org> References: <20231222052521.14333-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785958510777213206 X-GMAIL-MSGID: 1785958510777213206 Use kernel-doc format for functions that have comments that begin with "/**". This prevents 6 kernel-doc warnings. Signed-off-by: Randy Dunlap Cc: Hans de Goede Cc: Arnd Bergmann Cc: Greg Kroah-Hartman --- drivers/virt/vboxguest/vboxguest_utils.c | 33 +++++++++++++-------- 1 file changed, 21 insertions(+), 12 deletions(-) diff -- a/drivers/virt/vboxguest/vboxguest_utils.c b/drivers/virt/vboxguest/vboxguest_utils.c --- a/drivers/virt/vboxguest/vboxguest_utils.c +++ b/drivers/virt/vboxguest/vboxguest_utils.c @@ -237,14 +237,16 @@ static int hgcm_call_preprocess_linaddr( } /** - * Preprocesses the HGCM call, validate parameters, alloc bounce buffers and - * figure out how much extra storage we need for page lists. - * Return: 0 or negative errno value. + * hgcm_call_preprocess - Preprocesses the HGCM call, validate parameters, + * alloc bounce buffers and figure out how much extra storage we need for + * page lists. * @src_parm: Pointer to source function call parameters * @parm_count: Number of function call parameters. * @bounce_bufs_ret: Where to return the allocated bouncebuffer array * @extra: Where to return the extra request space needed for * physical page lists. + * + * Return: %0 or negative errno value. */ static int hgcm_call_preprocess( const struct vmmdev_hgcm_function_parameter *src_parm, @@ -301,10 +303,11 @@ static int hgcm_call_preprocess( } /** - * Translates linear address types to page list direction flags. + * hgcm_call_linear_addr_type_to_pagelist_flags - Translates linear address + * types to page list direction flags. + * @type: The type. * * Return: page list flags. - * @type: The type. */ static u32 hgcm_call_linear_addr_type_to_pagelist_flags( enum vmmdev_hgcm_function_parameter_type type) @@ -369,7 +372,8 @@ static void hgcm_call_init_linaddr(struc } /** - * Initializes the call request that we're sending to the host. + * hgcm_call_init_call - Initializes the call request that we're sending + * to the host. * @call: The call to initialize. * @client_id: The client ID of the caller. * @function: The function number of the function to call. @@ -425,7 +429,9 @@ static void hgcm_call_init_call( } /** - * Tries to cancel a pending HGCM call. + * hgcm_cancel_call - Tries to cancel a pending HGCM call. + * @gdev: The VBoxGuest device extension. + * @call: The call to cancel. * * Return: VBox status code */ @@ -459,13 +465,15 @@ static int hgcm_cancel_call(struct vbg_d } /** - * Performs the call and completion wait. - * Return: 0 or negative errno value. + * vbg_hgcm_do_call - Performs the call and completion wait. * @gdev: The VBoxGuest device extension. * @call: The call to execute. * @timeout_ms: Timeout in ms. + * @interruptible: whether this call is interruptible * @leak_it: Where to return the leak it / free it, indicator. * Cancellation fun. + * + * Return: %0 or negative errno value. */ static int vbg_hgcm_do_call(struct vbg_dev *gdev, struct vmmdev_hgcm_call *call, u32 timeout_ms, bool interruptible, bool *leak_it) @@ -545,13 +553,14 @@ static int vbg_hgcm_do_call(struct vbg_d } /** - * Copies the result of the call back to the caller info structure and user - * buffers. - * Return: 0 or negative errno value. + * hgcm_call_copy_back_result - Copies the result of the call back to + * the caller info structure and user buffers. * @call: HGCM call request. * @dst_parm: Pointer to function call parameters destination. * @parm_count: Number of function call parameters. * @bounce_bufs: The bouncebuffer array. + * + * Return: %0 or negative errno value. */ static int hgcm_call_copy_back_result( const struct vmmdev_hgcm_call *call,