From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
linux-hwmon@vger.kernel.org
Subject: [PATCH v2 07/21] docs: hwmon: fam15h_power: convert to ReST format
Date: Wed, 10 Apr 2019 16:22:44 -0300 [thread overview]
Message-ID: <5ac49872dfbdb4d36868980e9a535d657a6679e0.1554923967.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1554923967.git.mchehab+samsung@kernel.org>
Convert fam15h_power to ReST format, in order to allow it to
be parsed by Sphinx.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/hwmon/fam15h_power | 85 +++++++++++++++++++++-----------
1 file changed, 57 insertions(+), 28 deletions(-)
diff --git a/Documentation/hwmon/fam15h_power b/Documentation/hwmon/fam15h_power
index fb594c281c46..fdde632c93a3 100644
--- a/Documentation/hwmon/fam15h_power
+++ b/Documentation/hwmon/fam15h_power
@@ -2,15 +2,20 @@ Kernel driver fam15h_power
==========================
Supported chips:
+
* AMD Family 15h Processors
+
* AMD Family 16h Processors
Prefix: 'fam15h_power'
+
Addresses scanned: PCI space
+
Datasheets:
- BIOS and Kernel Developer's Guide (BKDG) For AMD Family 15h Processors
- BIOS and Kernel Developer's Guide (BKDG) For AMD Family 16h Processors
- AMD64 Architecture Programmer's Manual Volume 2: System Programming
+
+ - BIOS and Kernel Developer's Guide (BKDG) For AMD Family 15h Processors
+ - BIOS and Kernel Developer's Guide (BKDG) For AMD Family 16h Processors
+ - AMD64 Architecture Programmer's Manual Volume 2: System Programming
Author: Andreas Herrmann <herrmann.der.user@googlemail.com>
@@ -31,14 +36,19 @@ For AMD Family 15h and 16h processors the following power values can
be calculated using different processor northbridge function
registers:
-* BasePwrWatts: Specifies in watts the maximum amount of power
- consumed by the processor for NB and logic external to the core.
-* ProcessorPwrWatts: Specifies in watts the maximum amount of power
- the processor can support.
-* CurrPwrWatts: Specifies in watts the current amount of power being
- consumed by the processor.
+* BasePwrWatts:
+ Specifies in watts the maximum amount of power
+ consumed by the processor for NB and logic external to the core.
+
+* ProcessorPwrWatts:
+ Specifies in watts the maximum amount of power
+ the processor can support.
+* CurrPwrWatts:
+ Specifies in watts the current amount of power being
+ consumed by the processor.
This driver provides ProcessorPwrWatts and CurrPwrWatts:
+
* power1_crit (ProcessorPwrWatts)
* power1_input (CurrPwrWatts)
@@ -53,35 +63,53 @@ calculate the average power consumed by a processor during a
measurement interval Tm. The feature of accumulated power mechanism is
indicated by CPUID Fn8000_0007_EDX[12].
-* Tsample: compute unit power accumulator sample period
-* Tref: the PTSC counter period
-* PTSC: performance timestamp counter
-* N: the ratio of compute unit power accumulator sample period to the
- PTSC period
-* Jmax: max compute unit accumulated power which is indicated by
- MaxCpuSwPwrAcc MSR C001007b
-* Jx/Jy: compute unit accumulated power which is indicated by
- CpuSwPwrAcc MSR C001007a
-* Tx/Ty: the value of performance timestamp counter which is indicated
- by CU_PTSC MSR C0010280
-* PwrCPUave: CPU average power
+* Tsample:
+ compute unit power accumulator sample period
+
+* Tref:
+ the PTSC counter period
+
+* PTSC:
+ performance timestamp counter
+
+* N:
+ the ratio of compute unit power accumulator sample period to the
+ PTSC period
+
+* Jmax:
+ max compute unit accumulated power which is indicated by
+ MaxCpuSwPwrAcc MSR C001007b
+
+* Jx/Jy:
+ compute unit accumulated power which is indicated by
+ CpuSwPwrAcc MSR C001007a
+* Tx/Ty:
+ the value of performance timestamp counter which is indicated
+ by CU_PTSC MSR C0010280
+
+* PwrCPUave:
+ CPU average power
i. Determine the ratio of Tsample to Tref by executing CPUID Fn8000_0007.
+
N = value of CPUID Fn8000_0007_ECX[CpuPwrSampleTimeRatio[15:0]].
ii. Read the full range of the cumulative energy value from the new
-MSR MaxCpuSwPwrAcc.
+ MSR MaxCpuSwPwrAcc.
+
Jmax = value returned.
+
iii. At time x, SW reads CpuSwPwrAcc MSR and samples the PTSC.
- Jx = value read from CpuSwPwrAcc and Tx = value read from
-PTSC.
+
+ Jx = value read from CpuSwPwrAcc and Tx = value read from PTSC.
iv. At time y, SW reads CpuSwPwrAcc MSR and samples the PTSC.
- Jy = value read from CpuSwPwrAcc and Ty = value read from
-PTSC.
+
+ Jy = value read from CpuSwPwrAcc and Ty = value read from PTSC.
v. Calculate the average power consumption for a compute unit over
-time period (y-x). Unit of result is uWatt.
+ time period (y-x). Unit of result is uWatt::
+
if (Jy < Jx) // Rollover has occurred
Jdelta = (Jy + Jmax) - Jx
else
@@ -90,13 +118,14 @@ time period (y-x). Unit of result is uWatt.
This driver provides PwrCPUave and interval(default is 10 millisecond
and maximum is 1 second):
+
* power1_average (PwrCPUave)
* power1_average_interval (Interval)
The power1_average_interval can be updated at /etc/sensors3.conf file
as below:
-chip "fam15h_power-*"
+chip `fam15h_power-*`
set power1_average_interval 0.01
Then save it with "sensors -s".
--
2.20.1
next prev parent reply other threads:[~2019-04-10 19:25 UTC|newest]
Thread overview: 73+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-10 19:22 [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-11 13:05 ` Liviu Dudau
2019-04-10 19:22 ` [PATCH v2 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-10 19:22 ` Mauro Carvalho Chehab [this message]
2019-04-10 19:22 ` [PATCH v2 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-11 0:27 ` Andrew Jeffery
2019-04-10 19:22 ` [PATCH v2 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-11 13:07 ` Liviu Dudau
2019-04-11 18:43 ` [PATCH v2 00/21] Convert hwmon documentation to ReST Jonathan Corbet
2019-04-11 20:43 ` Mauro Carvalho Chehab
2019-04-11 21:07 ` Guenter Roeck
2019-04-11 23:54 ` Mauro Carvalho Chehab
2019-04-12 16:04 ` Jonathan Corbet
2019-04-12 16:12 ` Guenter Roeck
2019-04-13 0:25 ` Mauro Carvalho Chehab
2019-04-13 0:52 ` Guenter Roeck
2019-04-13 3:09 ` Guenter Roeck
2019-04-16 20:19 ` Jonathan Corbet
2019-04-16 20:31 ` Guenter Roeck
2019-04-17 1:58 ` Mauro Carvalho Chehab
2019-04-17 3:49 ` Guenter Roeck
2019-04-17 9:46 ` [PATCH v3 00/21]Convert " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-17 10:24 ` Liviu Dudau
2019-04-17 10:31 ` Mauro Carvalho Chehab
2019-04-17 11:29 ` Liviu Dudau
2019-04-17 9:46 ` [PATCH v3 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-17 11:31 ` Liviu Dudau
2019-04-17 16:47 ` Guenter Roeck
2019-04-17 16:54 ` Guenter Roeck
2019-04-17 17:13 ` Mauro Carvalho Chehab
2019-04-17 17:22 ` Mauro Carvalho Chehab
2019-04-17 17:43 ` Guenter Roeck
2019-04-17 17:47 ` Guenter Roeck
2019-04-18 9:44 ` Mauro Carvalho Chehab
2019-04-18 13:36 ` Guenter Roeck
2019-04-17 9:47 ` [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
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=5ac49872dfbdb4d36868980e9a535d657a6679e0.1554923967.git.mchehab+samsung@kernel.org \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=mchehab@infradead.org \
/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).