Received: by 2002:a05:7412:5112:b0:fa:6e18:a558 with SMTP id fm18csp602844rdb; Tue, 23 Jan 2024 08:59:47 -0800 (PST) X-Google-Smtp-Source: AGHT+IFpj1GgRKld467zNsKvPw75nSj6iubBQJHokN0D9/dZy0JmgUnT4gLilVi6JRtcTmiib5rD X-Received: by 2002:a05:6a20:bcaf:b0:19b:1e87:6c56 with SMTP id fx47-20020a056a20bcaf00b0019b1e876c56mr5680876pzb.53.1706029187573; Tue, 23 Jan 2024 08:59:47 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1706029187; cv=pass; d=google.com; s=arc-20160816; b=t5wgJq7ShqkntEHgFMKaNCOhrvUHggT5lnjEGFJ+RrHu6UhYo9ndaWMpi8NissmLff j5Yu2j++OOcmd3bx6QR/U55m3Z0PHp7iZGaDMpcLoxEXLAmX2DvmSy0BCpK3iku8IOjx m7qSxOG84f5i+oYOHgFmQAb8Uj2GV7fZOEIfeDS92WgDWczCQcKLwhLqYLpy/H0vZBpX f73VCySeByRUHB9IVGY/Yieuhfn5Qbt2/h1Sa8K4Vp4tjIuRGDVXr7+Ic5+wO5tH4ckM m07og4A0+K3JiRbuWfORm9scAXcvMlXabuQRQxU8OukQhS/oyKJB2TScIbuBufCWeeWf /6zw== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:dkim-signature:dkim-signature:from; bh=PhoBCIZZLnCECGPqIowTZ08lfwc9D2r/FOyJZ9QOgHo=; fh=nOEvUOtvIydWxxQpRdVGTZdE7oDfSvGmdNyLCMjLbrA=; b=elXJ/baM/oe10LB/S3kVfmnBwFgHBnkoRJxnA1CS5Cm8Nutxp1YuBx+vObCi4lQQWj tORgXBjnVSooZm2t7ESMlW4v83O5l/VspOxkpWml/eoHInm7a341Jz3wjFZi3cIvDd9j 8DjaShvFwIKNqxnXkHtoVV0+ISr6P4wKybICvZpRXZ93Ect8jIBxtFgGeibYhG0nX8GK /K7/xZYKikNc/1ZIf1eZZtP+TvkCQJ+5wSOJyiGBizd4LoesEuaB1oPvJJzXFd/HaQ0y ml/nF/oEzfYkLn9V1juNzC/a0M2mmWLnso6Har47a/+86mFVcHAvtpEi4kcV5mtPko5M 0Osg== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=BQbY4po9; 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-35702-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-35702-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Return-Path: Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [139.178.88.99]) by mx.google.com with ESMTPS id n3-20020aa79843000000b006da8c929a14si12314498pfq.106.2024.01.23.08.59.47 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Jan 2024 08:59:47 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-35702-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=BQbY4po9; 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-35702-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-35702-linux.lists.archive=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 sv.mirrors.kernel.org (Postfix) with ESMTPS id 79D442863B2 for ; Tue, 23 Jan 2024 16:51:56 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 043EC823D1; Tue, 23 Jan 2024 16:47:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="BQbY4po9"; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="hCS4YdrH" 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 8D30581ADA; Tue, 23 Jan 2024 16:47:18 +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=1706028440; cv=none; b=au+XFqf+TYO2rxzSUpnaNiJLpsxUOakg8T3yyg6n21xs1UAupLOGTGw0isset81C/5Uil0A9nMiOX50ZuFDuFz2WUS/X7HzVWZW+gVDPkZ5QXu/gN9bRHoHGzuGw9oorAqLDZgFlquWJ+IFPt3xqp1u97ibL5LR+qZJeo8zFqYc= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706028440; c=relaxed/simple; bh=HFSMKE1bgjlAsGi1MrNiRokzcDfgJUWmntUgaecyamk=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=uoiQcr43motOuMY3+UmKSkcC4haIhNAzwlKaeFUJFLJT8wdD5QzRTGMzFflBzsBJsnPFounGbCrlOiFB1OyiRfsuq121jNn3mZcRgpw082XTJugutuVuwKWUdrVudtjfqpYrUKCDNr+WM7v3s1pZsbUd15iQw/97LTPDgOx9SPg= 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=BQbY4po9; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=hCS4YdrH; 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 From: Anna-Maria Behnsen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1706028436; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=PhoBCIZZLnCECGPqIowTZ08lfwc9D2r/FOyJZ9QOgHo=; b=BQbY4po9HrsTcQSx6IkQD07yysEbfa4dnqHfgGWm2R08w1+kBTf3TcXMz1E0ZWoUu76L7R y+A/uJuVblFUHY0X9+q9KY/cr7ZvpMECXXNvn2OZKj12dvirphwqwWJYCr3QYydDrzduzr y/kBQGhCVHoHmuidPBEPv5TB0gdGuKRXypCoaNdQLrA80U2GGNstNYpxpZVREkGTkrIsoB RmZc9aXaj9PRk0HjiBwZCPAW0QiRGACAuIQAlvNDZWe7HmC78IKiN4GQL/nEmTOQAnbfOu +3mfaxW9XGUu+Pm/QmjfehV6rlL2VT2U4PNgE+P4/IfT/jCSNWQ750wKlAcXqA== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1706028436; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=PhoBCIZZLnCECGPqIowTZ08lfwc9D2r/FOyJZ9QOgHo=; b=hCS4YdrHkHiUDoT7f1qYKpzoe5053vW64j3zVCAWgRFdpio0XsNCTJa6rBZ33hdfoAjs2J Q0wxamm1ERTY60BQ== To: linux-kernel@vger.kernel.org Cc: Thomas Gleixner , Frederic Weisbecker , Ingo Molnar , John Stultz , Stephen Boyd , Jonathan Corbet , Clemens Ladisch , linux-doc@vger.kernel.org, Anna-Maria Behnsen Subject: [PATCH 3/8] tick/sched: Add function description for tick_nohz_next_event() Date: Tue, 23 Jan 2024 17:46:57 +0100 Message-Id: <20240123164702.55612-4-anna-maria@linutronix.de> In-Reply-To: <20240123164702.55612-1-anna-maria@linutronix.de> References: <20240123164702.55612-1-anna-maria@linutronix.de> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit The return value of tick_nohz_next_event() is not obvious at the first glance. Add a kernel-doc compatible function description which also covers return values. Signed-off-by: Anna-Maria Behnsen --- kernel/time/tick-sched.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/kernel/time/tick-sched.c b/kernel/time/tick-sched.c index d2501673028d..e1d80f462551 100644 --- a/kernel/time/tick-sched.c +++ b/kernel/time/tick-sched.c @@ -799,6 +799,16 @@ static inline bool local_timer_softirq_pending(void) return local_softirq_pending() & BIT(TIMER_SOFTIRQ); } +/** + * tick_nohz_next_event() - return the clock monotonic based next event + * @ts: pointer to tick_sched struct + * @cpu: CPU number + * + * Return: + * *%0 - When the next event is a maximum of TICK_NSEC in the future + * and the tick is not stopped yet + * *%next_event - Next event based on clock monotonic + */ static ktime_t tick_nohz_next_event(struct tick_sched *ts, int cpu) { u64 basemono, next_tick, delta, expires; -- 2.39.2