[PATCH 6/6] hwmon: (amd_energy) Update driver documentation

Naveen Krishna Chatradhi
2020-09-05T14:33:10Z

Update the documentation of the newly added features
1. Set the accumulation interval based on resolution
2. Debugfs entries to capture the counters of all
the cores and sockets
3. Control the software accumulation

Signed-off-by: Naveen Krishna Chatradhi <nchatrad@amd.com>
---
Documentation/hwmon/amd_energy.rst | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)

diff --git a/Documentation/hwmon/amd_energy.rst b/Documentation/hwmon/amd_energy.rst
index f8288edff664..fe145ad158dd 100644
--- a/Documentation/hwmon/amd_energy.rst
+++ b/Documentation/hwmon/amd_energy.rst
@@ -84,9 +84,28 @@ per run to a respective 64-bit counter. The kernel thread starts
running during probe, wakes up every 100secs and stops running
when driver is removed.

+Frequency of the accumulator thread is set during the probe
+based on the chosen energy unit resolution.
+A. fine grain (1.625 micro J)
+B. course grain (0.125 milli J)
+
A socket and core energy read would return the current register
value added to the respective energy accumulator.

+The energy counters of all the core and sockets are available
+under debugfs path in '/sys/kernel/debug/amd_energy/'
+
+file cenergy_dump: To print out the core energy counters
+file senergy_dump: To print out the socket energy counters
+
+Control the Energy accumulation
+---------------------------------
+
+The software accumulation of energy counters is disabled by default.
+
+A sysfs entry "accumulator_status" is provided to enable/disable
+the same.
+
Sysfs attributes
----------------

--
2.26.2