Merge tag 'trace-v4.20' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[sfrench/cifs-2.6.git] / Documentation / ABI / testing / configfs-stp-policy-p_sys-t
1 What:           /config/stp-policy/<device>:p_sys-t.<policy>/<node>/uuid
2 Date:           June 2018
3 KernelVersion:  4.19
4 Description:
5                 UUID source identifier string, RW.
6                 Default value is randomly generated at the mkdir <node> time.
7                 Data coming from trace sources that use this <node> will be
8                 tagged with this UUID in the MIPI SyS-T packet stream, to
9                 allow the decoder to discern between different sources
10                 within the same master/channel range, and identify the
11                 higher level decoders that may be needed for each source.
12
13 What:           /config/stp-policy/<device>:p_sys-t.<policy>/<node>/do_len
14 Date:           June 2018
15 KernelVersion:  4.19
16 Description:
17                 Include payload length in the MIPI SyS-T header, boolean.
18                 If enabled, the SyS-T protocol encoder will include payload
19                 length in each packet's metadata. This is normally redundant
20                 if the underlying transport protocol supports marking message
21                 boundaries (which STP does), so this is off by default.
22
23 What:           /config/stp-policy/<device>:p_sys-t.<policy>/<node>/ts_interval
24 Date:           June 2018
25 KernelVersion:  4.19
26 Description:
27                 Time interval in milliseconds. Include a timestamp in the
28                 MIPI SyS-T packet metadata, if this many milliseconds have
29                 passed since the previous packet from this source. Zero is
30                 the default and stands for "never send the timestamp".
31
32 What:           /config/stp-policy/<device>:p_sys-t.<policy>/<node>/clocksync_interval
33 Date:           June 2018
34 KernelVersion:  4.19
35 Description:
36                 Time interval in milliseconds. Send a CLOCKSYNC packet if
37                 this many milliseconds have passed since the previous
38                 CLOCKSYNC packet from this source. Zero is the default and
39                 stands for "never send the CLOCKSYNC". It makes sense to
40                 use this option with sources that generate constant and/or
41                 periodic data, like stm_heartbeat.