Add full ABI dcoumentation for stlmfs under testing/ Signed-off-by: Cristian Marussi --- RFC since the documentation is still NOT complete and unsure if place this into stable/ or testing/ --- Documentation/ABI/testing/stlmfs | 153 +++++++++++++++++++++++++++++++ 1 file changed, 153 insertions(+) create mode 100644 Documentation/ABI/testing/stlmfs diff --git a/Documentation/ABI/testing/stlmfs b/Documentation/ABI/testing/stlmfs new file mode 100644 index 000000000000..efa001a7d82f --- /dev/null +++ b/Documentation/ABI/testing/stlmfs @@ -0,0 +1,153 @@ +What: /sys/fs/arm_telemetry/tlm_/all_des_enable +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A boolean WO entry to enable all the discovered Data Events for + SCMI instance . +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/all_tstamp_des_enable +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A boolean WO entry to enable timestamps for all the discovered + Data Events for SCMI instance . (when available) +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/available_update_intervals_ms +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A RO entry that returns a space separated list of tuples of + values, separated by a coma, each one representing a + configurable update interval for SCMI instance . + Each tuple describes a possible update interval using the + format , where the final represented interval is + calculated as: * 10 ^ + An example of list of tuples that can be read from this entry: + 3,0 4,-1 75,-2 300,-3 1,1 5,3 222,-7 +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/current_update_intervals_ms +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: An RW entry that can be used to get or set the platform update + interval for SCMI instance . + On read the returned tuple represents the current update + interval using the format , where the final + represented interval is calculated as: * 10 ^ + On write the accepted format is the same as on read , + but, optionally, the second element of the tuple can be omitted + and in that case the assumed value for the exponent will default + to -3 signifying milliseconds. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/control +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: An RW entry that can be used to discover, configure and retrieve + Telemetry data using the alternative binary interface based on + ioctls which is documented in include/uapi/linux/scmi.h +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/de_implementation_version +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A RO entry that returns a string representing the 128bit UUID + that uniquely identifies the set of SCMI Telemetry Data Events + and their semantic for SCMI instance . + This is compliant with the DE_IMPLEMENTATION_REVISION described + in SCMI v4.0 Telemetry 3.12.4.3. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des_bulk_read +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A RO entry that returns a multi-line string containing all the + the DEs enabled for SCMI instance , one-per-line, formmatted + as: . + These DEs readings represent the last value updated by the + platform following the configured update interval: on the + backend they may have been collected in a number of different + ways: on-demand SHMTI lookup, notifications, fastchannels. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des_single_sample_read +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A RO entry that returns a multi-line string containing all the + the DEs enabled for SCMI instance , one-per-line, formmatted + as: . + These DEs readings are generated by triggering an explicit and + immediate platform update using single sample asynchronous + collect methods. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/intervals_discrete +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A boolean RO entry to specify if the intervals reported for + SCMI instance in available_update_intervals_ms are a list of + discrete intervals or a triplet of values representing + . +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/reset +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A boolean WO entry that can be used the full reset of the SCMI + Telemetry subsystem, both of the configurations and of the + collected data, as specified in SCMI v4.0 3.12.4.12 +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/tlm_enable +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A boolean RW entry that can be used to get or set the general + enable status of the Telemetry subsystem. Temporarily disabling + Telemetry as a whole does NOT reset the current configuration, + it only stops all the DEs updates platform side. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/version +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A RO entry used to report the SCMI Telemetry protocol version + used in this implementation. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/value +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A RO entry used to read the last value reported for Data Event + with id 0x for SCMI instance . +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/enable +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A RW boolean entry used to enable or disable Data Event + with id 0x for SCMI instance . +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/tstamp_enable +Date: January 2026 +KernelVersion: 7.0 +Contact: cristian.marussi@arm.com +Description: A RW boolean entry used to enable or disable timestamping for + Data Event with id 0x for SCMI instance . +Users: Any userspace telemetry tool + + +... To BE CONTINUED ... -- 2.52.0