From patchwork Sat Oct 7 00:16:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 149465 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:a888:0:b0:403:3b70:6f57 with SMTP id x8csp673462vqo; Fri, 6 Oct 2023 17:28:56 -0700 (PDT) X-Google-Smtp-Source: AGHT+IG0H/LfC2gJ+5PU4/nuyyOwW/BMk+0EGk1wyrtOMttKLMkRpiht6tKIl7g+cNP1ywA3XbT6 X-Received: by 2002:a81:4a55:0:b0:599:8bd:5bdf with SMTP id x82-20020a814a55000000b0059908bd5bdfmr10236578ywa.50.1696638535995; Fri, 06 Oct 2023 17:28:55 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696638535; cv=none; d=google.com; s=arc-20160816; b=RsyoI/xRvb19JfyS7Y2maxJqUL6W1pNaGFyOgGp59IozzxPNt/JIqeuX6fLYscFH1F IKz1kzXuIqrqLTvg0ZL+hlt5Nzm3XnNFptorFyKKFjIMfQv2B3GdP2ijC9Rhe2TNLkiY a/1/cdCTOriPcbKQX6aXHTN3Zp8JK9hBKQAG1caKBUO3kyod0EYOUYm0IACp3YMf8Gws VKev+X7IrFK5sK0pGolNb8Xkrkl5QXRLgJlV+V/MYo43M9r9ZrDCheJdqhHHqGQUcXQH MjWKr5UU5f6XZdFOyzEMpsJ9tBp9qkrEKNBy6MWPr+SnBV4HER4GI+dWMtXWjoBLMsej wn2A== 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 :message-id:date:subject:cc:to:from:dkim-signature; bh=Tx7VhSKfhB/BAKmLe8z7FqjkSdVa9zklLy9NfKVnpaM=; fh=OWM1Fyayy0267WyGInRXGgVrf7KmDwBDFAL4YNZV3zQ=; b=K2udCz/i/3/VyOtIci60itOKa5moJZae+lyJ2h0T0N/Tm+zqrx8ItOxqiT/SwTJmIB oFdfzPXr9F3MWD1rgMXQ1Ma6pdM53Q3WGvwj3B1y7+SqLfjfY+ayACrQKGDh4jEbqCs5 X9dpGi8I2F1An9D++7I3CLWCXkUUSQ32ZsLIj+e/ii45VJ6e4Cfj9hqLxe/Y+hlqNpqo jKOuvDNHxp1XHDjYqQkcIYhYVJJvi9eMsJscRu3DF/1o0YaGHiha9YLfS2Kae9glUE7P +71yE7ctJbSgM5M1ZJTC67rzTp/nWIdmvZDhHFQKaeLdcKm0/w+Nn4VYpW9V6l9DxhSe jZpg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=f+UL4dr1; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from lipwig.vger.email (lipwig.vger.email. [23.128.96.33]) by mx.google.com with ESMTPS id q4-20020a170902f34400b001b829a32f2dsi4415571ple.457.2023.10.06.17.28.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Oct 2023 17:28:55 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 as permitted sender) client-ip=23.128.96.33; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=f+UL4dr1; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by lipwig.vger.email (Postfix) with ESMTP id 8579F8211414; Fri, 6 Oct 2023 17:28:53 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at lipwig.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233883AbjJGAQH (ORCPT + 18 others); Fri, 6 Oct 2023 20:16:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51744 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233696AbjJGAQH (ORCPT ); Fri, 6 Oct 2023 20:16:07 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ABF30BE; Fri, 6 Oct 2023 17:16:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=Tx7VhSKfhB/BAKmLe8z7FqjkSdVa9zklLy9NfKVnpaM=; b=f+UL4dr15vOTP1w1SwnfoGiCm5 lGei2sZ6q3tI6BzAN9WHqXoXFO3Sjxct/6j8DWHJYVEkOFNvhz5G/oAlnBU+Nq7qNUqEApmf2aeKq oY0tW/IbcnopSskKtYrApnqMjP7DaFPeynQyIwI4Ta1I4xWl0wgLZ+2lPMs6k/+krCH7YmYC+B7rS qCkbJqGvKHynKP6o82pF4jHHcxPezFUEz6G7Lo/5PVe0r51TECtDTjLpigDW5iPqSOL9XUmH4uxds +4Dsx8DquOkl7pQDzo7BVKYqjSuL0xra7nlHr+NbMjlh9Fb4vr1FkkQjKSjHRA37MmEpBGqIHxsor OVoonlHA==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qouzE-006hCS-21; Sat, 07 Oct 2023 00:16:04 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , kernel test robot , Arnd Bergmann , Vaibhav Hiremath , Felipe Balbi , Tony Lindgren , Xunlei Pang , John Stultz , Ingo Molnar , Aaro Koskinen , Janusz Krzysztofik , linux-omap@vger.kernel.org, linux-arm-kernel@lists.infradead.org Subject: [PATCH] ARM: OMAP: timer32K: fix all kernel-doc warnings Date: Fri, 6 Oct 2023 17:16:03 -0700 Message-ID: <20231007001603.24972-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 X-Spam-Status: No, score=2.7 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, RCVD_IN_SBL_CSS,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lipwig.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (lipwig.vger.email [0.0.0.0]); Fri, 06 Oct 2023 17:28:53 -0700 (PDT) X-Spam-Level: ** X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1779054449517498374 X-GMAIL-MSGID: 1779054449517498374 Fix kernel-doc warnings reported by the kernel test robot: timer32k.c:186: warning: cannot understand function prototype: 'struct timespec64 persistent_ts; ' timer32k.c:191: warning: Function parameter or member 'ts' not described in 'omap_read_persistent_clock64' timer32k.c:216: warning: Function parameter or member 'vbase' not described in 'omap_init_clocksource_32k' timer32k.c:216: warning: Excess function parameter 'pbase' description in 'omap_init_clocksource_32k' timer32k.c:216: warning: Excess function parameter 'size' description in 'omap_init_clocksource_32k' timer32k.c:216: warning: No description found for return value of 'omap_init_clocksource_32k' Fixes: a451570c008b ("ARM: OMAP: 32k counter: Provide y2038-safe omap_read_persistent_clock() replacement") Fixes: 1fe97c8f6a1d ("ARM: OMAP: Make OMAP clocksource source selection using kernel param") Signed-off-by: Randy Dunlap Reported-by: kernel test robot Closes: https://lore.kernel.org/all/202310070106.8QSyJOm3-lkp@intel.com/ Cc: Arnd Bergmann Cc: Vaibhav Hiremath Cc: Felipe Balbi Cc: Tony Lindgren Cc: Xunlei Pang Cc: John Stultz Cc: Ingo Molnar Cc: Aaro Koskinen Cc: Janusz Krzysztofik Cc: linux-omap@vger.kernel.org Cc: linux-arm-kernel@lists.infradead.org --- arch/arm/mach-omap1/timer32k.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff -- a/arch/arm/mach-omap1/timer32k.c b/arch/arm/mach-omap1/timer32k.c --- a/arch/arm/mach-omap1/timer32k.c +++ b/arch/arm/mach-omap1/timer32k.c @@ -176,17 +176,18 @@ static u64 notrace omap_32k_read_sched_c return sync32k_cnt_reg ? readl_relaxed(sync32k_cnt_reg) : 0; } +static struct timespec64 persistent_ts; +static cycles_t cycles; +static unsigned int persistent_mult, persistent_shift; + /** * omap_read_persistent_clock64 - Return time from a persistent clock. + * @ts: &struct timespec64 for the returned time * * Reads the time from a source which isn't disabled during PM, the * 32k sync timer. Convert the cycles elapsed since last read into * nsecs and adds to a monotonically increasing timespec64. */ -static struct timespec64 persistent_ts; -static cycles_t cycles; -static unsigned int persistent_mult, persistent_shift; - static void omap_read_persistent_clock64(struct timespec64 *ts) { unsigned long long nsecs; @@ -206,10 +207,9 @@ static void omap_read_persistent_clock64 /** * omap_init_clocksource_32k - setup and register counter 32k as a * kernel clocksource - * @pbase: base addr of counter_32k module - * @size: size of counter_32k to map + * @vbase: base addr of counter_32k module * - * Returns 0 upon success or negative error code upon failure. + * Returns: %0 upon success or negative error code upon failure. * */ static int __init omap_init_clocksource_32k(void __iomem *vbase)