From nobody Mon Apr 6 20:12:42 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 57CD3ECAAD5 for ; Sat, 3 Sep 2022 18:31:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231701AbiICSbx (ORCPT ); Sat, 3 Sep 2022 14:31:53 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44020 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231573AbiICSbm (ORCPT ); Sat, 3 Sep 2022 14:31:42 -0400 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 955CD5509A for ; Sat, 3 Sep 2022 11:31:24 -0700 (PDT) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id B2C7CED1; Sat, 3 Sep 2022 11:31:29 -0700 (PDT) Received: from e120937-lin.home (unknown [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id A6C793F71A; Sat, 3 Sep 2022 11:31:21 -0700 (PDT) From: Cristian Marussi To: linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org Cc: sudeep.holla@arm.com, james.quinlan@broadcom.com, Jonathan.Cameron@Huawei.com, f.fainelli@gmail.com, etienne.carriere@linaro.org, vincent.guittot@linaro.org, souvik.chakravarty@arm.com, wleavitt@marvell.com, peter.hilber@opensynergy.com, nicola.mazzucato@arm.com, tarek.el-sherbiny@arm.com, cristian.marussi@arm.com Subject: [PATCH v3 7/9] firmware: arm_scmi: Add debugfs ABI documentation for Raw mode Date: Sat, 3 Sep 2022 19:30:40 +0100 Message-Id: <20220903183042.3913053-8-cristian.marussi@arm.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220903183042.3913053-1-cristian.marussi@arm.com> References: <20220903183042.3913053-1-cristian.marussi@arm.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" Add description of the debugfs SCMI Raw ABI. Signed-off-by: Cristian Marussi --- Documentation/ABI/testing/debugfs-scmi-raw | 88 ++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 Documentation/ABI/testing/debugfs-scmi-raw diff --git a/Documentation/ABI/testing/debugfs-scmi-raw b/Documentation/ABI= /testing/debugfs-scmi-raw new file mode 100644 index 000000000000..183ec678cb3e --- /dev/null +++ b/Documentation/ABI/testing/debugfs-scmi-raw @@ -0,0 +1,88 @@ +What: /sys/kernel/debug/scmi_raw/transport_max_msg_size +Date: December 2022 +KernelVersion: 6.1 +Contact: cristian.marussi@arm.com +Description: Max message size of allowed SCMI messages for the currently + configured SCMI transport. +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw/transport_tx_max_msg +Date: December 2022 +KernelVersion: 6.1 +Contact: cristian.marussi@arm.com +Description: Max number of concurrently allowed in-flight SCMI messages for + the currently configured SCMI transport. +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw/transport_rx_timeout_ms +Date: December 2022 +KernelVersion: 6.1 +Contact: cristian.marussi@arm.com +Description: Timeout in milliseconds allowed for SCMI synchronous replies + for the currently configured SCMI transport. +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw/message +Date: December 2022 +KernelVersion: 6.1 +Contact: cristian.marussi@arm.com +Description: SCMI Raw synchronous message injection/snooping facility; wri= te + a complete SCMI synchronous command message (header included) + in little-endian binary format to have it sent to the configured + backend SCMI server. + Any subsequently received response can be read from this same + entry if it arrived within the configured timeout. + Each write to the entry causes one command request to be built + and sent while the replies are read back one message at time + (receiving an EOF at each message boundary). +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw/message_async +Date: December 2022 +KernelVersion: 6.1 +Contact: cristian.marussi@arm.com +Description: SCMI Raw asynchronous message injection/snooping facility; wr= ite + a complete SCMI asynchronous command message (header included) + in little-endian binary format to have it sent to the configured + backend SCMI server. + Any subsequently received response can be read from this same + entry if it arrived within the configured timeout. + Any additional delayed response received afterwards can be read + from this same entry too if it arrived within the configured + timeout. + Each write to the entry causes one command request to be built + and sent while the replies are read back one message at time + (receiving an EOF at each message boundary). +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw/errors +Date: December 2022 +KernelVersion: 6.1 +Contact: cristian.marussi@arm.com +Description: SCMI Raw message errors facility; any kind of timed-out or + generally unexpectedly received SCMI message can be read from + this entry. + Each read gives back one message at time (receiving an EOF at + each message boundary). +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw/notification +Date: December 2022 +KernelVersion: 6.1 +Contact: cristian.marussi@arm.com +Description: SCMI Raw notification snooping facility; any notification + emitted by the backend SCMI server can be read from this entry. + Each read gives back one message at time (receiving an EOF at + each message boundary). +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw/reset +Date: December 2022 +KernelVersion: 6.1 +Contact: cristian.marussi@arm.com +Description: SCMI Raw stack reset facility; writing a value to this entry + causes the internal queues of any kind of received message, + still pending to be read out, to be flushed. + Can be used to reset and clean the SCMI Raw stack between to + different test-run. +Users: Debugging, any userspace test suite --=20 2.32.0