From: Naveen Krishna Chatradhi <nchatrad@amd.com>
To: linux-hwmon@vger.kernel.org
Cc: linux@roeck-us.net, Akshay Gupta <Akshay.Gupta@amd.com>,
Naveen Krishna Chatradhi <nchatrad@amd.com>
Subject: [PATCH 2/3] hwmon: sbrmi: Add Documentation
Date: Fri, 25 Jun 2021 18:55:43 +0530 [thread overview]
Message-ID: <20210625132544.18094-2-nchatrad@amd.com> (raw)
In-Reply-To: <20210625132544.18094-1-nchatrad@amd.com>
From: Akshay Gupta <Akshay.Gupta@amd.com>
- Add documentation for sbrmi module
Signed-off-by: Akshay Gupta <Akshay.Gupta@amd.com>
Signed-off-by: Naveen Krishna Chatradhi <nchatrad@amd.com>
---
Documentation/hwmon/index.rst | 1 +
Documentation/hwmon/sbrmi.rst | 79 +++++++++++++++++++++++++++++++++++
2 files changed, 80 insertions(+)
create mode 100644 Documentation/hwmon/sbrmi.rst
diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 9ed60fa84cbe..5cd4798fe193 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -158,6 +158,7 @@ Hardware Monitoring Kernel Drivers
q54sj108a2
raspberrypi-hwmon
sbtsi_temp
+ sbrmi
sch5627
sch5636
scpi-hwmon
diff --git a/Documentation/hwmon/sbrmi.rst b/Documentation/hwmon/sbrmi.rst
new file mode 100644
index 000000000000..db50393167bb
--- /dev/null
+++ b/Documentation/hwmon/sbrmi.rst
@@ -0,0 +1,79 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Kernel driver sbrmi
+===================
+
+Supported hardware:
+
+ * Sideband Remote Management Interface (SB-RMI) compliant AMD SoC
+ device connected to the BMC via the APML.
+
+ Prefix: 'sbrmi'
+
+ Addresses scanned: This driver doesn't support address scanning.
+
+ To instantiate this driver on an AMD CPU with SB-RMI
+ support, the i2c bus number would be the bus connected from the board
+ management controller (BMC) to the CPU.
+ The SMBus address is really 7 bits. Some vendors and the SMBus
+ specification show the address as 8 bits, left justified with the R/W
+ bit as a write (0) making bit 0. Some vendors use only the 7 bits
+ to describe the address.
+ As mentioned in AMD's APML specification, The SB-RMI address is
+ normally 78h(0111 100W) or 3Ch(011 1100) for socket 0 and 70h(0111 000W)
+ or 38h(011 1000) for socket 1, but it could vary based on hardware
+ address select pins.
+
+ Datasheet: The SB-RMI interface and protocol along with the Advanced
+ Platform Management Link (APML) Specification is available
+ as part of the open source SoC register reference at:
+
+ https://www.amd.com/en/support/tech-docs?keyword=55898
+
+Author: Akshay Gupta <akshay.gupta@amd.com>
+
+Description
+-----------
+
+The APML provides a way to communicate with the SB Remote Management interface
+(SB-RMI) module from the external SMBus master that can be used to report socket
+power on AMD platforms using mailbox command and resembles a typical 8-pin remote
+power sensor's I2C interface to BMC.
+
+This driver implements current power with power cap and power cap max.
+
+sysfs-Interface
+---------------
+Power sensors can be queried and set via the standard ``hwmon`` interface
+on ``sysfs``, under the directory ``/sys/class/hwmon/hwmonX`` for some value
+of ``X`` (search for the ``X`` such that ``/sys/class/hwmon/hwmonX/name`` has
+content ``sbrmi``)
+
+================ ===== ========================================================
+Name Perm Description
+================ ===== ========================================================
+power#_input RO Current Power consumed
+power#_cap RW Power limit can be set between 0 and power#_cap_max
+power#_cap_max RO Maximum powerlimit calculated and reported by the SMU FW
+================ ===== ========================================================
+
+The following example show how the 'Power' attribute from the i2c-addresses
+can be monitored using the userspace utilities like ``sensors`` binary::
+
+ # sensors
+ sbrmi-i2c-1-38
+ Adapter: bcm2835 I2C adapter
+ power1: 61.00 W (cap = 225.00 W)
+
+ sbrmi-i2c-1-3c
+ Adapter: bcm2835 I2C adapter
+ power1: 28.39 W (cap = 224.77 W)
+ #
+
+Also, Below shows how get and set the values from sysfs entries individually::
+ # cat /sys/class/hwmon/hwmon1/power1_cap_max
+ 225000000
+
+ # echo 180000000 > /sys/class/hwmon/hwmon1/power1_cap
+ # cat /sys/class/hwmon/hwmon1/power1_cap
+ 180000000
--
2.17.1
next prev parent reply other threads:[~2021-06-25 13:26 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-25 13:25 [PATCH 1/3] hwmon: sbrmi: Add support for sbrmi power module Naveen Krishna Chatradhi
2021-06-25 13:25 ` Naveen Krishna Chatradhi [this message]
2021-06-28 15:01 ` [PATCH 2/3] hwmon: sbrmi: Add Documentation Guenter Roeck
2021-06-25 13:25 ` [PATCH 3/3] dt-bindings: sbrmi: Add SB-RMI hwmon driver bindings Naveen Krishna Chatradhi
2021-06-28 14:58 ` [PATCH 1/3] hwmon: sbrmi: Add support for sbrmi power module Guenter Roeck
2021-06-29 15:05 ` Chatradhi, Naveen Krishna
2021-07-07 14:14 ` Chatradhi, Naveen Krishna
2021-07-07 14:21 ` Guenter Roeck
2021-07-07 15:58 ` Chatradhi, Naveen Krishna
2021-07-07 15:58 ` [PATCH v2 " Naveen Krishna Chatradhi
2021-07-07 15:58 ` [PATCH v2 2/3] hwmon: sbrmi: Add Documentation Naveen Krishna Chatradhi
2021-07-07 15:58 ` [PATCH v2 3/3] dt-bindings: sbrmi: Add SB-RMI hwmon driver bindings Naveen Krishna Chatradhi
2021-07-16 5:58 ` [PATCH v2 1/3] hwmon: sbrmi: Add support for sbrmi power module Guenter Roeck
2021-07-19 15:50 ` Chatradhi, Naveen Krishna
2021-07-19 16:21 ` Guenter Roeck
2021-07-20 5:57 ` [PATCH v3 " Naveen Krishna Chatradhi
2021-07-20 5:57 ` [PATCH v3 2/3] hwmon: sbrmi: Add Documentation Naveen Krishna Chatradhi
2021-07-25 21:40 ` Guenter Roeck
2021-07-20 5:57 ` [PATCH v3 3/3] dt-bindings: sbrmi: Add SB-RMI hwmon driver bindings Naveen Krishna Chatradhi
2021-07-25 21:36 ` Guenter Roeck
2021-07-26 4:36 ` Chatradhi, Naveen Krishna
2021-07-26 4:58 ` Guenter Roeck
2021-07-25 21:38 ` [PATCH v3 1/3] hwmon: sbrmi: Add support for sbrmi power module Guenter Roeck
2021-07-26 13:36 ` [PATCH v4 " Naveen Krishna Chatradhi
2021-07-26 13:36 ` [PATCH v4 2/3] hwmon: sbrmi: Add Documentation Naveen Krishna Chatradhi
2021-07-26 13:36 ` [PATCH v4 3/3] dt-bindings: sbrmi: Add SB-RMI hwmon driver bindings Naveen Krishna Chatradhi
2021-07-26 22:43 ` Rob Herring
2021-07-28 16:57 ` [PATCH v4 1/3] hwmon: sbrmi: Add support for sbrmi power module Guenter Roeck
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=20210625132544.18094-2-nchatrad@amd.com \
--to=nchatrad@amd.com \
--cc=Akshay.Gupta@amd.com \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux@roeck-us.net \
/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).