From patchwork Thu Dec 29 18:22:47 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cristian Marussi X-Patchwork-Id: 37475 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4e01:0:0:0:0:0 with SMTP id p1csp2533734wrt; Thu, 29 Dec 2022 10:26:10 -0800 (PST) X-Google-Smtp-Source: AMrXdXuSzFenuvjKoqBqMozftmTv8zCCGmGKCJb+wPSLewvzDPbkUq8oUaGQ6k8cmojajfTNdVk2 X-Received: by 2002:a17:907:6746:b0:836:e7de:9792 with SMTP id qm6-20020a170907674600b00836e7de9792mr10707907ejc.32.1672338370363; Thu, 29 Dec 2022 10:26:10 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1672338370; cv=none; d=google.com; s=arc-20160816; b=IQ/BD4euVdLy5ye9aszFcTyAKQg4rYUK3OaPCYJO8/Shj4qTsACT2QD8w8VZazI9En mP6+zL1IhbH8W7MHZndr0S9z9Q1NufKC9RBrv+DvHiw0K2NxNuPcUxrQJGnrCFT532Eo 6ppZLcNKTUYPF8Xrr4e5EuqZy0pNblY6SDvOwqLjKbrZP3oMs0CW9mtqH8r180Kcyj3q iXLAxEBR2jqcO7UEeR/Ntic5g7DINAFztvokI493TaX8h2N4Qvf2WU8b0+EeNcp8tq6J 08u+NzoRRC2nH7jiCkiSjmtzMljisqPIo30UFZjY86B4Bw6bs0sI+E4b3hXag2IchFW3 yifQ== 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=PiK9oLxtCPfmTILeMJI21JddvT2DndBEaGkKRvHzUb0=; b=HQeSJnuXCLrWeZ1iih6/WqjKmrLswQk9fJEBD4NJ3bE9RI+eyonrS/wsv4/JsC6MuN nWHh/XwDrd3YCkFkKl5bEZ638r0pWi7QmqpeVCqEO9tniU+FjKLv58axEhNSgtBAMCvr olCeucCuE0e8VDg8vUipJdlOS7GqsfDV9kTinyJk/5HIAUkkAmg8In0vtW0WgciQzkC2 5X/cy1YXI8R2Gx6qmi9ToWmTvP3YADfId4JPPyKXj0aDoCGfuGie+jmTJ/H4RE+0x1zN +9f7v7dA84eeueE6WhuiNlNNsUsLTgZDA5Sh6jG75VBInNmcAkOEcr+eaRyY9xm2vqLU AmZQ== 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 oz32-20020a1709077da000b007c093acadb0si16487954ejc.508.2022.12.29.10.25.47; Thu, 29 Dec 2022 10:26:10 -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 S231149AbiL2SYm (ORCPT + 99 others); Thu, 29 Dec 2022 13:24:42 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44940 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233791AbiL2SYP (ORCPT ); Thu, 29 Dec 2022 13:24:15 -0500 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 8FE8113F80 for ; Thu, 29 Dec 2022 10:24:14 -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 C164316F3; Thu, 29 Dec 2022 10:24:55 -0800 (PST) Received: from e120937-lin.. (unknown [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 537FB3F71A; Thu, 29 Dec 2022 10:24:12 -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 11/17] firmware: arm_scmi: Add debugfs ABI documentation for common entries Date: Thu, 29 Dec 2022 18:22:47 +0000 Message-Id: <20221229182253.948175-12-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?1753573878730778160?= X-GMAIL-MSGID: =?utf-8?q?1753573878730778160?= Add description of the debugfs SCMI common ABI. Signed-off-by: Cristian Marussi --- Documentation/ABI/testing/debugfs-scmi | 70 ++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 Documentation/ABI/testing/debugfs-scmi diff --git a/Documentation/ABI/testing/debugfs-scmi b/Documentation/ABI/testing/debugfs-scmi new file mode 100644 index 000000000000..ee7179ab2edf --- /dev/null +++ b/Documentation/ABI/testing/debugfs-scmi @@ -0,0 +1,70 @@ +What: /sys/kernel/debug/scmi//instance_name +Date: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: The name of the underlying SCMI instance described by + all the debugfs accessors rooted at /sys/kernel/debug/scmi/, + expressed as the full name of the top DT SCMI node under which + this SCMI instance is rooted. +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi//atomic_threshold_us +Date: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: An optional time value, expressed in microseconds, representing, + on this SCMI instance , the threshold above which any SCMI + command, advertised to have an higher-than-threshold execution + latency, should not be considered for atomic mode of operation, + even if requested. +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi//transport/type +Date: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: A string representing the type of transport configured for this + SCMI instance . +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi//transport/is_atomic +Date: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: A boolean stating if the transport configured on the underlying + SCMI instance is capable of atomic mode of operation. +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi//transport/max_rx_timeout_ms +Date: March 2023 +KernelVersion: 6.3 +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//transport/max_msg_size +Date: March 2023 +KernelVersion: 6.3 +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//transport/tx_max_msg +Date: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: Max number of concurrently allowed in-flight SCMI messages for + the currently configured SCMI transport for instance on the + TX channels. +Users: Debugging, any userspace test suite + +What: /sys/kernel/debug/scmi//transport/rx_max_msg +Date: March 2023 +KernelVersion: 6.3 +Contact: cristian.marussi@arm.com +Description: Max number of concurrently allowed in-flight SCMI messages for + the currently configured SCMI transport for instance on the + RX channels. +Users: Debugging, any userspace test suite