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;
From:   Quan Nguyen <quan@os.amperecomputing.com>
To:     macro@orcam.me.uk, Lee Jones <lee@kernel.org>,
        Bagas Sanjaya <bagasdotme@gmail.com>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        Jonathan Corbet <corbet@lwn.net>,
        Derek Kiernan <derek.kiernan@xilinx.com>,
        Dragan Cvetic <dragan.cvetic@xilinx.com>,
        Arnd Bergmann <arnd@arndb.de>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Quan Nguyen <quan@os.amperecomputing.com>,
        Thu Nguyen <thu@os.amperecomputing.com>,
        linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
        OpenBMC Maillist <openbmc@lists.ozlabs.org>,
        Open Source Submission <patches@amperecomputing.com>
Cc:     Phong Vo <phong@os.amperecomputing.com>,
        thang@os.amperecomputing.com
Subject: [PATCH v9 6/9] docs: misc-devices: (smpro-misc) Add documentation
Date:   Thu, 29 Sep 2022 16:43:18 +0700
Message-Id: <20220929094321.770125-7-quan@os.amperecomputing.com>
In-Reply-To: <20220929094321.770125-1-quan@os.amperecomputing.com>
References: <20220929094321.770125-1-quan@os.amperecomputing.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?1VPApfgMHe/81+8JrDCcNuOfDBT+gdCDBt4SRZK4e2OEBQ+YeY9YXaMxbMtE?=
 =?us-ascii?Q?5yjTsQqI1hImngwkBjmk11Ljuq6eCxbp/ZZuqsKoGviI2Tfgl3sHywE3AWr3?=
 =?us-ascii?Q?rIcydKng7e2TRWZBFGj0W5SgPsgALXP4ToEds++AAhxv7UFGlbL9d20EnTRC?=
 =?us-ascii?Q?lWsNKmeDPEVUmWesGvBe1yHvMBXgNe/As9Oo+c4P4xJtzpWancZB0nAw3A78?=
 =?us-ascii?Q?2Jo22ih4Hd6inB+khcOgn2+xZYm5E4QqWPWTbABrUQ5L0SG0RXG2LbRNxUfO?=
 =?us-ascii?Q?bC0q7lRoMQmX6PGrHGRzD15oN5asbla/tgDA8YtoKkYpRJEN8darTN/BwO3x?=
 =?us-ascii?Q?XGKWrAY1SGNKmrGaXnBf/002maT+6dOA7OqTo/YNq1lMXWvTJP+NUsNPKLaX?=
 =?us-ascii?Q?vHTIwuPqSw6qxpuTFBohADPYyi8RwaDkyPi3BJIQsYmNLIuj6n7mcFkk2PSJ?=
 =?us-ascii?Q?uQ8nCSyqi9xGC90x7GT1U39OqBnzQAJeIfj8vZfYFOnnzZ8ZfvBwRSbHbYVe?=
 =?us-ascii?Q?gVld/ZMcgo0dh6VdYVWgklSAjtQls/R632w+taGkIc/d3jMIOBzsMHxu9uiG?=
 =?us-ascii?Q?Ykvh9YWEm+FwgQy7XgtIwu5KiqxmRJvZekQAsdMT/CzFsLm/RKmlrCpeMJq8?=
 =?us-ascii?Q?XR/vIKCAvr2qYewA7+oQ/CVATqwZND7WoLJJcrRlHN+LVoh8tTaSl3coCvAA?=
 =?us-ascii?Q?Is1ZaLr0jdGXNrn67HOdqwOO73QWaJPue4dhn913adGPMmb12hYtUiIB7fIt?=
 =?us-ascii?Q?5UhKBaZLTgOas1I6Y8G5/sB3fviGK4tvRPbGZE941nu64iPYASCLa6Cm0UMr?=
 =?us-ascii?Q?j8Pr4266sejf+/liOqeiYWu5MWyLbHqnvbSKsC0TxWZeB8GHk9KOAcNasLq0?=
 =?us-ascii?Q?a7gCWINJkZEVeRfjj8kASbWtSTbRKYD08UW232yNTZ500C+talTjGDxk3QWc?=
 =?us-ascii?Q?StxrLq6BU9/Q+/GUhqiBxXln/fU0L5E/skcVj4oIT6UmmmyFmnxg+27jqmL0?=
 =?us-ascii?Q?fsTFhTRV6bnRaky6hzLnTZ2uYVRWs4Tltb2zRGx2dq/4uG/rV3fTE9gGQ/k/?=
 =?us-ascii?Q?glJ61YNnGHqfl49mfD7Ysvt3gKHP59MRNZPYIPUFmnStJeSdvNnPG8dtFDfp?=
 =?us-ascii?Q?p911+5FsY9QHsTNxR5E0rtrkdlMoGsAg4kmUwWdYSrHbQmioFsu/8YgbU9J7?=
 =?us-ascii?Q?PFMnKZDr+dxD5CvnQPNLIqttImLJ2c/kjg4cC5sS7pO74XyvMNx7z/iQwuSo?=
 =?us-ascii?Q?VZLOU0LcLgsl5yFNSJf5LszPB6YIy3mf0FziQldWY0s3WCJAExW1b6FIIMfz?=
 =?us-ascii?Q?yZJh8ADwD+QhMb05Ytoox40IkmnzKbwgwLl+FxHLXB+sKOZgyhulNV3OZuJ7?=
 =?us-ascii?Q?tlwzo2m4w9hX3e2MqD7joU5h7JtintvRtt1PqJe8ocpKRY2JN5P4GWKjzfQN?=
 =?us-ascii?Q?CwdMDVL3/sTDTshybbErLd8WY4B70UX7TluhVy9YnId0ElZyPDgChOry4xyS?=
 =?us-ascii?Q?78wYgs/dtdq2rFQnC1UNEQJGZlvjECFoY/pBwkv89bNIAhpOm2hfnX+hDljH?=
 =?us-ascii?Q?lz7C9HIp4GxSEt/IlBJRP7GKR/JZ6XL5h/AYi7GzuTZfLFqBB9V1WWl1mYsq?=
 =?us-ascii?Q?H2StBgijd5ZlZud/AHAsexc=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8ac40aac-b81d-433e-274b-08daa1ff2ddd
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Sep 2022 09:44:18.7983
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 72HQDg9hEVgf8Ba9SmKSyR6ht0GfMAmnRcHMr4N3kN13YYvD9fPnmOzVd7effT08l8Np8JnFFlcQ+Xc2IVyB8UT8LShonTcI0AXo5nGpWWo=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN6PR01MB4798
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,
        SPF_HELO_PASS,SPF_PASS 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: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Adds documentation for the Ampere(R)'s Altra(R) SMpro misc driver.

