From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 83342C00140 for ; Mon, 15 Aug 2022 16:18:15 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 787CA8437C; Mon, 15 Aug 2022 18:18:13 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=denx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=denx.de; s=phobos-20191101; t=1660580294; bh=1Ll7KlkbRmBky7VWjocQHvcZVFhfqGrJLOZ52kCHAlw=; h=Date:Subject:To:Cc:References:From:In-Reply-To:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From; b=z5i+REYFO1+IW2ltDJtkBzYeEaZZVj41WoTYctPW0d5P+OQk+Ht2L8J8uk6vYnDcN 8TGaMZGuPodGbvFJAbkqA1MV+iyIOikL3N10NCAOyS/cwG7hSbJxI/J+VVRC6NQks9 BJAOs+72wcTL4eudG4t84ROd5+4EarWJ32U8mOcBlvxhsz24Rusn8JJ/DFeJ1rkOL+ WqkrIX8hfehrBndw5U2QZAAUnoQYHsEyTt7vLmY3Wjfv7TXWVJcmQHO9TIYnqzKegg sFKBWd1/stYvt8N3s1ZzOgdLNLj9MS0XabCuMtRkg2v7Aylk6F07R88WdMLJVXtr5C SHPG03jBLPidg== Received: by phobos.denx.de (Postfix, from userid 109) id CDC138452C; Mon, 15 Aug 2022 18:18:11 +0200 (CEST) Received: from mout-u-107.mailbox.org (mout-u-107.mailbox.org [80.241.59.207]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 910188435C for ; Mon, 15 Aug 2022 18:18:09 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=denx.de Authentication-Results: phobos.denx.de; spf=fail smtp.mailfrom=sr@denx.de Received: from smtp1.mailbox.org (smtp1.mailbox.org [IPv6:2001:67c:2050:b231:465::1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-u-107.mailbox.org (Postfix) with ESMTPS id 4M5zwH5FNqz9sPl; Mon, 15 Aug 2022 18:18:07 +0200 (CEST) Message-ID: Date: Mon, 15 Aug 2022 18:18:06 +0200 MIME-Version: 1.0 Subject: Re: [PATCH v3 8/8] cyclic: Add documentation Content-Language: en-US To: Simon Glass Cc: U-Boot Mailing List , Tom Rini , Chandrakala Chavva , Aaron Williams References: <20220805142610.375427-1-sr@denx.de> <20220805142610.375427-9-sr@denx.de> From: Stefan Roese In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: 4M5zwH5FNqz9sPl X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean Hi Simon. On 05.08.22 18:48, Simon Glass wrote: > Hi Stefan, > > On Fri, 5 Aug 2022 at 08:26, Stefan Roese wrote: >> >> Add documentation for the cyclic function infrastructure, including the >> cyclic command. >> >> Signed-off-by: Stefan Roese >> --- >> v3: >> - New patch >> >> doc/develop/cyclic.rst | 50 ++++++++++++++++++++++++++++++++++++++++ >> doc/develop/index.rst | 1 + >> doc/usage/cmd/cyclic.rst | 45 ++++++++++++++++++++++++++++++++++++ >> doc/usage/index.rst | 1 + >> 4 files changed, 97 insertions(+) >> create mode 100644 doc/develop/cyclic.rst >> create mode 100644 doc/usage/cmd/cyclic.rst > > Reviewed-by: Simon Glass > >> >> diff --git a/doc/develop/cyclic.rst b/doc/develop/cyclic.rst >> new file mode 100644 >> index 000000000000..f9cb2668b84c >> --- /dev/null >> +++ b/doc/develop/cyclic.rst >> @@ -0,0 +1,50 @@ >> +.. SPDX-License-Identifier: GPL-2.0+ >> + >> +Cyclic functions >> +================ >> + >> +The cyclic function execution infrastruture provides a way to periodically >> +execute code, e.g. all 100ms. Examples for such functions might be LED > > s/all/every/ ? Thanks, changed in the next version. Thanks, Stefan >> +blinking etc. The functions that are hooked into this cyclic list should >> +be small timewise as otherwise the execution of the other code that relies >> +on a high frequent polling (e.g. UART rx char ready check) might be >> +delayed too much. To detect cyclic functions with a too long execution >> +time, the Kconfig option `CONFIG_CYCLIC_MAX_CPU_TIME_US` is introduced, >> +which configures the max allowed time for such a cyclic function. If it's >> +execution time exceeds this time, this cyclic function will get removed >> +from the cyclic list. > > [..] > > Regards, > SImon Viele Grüße, Stefan Roese -- DENX Software Engineering GmbH, Managing Director: Wolfgang Denk HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: sr@denx.de