From patchwork Thu Dec 29 18:22:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cristian Marussi X-Patchwork-Id: 37476 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4e01:0:0:0:0:0 with SMTP id p1csp2533747wrt; Thu, 29 Dec 2022 10:26:11 -0800 (PST) X-Google-Smtp-Source: AMrXdXvS4ckqzckA6owbYeRN6Aj3i25EjfPX9eQmzLNaASsNk2xM6DmCOWlNzIoda+MbA3br73Qm X-Received: by 2002:a50:d0d1:0:b0:478:be92:3384 with SMTP id g17-20020a50d0d1000000b00478be923384mr27194487edf.14.1672338371458; Thu, 29 Dec 2022 10:26:11 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1672338371; cv=none; d=google.com; s=arc-20160816; b=FXsAgB+tenuuuIV9BESqvrMnE9xkucn4LjAffvKU8ABLSSqHmCrWCF6vd5jtZG0/oz vSXz7Yu+axi8J2YRGTtDQ19+RvbonsSGVUGv4E7udGCW16MQ07i83WXq9ZWQ6Ici1bIu GaNif/yeSvr3nykn9GD2EgHyIv4h2Vo+8ivGS9cVK90CYsXAfhJFmbgCORBhkvCihRTK cESM/YMPEkwhrPVA5DLv6XhXGSUt21y1SFHjMYh2gUAiZbHKXoQ68SHXfPl9mOAEy4bk B8/pep9QLSk62ENVet9O8+IHEeRHB4EmkxJcpwderhfhyMKCi9eZcjVXu1PWFIEkzn7d X2/Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=MLSVv6zfzqwg1xR1t73mOMjJhydl2fbzXXQ3aZsbFFo=; b=zPbQQnvIMkob0wvZxtX542m+5aeUDM4V1xKVz0GhNZs2EJneDix6n1Q0ip69hLLF4h g9KRQHCEZ8yXy+wv23OBsPzpi7alWGpERmjucWbfL1+BEl/VDWGOvizzNxgBdpAkmkS6 YolwLgKCAp4QJ26en6DtRms+2zaAnBY+CfpMjPUdKv5vhr9/rV5Q9Qt46Bd+bzm/MVrG ZJ/4UZhB7j4q54XLfq1LBhqyRUH9r6830RYBnzaelK3vIlhhAWWhu7afcoqvbH/pUoLV z5xcfJ1OrEmgHLgwIT86438V56UV+PHCedjYID/J+cGlMDUTirEVBq3lP0PWW71oR+hi rBVg== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=arm.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id u26-20020a50a41a000000b00476ac0819ecsi18103542edb.426.2022.12.29.10.25.48; Thu, 29 Dec 2022 10:26:11 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=arm.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234028AbiL2SYr (ORCPT + 99 others); Thu, 29 Dec 2022 13:24:47 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44914 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233894AbiL2SYW (ORCPT ); Thu, 29 Dec 2022 13:24:22 -0500 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 510CC13F91 for ; Thu, 29 Dec 2022 10:24:19 -0800 (PST) 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 830F6AD7; Thu, 29 Dec 2022 10:25:00 -0800 (PST) Received: from e120937-lin.. (unknown [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 1E9C83F71A; Thu, 29 Dec 2022 10:24:17 -0800 (PST) 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, quic_kshivnan@quicinc.com, cristian.marussi@arm.com Subject: [PATCH v6 13/17] firmware: arm_scmi: Add debugfs ABI documentation for Raw mode Date: Thu, 29 Dec 2022 18:22:49 +0000 Message-Id: <20221229182253.948175-14-cristian.marussi@arm.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221229182253.948175-1-cristian.marussi@arm.com> References: <20221229182253.948175-1-cristian.marussi@arm.com> MIME-Version: 1.0 X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1753573879969775036?= X-GMAIL-MSGID: =?utf-8?q?1753573879969775036?= Add description of the debugfs SCMI Raw ABI. Signed-off-by: Cristian Marussi --- v5 --> v6 - split debugfs Raw ABI doc into its own docfile and changed the top rootfs structure v4 --> v5 - updated ABI description for multiple SCMI instances support --- Documentation/ABI/testing/debugfs-scmi-raw | 66 ++++++++++++++++++++++ 1 file changed, 66 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..45817d465b1f --- /dev/null +++ b/Documentation/ABI/testing/debugfs-scmi-raw @@ -0,0 +1,66 @@ +What: /sys/kernel/debug/scmi//raw/message +Date: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: SCMI Raw synchronous message injection/snooping facility; write + a complete SCMI synchronous command message (header included) + in little-endian binary format to have it sent to the configured + backend SCMI server for instance . + 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: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: SCMI Raw asynchronous message injection/snooping facility; write + a complete SCMI asynchronous command message (header included) + in little-endian binary format to have it sent to the configured + backend SCMI server for instance . + 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: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: SCMI Raw message errors facility; any kind of timed-out or + generally unexpectedly received SCMI message, for instance , + 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: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: SCMI Raw notification snooping facility; any notification + emitted by the backend SCMI server, for instance , 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: March 2023 +KernelVersion: 6.3 +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 for instance , to be immediately + flushed. + Can be used to reset and clean the SCMI Raw stack between to + different test-run. +Users: Debugging, any userspace test suite