From patchwork Tue Dec 5 23:04:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 174228 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:bcd1:0:b0:403:3b70:6f57 with SMTP id r17csp3757990vqy; Tue, 5 Dec 2023 15:05:16 -0800 (PST) X-Google-Smtp-Source: AGHT+IFd/SrTmTuViDjPDKUjSGo7mvtHhtmtDo6VrJz9EZcxLtPpnt5wsD3jc7d5rQ/0NHSMe19H X-Received: by 2002:a05:6a00:2e8b:b0:6ce:55d1:8b70 with SMTP id fd11-20020a056a002e8b00b006ce55d18b70mr2314962pfb.44.1701817516121; Tue, 05 Dec 2023 15:05:16 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1701817516; cv=none; d=google.com; s=arc-20160816; b=oesq3PtgWWsnseotnDYoeBuVfRAyy5PTk05lro2l4GFTrSLsFr22uekomMaBWEW+DC NBxlUIbA/xKtmLGzrRBcoNn4rpkaLXNODBuxQp8L7LNOEh+2LBokLWb/yjWuxEAP9B1C 8oQWX8xKzKMAl+o/8lrj+CZaZFT2akgMc7baAS06xjiombFMkimZXzLWPht3Iv3RzUFJ bq4Nvr0hj9S+oE9H+sHMdi+ktoXZ8zFl75auXc9j9ivsyG9sE8vD+QLcv4NT5RYl62zp /P9vkpDZZfKu8LXKTOUxBxh9NBadp57kUHJC3NA4v+ym1tYwJW+NSCeyAt8jGqKafbiQ NwrA== 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=nGFCpAiXZSazz4S8hvXcJ0KUtE2WqKR2kqCHDpBm/gg=; fh=MvlUPR2wEQEa/d3oxXmluAifQqPlP25oWjKrmuzgtUs=; b=inEIqqnACHlGbLVkRITOALPeFKlbfLcTe5aP0wzBTxmQm0BO06AIcKV5E7Kjac8lwU S6Y0Wuz/jtGO2ZaVZG7O6LUE/5esNHzQCMSxeCUUtNhJIvMg8N51SYNK5sEuJ2CcwXeP 1D914f7KlvnugDVUhBPw/hiHXdL97nQCiGfmIHEax+n3HfB0p4VWzUzGPUTCDw8fFyYN uuiPhDAtpQpUjTYejvz1zxwZcAbqbJpRb1hwceRobD5+DGeZyH4mGIgrMadYSCBdfJNu OQTo4tyuS/SYn1eCuMGtxxGLagISABD7ndu4sdKrzmJPz0ay8kYFfu7gO0WGgsamZEdh gXNw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=RgBO7w7z; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from pete.vger.email (pete.vger.email. [23.128.96.36]) by mx.google.com with ESMTPS id f22-20020a635116000000b005be007363a4si10031384pgb.669.2023.12.05.15.05.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 05 Dec 2023 15:05:16 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) client-ip=23.128.96.36; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=RgBO7w7z; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 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 pete.vger.email (Postfix) with ESMTP id 1CFB180CF53A; Tue, 5 Dec 2023 15:05:04 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at pete.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1346259AbjLEXEz (ORCPT + 99 others); Tue, 5 Dec 2023 18:04:55 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48614 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230165AbjLEXEy (ORCPT ); Tue, 5 Dec 2023 18:04:54 -0500 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6C856B9 for ; Tue, 5 Dec 2023 15:05:00 -0800 (PST) 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=nGFCpAiXZSazz4S8hvXcJ0KUtE2WqKR2kqCHDpBm/gg=; b=RgBO7w7z3ITS/htE6ZMd7kGcd8 5IGoriF9dmsvxjbTVfKAX0bLjmDZpDL8CCIh3XWB48x0pLUhBuWui3yNu3LkM3wcwCUBEhdCsWhOe 1LrImW2oxlrztawTOsvXfPRNQvX6d7LCZx0GlLJ95mBPVsy2z9bE9cFCgahI/u9OqYqLgiwCDrhuB DamETEe6tfg41lAYDNYvJG7pX+/KUYFE8p8+eqRjrW9u+waBAYZszpQSlshYov4nqJQGNjFHocF9h eCxHl9GUjcD4xG5jKsk6latkeP1ItlEuYIoJ30W4r+XAF+zOzU8xGwi9HQ7IRM1xjQAGDZODm2lHN dtmoBvGA==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rAeTA-008ZyG-37; Tue, 05 Dec 2023 23:04:58 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Michal Simek , Daniel Lezcano , Thomas Gleixner , linux-arm-kernel@lists.infradead.org Subject: [PATCH] clocksource: cadence-ttc: fix some kernel-doc warnings Date: Tue, 5 Dec 2023 15:04:48 -0800 Message-ID: <20231205230448.772-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on pete.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 (pete.vger.email [0.0.0.0]); Tue, 05 Dec 2023 15:05:04 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1784485004142803739 X-GMAIL-MSGID: 1784485004142803739 Fix some function kernel-doc warnings to placate scripts/kernel-doc. timer-cadence-ttc.c:79: warning: Function parameter or member 'clk_rate_change_nb' not described in 'ttc_timer' timer-cadence-ttc.c:158: warning: Function parameter or member 'cs' not described in '__ttc_clocksource_read' timer-cadence-ttc.c:194: warning: expecting prototype for ttc_set_{shutdown|oneshot|periodic}(). Prototype was for ttc_shutdown() instead timer-cadence-ttc.c:196: warning: No description found for return value of 'ttc_shutdown' timer-cadence-ttc.c:212: warning: No description found for return value of 'ttc_set_periodic' Signed-off-by: Randy Dunlap Cc: Michal Simek Cc: Daniel Lezcano Cc: Thomas Gleixner Cc: linux-arm-kernel@lists.infradead.org Acked-by: Michal Simek Tested-by: Michal Simek --- drivers/clocksource/timer-cadence-ttc.c | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff -- a/drivers/clocksource/timer-cadence-ttc.c b/drivers/clocksource/timer-cadence-ttc.c --- a/drivers/clocksource/timer-cadence-ttc.c +++ b/drivers/clocksource/timer-cadence-ttc.c @@ -69,7 +69,7 @@ * @base_addr: Base address of timer * @freq: Timer input clock frequency * @clk: Associated clock source - * @clk_rate_change_nb Notifier block for clock rate changes + * @clk_rate_change_nb: Notifier block for clock rate changes */ struct ttc_timer { void __iomem *base_addr; @@ -134,7 +134,7 @@ static void ttc_set_interval(struct ttc_ * @irq: IRQ number of the Timer * @dev_id: void pointer to the ttc_timer instance * - * returns: Always IRQ_HANDLED - success + * Returns: Always IRQ_HANDLED - success **/ static irqreturn_t ttc_clock_event_interrupt(int irq, void *dev_id) { @@ -151,8 +151,9 @@ static irqreturn_t ttc_clock_event_inter /** * __ttc_clocksource_read - Reads the timer counter register + * @cs: &clocksource to read from * - * returns: Current timer counter register value + * Returns: Current timer counter register value **/ static u64 __ttc_clocksource_read(struct clocksource *cs) { @@ -173,7 +174,7 @@ static u64 notrace ttc_sched_clock_read( * @cycles: Timer interval ticks * @evt: Address of clock event instance * - * returns: Always 0 - success + * Returns: Always %0 - success **/ static int ttc_set_next_event(unsigned long cycles, struct clock_event_device *evt) @@ -186,9 +187,12 @@ static int ttc_set_next_event(unsigned l } /** - * ttc_set_{shutdown|oneshot|periodic} - Sets the state of timer - * + * ttc_shutdown - Sets the state of timer * @evt: Address of clock event instance + * + * Used for shutdown or oneshot. + * + * Returns: Always %0 - success **/ static int ttc_shutdown(struct clock_event_device *evt) { @@ -202,6 +206,12 @@ static int ttc_shutdown(struct clock_eve return 0; } +/** + * ttc_set_periodic - Sets the state of timer + * @evt: Address of clock event instance + * + * Returns: Always %0 - success + */ static int ttc_set_periodic(struct clock_event_device *evt) { struct ttc_timer_clockevent *ttce = to_ttc_timer_clkevent(evt);