| Message ID | 20200417190459.233179-2-nchatrad@amd.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v2,1/2] hwmon: Add amd_energy driver to report energy counters | expand |
On 4/17/20 12:04 PM, Naveen Krishna Chatradhi wrote: > Document amd_energy driver with all chips supported by it. > > Cc: Guenter Roeck <linux@roeck-us.net> > Signed-off-by: Naveen Krishna Chatradhi <nchatrad@amd.com> > --- > Documentation/hwmon/amd_energy.rst | 83 ++++++++++++++++++++++++++++++ > Documentation/hwmon/index.rst | 1 + > 2 files changed, 84 insertions(+) > create mode 100644 Documentation/hwmon/amd_energy.rst > > diff --git a/Documentation/hwmon/amd_energy.rst b/Documentation/hwmon/amd_energy.rst > new file mode 100644 > index 000000000000..3bd5855b4a6b > --- /dev/null > +++ b/Documentation/hwmon/amd_energy.rst > @@ -0,0 +1,83 @@ > +Kernel driver amd_energy > +========================== > + > +Supported chips: > + > +* AMD Family 17h Processors > + > + Prefix: 'amd_energy' > + > + Addresses used: RAPL MSRs > + > + Datasheets: > + > + - Processor Programming Reference (PPR) for AMD Family 17h Model 01h, Revision B1 Processors > + > + https://developer.amd.com/wp-content/resources/55570-B1_PUB.zip > + > + - Preliminary Processor Programming Reference (PPR) for AMD Family 17h Model 31h, Revision B0 Processors > + > + https://developer.amd.com/wp-content/resources/56176_ppr_Family_17h_Model_71h_B0_pub_Rev_3.06.zip > + > +Author: Naveen Krishna Chatradhi <nchatrad@amd.com> > + > +Description > +----------- > + > +The Energy driver exposes the energy counters that are > +reported via the Running Average Power Limit (RAPL) > +Model-specific Registers (MSRs) via the hardware monitor > +(HWMON) sysfs interface. > + > +1. Power, Energy and Time Units > + * MSR_RAPL_POWER_UNIT/ C001_0299: > + -> shared with all cores in the socket > + > +2. Energy consumed by each Core > + * MSR_CORE_ENERGY_STATUS/ C001_029A: > + -> 32-bitRO, Accumulator, core-level power reporting > + > +3. Energy consumed by Socket > + * MSR_PACKAGE_ENERGY_STATUS/ C001_029B: > + -> 32-bitRO, Accumulator, socket-level power reporting, > + -> shared with all cores in socket > + > +These registers are updated every 1ms and cleared on > +reset of the system. > + > +Energy Caluclation > +------------------ > + > +Energy information (in Joules) is based on the multiplier, > +1/2^ESU; where ESU is an unsigned integer read from > +MSR_RAPL_POWER_UNIT register. Default value is 10000b, > +indicating energy status unit is 15.3 micro-Joules increment. > + > +Reported values are scaled as per the formula > + > +scaled value = ((1/2^ESU) * (Raw value) * 1000000UL) in Joules > + > +Users calculate power for a given domain by calculating > + dEnergy/dTime for that domain. > + > +Sysfs attributes > +---------------- > + > +=============== ======== ===================================== > +Attribute Label Description > +=============== ======== ===================================== > + > +* For index N between [1] and [nr_cpus] > + > +=============== ======== ====================================== > +energy[N]_input EcoreX Core Energy X = [0] to [nr_cpus - 1] > + Measured input core energy > +=============== ======== ====================================== > + > +* For N between [nr_cpus] and [nr_cpus + nr_socks] > + > +=============== ======== ====================================== > +energy[N]_input EsocketX Socket Energy X = [0] to [nr_socks -1] > + Measured input socket energy > +=============== ======== ====================================== > + > diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst > index 8ef62fd39787..fc4b89810e67 100644 > --- a/Documentation/hwmon/index.rst > +++ b/Documentation/hwmon/index.rst > @@ -39,6 +39,7 @@ Hardware Monitoring Kernel Drivers > adt7470 > adt7475 > amc6821 > + amd_energy > asb100 > asc7621 > aspeed-pwm-tacho > groeck@server:~/src/linux-stable$ git am -s amd2 Applying: hwmon: (amd_energy) Add documentation .git/rebase-apply/patch:95: new blank line at EOF. + warning: 1 line adds whitespace errors. and: /home/groeck/src/linux-stable/Documentation/hwmon/amd_energy.rst:33: WARNING: Enumerated list ends without a blank line; unexpected unindent. /home/groeck/src/linux-stable/Documentation/hwmon/amd_energy.rst:37: WARNING: Enumerated list ends without a blank line; unexpected unindent. /home/groeck/src/linux-stable/Documentation/hwmon/amd_energy.rst:41: WARNING: Enumerated list ends without a blank line; unexpected unindent. Guenter
On 4/17/20 12:04 PM, Naveen Krishna Chatradhi wrote: > Document amd_energy driver with all chips supported by it. > > Cc: Guenter Roeck <linux@roeck-us.net> > Signed-off-by: Naveen Krishna Chatradhi <nchatrad@amd.com> > --- > Documentation/hwmon/amd_energy.rst | 83 ++++++++++++++++++++++++++++++ > Documentation/hwmon/index.rst | 1 + > 2 files changed, 84 insertions(+) > create mode 100644 Documentation/hwmon/amd_energy.rst > > diff --git a/Documentation/hwmon/amd_energy.rst b/Documentation/hwmon/amd_energy.rst > new file mode 100644 > index 000000000000..3bd5855b4a6b > --- /dev/null > +++ b/Documentation/hwmon/amd_energy.rst > @@ -0,0 +1,83 @@ > +Kernel driver amd_energy WARNING: Missing or malformed SPDX-License-Identifier tag in line 1 #30: FILE: Documentation/hwmon/amd_energy.rst:1: +Kernel driver amd_energy
diff --git a/Documentation/hwmon/amd_energy.rst b/Documentation/hwmon/amd_energy.rst new file mode 100644 index 000000000000..3bd5855b4a6b --- /dev/null +++ b/Documentation/hwmon/amd_energy.rst @@ -0,0 +1,83 @@ +Kernel driver amd_energy +========================== + +Supported chips: + +* AMD Family 17h Processors + + Prefix: 'amd_energy' + + Addresses used: RAPL MSRs + + Datasheets: + + - Processor Programming Reference (PPR) for AMD Family 17h Model 01h, Revision B1 Processors + + https://developer.amd.com/wp-content/resources/55570-B1_PUB.zip + + - Preliminary Processor Programming Reference (PPR) for AMD Family 17h Model 31h, Revision B0 Processors + + https://developer.amd.com/wp-content/resources/56176_ppr_Family_17h_Model_71h_B0_pub_Rev_3.06.zip + +Author: Naveen Krishna Chatradhi <nchatrad@amd.com> + +Description +----------- + +The Energy driver exposes the energy counters that are +reported via the Running Average Power Limit (RAPL) +Model-specific Registers (MSRs) via the hardware monitor +(HWMON) sysfs interface. + +1. Power, Energy and Time Units + * MSR_RAPL_POWER_UNIT/ C001_0299: + -> shared with all cores in the socket + +2. Energy consumed by each Core + * MSR_CORE_ENERGY_STATUS/ C001_029A: + -> 32-bitRO, Accumulator, core-level power reporting + +3. Energy consumed by Socket + * MSR_PACKAGE_ENERGY_STATUS/ C001_029B: + -> 32-bitRO, Accumulator, socket-level power reporting, + -> shared with all cores in socket + +These registers are updated every 1ms and cleared on +reset of the system. + +Energy Caluclation +------------------ + +Energy information (in Joules) is based on the multiplier, +1/2^ESU; where ESU is an unsigned integer read from +MSR_RAPL_POWER_UNIT register. Default value is 10000b, +indicating energy status unit is 15.3 micro-Joules increment. + +Reported values are scaled as per the formula + +scaled value = ((1/2^ESU) * (Raw value) * 1000000UL) in Joules + +Users calculate power for a given domain by calculating + dEnergy/dTime for that domain. + +Sysfs attributes +---------------- + +=============== ======== ===================================== +Attribute Label Description +=============== ======== ===================================== + +* For index N between [1] and [nr_cpus] + +=============== ======== ====================================== +energy[N]_input EcoreX Core Energy X = [0] to [nr_cpus - 1] + Measured input core energy +=============== ======== ====================================== + +* For N between [nr_cpus] and [nr_cpus + nr_socks] + +=============== ======== ====================================== +energy[N]_input EsocketX Socket Energy X = [0] to [nr_socks -1] + Measured input socket energy +=============== ======== ====================================== + diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst index 8ef62fd39787..fc4b89810e67 100644 --- a/Documentation/hwmon/index.rst +++ b/Documentation/hwmon/index.rst @@ -39,6 +39,7 @@ Hardware Monitoring Kernel Drivers adt7470 adt7475 amc6821 + amd_energy asb100 asc7621 aspeed-pwm-tacho
Document amd_energy driver with all chips supported by it. Cc: Guenter Roeck <linux@roeck-us.net> Signed-off-by: Naveen Krishna Chatradhi <nchatrad@amd.com> --- Documentation/hwmon/amd_energy.rst | 83 ++++++++++++++++++++++++++++++ Documentation/hwmon/index.rst | 1 + 2 files changed, 84 insertions(+) create mode 100644 Documentation/hwmon/amd_energy.rst