Open Menu / doc / usage / cmd / cyclic.rst
Loading...
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
.. SPDX-License-Identifier: GPL-2.0+

.. index::
   single: cyclic (command)

cyclic command
==============

Synopsis
--------

::

    cyclic list

Description
-----------

The cyclic list command provides a list of the currently registered
cyclic functions.

This shows the following information:

Function
    Function name

cpu-time
    Total time spent in this cyclic function.

Frequency
    Frequency of execution of this function, e.g. 100 times/s for a
    pediod of 10ms.


See :doc:`../../develop/cyclic` for more information on cyclic functions.

Example
-------

::

    => cyclic list
    function: cyclic_demo, cpu-time: 52906 us, frequency: 99.20 times/s

Configuration
-------------

The cyclic command is only available if CONFIG_CMD_CYCLIC=y.