From patchwork Fri Jan 8 20:14:43 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 359052 Delivered-To: patch@linaro.org Received: by 2002:a02:85a7:0:0:0:0:0 with SMTP id d36csp855928jai; Fri, 8 Jan 2021 12:15:51 -0800 (PST) X-Google-Smtp-Source: ABdhPJzqtugyrxspT5fvg6sZEi1p8UluUwDchA9wTtPNRjCL4vjAia8vDcpa/B1MOCcOWbjR9McB X-Received: by 2002:a63:987:: with SMTP id 129mr8652808pgj.251.1610136951490; Fri, 08 Jan 2021 12:15:51 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1610136951; cv=none; d=google.com; s=arc-20160816; b=u+7+hT1hJGLIzq2d/V3S2fREd7h0gFPtZIqDkmrSbl6rmSkuFmQybZw6SwfosadavH DXe2PM3Yq1m0mmhDVOYRamqDh0423Aral9J7QAt/DB35EUc97JCj+Cn893I4yy02Btt3 FZFcJy+hvKU9lJnXH3Buuio/tLdA87QgDNpufWujTiczN10otasf2C1N9uKilTvPOy3+ Sfnn1YSN+et8hFQGNPL9b6PngrMFCkltXOkGJa4JPmic0cJsNw96dhK25Guf+sKoE3dv orBaP8PRx2e7E1rH2kgdtkn+R68tvz5bHxqlzQCZJevw/SmaRyFQvmLOpDWB83hVaxe7 sgew== 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=029SmJDyxOgIurhcovC12aIiikM6nActaicpgfa8Pg8=; b=NbjbJ1/XOYn1gVrTLmygjk03FZCWGEu4Crv3e3+Xw39CjMZTfpMhcjJprcrHsmZ8s3 U9Wyz8R83hh5WbwQSMV2UIg7Qy1MweHzYBlI3Dy+k/3ZNpM/J+QBW/uNNyCsroL2pocK KbnsQODRYyQfIT7w4JsFGcaY+n9Xy6msPi9FtdLRtRUNaMWh9epFbTiGXI1DT6zdu0Dj fVjVv8ZZA9b9APq7nLBEk5N2iAct23n2glzyV9Q14FwGyz94JBP/Aa2bWNAYp51SwN2q 73aN7tloEmjpVb30ewjKcD/2I4Z1tmb3i8dku1u/yqU1xQ1WqMXdKOAyFi37X7G/mJMH c5aw== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=Xy31cYvB; 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 c10si9967512pfi.143.2021.01.08.12.15.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 08 Jan 2021 12:15:51 -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=Xy31cYvB; 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 BCB5B6E8E7; Fri, 8 Jan 2021 20:15:46 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) by gabe.freedesktop.org (Postfix) with ESMTPS id C4AC86E8E3 for ; Fri, 8 Jan 2021 20:15:43 +0000 (UTC) Received: by mail-wr1-x42d.google.com with SMTP id 91so10154005wrj.7 for ; Fri, 08 Jan 2021 12:15:43 -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=pblAeFWzmcS2QjfKQcW4YzpdGFQhCgUQwjxDwmXWZWw=; b=Xy31cYvBZTa7wJ1AwNUqIzABwROlfQfrASnc5CTUU081n4VYSnlDIaJAc21aaE+eWx 8Ux4vVwgMYkbOuZ1bXU/h+qbLVBFN5564/w1AT1hrGktaGQJcMFovbEaR51iRcy6atHQ w0tIx2ZCcnJzTPYP3lZ/jEvrd+457uEkr1i1voZClrunnwQyMLA0wv1XJ2Ho5BiMnSb4 9WmbTG/OO7FoDPt0+ULwXPcOYlOd5xuGi4gGEfGEFMrCQX1erOpB3+qtS6QEMT/T46ZT U4gIigaDRgZ6AzJKcAF2A5Ktgq8NRtyYj686vz5UgfdAe5z9n1JMZ/ThH7y7PYkCTIOO moTg== 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=pblAeFWzmcS2QjfKQcW4YzpdGFQhCgUQwjxDwmXWZWw=; b=lxuB0nBSu27OGWMI8SLKeRKU7KygQChMjcHQsk5gNSPrxrZhwkGrk0I0StPBkEw02n TB2SAoSbIZ8S2TVRvkI2nUmIlRLPyzBd1ABCnpldr0rcHRuSvPMOyRCPrfB5F2qLxniO KQzdbCghiOgg0vb1BvuvvbyueFW+K6MQ7cmCKB9bnCWCi9q/hc47QKOBrYTwD20KcFdx eNa8R/zJzDtEtNmnoVf7057D3vFj5TJyaY6YFUrVs4eNdjCkHAz/NJKeHOfPpQ16Qjk3 WIPcQuL5XMjn1A7053+m5WfWmemy5apM/ErkglyjvdZIwA9R32UTDGrk6cDVOrYYgxTw 4j1A== X-Gm-Message-State: AOAM532rrQ7AzO3uHOxvDBb4BvQ0jgh9vH1poHSC5jRSglCIdKGkf8b6 8FRhx4RXKSfnMUtejzMbXostYqy4ULaWLCeO X-Received: by 2002:a05:6000:1188:: with SMTP id g8mr5413367wrx.111.1610136942484; Fri, 08 Jan 2021 12:15:42 -0800 (PST) Received: from dell.default ([91.110.221.229]) by smtp.gmail.com with ESMTPSA id l8sm15598671wrb.73.2021.01.08.12.15.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 08 Jan 2021 12:15:41 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Subject: [PATCH 26/40] drm/amd/display/dc/dce/dce_clock_source: Fix formatting/spelling of worthy function headers Date: Fri, 8 Jan 2021 20:14:43 +0000 Message-Id: <20210108201457.3078600-27-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210108201457.3078600-1-lee.jones@linaro.org> References: <20210108201457.3078600-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 , Bhawanpreet Lakha , 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" Demote the one that provides no param descriptions. Fixes the following W=1 kernel build warning(s): drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:142: warning: Function parameter or member 'calc_pll_cs' not described in 'calculate_fb_and_fractional_fb_divider' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:142: warning: Function parameter or member 'target_pix_clk_100hz' not described in 'calculate_fb_and_fractional_fb_divider' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:142: warning: Function parameter or member 'ref_divider' not described in 'calculate_fb_and_fractional_fb_divider' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:142: warning: Function parameter or member 'post_divider' not described in 'calculate_fb_and_fractional_fb_divider' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:142: warning: Function parameter or member 'feedback_divider_param' not described in 'calculate_fb_and_fractional_fb_divider' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:142: warning: Function parameter or member 'fract_feedback_divider_param' not described in 'calculate_fb_and_fractional_fb_divider' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:200: warning: Function parameter or member 'calc_pll_cs' not described in 'calc_fb_divider_checking_tolerance' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:200: warning: Function parameter or member 'pll_settings' not described in 'calc_fb_divider_checking_tolerance' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:200: warning: Function parameter or member 'ref_divider' not described in 'calc_fb_divider_checking_tolerance' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:200: warning: Function parameter or member 'post_divider' not described in 'calc_fb_divider_checking_tolerance' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:200: warning: Function parameter or member 'tolerance' not described in 'calc_fb_divider_checking_tolerance' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:478: warning: Function parameter or member 'clk_src' not described in 'dce110_get_pix_clk_dividers_helper' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:478: warning: Function parameter or member 'pll_settings' not described in 'dce110_get_pix_clk_dividers_helper' drivers/gpu/drm/amd/amdgpu/../display/dc/dce/dce_clock_source.c:478: warning: Function parameter or member 'pix_clk_params' not described in 'dce110_get_pix_clk_dividers_helper' Cc: Harry Wentland Cc: Leo Li Cc: Alex Deucher Cc: "Christian König" Cc: David Airlie Cc: Daniel Vetter Cc: Bhawanpreet Lakha Cc: amd-gfx@lists.freedesktop.org Cc: dri-devel@lists.freedesktop.org Signed-off-by: Lee Jones --- .../drm/amd/display/dc/dce/dce_clock_source.c | 57 +++++++++---------- 1 file changed, 28 insertions(+), 29 deletions(-) diff --git a/drivers/gpu/drm/amd/display/dc/dce/dce_clock_source.c b/drivers/gpu/drm/amd/display/dc/dce/dce_clock_source.c index fb733f573715e..10938a8c9500a 100644 --- a/drivers/gpu/drm/amd/display/dc/dce/dce_clock_source.c +++ b/drivers/gpu/drm/amd/display/dc/dce/dce_clock_source.c @@ -113,20 +113,19 @@ static const struct spread_spectrum_data *get_ss_data_entry( } /** - * Function: calculate_fb_and_fractional_fb_divider + * calculate_fb_and_fractional_fb_divider - Calculates feedback and fractional + * feedback dividers values * - * * DESCRIPTION: Calculates feedback and fractional feedback dividers values + * @calc_pll_cs: Pointer to clock source information + * @target_pix_clk_100hz: Desired frequency in 100 Hz + * @ref_divider: Reference divider (already known) + * @post_divider: Post Divider (already known) + * @feedback_divider_param: Pointer where to store + * calculated feedback divider value + * @fract_feedback_divider_param: Pointer where to store + * calculated fract feedback divider value * - *PARAMETERS: - * targetPixelClock Desired frequency in 100 Hz - * ref_divider Reference divider (already known) - * postDivider Post Divider (already known) - * feedback_divider_param Pointer where to store - * calculated feedback divider value - * fract_feedback_divider_param Pointer where to store - * calculated fract feedback divider value - * - *RETURNS: + * return: * It fills the locations pointed by feedback_divider_param * and fract_feedback_divider_param * It returns - true if feedback divider not 0 @@ -175,22 +174,22 @@ static bool calculate_fb_and_fractional_fb_divider( } /** -*calc_fb_divider_checking_tolerance -* -*DESCRIPTION: Calculates Feedback and Fractional Feedback divider values -* for passed Reference and Post divider, checking for tolerance. -*PARAMETERS: -* pll_settings Pointer to structure -* ref_divider Reference divider (already known) -* postDivider Post Divider (already known) -* tolerance Tolerance for Calculated Pixel Clock to be within -* -*RETURNS: -* It fills the PLLSettings structure with PLL Dividers values -* if calculated values are within required tolerance -* It returns - true if error is within tolerance -* - false if error is not within tolerance -*/ + * calc_fb_divider_checking_tolerance - Calculates Feedback and + * Fractional Feedback divider values + * for passed Reference and Post divider, + * checking for tolerance. + * @calc_pll_cs: Pointer to clock source information + * @pll_settings: Pointer to PLL settings + * @ref_divider: Reference divider (already known) + * @post_divider: Post Divider (already known) + * @tolerance: Tolerance for Calculated Pixel Clock to be within + * + * return: + * It fills the PLLSettings structure with PLL Dividers values + * if calculated values are within required tolerance + * It returns - true if error is within tolerance + * - false if error is not within tolerance + */ static bool calc_fb_divider_checking_tolerance( struct calc_pll_clock_source *calc_pll_cs, struct pll_settings *pll_settings, @@ -460,7 +459,7 @@ static bool pll_adjust_pix_clk( return false; } -/** +/* * Calculate PLL Dividers for given Clock Value. * First will call VBIOS Adjust Exec table to check if requested Pixel clock * will be Adjusted based on usage.