From patchwork Wed Mar 3 13:43:04 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 12113557 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C5BBFC433DB for ; Wed, 3 Mar 2021 13:44:46 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 82FBE64EEB for ; Wed, 3 Mar 2021 13:44:46 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 82FBE64EEB Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 05DEC6E906; Wed, 3 Mar 2021 13:44:16 +0000 (UTC) Received: from mail-wm1-x329.google.com (mail-wm1-x329.google.com [IPv6:2a00:1450:4864:20::329]) by gabe.freedesktop.org (Postfix) with ESMTPS id B86EE6E906 for ; Wed, 3 Mar 2021 13:44:14 +0000 (UTC) Received: by mail-wm1-x329.google.com with SMTP id l22so5231194wme.1 for ; Wed, 03 Mar 2021 05:44:14 -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=skXCklvbLkMdUopRkkr7nz9lm78nkYKqb32FzAH7TqM=; b=VYP0HDoLjO3oZLwwUXl4OtppTMndAhsqKdA/I28iUr+7kmM0FBHDRY5Nfgy6V3kYLP B1AF5yzPzAWn62i1s+UOzUSBjCqjeaZ+qInKZgPpSux/544nyXDvOaKXw/351XXI4qN3 I0nUMq3JAkLpcUyCLUDbBpUs22MZnBfAqHUR6LNsWzPS9LZxtyuhzbEjiFqUaWdGJuhn TbLoxbcqysuDGfNlU1UvZVD3Ds0SurcGNzsA3R9vXsxlGtkccB6rgumvrSilo/mKlP8e BZ05EefhF15519Ozh159XAmZ8TrhLURNqOYKcsbSTI+swv1AXJhiliTHHjNpy8v4pRkZ 19iA== 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=skXCklvbLkMdUopRkkr7nz9lm78nkYKqb32FzAH7TqM=; b=RawbmNtWMnz6q9f+f9vKqdPHKU4XQZPUUvtDWn8yvb8+tda/djqkDXrckbIX4w3wVh e5U5qV0/ahU809j7IpMKAxGyOXy+yS5oO+Qo5YX3GFg58z/xjiqhlOhLhEZ81KRLYejU 3CPnvk5bUHFv1t+oNTEVhck9AOt4pIumm37A/bVv92jko4KfDTj/pmBt9TFKWJivG45C xAuK6g2poVR9lGZ9nTzsUHflpbrwzSZUXPcOYf4Adf9B5j2jl/+IgQejLywun5yH4lBI kaubouYv2Wc6zQXlyUL0H4uTkiBd+exL1dhJFmuEcTUKcPmmoH2ayNfQneZNTTQMhlj5 /pKQ== X-Gm-Message-State: AOAM533vqXijx+qz0kCjP3C6DUaDU7BquWAdybAsM6AlXU7HOkdnzdkP tW0rGOYvlxdf4/P4cYj4LrG6Bg== X-Google-Smtp-Source: ABdhPJwe+gr1id7lFcISbMgFcWSv4o73aEwdV4x1IoMr0r1dFOC7mRTEkAOXQGqFKFeTquh12fefog== X-Received: by 2002:a1c:f30a:: with SMTP id q10mr9541891wmq.159.1614779053381; Wed, 03 Mar 2021 05:44:13 -0800 (PST) Received: from dell.default ([91.110.221.155]) by smtp.gmail.com with ESMTPSA id w18sm6109524wrr.7.2021.03.03.05.44.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 Mar 2021 05:44:12 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Subject: [PATCH 38/53] drm/vmwgfx/vmwgfx_surface: Fix some kernel-doc related issues Date: Wed, 3 Mar 2021 13:43:04 +0000 Message-Id: <20210303134319.3160762-39-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, VMware Graphics 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_surface.c:55: warning: Function parameter or member 'prime' not described in 'vmw_user_surface' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:55: warning: Function parameter or member 'backup_base' not described in 'vmw_user_surface' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:78: warning: cannot understand function prototype: 'struct vmw_surface_dirty ' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:173: warning: Function parameter or member 'header' not described in 'vmw_surface_dma' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:173: warning: Function parameter or member 'body' not described in 'vmw_surface_dma' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:173: warning: Function parameter or member 'cb' not described in 'vmw_surface_dma' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:173: warning: Function parameter or member 'suffix' not described in 'vmw_surface_dma' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:181: warning: Function parameter or member 'header' not described in 'vmw_surface_define' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:181: warning: Function parameter or member 'body' not described in 'vmw_surface_define' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:189: warning: Function parameter or member 'header' not described in 'vmw_surface_destroy' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:189: warning: Function parameter or member 'body' not described in 'vmw_surface_destroy' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:555: warning: Function parameter or member 'readback' not described in 'vmw_legacy_srf_unbind' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:1067: warning: Function parameter or member 'res' not described in 'vmw_gb_surface_create' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:1067: warning: Excess function parameter 'srf' description in 'vmw_gb_surface_create' drivers/gpu/drm/vmwgfx/vmwgfx_surface.c:1067: warning: Excess function parameter 'cmd_space' description in 'vmw_gb_surface_create' Cc: VMware Graphics Cc: Roland Scheidegger Cc: David Airlie Cc: Daniel Vetter Cc: dri-devel@lists.freedesktop.org Signed-off-by: Lee Jones Signed-off-by: Zack Rusin Link: https://patchwork.freedesktop.org/patch/msgid/20210115181313.3431493-34-lee.jones@linaro.org --- drivers/gpu/drm/vmwgfx/vmwgfx_surface.c | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/drivers/gpu/drm/vmwgfx/vmwgfx_surface.c b/drivers/gpu/drm/vmwgfx/vmwgfx_surface.c index f6cab77075a04..c3e55c1376eb8 100644 --- a/drivers/gpu/drm/vmwgfx/vmwgfx_surface.c +++ b/drivers/gpu/drm/vmwgfx/vmwgfx_surface.c @@ -41,10 +41,12 @@ /** * struct vmw_user_surface - User-space visible surface resource * + * @prime: The TTM prime object. * @base: The TTM base object handling user-space visibility. * @srf: The surface metadata. * @size: TTM accounting size for the surface. - * @master: master of the creating client. Used for security check. + * @master: Master of the creating client. Used for security check. + * @backup_base: The TTM base object of the backup buffer. */ struct vmw_user_surface { struct ttm_prime_object prime; @@ -69,7 +71,7 @@ struct vmw_surface_offset { }; /** - * vmw_surface_dirty - Surface dirty-tracker + * struct vmw_surface_dirty - Surface dirty-tracker * @cache: Cached layout information of the surface. * @size: Accounting size for the struct vmw_surface_dirty. * @num_subres: Number of subresources. @@ -162,7 +164,7 @@ static const struct vmw_res_func vmw_gb_surface_func = { .clean = vmw_surface_clean, }; -/** +/* * struct vmw_surface_dma - SVGA3D DMA command */ struct vmw_surface_dma { @@ -172,7 +174,7 @@ struct vmw_surface_dma { SVGA3dCmdSurfaceDMASuffix suffix; }; -/** +/* * struct vmw_surface_define - SVGA3D Surface Define command */ struct vmw_surface_define { @@ -180,7 +182,7 @@ struct vmw_surface_define { SVGA3dCmdDefineSurface body; }; -/** +/* * struct vmw_surface_destroy - SVGA3D Surface Destroy command */ struct vmw_surface_destroy { @@ -544,6 +546,7 @@ static int vmw_legacy_srf_bind(struct vmw_resource *res, * * @res: Pointer to a struct vmw_res embedded in a struct * vmw_surface. + * @readback: Readback - only true if dirty * @val_buf: Pointer to a struct ttm_validate_buffer containing * information about the backup buffer. * @@ -1060,8 +1063,8 @@ int vmw_surface_reference_ioctl(struct drm_device *dev, void *data, /** * vmw_surface_define_encode - Encode a surface_define command. * - * @srf: Pointer to a struct vmw_surface object. - * @cmd_space: Pointer to memory area in which the commands should be encoded. + * @res: Pointer to a struct vmw_resource embedded in a struct + * vmw_surface. */ static int vmw_gb_surface_create(struct vmw_resource *res) {