From patchwork Thu Jul 8 18:08:40 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sudeep Holla X-Patchwork-Id: 471271 Delivered-To: patch@linaro.org Received: by 2002:a02:c94a:0:0:0:0:0 with SMTP id u10csp525898jao; Thu, 8 Jul 2021 11:09:04 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzMKWyC0tv6onWN+BGVSnQWf6HRpy8RcpmxX1ePOYuQmpDvQOYob6Ty31w4hwoafK8QG6pu X-Received: by 2002:aa7:d143:: with SMTP id r3mr19510305edo.110.1625767744290; Thu, 08 Jul 2021 11:09:04 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1625767744; cv=none; d=google.com; s=arc-20160816; b=xJeUPHwlkjZ+Sk44/MqQsVio66pIc2G9gqZOGQHU2RwXfANtjTNQmW1z6EUjk8EAHb w8OFu6/VTB2l7W/eEzpWy3vbFrLQZMujoZW5QQ+j2KhIQVvvQhouCLlsQIlzMTOoOUuv vzUzmdrr9S7WbMEP03Wsz9zx8QWh5IdHSTRjnzHkQ2jzwvnVsmx67NrVzTbLhGyMEF9s KRCHY+9EvwRZzorNbksYo8Gbvd2lTq40d5Re/V4nIFHdFYuhBCZXimUgZplSavwqQxl8 WVCLwPfFgtp/UMBtgZwg/eZFI6W3mup/071Wah3tR44SHSMfPdINnJhBnB4zGnUyTsPF sJdQ== 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=06UWdvjQnk9ooxekP5mH3kzJ79A/vzsfDT2UUrmLdpU=; b=CA0vKyk6GD1TWi2CzHTwLxtfPvstfXoy65vWL3w4PfGJbIL2RgvEdhnseSem3YFImN HyVBGW27m8hDL87bPZlIKssau0iSV/6Lk7LBsq/gzHE84SJae8gPcaQx2ns28vtd4gWy UFZZ/qo9MFkztZFy6rLilpXmnHMUp951S/Y5TOs4WZwUkFUH+cpfRxnLzSJGIgYXDhe1 GhpE4qbNLfBT9z8OXdhOPZxlSDtD/gqIvJmwQClrh/mymF26Yz0Tl2zcRSBqDLPYnpZ4 3GrVKpFI9lkaKc/Mu5QpZJgHkJhm3qh8Hx6SEEV0uBk8lccBu9Q1ZSyJZs1Y9k9NI5I6 mMWw== 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 24si3945545ejw.232.2021.07.08.11.09.04; Thu, 08 Jul 2021 11:09:04 -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 S230178AbhGHSLn (ORCPT + 4 others); Thu, 8 Jul 2021 14:11:43 -0400 Received: from foss.arm.com ([217.140.110.172]:35974 "EHLO foss.arm.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230166AbhGHSLn (ORCPT ); Thu, 8 Jul 2021 14:11:43 -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 0BEE6D6E; Thu, 8 Jul 2021 11:09:01 -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 261283F66F; Thu, 8 Jul 2021 11:09:00 -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 02/13] ACPI: CPPC: Fix doxygen comments Date: Thu, 8 Jul 2021 19:08:40 +0100 Message-Id: <20210708180851.2311192-3-sudeep.holla@arm.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210708180851.2311192-1-sudeep.holla@arm.com> References: <20210708180851.2311192-1-sudeep.holla@arm.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org Clang complains about doxygen comments too with W=1 in the build. | 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, 7 insertions(+) -- 2.25.1 diff --git a/drivers/acpi/cppc_acpi.c b/drivers/acpi/cppc_acpi.c index a4d4eebba1da..eb5685167d19 100644 --- a/drivers/acpi/cppc_acpi.c +++ b/drivers/acpi/cppc_acpi.c @@ -562,6 +562,8 @@ 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 * is shared between multiple CPUs. This is seen especially in CPUs @@ -1347,10 +1349,15 @@ EXPORT_SYMBOL_GPL(cppc_set_perf); /** * cppc_get_transition_latency - returns 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) {