From: Cristian Marussi <cristian.marussi@arm.com>
To: linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org, arm-scmi@vger.kernel.org,
linux-doc@vger.kernel.org
Cc: sudeep.holla@kernel.org, james.quinlan@broadcom.com,
f.fainelli@gmail.com, vincent.guittot@linaro.org,
etienne.carriere@st.com, peng.fan@oss.nxp.com,
michal.simek@amd.com, d-gole@ti.com, jic23@kernel.org,
elif.topuz@arm.com, lukasz.luba@arm.com, philip.radford@arm.com,
david@kernel.org, souvik.chakravarty@arm.com, leitao@kernel.org,
kas@kernel.org, puranjay@kernel.org, usama.arif@linux.dev,
kernel-team@meta.com, Cristian Marussi <cristian.marussi@arm.com>
Subject: [PATCH v11 17/25] firmware: arm_scmi: Add Telemetry debugfs ABI documentation
Date: Sun, 6 Sep 2026 11:06:15 +0100 [thread overview]
Message-ID: <20260906100623.3488327-18-cristian.marussi@arm.com> (raw)
In-Reply-To: <20260906100623.3488327-1-cristian.marussi@arm.com>
Add description of the debugfs SCMI Telemetry protocol ABI.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v5 --> v6
- fixed typos
---
Documentation/ABI/testing/debugfs-scmi | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/Documentation/ABI/testing/debugfs-scmi b/Documentation/ABI/testing/debugfs-scmi
index ee7179ab2edf..edbbe360321d 100644
--- a/Documentation/ABI/testing/debugfs-scmi
+++ b/Documentation/ABI/testing/debugfs-scmi
@@ -68,3 +68,25 @@ Description: Max number of concurrently allowed in-flight SCMI messages for
the currently configured SCMI transport for instance <n> on the
RX channels.
Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi/<n>/protocols/0x<m>/
+Date: Nov 2026
+KernelVersion: 7.3
+Contact: cristian.marussi@arm.com
+Description: A subdirectory grouping debug entries related to protocol <m>
+ for instance <n>. Each protocol owns and defines the subtree
+ of entries rooted under this directory.
+Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi/<n>/protocols/0x1B/shmtis/<m>
+Date: Nov 2026
+KernelVersion: 7.3
+Contact: cristian.marussi@arm.com
+Description: A set of RO files exposed by the Telemetry protocol (0x1B) in
+ order to dump the latest snapshot of each SHMTI memory area in
+ binary format: each file is named by its SHMTI id.
+ File is seekable and a seek to position zero on an open file
+ causes the SHMTI snapshot to be refreshed; file timestamps are
+ updated after each snapshot.
+ This directory reports SHMTIs for instance <n>.
+Users: Debugging, any userspace test suite
--
2.54.0
next prev parent reply other threads:[~2026-09-06 10:08 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-06 10:05 [PATCH v11 00/25] Introduce SCMI Telemetry support Cristian Marussi
2026-09-06 10:05 ` [PATCH v11 01/25] firmware: arm_scmi: Add new SCMIv4.0 error codes definitions Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 02/25] firmware: arm_scmi: Allow registration of unknown-size events/reports Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 03/25] firmware: arm_scmi: Introduce protocol instance notifiers Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 04/25] dt-bindings: firmware: arm,scmi: Add support for telemetry protocol Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 05/25] include: trace: Add Telemetry trace events Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 06/25] firmware: arm_scmi: Add basic Telemetry support Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 07/25] firmware: arm_scmi: Add support to parse SHMTIs areas Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 08/25] firmware: arm_scmi: Add Telemetry configuration operations Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 09/25] firmware: arm_scmi: Add Telemetry DataEvent read capabilities Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 10/25] firmware: arm_scmi: Add support for Telemetry reset Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 11/25] firmware: arm_scmi: Add Telemetry notification support Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 12/25] firmware: arm_scmi: Add support for boot-on Telemetry Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 13/25] firmware: arm-scmi: Add telemetry generic event support Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 14/25] firmware: arm_scmi: Add Telemetry generation counter event Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 15/25] firmware: arm_scmi: Add common per-protocol debugfs support Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 16/25] firmware: arm_scmi: Add Telemetry debugfs SHMTI dump support Cristian Marussi
2026-09-06 10:06 ` Cristian Marussi [this message]
2026-09-06 10:06 ` [PATCH v11 18/25] firmware: arm_scmi: Expose per-instance identifier Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 19/25] firmware: arm_scmi: Add un-managed methods to get/put protocols operations Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 20/25] uapi: Add ARM SCMI Telemetry definitions Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 21/25] firmware: arm_scmi: Add System Telemetry driver Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 22/25] docs: ioctl-number: Add SCMI Ioctls Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 23/25] [RFC] Documentation: Add SCMI System Telemetry documentation Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 24/25] [RFC] tools/scmi: Add SCMI Telemetry testing tool Cristian Marussi
2026-09-06 10:06 ` [PATCH v11 25/25] [RFC] kselftest/arm64: Add SCMI Telemetry UAPI compliance testcases Cristian Marussi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260906100623.3488327-18-cristian.marussi@arm.com \
--to=cristian.marussi@arm.com \
--cc=arm-scmi@vger.kernel.org \
--cc=d-gole@ti.com \
--cc=david@kernel.org \
--cc=elif.topuz@arm.com \
--cc=etienne.carriere@st.com \
--cc=f.fainelli@gmail.com \
--cc=james.quinlan@broadcom.com \
--cc=jic23@kernel.org \
--cc=kas@kernel.org \
--cc=kernel-team@meta.com \
--cc=leitao@kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukasz.luba@arm.com \
--cc=michal.simek@amd.com \
--cc=peng.fan@oss.nxp.com \
--cc=philip.radford@arm.com \
--cc=puranjay@kernel.org \
--cc=souvik.chakravarty@arm.com \
--cc=sudeep.holla@kernel.org \
--cc=usama.arif@linux.dev \
--cc=vincent.guittot@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox