From: Quan Nguyen <quan@os.amperecomputing.com>
To: Lee Jones <lee.jones@linaro.org>,
Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzk+dt@kernel.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>,
Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>,
linux-kernel@vger.kernel.org (open list),
devicetree@vger.kernel.org (open list:OPEN FIRMWARE AND
FLATTENED DEVICE TREE BINDINGS),
linux-hwmon@vger.kernel.org (open list:HARDWARE MONITORING),
linux-doc@vger.kernel.org (open list:DOCUMENTATION),
OpenBMC Maillist <openbmc@lists.ozlabs.org>
Cc: Open Source Submission <patches@amperecomputing.com>,
Phong Vo <phong@os.amperecomputing.com>,
"Thang Q . Nguyen" <thang@os.amperecomputing.com>
Subject: [PATCH v7 6/9] docs: misc-devices: (smpro-misc) Add documentation
Date: Mon, 21 Mar 2022 15:13:52 +0700 [thread overview]
Message-ID: <20220321081355.6802-7-quan@os.amperecomputing.com> (raw)
In-Reply-To: <20220321081355.6802-1-quan@os.amperecomputing.com>
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 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 7a6a6263cbab..284568eca747 100644
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -27,6 +27,7 @@ fit into other categories.
max6875
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..7c856eb1a7f3
--- /dev/null
+++ b/Documentation/misc-devices/smpro-misc.rst
@@ -0,0 +1,82 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+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
+ 0x01 0x02 0x808454A8
+
+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
next prev parent reply other threads:[~2022-03-21 8:15 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-21 8:13 [PATCH v7 0/9] Add Ampere's Altra SMPro MFD and its child drivers Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 1/9] hwmon: smpro: Add Ampere's Altra smpro-hwmon driver Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 2/9] docs: hwmon: (smpro-hwmon) Add documentation Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 3/9] misc: smpro-errmon: Add Ampere's SMpro error monitor driver Quan Nguyen
2022-03-21 14:24 ` kernel test robot
2022-03-21 8:13 ` [PATCH v7 4/9] docs: misc-devices: (smpro-errmon) Add documentation Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 5/9] misc: smpro-misc: Add Ampere's Altra SMpro misc driver Quan Nguyen
2022-03-21 8:21 ` Greg Kroah-Hartman
2022-03-21 9:46 ` Quan Nguyen
2022-03-21 10:02 ` Greg Kroah-Hartman
2022-03-25 7:14 ` Quan Nguyen
2022-03-21 8:13 ` Quan Nguyen [this message]
2022-03-21 8:13 ` [PATCH v7 7/9] dt-bindings: mfd: Add bindings for Ampere Altra SMPro MFD driver Quan Nguyen
2022-03-21 10:08 ` Krzysztof Kozlowski
2022-03-25 7:13 ` Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 8/9] mfd: smpro-mfd: Adds Ampere's Altra SMpro " Quan Nguyen
2022-03-21 17:38 ` kernel test robot
2022-03-21 8:13 ` [PATCH v7 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces Quan Nguyen
2022-03-21 8:23 ` Greg Kroah-Hartman
2022-03-21 9:46 ` Quan Nguyen
2022-03-21 10:03 ` Greg Kroah-Hartman
2022-03-25 7:14 ` Quan Nguyen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220321081355.6802-7-quan@os.amperecomputing.com \
--to=quan@os.amperecomputing.com \
--cc=Gustavo.Pimentel@synopsys.com \
--cc=arnd@arndb.de \
--cc=corbet@lwn.net \
--cc=derek.kiernan@xilinx.com \
--cc=devicetree@vger.kernel.org \
--cc=dragan.cvetic@xilinx.com \
--cc=gregkh@linuxfoundation.org \
--cc=jdelvare@suse.com \
--cc=krzk+dt@kernel.org \
--cc=lee.jones@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=openbmc@lists.ozlabs.org \
--cc=patches@amperecomputing.com \
--cc=phong@os.amperecomputing.com \
--cc=robh+dt@kernel.org \
--cc=thang@os.amperecomputing.com \
--cc=thu@os.amperecomputing.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).