From patchwork Thu Jan 18 19:23:57 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: tip-bot2 for Thomas Gleixner X-Patchwork-Id: 189327 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:2bc4:b0:101:a8e8:374 with SMTP id hx4csp571799dyb; Thu, 18 Jan 2024 11:25:01 -0800 (PST) X-Google-Smtp-Source: AGHT+IHdp3fHjxhgW9Ib2flK2BnH4xCR4NI+lHsvkloNsioZnmxikKVE9QbFSPX5rkA7YkZ++Dvu X-Received: by 2002:a05:620a:164a:b0:783:250e:5293 with SMTP id c10-20020a05620a164a00b00783250e5293mr161810qko.69.1705605900982; Thu, 18 Jan 2024 11:25:00 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1705605900; cv=pass; d=google.com; s=arc-20160816; b=EvR51jANzrsfnmYe1jrYNOVn/dXctcc3E0sUa9pxs7z2irEoCx8aRbkT3CvAG2yph1 /vaFZcWnULZ9bMXNRr3drmC9Rgmhk3M8AjsHAzx7P2dxIpvG4CaAvdHzUY5PL6WWY9Cd vqvqcUDMIW3HAhth1gBYZP7T3oFT9BkxQDyDG+09tfOXSPEmy20ssrAKipTPcmFR1dyL S85B+QOuES/xACcvwjPPORjBUNKUEkdGG3CDZ6PCFF/fTIhPW5xMLDIoJFUGaY93vP6v 7RZfXh0TIasuJo5klVYh9KS8mjTBrO6DsKxpVVHkCjIUBgPNRxeof2u9lSOaCdvv/t1V vD6g== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:precedence:robot-unsubscribe:robot-id :message-id:mime-version:list-unsubscribe:list-subscribe:list-id :precedence:references:in-reply-to:cc:subject:to:reply-to:sender :from:dkim-signature:dkim-signature:date; bh=Z+GSrxSjx2jp9oVG18JQ4NxkjYNv6JcZvqq8fVZoPU4=; fh=JhxuW3SI479UE//5lxPmS4W3o+qMzzgyLbPLj5cWVm4=; b=f0HUgYVDqhHOUwz/HrtKRTuNidEKT/ncrTfxaEzSjXT7CnfU8l4M+c8TkvqN2rp2V6 s0SgZ0+OgMc/aR8i6ObNoTJsGJPD7HbfLLwC05C1Y8apYFj/r5cYnuxy0k0RvWPOvCtv yzs0fJz3Y+9yB49uX1b2cZ4+COOgZ9Uro8sL4x1xmqYtHxu/DV8iPtEPg2sO+URUKQHk C3s+bEwY47EiIbfej7qHeF5xzdDMTXb+XxtKWcDpz/9ufdf5rxxUQxwPZ85cvuG6pAg8 OSrciajuPBLDXU7c6kRb0Az1JopuaNyVvypPYmkFoS9raCWo+egk3KBQCKOozH1dqdNj qcCA== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=4cKVDkm7; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e; arc=pass (i=1 spf=pass spfdomain=linutronix.de dkim=pass dkdomain=linutronix.de dmarc=pass fromdomain=linutronix.de); spf=pass (google.com: domain of linux-kernel+bounces-30508-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-30508-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id j13-20020a37c24d000000b007832a1c2a08si14728561qkm.372.2024.01.18.11.25.00 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Jan 2024 11:25:00 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-30508-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=4cKVDkm7; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e; arc=pass (i=1 spf=pass spfdomain=linutronix.de dkim=pass dkdomain=linutronix.de dmarc=pass fromdomain=linutronix.de); spf=pass (google.com: domain of linux-kernel+bounces-30508-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-30508-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ny.mirrors.kernel.org (Postfix) with ESMTPS id B475C1C23758 for ; Thu, 18 Jan 2024 19:25:00 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 2214131A81; Thu, 18 Jan 2024 19:24:05 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="4cKVDkm7"; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="5ZBfmmbF" Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5A9112E627; Thu, 18 Jan 2024 19:24:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=193.142.43.55 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705605842; cv=none; b=J1ed9oSSE+4ZI/4f62KYKvJ7FlmgrLaRluk1i33W3+bz5Mlp0G5y6C2tdBBPbwyXjxSeGpfDAKWP+tFZsqt+JHL1bmBhYGJ/uQivTeRYv9QycUEQXYB19FK4hiYA48dY8U/i0pwXPfU4n4lM/4st7NL1aLkBGiPEIWBKbqOn3Ss= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705605842; c=relaxed/simple; bh=w0lm96EX1GWlkiRDkJnpiFGrGjx4p3varQv30XBBRxo=; h=Date:From:To:Subject:Cc:In-Reply-To:References:MIME-Version: Message-ID:Content-Type; b=rQjPogRwmScVb1lBMSjC5ZClUpoCMCFRkNaBxw76lUsiBS4X8xOvWxYFw0/iEWneRwe1khUDWBq3HoGDg6hk2PD2UEMpRyTxW/kWZffBcOCLD+f7Cor5CYvMYJdN+N2rsXtL0kgc77JTojX4ZLMxt9mNeaxUccpo4Ma/c0G0H+0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linutronix.de; spf=pass smtp.mailfrom=linutronix.de; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=4cKVDkm7; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=5ZBfmmbF; arc=none smtp.client-ip=193.142.43.55 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linutronix.de Date: Thu, 18 Jan 2024 19:23:57 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1705605838; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Z+GSrxSjx2jp9oVG18JQ4NxkjYNv6JcZvqq8fVZoPU4=; b=4cKVDkm7apslET2M4bnQESZ9P7XaIz6jCL9ii4amxbJXsdlN07ozJbt2XVzoh1szdkvVMK D61zvfs86hrOEtDxCaRQoMagqRA1qqCTnTtAJpIDVIlHoivcZaRPDXWE7/sucdI3+L7+CR GuUbuYABLbUvD8DhYl3DD+sbAQRk8Iow3cdrjAstWgCM5R3vWznYAwGhP5Xen5FdNYPxhN O40SVgxJZjerLfLDMtGMihfexMcI+pWB+eaAvPTnTvANwMPrW6sLdZ1Paq311T7Bn/M/XA BRyL63Z+YEJsCvIz39FLY+fBjmHOel09v6r9eAEsCilQgad63bBJBRhPrN0BrA== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1705605838; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Z+GSrxSjx2jp9oVG18JQ4NxkjYNv6JcZvqq8fVZoPU4=; b=5ZBfmmbFNTI7z9M3iKGfba9M69PzSJGY3n5+4XmxRBym+W3+gC6iDeBfF9wtVnJs7Sjm8c uHSkvty62/KxBrDw== From: "tip-bot2 for Randy Dunlap" Sender: tip-bot2@linutronix.de Reply-to: linux-kernel@vger.kernel.org To: linux-tip-commits@vger.kernel.org Subject: [tip: timers/core] clocksource/drivers/cadence-ttc: Fix some kernel-doc warnings Cc: Randy Dunlap , Michal Simek , Daniel Lezcano , Thomas Gleixner , linux-arm-kernel@lists.infradead.org, x86@kernel.org, linux-kernel@vger.kernel.org In-Reply-To: <20231205230448.772-1-rdunlap@infradead.org> References: <20231205230448.772-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-ID: <170560583779.398.16956376117878926079.tip-bot2@tip-bot2> Robot-ID: Robot-Unsubscribe: Contact to get blacklisted from these emails Precedence: bulk X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1788457413219082803 X-GMAIL-MSGID: 1788457413219082803 The following commit has been merged into the timers/core branch of tip: Commit-ID: 0515c73467fd550249ef83062e1d03d99c718b4f Gitweb: https://git.kernel.org/tip/0515c73467fd550249ef83062e1d03d99c718b4f Author: Randy Dunlap AuthorDate: Tue, 05 Dec 2023 15:04:48 -08:00 Committer: Daniel Lezcano CommitterDate: Wed, 27 Dec 2023 15:37:11 +01:00 clocksource/drivers/cadence-ttc: Fix some kernel-doc warnings 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 Signed-off-by: Daniel Lezcano Link: https://lore.kernel.org/r/20231205230448.772-1-rdunlap@infradead.org --- drivers/clocksource/timer-cadence-ttc.c | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/drivers/clocksource/timer-cadence-ttc.c b/drivers/clocksource/timer-cadence-ttc.c index 32daaac..ca7a064 100644 --- 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_timer *timer, * @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_interrupt(int irq, void *dev_id) /** * __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(void) * @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 long cycles, } /** - * 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_event_device *evt) 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);