From patchwork Thu Nov 3 19:52:21 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cristian Marussi X-Patchwork-Id: 15138 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp737266wru; Thu, 3 Nov 2022 12:55:22 -0700 (PDT) X-Google-Smtp-Source: AMsMyM7qb9tmftv/xZIOhNrFd7QnOvGb+AyKSBfJSOw3VBxTtNKj4G4la4RgYv3wZKe/twi1tPNq X-Received: by 2002:a17:906:b345:b0:7ae:8d4:4204 with SMTP id cd5-20020a170906b34500b007ae08d44204mr9038609ejb.746.1667505322287; Thu, 03 Nov 2022 12:55:22 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1667505322; cv=none; d=google.com; s=arc-20160816; b=oc9yeVMOY8nYw1eGm5kZlVDJB/q07xT1FQoMySfOcj8SNPnRfFZlfj9ubp3iP3yj95 4IPJWlyGNBsysm/AotXcYTF+ZkLwmP4ajlB7+EQJRB+nZraYrpmC9NvgIP9PDSf3tkAR MP/04X9k7souvZhLliW4RpuvmXchg9KpWTJDbrq6XMdRJxPN3mDO4ZiQm45eV9tdzZDS wF2QfCE/Z6z1DtWR0X36nkIuXUIG6XcIqOQEfmNT46h3lXtHpdWXWvIouatYODoobfsp sXPT2xmRfXGNjNPT81GlOrVkZrTk/pj+J3v+yvptRD2uLJ815hNtZ4svNhZ2nMlF4D0S xN2Q== 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=0VCK+yMQnXZFjnFdXMl/EFJ6jvQzkM3t5W7bE7oa1Ro=; b=yzXtX40uWQUol3jQTciavt6a+YGgG1+aF+oHcaW/i4x1gOSYCclk0cA645KqAKBA2y scTUpUzAvc9tO5RqEb/PXwAEKkKxk2hV/v0SRJJW72JlsEWfRwqv/4f6/Hw0fnwpXf3W RlVBidIGIJawx6/a95A94/nm2eacg9Kcyf6ndLnBvf+dt2V9Nj12DcM54pEYpT2m5F0W +Kyvf26S9nvZ/rB3Iujk5Ay3TkmkwP3UmOA0b4du3RLnUxoiOvaf3xJydj+Mlgd37/4w n6h/lBR671x1LX8q0ZYnX28ofFJtlpIRRezw3S2iTGtetRU8GD6jg2FwBGUyglPKnEQh I3CA== 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 z3-20020a05640240c300b00462352ef503si2703132edb.518.2022.11.03.12.54.58; Thu, 03 Nov 2022 12:55:22 -0700 (PDT) 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 S231161AbiKCTyH (ORCPT + 99 others); Thu, 3 Nov 2022 15:54:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46246 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231297AbiKCTxS (ORCPT ); Thu, 3 Nov 2022 15:53:18 -0400 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id C427420BE2 for ; Thu, 3 Nov 2022 12:53:12 -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 D639A23A; Thu, 3 Nov 2022 12:53:18 -0700 (PDT) Received: from e120937-lin.fritz.box (unknown [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 948463F534; Thu, 3 Nov 2022 12:53:10 -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, quic_kshivnan@quicinc.com, cristian.marussi@arm.com Subject: [PATCH v5 10/14] firmware: arm_scmi: Add debugfs ABI documentation for Raw mode Date: Thu, 3 Nov 2022 19:52:21 +0000 Message-Id: <20221103195225.1028864-11-cristian.marussi@arm.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221103195225.1028864-1-cristian.marussi@arm.com> References: <20221103195225.1028864-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?1748506060918602197?= X-GMAIL-MSGID: =?utf-8?q?1748506060918602197?= Add description of the debugfs SCMI Raw ABI. Signed-off-by: Cristian Marussi --- v4 --> v5 - updated ABI description for multiple SCMI instances support --- Documentation/ABI/testing/debugfs-scmi-raw | 98 ++++++++++++++++++++++ 1 file changed, 98 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..f50fead5d2a8 --- /dev/null +++ b/Documentation/ABI/testing/debugfs-scmi-raw @@ -0,0 +1,98 @@ +What: /sys/kernel/debug/scmi_raw//instance_name +Date: December 2022 +KernelVersion: 6.2 +Contact: cristian.marussi@arm.com +Description: The name of the underlying SCMI instance accessed by this Raw + interface accessors expressed as the full name of the top DT + SCMI node under which the SCMI instance is rooted. +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw//transport_max_msg_size +Date: December 2022 +KernelVersion: 6.2 +Contact: cristian.marussi@arm.com +Description: Max message size of allowed SCMI messages for the currently + configured SCMI transport for instance . +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw//transport_tx_max_msg +Date: December 2022 +KernelVersion: 6.2 +Contact: cristian.marussi@arm.com +Description: Max number of concurrently allowed in-flight SCMI messages for + the currently configured SCMI transport for instance . +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw//transport_rx_timeout_ms +Date: December 2022 +KernelVersion: 6.2 +Contact: cristian.marussi@arm.com +Description: Timeout in milliseconds allowed for SCMI synchronous replies + for the currently configured SCMI transport for instance . +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi_raw//message +Date: December 2022 +KernelVersion: 6.2 +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: December 2022 +KernelVersion: 6.2 +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: December 2022 +KernelVersion: 6.2 +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: December 2022 +KernelVersion: 6.2 +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: December 2022 +KernelVersion: 6.2 +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, for instance . + Can be used to reset and clean the SCMI Raw stack between to + different test-run. +Users: Debugging, any userspace test suite