xref: /linux/Documentation/tools/rtla/common_osnoise_options.rst (revision 68a052239fc4b351e961f698b824f7654a346091)
1.. |threshold|  replace:: **-a/--auto**, **-s/--stop**, or **-S/--stop-total**
2.. |thresharg|  replace:: -s
3.. |tracer|     replace:: osnoise
4
5.. |actionsperf| replace::
6        Due to implementational limitations, actions might be delayed
7        up to one second after tracing is stopped.
8
9**-a**, **--auto** *us*
10
11        Set the automatic trace mode. This mode sets some commonly used options
12        while debugging the system. It is equivalent to use **-s** *us* **-T 1 -t**.
13
14**-p**, **--period** *us*
15
16        Set the *osnoise* tracer period in microseconds.
17
18**-r**, **--runtime** *us*
19
20        Set the *osnoise* tracer runtime in microseconds.
21
22**-s**, **--stop** *us*
23
24        Stop the trace if a single sample is higher than the argument in microseconds.
25        If **-T** is set, it will also save the trace to the output.
26
27**-S**, **--stop-total** *us*
28
29        Stop the trace if the total sample is higher than the argument in microseconds.
30        If **-T** is set, it will also save the trace to the output.
31
32**-T**, **--threshold** *us*
33
34        Specify the minimum delta between two time reads to be considered noise.
35        The default threshold is *5 us*.
36
37**-t**, **--trace** \[*file*]
38
39        Save the stopped trace to [*file|osnoise_trace.txt*].
40