diff mbox series

[v2,4/4] hwmon: (amd_energy) Update driver documentation

Message ID 20200929105322.8919-5-nchatrad@amd.com (mailing list archive)
State Accepted
Headers show
Series hwmon: improvements to amd_energy driver | expand

Commit Message

Naveen Krishna Chatradhi Sept. 29, 2020, 10:53 a.m. UTC 
Update the documentation with the newly added features
* Set the accumulation interval based on resolution

Signed-off-by: Naveen Krishna Chatradhi <nchatrad@amd.com>
---
Changes since v1:
Dropped the accumulator status control and debugfs feature updates

 Documentation/hwmon/amd_energy.rst | 5 +++++
 1 file changed, 5 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/hwmon/amd_energy.rst b/Documentation/hwmon/amd_energy.rst
index f8288edff664..86e4ebc5cbc2 100644
--- a/Documentation/hwmon/amd_energy.rst
+++ b/Documentation/hwmon/amd_energy.rst
@@ -84,6 +84,11 @@  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. For example
+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.