From patchwork Wed Jan 13 08:07:42 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 362053 Delivered-To: patch@linaro.org Received: by 2002:a02:ccad:0:0:0:0:0 with SMTP id t13csp296978jap; Wed, 13 Jan 2021 00:08:36 -0800 (PST) X-Google-Smtp-Source: ABdhPJxNYF7e2MlqxHizGQNe9PvsS28t+6IJEGDBAkZZb5egBtdU/McJEbpgA1AMgHX3vAc0axvd X-Received: by 2002:a17:90a:4606:: with SMTP id w6mr1043420pjg.172.1610525316498; Wed, 13 Jan 2021 00:08:36 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1610525316; cv=none; d=google.com; s=arc-20160816; b=yJiVIG0pRrWpeNTnmhrtpYslnvXrdMQSPrtQODe3Wc+XXdv4VkwXuYZht091yoWxgA g7KImwW/4RcCj0DrCnqdQ6icMTZIepoYB09MHA6j/S0Vz5Krtt4NVQFlmHjHyM7CTkjM MZV1HMX27p4X+4hjlBjEIMEk5cwt4ul6Oe1LXzXKFxLzznV462nMg1E9YLUDtm1K+T4Y iNtC4wjxFfnHXG5pQBk8BQYZoMPIYjv68g9JHjobM70B9emnaRkMXVPqcBrm/7uNxTLf rtiuY4wyLPfnJsYEEiHPTvEB2TXmYbASDZp4EbxWLozpRfTYACKNmFMZ/AEIdFswcq7L c7XQ== 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=u/6Bj3tG4M+dZ4E2HY4El1jUS6EgWAHCR7ui/0Qsz8M=; b=IJVjDWRatq5iaqaHgKezzEhQHP7vcp1EfgvacHSEnlUsJUqWXvvRoBizs7xo8ZwEWz W9g1ius3GkHElVBoY23rTaxlU3H9y5eUT2qPsiznHAdez5BS2b8xaU6+7WC4Urw5lfvH lGZXkLpCA28smM1rwOhLBa1vzKt4l/Dr0oqZNrw21IMXvLNjhZhyKUqy2cLy3/60o6Fh ZJaf7wpEk8TYQasLcTrIMK9WoIN0U2zmPauNQxq8V65O1Kmh6owGccMNTD5B75VW1iu7 PrHQpRA4+YLfLIXqMCPvKoX4VFlAWSoVHHQzlLD0hfauDuqgiieMqj0VUmTw5VY+kMaR illg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=lbwRgZbP; spf=pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 2610:10:20:722:a800:ff:fe36:1795 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. [2610:10:20:722:a800:ff:fe36:1795]) by mx.google.com with ESMTPS id z12si1670218pgu.300.2021.01.13.00.08.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Jan 2021 00:08:36 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 2610:10:20:722:a800:ff:fe36:1795 as permitted sender) client-ip=2610:10:20:722:a800:ff:fe36:1795; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=lbwRgZbP; spf=pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 2610:10:20:722:a800:ff:fe36:1795 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 C2E806E096; Wed, 13 Jan 2021 08:08:23 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-wm1-x332.google.com (mail-wm1-x332.google.com [IPv6:2a00:1450:4864:20::332]) by gabe.freedesktop.org (Postfix) with ESMTPS id 301376E072 for ; Wed, 13 Jan 2021 08:08:22 +0000 (UTC) Received: by mail-wm1-x332.google.com with SMTP id r4so708542wmh.5 for ; Wed, 13 Jan 2021 00:08:22 -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=VziGpla9CXHb4VzE3DuAR1EazcEsD8QPraycH5WIRSc=; b=lbwRgZbP9xaz0MoRQPGeYDTj8v589eA7dm1Uy37pKQvTgix70bV95WKhysILiuhLnr X/IoChmCmepg3Tbx6LBfkVnmlA/RIM3EDMVJg6T6ruPjY9yrvrXGCQoIcVZ79tfE/PWs 4mkUE3DUsymzBsrpRsCDU8Ktu/0DRUcZB9cV6wI8WNYkv3jWMtC+G82lGGz0vfMkCTXA SEPQWMlKrKAjiJE99bhtRYwTyXkG5ysCP9oab4bXxelwOBTv1Lkp+MZwXAQXp0OXGudT SubAZ8iP8LxkxI3TwbnIGfiW2Ph5h0UUDSWVr/Qdms1Ey8M2CHepKkGIWyaUTelpM+H3 GUDw== 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=VziGpla9CXHb4VzE3DuAR1EazcEsD8QPraycH5WIRSc=; b=nGvvnVX2tB+b5uEXJw0SOb7dROF4c7zqfJ3CqOskdlcrEqsZXkDQtG7GFXXHzGGOJc eaE8w8ghBLW40JFOLT4voN5T02dSGRrlb2ieTEMoAg5kU1urREsYEuJ3qVGTyUx/Q4X4 6hDCmB8jaLsaHS830eLnYHIENULqpM6FWwxgGfpNxXE/6gY/tYAwT1tLGEZ1Qgnl+yLJ ITPGY5oilG4+lXaaY4hDhi5J1RQxfm13Buyo83tmVWfdvgoN9KQY6ikkbNGUgiX/o+1S i+li4G5SU9Xp+WpMnNXAwn+CBo3KTzI+blTv334GuwY6JvZliDFTYvbjwskfNxGTZyZt 5gyQ== X-Gm-Message-State: AOAM531u8P/Ks264xHxxJR+dzQGNybv+HDRbjbxZsh3FEo6QpAW9QyQI Pq29za5Fw/YWwEM8Mm/4grhn/g== X-Received: by 2002:a1c:6402:: with SMTP id y2mr923252wmb.43.1610525300839; Wed, 13 Jan 2021 00:08:20 -0800 (PST) Received: from dell.default ([91.110.221.229]) by smtp.gmail.com with ESMTPSA id r20sm1642486wmh.15.2021.01.13.00.08.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Jan 2021 00:08:20 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Subject: [PATCH 20/30] drm/amd/display/dc/core/dc: Fix a bunch of documentation misdemeanours Date: Wed, 13 Jan 2021 08:07:42 +0000 Message-Id: <20210113080752.1003793-21-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210113080752.1003793-1-lee.jones@linaro.org> References: <20210113080752.1003793-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: Leo Li , linux-kernel@vger.kernel.org, amd-gfx@lists.freedesktop.org, David Airlie , dri-devel@lists.freedesktop.org, Alex Deucher , =?utf-8?q?Christian_K=C3=B6nig?= Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Fixes the following W=1 kernel build warning(s): drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:287: warning: Cannot understand ***************************************************************************** drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:366: warning: Function parameter or member 'crc_window' not described in 'dc_stream_configure_crc' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function parameter or member 'r_cr' not described in 'dc_stream_get_crc' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function parameter or member 'g_y' not described in 'dc_stream_get_crc' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:430: warning: Function parameter or member 'b_cb' not described in 'dc_stream_get_crc' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'dc' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'updates' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'surface_count' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'stream_update' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2026: warning: Function parameter or member 'stream_status' not described in 'dc_check_update_surfaces_for_stream' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function parameter or member 'dc' not described in 'dc_interrupt_set' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function parameter or member 'src' not described in 'dc_interrupt_set' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2822: warning: Function parameter or member 'enable' not described in 'dc_interrupt_set' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function parameter or member 'link' not described in 'dc_link_add_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function parameter or member 'edid' not described in 'dc_link_add_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function parameter or member 'len' not described in 'dc_link_add_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:2962: warning: Function parameter or member 'init_data' not described in 'dc_link_add_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3022: warning: Function parameter or member 'link' not described in 'dc_link_remove_remote_sink' drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3022: warning: Function parameter or member 'sink' not described in 'dc_link_remove_remote_sink' Cc: Harry Wentland Cc: Leo Li Cc: Alex Deucher Cc: "Christian König" Cc: David Airlie Cc: Daniel Vetter Cc: amd-gfx@lists.freedesktop.org Cc: dri-devel@lists.freedesktop.org Signed-off-by: Lee Jones --- drivers/gpu/drm/amd/display/dc/core/dc.c | 33 ++++++++++++------------ 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/drivers/gpu/drm/amd/display/dc/core/dc.c b/drivers/gpu/drm/amd/display/dc/core/dc.c index 0a07e608485ff..3ee3978fae977 100644 --- a/drivers/gpu/drm/amd/display/dc/core/dc.c +++ b/drivers/gpu/drm/amd/display/dc/core/dc.c @@ -284,20 +284,16 @@ static void dc_perf_trace_destroy(struct dc_perf_trace **perf_trace) } /** - ***************************************************************************** - * Function: dc_stream_adjust_vmin_vmax + * dc_stream_adjust_vmin_vmax: * - * @brief - * Looks up the pipe context of dc_stream_state and updates the - * vertical_total_min and vertical_total_max of the DRR, Dynamic Refresh - * Rate, which is a power-saving feature that targets reducing panel - * refresh rate while the screen is static + * Looks up the pipe context of dc_stream_state and updates the + * vertical_total_min and vertical_total_max of the DRR, Dynamic Refresh + * Rate, which is a power-saving feature that targets reducing panel + * refresh rate while the screen is static * - * @param [in] dc: dc reference - * @param [in] stream: Initial dc stream state - * @param [in] adjust: Updated parameters for vertical_total_min and - * vertical_total_max - ***************************************************************************** + * @dc: dc reference + * @stream: Initial dc stream state + * @adjust: Updated parameters for vertical_total_min and vertical_total_max */ bool dc_stream_adjust_vmin_vmax(struct dc *dc, struct dc_stream_state *stream, @@ -355,6 +351,7 @@ bool dc_stream_get_crtc_position(struct dc *dc, * @dc: DC Object * @stream: The stream to configure CRC on. * @enable: Enable CRC if true, disable otherwise. + * @crc_window: CRC window (x/y start/end) information * @continuous: Capture CRC on every frame if true. Otherwise, only capture * once. * @@ -420,7 +417,9 @@ bool dc_stream_configure_crc(struct dc *dc, struct dc_stream_state *stream, * dc_stream_get_crc() - Get CRC values for the given stream. * @dc: DC object * @stream: The DC stream state of the stream to get CRCs from. - * @r_cr, g_y, b_cb: CRC values for the three channels are stored here. + * @r_cr: CRC value for the first of the 3 channels stored here. + * @g_y: CRC value for the second of the 3 channels stored here. + * @b_cb: CRC value for the third of the 3 channels stored here. * * dc_stream_configure_crc needs to be called beforehand to enable CRCs. * Return false if stream is not found, or if CRCs are not enabled. @@ -2012,7 +2011,7 @@ static enum surface_update_type check_update_surfaces_for_stream( return overall_type; } -/** +/* * dc_check_update_surfaces_for_stream() - Determine update type (fast, med, or full) * * See :c:type:`enum surface_update_type ` for explanation of update types @@ -2815,7 +2814,7 @@ enum dc_irq_source dc_interrupt_to_irq_source( return dal_irq_service_to_irq_source(dc->res_pool->irqs, src_id, ext_id); } -/** +/* * dc_interrupt_set() - Enable/disable an AMD hw interrupt source */ bool dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable) @@ -2949,7 +2948,7 @@ static bool link_add_remote_sink_helper(struct dc_link *dc_link, struct dc_sink return true; } -/** +/* * dc_link_add_remote_sink() - Create a sink and attach it to an existing link * * EDID length is in bytes @@ -3012,7 +3011,7 @@ struct dc_sink *dc_link_add_remote_sink( return NULL; } -/** +/* * dc_link_remove_remote_sink() - Remove a remote sink from a dc_link * * Note that this just removes the struct dc_sink - it doesn't