From patchwork Wed Mar 3 13:42:49 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 392084 Delivered-To: patch@linaro.org Received: by 2002:a02:290e:0:0:0:0:0 with SMTP id p14csp5133227jap; Wed, 3 Mar 2021 05:44:23 -0800 (PST) X-Google-Smtp-Source: ABdhPJydkcAWa+fagvLPZQkrJJQhYLTaHJuKy50usq+oMepsFg6ypESwUypQ7Te1/ofDWhtxcVNp X-Received: by 2002:a63:e84f:: with SMTP id a15mr22695921pgk.249.1614779063610; Wed, 03 Mar 2021 05:44:23 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1614779063; cv=none; d=google.com; s=arc-20160816; b=hMIuzQhZVR9wwXvidxst09m3qPHJAh/Fl2ha0Nuuw+H2+y9szCkWmbIoJwLcayoRFX uzBGRNGwv46/9bZ8XBgEFkM1VBp9xsC+n6xoz21AEyJFw6OCeRSBxnKlvB/PCuAxI0Hw 3X0BXrIa1C0Ip2sZhIwuB9i1AUyfz07+xM3vLIW1ANdFM5InNlhQ+69SaLyzk8vEB8Yc OCvB5RPqgtpdaJNTAwdrCqaIpYR4mLHAabznxeMV2QrcPXE7inXadlbjRRXHl/7T9GFK Vh+00gWcxiKBESBzud53GukQoo1pTtzTM3FIDony+R0WH1+CO+Vo+Mx194YGuqAAz/Q4 Zu3g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:cc:list-subscribe :list-help:list-post:list-archive:list-unsubscribe:list-id :precedence:mime-version:references:in-reply-to:message-id:date :subject:to:from:dkim-signature:delivered-to; bh=rG9Qz9hHj5rpuRM0H5tSRrITIe+hC2xnKmrbNOs3ryg=; b=BVlr72MjFa+2jara9z2utqP0QQR1M1vpOC2JPiuCSUj94eozGoHpuzPXDMClCvVku+ Q+PTWxG2DMIazBA4FfTp9e3TT+ALxJrjXmy2QcW1WwSxC5hZK3Mm/hoXAZqyenuLDhN1 5nTW8YBOLdePlcRyHSUyZGCPnJOdpZrA1pt+U3PSkjIB2Zm59nRv+GAUuAzX4uqiggk7 g6P4YC8XjaWpXZ8GFgBHvYQD7MLB4vuWqoos9bqS0OHaS/GFIlpORf2y3JXDZC5F/vMy E0DeC1FqYk9XTDBMRz34F7Jc/Qp/bpVDYFk5YLy+do47CfOuZAg3Y2m6xPOlanyYfK3k YjOg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=JN+pNUBN; spf=pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 131.252.210.177 as permitted sender) smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from gabe.freedesktop.org (gabe.freedesktop.org. [131.252.210.177]) by mx.google.com with ESMTPS id p3si9765660plq.277.2021.03.03.05.44.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 Mar 2021 05:44:23 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 131.252.210.177 as permitted sender) client-ip=131.252.210.177; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=JN+pNUBN; spf=pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 131.252.210.177 as permitted sender) smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id A7A2A6E8E3; Wed, 3 Mar 2021 13:43:58 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-wm1-x331.google.com (mail-wm1-x331.google.com [IPv6:2a00:1450:4864:20::331]) by gabe.freedesktop.org (Postfix) with ESMTPS id 2E7C16E8FF for ; Wed, 3 Mar 2021 13:43:57 +0000 (UTC) Received: by mail-wm1-x331.google.com with SMTP id u125so6379692wmg.4 for ; Wed, 03 Mar 2021 05:43:57 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=sFatDrTTk8QqhpQrxXr3ebT1Fq28H33Kmdp2vbOtLEY=; b=JN+pNUBNmoRVzmyxYCjZbYRzO+sgBe9ntzqJZE5KsicmUm686iLD/gtmxYujDKuJFG EdpRwSuIDzKvMWWzXFpuVyMc0Z/8oUsNVwiD+Y/98rL1O3nZEEKacuG5oLnsEkg7UI32 i/CCJxLvq75MhT+jqReyFzFhOcB3Ylyl7+og6zurPtuI4vzr+pKkdbhT4YWhZroN0g9W QEpW44HNpHbO0XdwwhQPRYfcZ0zLnpSBGGVbFjs6xMKu1KcDzu6p2/SaXzYgDREiY++R DCboisRRX6fh4D+fEPxrtkhtVJvaSJO2vW3gA4YJgiU93YagoCJzCGGfPssKAzZTYNmx vCyA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=sFatDrTTk8QqhpQrxXr3ebT1Fq28H33Kmdp2vbOtLEY=; b=RnowRjLtHmeKvFJGxPJGu3YyjIK1O7OyN969RSDoEEaZcQJsUFnouKi/MXeRpHztAA oth0+eF8PtkPJ2SJXlQSxwiW32NiSgl+QM5mj5YXfybsVTL514A5+uqeIW8mplfdzyBF 9C1AVWurrBLsS4OdlMv/GjNcfKsz63yk//TmoLsWIGbGWVrUTGMEWHpOAq4JxTufc5U7 xr9gCQ2ddRxH9iRB2CaK8Ownw188lm+DCSWfulb5YuHB+MzQ90pLa8ZeSRhMjFIMjEMT nXi2A3IAl1CvRaJD7wYj3zjJi9c5GTAhx6WcvZKmwe8Ftl/yt0KoCFQq8G+mgArmwVU1 W/Xg== X-Gm-Message-State: AOAM531oLThBj4oHShbDZ8XU2zLmzGhvXHPjjQOGkHEq3H6ROwwS8kZ7 VjC1S9DJPw3XyN3IE4h9WbSFHA== X-Received: by 2002:a1c:2288:: with SMTP id i130mr9151603wmi.62.1614779035907; Wed, 03 Mar 2021 05:43:55 -0800 (PST) Received: from dell.default ([91.110.221.155]) by smtp.gmail.com with ESMTPSA id w18sm6109524wrr.7.2021.03.03.05.43.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 Mar 2021 05:43:55 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Subject: [PATCH 23/53] drm/vmwgfx/vmwgfx_execbuf: Fix some kernel-doc related issues Date: Wed, 3 Mar 2021 13:42:49 +0000 Message-Id: <20210303134319.3160762-24-lee.jones@linaro.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210303134319.3160762-1-lee.jones@linaro.org> References: <20210303134319.3160762-1-lee.jones@linaro.org> MIME-Version: 1.0 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: David Airlie , Roland Scheidegger , linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, =?utf-8?q?Christian_K=C3=B6nig?= , linaro-mm-sig@lists.linaro.org, VMware Graphics , linux-media@vger.kernel.org Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Fixes the following W=1 kernel build warning(s): drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:89: warning: Enum value 'vmw_res_rel_max' not described in enum 'vmw_resource_relocation_type' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:136: warning: Function parameter or member 'func' not described in 'vmw_cmd_entry' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:136: warning: Function parameter or member 'cmd_name' not described in 'vmw_cmd_entry' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:212: warning: Function parameter or member 'res' not described in 'vmw_cmd_ctx_first_setup' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:523: warning: Function parameter or member 'sw_context' not described in 'vmw_resource_relocation_add' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:523: warning: Excess function parameter 'list' description in 'vmw_resource_relocation_add' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:653: warning: Function parameter or member 'p_res' not described in 'vmw_cmd_res_check' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:653: warning: Excess function parameter 'p_val' description in 'vmw_cmd_res_check' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:1716: warning: Function parameter or member 'res' not described in 'vmw_cmd_res_switch_backup' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:1716: warning: Excess function parameter 'val_node' description in 'vmw_cmd_res_switch_backup' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3757: warning: Function parameter or member 'file_priv' not described in 'vmw_execbuf_fence_commands' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3757: warning: Function parameter or member 'dev_priv' not described in 'vmw_execbuf_fence_commands' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3757: warning: Function parameter or member 'p_fence' not described in 'vmw_execbuf_fence_commands' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3757: warning: Function parameter or member 'p_handle' not described in 'vmw_execbuf_fence_commands' drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3954: warning: Function parameter or member 'kernel_commands' not described in 'vmw_execbuf_cmdbuf' Cc: VMware Graphics Cc: Roland Scheidegger Cc: David Airlie Cc: Daniel Vetter Cc: Sumit Semwal Cc: "Christian König" Cc: dri-devel@lists.freedesktop.org Cc: linux-media@vger.kernel.org Cc: linaro-mm-sig@lists.linaro.org Signed-off-by: Lee Jones Signed-off-by: Zack Rusin Link: https://patchwork.freedesktop.org/patch/msgid/20210115181313.3431493-4-lee.jones@linaro.org --- drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c b/drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c index 462f173207085..7a24196f92c38 100644 --- a/drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c +++ b/drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c @@ -80,7 +80,8 @@ struct vmw_relocation { * with a NOP. * @vmw_res_rel_cond_nop: Conditional NOP relocation. If the resource id after * validation is -1, the command is replaced with a NOP. Otherwise no action. - */ + * @vmw_res_rel_max: Last value in the enum - used for error checking +*/ enum vmw_resource_relocation_type { vmw_res_rel_normal, vmw_res_rel_nop, @@ -122,9 +123,11 @@ struct vmw_ctx_validation_info { /** * struct vmw_cmd_entry - Describe a command for the verifier * + * @func: Call-back to handle the command. * @user_allow: Whether allowed from the execbuf ioctl. * @gb_disable: Whether disabled if guest-backed objects are available. * @gb_enable: Whether enabled iff guest-backed objects are available. + * @cmd_name: Name of the command. */ struct vmw_cmd_entry { int (*func) (struct vmw_private *, struct vmw_sw_context *, @@ -203,6 +206,7 @@ static void vmw_bind_dx_query_mob(struct vmw_sw_context *sw_context) * * @dev_priv: Pointer to the device private: * @sw_context: The command submission context + * @res: Pointer to the resource * @node: The validation node holding the context resource metadata */ static int vmw_cmd_ctx_first_setup(struct vmw_private *dev_priv, @@ -509,7 +513,7 @@ static int vmw_resource_context_res_add(struct vmw_private *dev_priv, /** * vmw_resource_relocation_add - Add a relocation to the relocation list * - * @list: Pointer to head of relocation list. + * @sw_context: Pointer to the software context. * @res: The resource. * @offset: Offset into the command buffer currently being parsed where the id * that needs fixup is located. Granularity is one byte. @@ -639,7 +643,7 @@ static int vmw_resources_reserve(struct vmw_sw_context *sw_context) * @converter: User-space visisble type specific information. * @id_loc: Pointer to the location in the command buffer currently being parsed * from where the user-space resource id handle is located. - * @p_val: Pointer to pointer to resource validalidation node. Populated on + * @p_res: Pointer to pointer to resource validalidation node. Populated on * exit. */ static int @@ -1700,7 +1704,7 @@ static int vmw_cmd_check_define_gmrfb(struct vmw_private *dev_priv, * * @dev_priv: Pointer to a device private struct. * @sw_context: The software context being used for this batch. - * @val_node: The validation node representing the resource. + * @res: Pointer to the resource. * @buf_id: Pointer to the user-space backup buffer handle in the command * stream. * @backup_offset: Offset of backup into MOB. @@ -3739,7 +3743,7 @@ static int vmw_resize_cmd_bounce(struct vmw_sw_context *sw_context, return 0; } -/** +/* * vmw_execbuf_fence_commands - create and submit a command stream fence * * Creates a fence object and submits a command stream marker. @@ -3939,9 +3943,9 @@ static int vmw_execbuf_submit_cmdbuf(struct vmw_private *dev_priv, * On successful return, the function returns a pointer to the data in the * command buffer and *@header is set to non-NULL. * - * If command buffers could not be used, the function will return the value of - * @kernel_commands on function call. That value may be NULL. In that case, the - * value of *@header will be set to NULL. + * @kernel_commands: If command buffers could not be used, the function will + * return the value of @kernel_commands on function call. That value may be + * NULL. In that case, the value of *@header will be set to NULL. * * If an error is encountered, the function will return a pointer error value. * If the function is interrupted by a signal while sleeping, it will return