Signed-off-by: Thu Nguyen <thu@os.amperecomputing.com>
Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
---
Changes in v9:
  + Update SPDX licence                          [Greg]

Changes in v8:
  + Update to reflect single value per sysfs     [Quan]

Changes in v7:
  + None

Changes in v6:
  + First introduced in v6 [Quan]

 Documentation/misc-devices/index.rst      |  1 +
 Documentation/misc-devices/smpro-misc.rst | 82 +++++++++++++++++++++++
 2 files changed, 83 insertions(+)
 create mode 100644 Documentation/misc-devices/smpro-misc.rst

diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
index b74b3b34a235..b40cd1b402f7 100644
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -28,6 +28,7 @@ fit into other categories.
    oxsemi-tornado
    pci-endpoint-test
    smpro-errmon
+   smpro-misc
    spear-pcie-gadget
    uacce
    xilinx_sdfec
diff --git a/Documentation/misc-devices/smpro-misc.rst b/Documentation/misc-devices/smpro-misc.rst
new file mode 100644
index 000000000000..d21be4a09e69
--- /dev/null
+++ b/Documentation/misc-devices/smpro-misc.rst
@@ -0,0 +1,82 @@
+.. SPDX-License-Identifier: GPL-2.0-only
+
+Kernel driver Ampere(R) Altra(R) SMpro miscellaneous
+====================================================
+
+Supported chips:
+
+  * Ampere(R) Altra(R)
+
+    Prefix: 'smpro'
+
+    Reference: Altra SoC BMC Interface Specification
+
+Author: Thu Nguyen <thu@os.amperecomputing.com>
+
+Description
+-----------
+
+This driver support the monitoring and configuration of various miscellaneous
+data provided by Ampere(R) Altra(R) SMpro processor.
+At this time, these include:
+
+  * Reading Boot Progress information
+  * Configuring SoC Power Limit
+
+Sysfs entries
+-------------
+
+1) Boot progress
+
+SMpro misc driver creates the sysfs files ``boot_progress``.
+The format of ``boot_progress`` file is as below::
+
+<boot stage><boot status><boot progress>
+
+Where:
+
+* Boot stage::
+
+    0: SMpro firmware booting.
+    1: PMpro firmware booting.
+    2: ATF BL1 firmware booting.
+    3: DDR initialization.
+    4: DDR training report status.
+    5: ATF BL2 firmware booting.
+    6: ATF BL31 firmware booting.
+    7: ATF BL32 firmware booting.
+    8: UEFI firmware booting.
+    9: OS booting.
+
+* Boot status::
+
+    0: Not started.
+    1: Started.
+    2: Complete without error.
+    3: Failure.
+
+* boot progress: 32 bits boot progress code
+
+The sysfs ``boot_progress`` only reports the boot state when the host is booting.
+If the host is already booted, it returns latest state.
+
+Example::
+
+    #cat boot_progress
+    0102808454A8
+
+2) SoC Power Limit
+
+SMpro misc driver creates the sysfs file ``soc_power_limit`` to get/set the SoC Power Limit.
+
+Reading this sysfs return the current setting of SoC Power Limit (W) in decimal string.
+Writing the desired value in decimal string to set the SoC Power Limit in Watt (W).
+The range of SoC Power Limit is 90-500(W) and will be ignored if out of range.
+
+Example::
+
+    #cat soc_power_limit
+    90
+    #echo 95 > soc_power_limit
+    #cat soc_power_limit
+    95
-- 
2.35.1