Add full ABI dcoumentation for stlmfs under testing/ Signed-off-by: Cristian Marussi --- v2-->v3 - complete ABI entries docs RFC since the documentation is still NOT complete and unsure if place this into stable/ or testing/ --- Documentation/ABI/testing/stlmfs | 297 +++++++++++++++++++++++++++++++ 1 file changed, 297 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..0d9b1c1885a2 --- /dev/null +++ b/Documentation/ABI/testing/stlmfs @@ -0,0 +1,297 @@ +What: /sys/fs/arm_telemetry/tlm_/all_des_enable +Date: May 2026 +KernelVersion: 7.2 +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: May 2026 +KernelVersion: 7.2 +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: May 2026 +KernelVersion: 7.2 +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_/by_components/ +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A subdirectory that exposes an alternative topological view of + the same set of discovered DEs that can be already found under + the des/ branch. + This topology subtree is built following this structure: + by_components/ + ├── + │   ├── + │   │   ├── + │   │   │   └── + │   │   │   └── 0x[] -> ../../../../../des/0x + + The leaves are actual symlinks to an existing des/0x + subdirectory, while the naming of the subdirectories composing + the inner nodes of the subtree are derived from the DataEvent + Descriptor in SCMI v4.0 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/control +Date: May 2026 +KernelVersion: 7.2 +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_/current_update_intervals_ms +Date: May 2026 +KernelVersion: 7.2 +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, i.e. milliseconds. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/de_implementation_version +Date: May 2026 +KernelVersion: 7.2 +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: May 2026 +KernelVersion: 7.2 +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, formatted + as: + These DEs readings represent the last value updated by the + platform following the configured update interval: on the + backend they will have been collected transparently in a number + of different ways: on-demand SHMTI lookup, notifications, + fastchannels. + Any disabled or unavailable DE is simply NOT included. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des_single_sample_read +Date: May 2026 +KernelVersion: 7.2 +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. + Any disabled or unavailable DE is simply NOT included. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/intervals_discrete +Date: May 2026 +KernelVersion: 7.2 +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: May 2026 +KernelVersion: 7.2 +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: May 2026 +KernelVersion: 7.2 +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 configured DEs updates platform side. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/version +Date: May 2026 +KernelVersion: 7.2 +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/compo_instance_id +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO entry to report the component instance to which this DE + belongs, as described by the DataEvent Descriptor in SCMI v4.0 + 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/compo_type +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO entry to report the component type to which this DE is + associated, as described by the DataEvent Descriptor in SCMI v4.0 + 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/instance_id +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO entry to report the DE instance ID that identifies this DE + within the component instance to which it belongs, as described + by the DataEvent Descriptor in SCMI v4.0 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/name +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A optional RO entry to report the name associated with this DE, + as described by the DataEvent Descriptor in SCMI v4.0 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/persistent +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO boolean to report that the DE data values are persistent + across all reboot cycles, except cold reboot, as described by + the DataEvent Descriptor in SCMI v4.0 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/tstamp_rate +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: An optional RO entry to report the clock rate in KHZ used to + generate the timestamps associated to this DE, as described by + the DataEvent Descriptor in SCMI v4.0 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/type +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO entry to report the type of DataEvent as described by the + DataEvent Descriptor in SCMI v4.0 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/unit +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO entry to report the unit of measurements used by this DE, + as described by the DataEvent Descriptor in SCMI v4.0 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/unit_exp +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO entry to report the power-of-10 multiplier in two's + complement format that is applied to the unit specified by the + DE unit field, as described by the DataEvent Descriptor in SCMI + v4.0 3.12.4.6. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/value +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO entry used to read the last value and timestamp collected + for Data Event with id 0x for SCMI instance . + The output is formatted as: : + Reading from this entry can fail with: + -ENODATA: the DE itself, or the whole telemetry subsystem, + was in a disabled state at the time of the read. + -EINVAL: the data value associated to this DE is NOT usable + since it was found to have been internally marked as + DATA_INVALID; this could be due to a temporary or + permanent error condition of the underlying hardware + in charge of this DE data collection. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/des/0x/enable +Date: May 2026 +KernelVersion: 7.2 +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: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: An RW boolean entry used to enable or disable timestamping for + Data Event with id 0x for SCMI instance . + This entry is optional and present only if the DE supports + timestamping. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/groups// +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A subdirectory containing entries that describe configurations + and values related to group of SCMI instance . + Most of the contained entries share the same names with some + other, already defined entries, elsewhere: + + groups/0/ + ├── available_update_intervals_ms + ├── control + ├── current_update_interval_ms + ├── des_bulk_read + ├── des_single_sample_read + ├── enable + ├── intervals_discrete + └── tstamp_enable + + These homonyms carry the same syntax and semantic as the other + but they are usually restricted in their definitions to the + specific group . + These common entries won't be described further again here. +Users: Any userspace telemetry tool + +What: /sys/fs/arm_telemetry/tlm_/groups//composing_des +Date: May 2026 +KernelVersion: 7.2 +Contact: cristian.marussi@arm.com +Description: A RO entry that reports the space separated list of DataEvents + belonging to group for SCMI instance +Users: Any userspace telemetry tool -- 2.53.0