From patchwork Fri Sep 17 13:33:45 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sudeep Holla X-Patchwork-Id: 514180 Delivered-To: patch@linaro.org Received: by 2002:a02:c816:0:0:0:0:0 with SMTP id p22csp2235910jao; Fri, 17 Sep 2021 06:34:14 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxdto/3+ohJS9kUgzfgMph4Knp6KJ1bANd+L1G7Iw6sUUE/Rgka9hF653zfg3grYLUBogN4 X-Received: by 2002:a7b:ce93:: with SMTP id q19mr10442959wmj.195.1631885654198; Fri, 17 Sep 2021 06:34:14 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1631885654; cv=none; d=google.com; s=arc-20160816; b=j5rLmex854JoZhhaONTn4x+aKRGPumvgdRNy6lzgvVIkALW64t5NqjUUMJ49ibzkS/ w5dnZIqWZNSF2AuXDjxnHmz1aiQnZcBPKcrNt9TPGTGpPVr0DHRKRE5+AjyTMuSzTJrw YjU/dLCDeRLVeCezU0wHJkzfGcLliK+o11naPwW9mqXEdrJG61kh1ZsoTKStrrpMS2uM LppAYABdDJF5XfzLXOSijsuyQGBYMQbLgHihMzCW4xvoEZBG1DNE9h8a3gzm9zrSj6t2 j3iXSw0qkmU1ng2XV5+Mz0LEfklo6gFBg+UWxgK+fV/HaJnrZL1Af9dzdOhNvK657Gi0 HETg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=UKpDK7AyTL1bz8o+w+wXAdS8UYRiJcU36xB1nAukeXk=; b=SwRHADnr50BEOSmsXc0fR5SIqiaakciplhGQBeIuqz8DCFIs50lv0SutgPNUtrJuGc mVE5M7hxPeUu7DaOBnYKoKy9zCKZhBW71dfg7MqXP8D3xNi7uaMsAqx+cltyAYk1W7lI tuzA35cB3XsCripoIyjzqRLqXhdTEZy+c+C5wUIiGKE4OQEhiOfQJw35K+KYah0J+4BI PQF8NNd05QJttzzm1UrGLfihPSEzAIcf6F9YdzLy1Z1MNIDluU+V3/m8cF++omS2+c81 4HvHnrKCUUDeX+L9dkO7tbyLzYZ9wIH4ruQP3Bsm2aTBDVF30bonU5PnBBwH7DPFCEP+ 6s9w== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-acpi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-acpi-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=arm.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id e23si6751823edj.198.2021.09.17.06.34.14; Fri, 17 Sep 2021 06:34:14 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-acpi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-acpi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-acpi-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=arm.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241544AbhIQNfe (ORCPT + 2 others); Fri, 17 Sep 2021 09:35:34 -0400 Received: from foss.arm.com ([217.140.110.172]:53266 "EHLO foss.arm.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S242548AbhIQNfb (ORCPT ); Fri, 17 Sep 2021 09:35:31 -0400 Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id F0F1B31B; Fri, 17 Sep 2021 06:34:08 -0700 (PDT) Received: from usa.arm.com (e103737-lin.cambridge.arm.com [10.1.197.49]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 16AB73F719; Fri, 17 Sep 2021 06:34:07 -0700 (PDT) From: Sudeep Holla To: linux-acpi@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Sudeep Holla , Cristian Marussi , "Rafael J . Wysocki" , Jassi Brar Subject: [PATCH v2 02/14] ACPI: CPPC: Fix kernel doc warnings Date: Fri, 17 Sep 2021 14:33:45 +0100 Message-Id: <20210917133357.1911092-3-sudeep.holla@arm.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210917133357.1911092-1-sudeep.holla@arm.com> References: <20210917133357.1911092-1-sudeep.holla@arm.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org Kernel doc validation script is unhappy and complains with the below set of warnings. | drivers/acpi/cppc_acpi.c:560: warning: Function parameter or member | 'pcc_ss_id' not described in 'pcc_data_alloc' | drivers/acpi/cppc_acpi.c:1343: warning: Function parameter or member | 'cpu_num' not described in 'cppc_get_transition_latency' Fix it. Signed-off-by: Sudeep Holla --- drivers/acpi/cppc_acpi.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) -- 2.25.1 diff --git a/drivers/acpi/cppc_acpi.c b/drivers/acpi/cppc_acpi.c index bd482108310c..e195123e26c0 100644 --- a/drivers/acpi/cppc_acpi.c +++ b/drivers/acpi/cppc_acpi.c @@ -561,6 +561,7 @@ bool __weak cpc_ffh_supported(void) /** * pcc_data_alloc() - Allocate the pcc_data memory for pcc subspace + * @pcc_ss_id: PCC Subspace channel identifier * * Check and allocate the cppc_pcc_data memory. * In some processor configurations it is possible that same subspace @@ -1360,12 +1361,16 @@ int cppc_set_perf(int cpu, struct cppc_perf_ctrls *perf_ctrls) EXPORT_SYMBOL_GPL(cppc_set_perf); /** - * cppc_get_transition_latency - returns frequency transition latency in ns + * cppc_get_transition_latency - Provides frequency transition latency in ns + * @cpu_num: Logical index of the CPU for which latencty is requested * * ACPI CPPC does not explicitly specify how a platform can specify the * transition latency for performance change requests. The closest we have * is the timing information from the PCCT tables which provides the info * on the number and frequency of PCC commands the platform can handle. + * + * Returns: frequency transition latency on success or CPUFREQ_ETERNAL on + * failure */ unsigned int cppc_get_transition_latency(int cpu_num) {