[PATCH v3 8/8] cyclic: Add documentation

[Simon Glass]

Hi Stefan,

On Fri, 5 Aug 2022 at 08:26, Stefan Roese <sr at denx.de> wrote:
>
> Add documentation for the cyclic function infrastructure, including the
> cyclic command.
>
> Signed-off-by: Stefan Roese <sr at denx.de>
> ---
> 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 <sjg at chromium.org>

>
> 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/ ?

> +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