From: Guenter Roeck <linux@roeck-us.net>
To: Zev Weiss <zweiss@equinix.com>,
Iwona Winiarska <iwona.winiarska@intel.com>
Cc: "linux-aspeed@lists.ozlabs.org" <linux-aspeed@lists.ozlabs.org>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
"openbmc@lists.ozlabs.org" <openbmc@lists.ozlabs.org>,
"x86@kernel.org" <x86@kernel.org>,
Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>,
Ingo Molnar <mingo@redhat.com>,
"devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
Jean Delvare <jdelvare@suse.com>,
Rob Herring <robh+dt@kernel.org>, Borislav Petkov <bp@alien8.de>,
Andy Lutomirski <luto@kernel.org>,
Thomas Gleixner <tglx@linutronix.de>,
Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
"linux-arm-kernel@lists.infradead.org"
<linux-arm-kernel@lists.infradead.org>,
"linux-hwmon@vger.kernel.org" <linux-hwmon@vger.kernel.org>,
Tony Luck <tony.luck@intel.com>, Andrew Jeffery <andrew@aj.id.au>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
Yazen Ghannam <yazen.ghannam@amd.com>
Subject: Re: [PATCH 13/14] docs: hwmon: Document PECI drivers
Date: Tue, 27 Jul 2021 17:49:01 -0700 [thread overview]
Message-ID: <0521a076-9772-532f-2eab-8870464ca211@roeck-us.net> (raw)
In-Reply-To: <20210727225808.GU8018@packtop>
On 7/27/21 3:58 PM, Zev Weiss wrote:
> On Mon, Jul 12, 2021 at 05:04:46PM CDT, Iwona Winiarska wrote:
>> From: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
>>
>> Add documentation for peci-cputemp driver that provides DTS thermal
>> readings for CPU packages and CPU cores and peci-dimmtemp driver that
>> provides DTS thermal readings for DIMMs.
>>
>> Signed-off-by: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
>> Co-developed-by: Iwona Winiarska <iwona.winiarska@intel.com>
>> Signed-off-by: Iwona Winiarska <iwona.winiarska@intel.com>
>> Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
>> ---
>> Documentation/hwmon/index.rst | 2 +
>> Documentation/hwmon/peci-cputemp.rst | 93 +++++++++++++++++++++++++++
>> Documentation/hwmon/peci-dimmtemp.rst | 58 +++++++++++++++++
>> MAINTAINERS | 2 +
>> 4 files changed, 155 insertions(+)
>> create mode 100644 Documentation/hwmon/peci-cputemp.rst
>> create mode 100644 Documentation/hwmon/peci-dimmtemp.rst
>>
>> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
>> index bc01601ea81a..cc76b5b3f791 100644
>> --- a/Documentation/hwmon/index.rst
>> +++ b/Documentation/hwmon/index.rst
>> @@ -154,6 +154,8 @@ Hardware Monitoring Kernel Drivers
>> pcf8591
>> pim4328
>> pm6764tr
>> + peci-cputemp
>> + peci-dimmtemp
>> pmbus
>> powr1220
>> pxe1610
>> diff --git a/Documentation/hwmon/peci-cputemp.rst b/Documentation/hwmon/peci-cputemp.rst
>> new file mode 100644
>> index 000000000000..d3a218ba810a
>> --- /dev/null
>> +++ b/Documentation/hwmon/peci-cputemp.rst
>> @@ -0,0 +1,93 @@
>> +.. SPDX-License-Identifier: GPL-2.0-only
>> +
>> +Kernel driver peci-cputemp
>> +==========================
>> +
>> +Supported chips:
>> + One of Intel server CPUs listed below which is connected to a PECI bus.
>> + * Intel Xeon E5/E7 v3 server processors
>> + Intel Xeon E5-14xx v3 family
>> + Intel Xeon E5-24xx v3 family
>> + Intel Xeon E5-16xx v3 family
>> + Intel Xeon E5-26xx v3 family
>> + Intel Xeon E5-46xx v3 family
>> + Intel Xeon E7-48xx v3 family
>> + Intel Xeon E7-88xx v3 family
>> + * Intel Xeon E5/E7 v4 server processors
>> + Intel Xeon E5-16xx v4 family
>> + Intel Xeon E5-26xx v4 family
>> + Intel Xeon E5-46xx v4 family
>> + Intel Xeon E7-48xx v4 family
>> + Intel Xeon E7-88xx v4 family
>> + * Intel Xeon Scalable server processors
>> + Intel Xeon D family
>> + Intel Xeon Bronze family
>> + Intel Xeon Silver family
>> + Intel Xeon Gold family
>> + Intel Xeon Platinum family
>> +
>> + Datasheet: Available from http://www.intel.com/design/literature.htm
>> +
>> +Author: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
>> +
>> +Description
>> +-----------
>> +
>> +This driver implements a generic PECI hwmon feature which provides Digital
>> +Thermal Sensor (DTS) thermal readings of the CPU package and CPU cores that are
>> +accessible via the processor PECI interface.
>> +
>> +All temperature values are given in millidegree Celsius and will be measurable
>> +only when the target CPU is powered on.
>> +
>> +Sysfs interface
>> +-------------------
>> +
>> +======================= =======================================================
>> +temp1_label "Die"
>> +temp1_input Provides current die temperature of the CPU package.
>> +temp1_max Provides thermal control temperature of the CPU package
>> + which is also known as Tcontrol.
>> +temp1_crit Provides shutdown temperature of the CPU package which
>> + is also known as the maximum processor junction
>> + temperature, Tjmax or Tprochot.
>> +temp1_crit_hyst Provides the hysteresis value from Tcontrol to Tjmax of
>> + the CPU package.
>> +
>> +temp2_label "DTS"
>> +temp2_input Provides current DTS temperature of the CPU package.
>
> Would this be a good place to note the slightly counter-intuitive nature
> of DTS readings? i.e. add something along the lines of "The DTS sensor
> produces a delta relative to Tjmax, so negative values are normal and
> values approaching zero are hot." (In my experience people who aren't
> already familiar with it tend to think something's wrong when a CPU
> temperature reading shows -50C.)
>
All attributes shall follow the ABI, and the driver must translate reported
values to degrees C. If those sensors do not follow the ABI and report something
else, I won't accept the driver.
Guenter
>> +temp2_max Provides thermal control temperature of the CPU package
>> + which is also known as Tcontrol.
>> +temp2_crit Provides shutdown temperature of the CPU package which
>> + is also known as the maximum processor junction
>> + temperature, Tjmax or Tprochot.
>> +temp2_crit_hyst Provides the hysteresis value from Tcontrol to Tjmax of
>> + the CPU package.
>> +
>> +temp3_label "Tcontrol"
>> +temp3_input Provides current Tcontrol temperature of the CPU
>> + package which is also known as Fan Temperature target.
>> + Indicates the relative value from thermal monitor trip
>> + temperature at which fans should be engaged.
>> +temp3_crit Provides Tcontrol critical value of the CPU package
>> + which is same to Tjmax.
>> +
>> +temp4_label "Tthrottle"
>> +temp4_input Provides current Tthrottle temperature of the CPU
>> + package. Used for throttling temperature. If this value
>> + is allowed and lower than Tjmax - the throttle will
>> + occur and reported at lower than Tjmax.
>> +
>> +temp5_label "Tjmax"
>> +temp5_input Provides the maximum junction temperature, Tjmax of the
>> + CPU package.
>> +
>> +temp[6-N]_label Provides string "Core X", where X is resolved core
>> + number.
>> +temp[6-N]_input Provides current temperature of each core.
>> +temp[6-N]_max Provides thermal control temperature of the core.
>> +temp[6-N]_crit Provides shutdown temperature of the core.
>> +temp[6-N]_crit_hyst Provides the hysteresis value from Tcontrol to Tjmax of
>> + the core.
>
> I only see *_label and *_input for the per-core temperature sensors, no
> *_max, *_crit, or *_crit_hyst.
>
>> +
>> +======================= =======================================================
>> diff --git a/Documentation/hwmon/peci-dimmtemp.rst b/Documentation/hwmon/peci-dimmtemp.rst
>> new file mode 100644
>> index 000000000000..1778d9317e43
>> --- /dev/null
>> +++ b/Documentation/hwmon/peci-dimmtemp.rst
>> @@ -0,0 +1,58 @@
>> +.. SPDX-License-Identifier: GPL-2.0
>> +
>> +Kernel driver peci-dimmtemp
>> +===========================
>> +
>> +Supported chips:
>> + One of Intel server CPUs listed below which is connected to a PECI bus.
>> + * Intel Xeon E5/E7 v3 server processors
>> + Intel Xeon E5-14xx v3 family
>> + Intel Xeon E5-24xx v3 family
>> + Intel Xeon E5-16xx v3 family
>> + Intel Xeon E5-26xx v3 family
>> + Intel Xeon E5-46xx v3 family
>> + Intel Xeon E7-48xx v3 family
>> + Intel Xeon E7-88xx v3 family
>> + * Intel Xeon E5/E7 v4 server processors
>> + Intel Xeon E5-16xx v4 family
>> + Intel Xeon E5-26xx v4 family
>> + Intel Xeon E5-46xx v4 family
>> + Intel Xeon E7-48xx v4 family
>> + Intel Xeon E7-88xx v4 family
>> + * Intel Xeon Scalable server processors
>> + Intel Xeon D family
>> + Intel Xeon Bronze family
>> + Intel Xeon Silver family
>> + Intel Xeon Gold family
>> + Intel Xeon Platinum family
>> +
>> + Datasheet: Available from http://www.intel.com/design/literature.htm
>> +
>> +Author: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
>> +
>> +Description
>> +-----------
>> +
>> +This driver implements a generic PECI hwmon feature which provides Digital
>> +Thermal Sensor (DTS) thermal readings of DIMM components that are accessible
>> +via the processor PECI interface.
>
> I had thought "DTS" referred to a fairly specific sensor in the CPU; is
> the same term also used for DIMM temp sensors or is the mention of it
> here a copy/paste error?
>
>> +
>> +All temperature values are given in millidegree Celsius and will be measurable
>> +only when the target CPU is powered on.
>> +
>> +Sysfs interface
>> +-------------------
>> +
>> +======================= =======================================================
>> +
>> +temp[N]_label Provides string "DIMM CI", where C is DIMM channel and
>> + I is DIMM index of the populated DIMM.
>> +temp[N]_input Provides current temperature of the populated DIMM.
>> +temp[N]_max Provides thermal control temperature of the DIMM.
>> +temp[N]_crit Provides shutdown temperature of the DIMM.
>> +
>> +======================= =======================================================
>> +
>> +Note:
>> + DIMM temperature attributes will appear when the client CPU's BIOS
>> + completes memory training and testing.
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index 35ba9e3646bd..d16da127bbdc 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -14509,6 +14509,8 @@ M: Iwona Winiarska <iwona.winiarska@intel.com>
>> R: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
>> L: linux-hwmon@vger.kernel.org
>> S: Supported
>> +F: Documentation/hwmon/peci-cputemp.rst
>> +F: Documentation/hwmon/peci-dimmtemp.rst
>> F: drivers/hwmon/peci/
>>
>> PECI SUBSYSTEM
>> --
>> 2.31.1
>>
>
next prev parent reply other threads:[~2021-07-28 0:49 UTC|newest]
Thread overview: 72+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-12 22:04 [PATCH 00/14] Introduce PECI subsystem Iwona Winiarska
2021-07-12 22:04 ` [PATCH 01/14] x86/cpu: Move intel-family to arch-independent headers Iwona Winiarska
2021-07-14 16:54 ` Williams, Dan J
2021-07-15 16:47 ` Winiarska, Iwona
2021-07-15 18:13 ` Dan Williams
2021-07-15 18:29 ` Luck, Tony
2021-07-12 22:04 ` [PATCH 02/14] x86/cpu: Extract cpuid helpers to arch-independent Iwona Winiarska
2021-07-14 16:58 ` Williams, Dan J
2021-07-15 16:51 ` Winiarska, Iwona
2021-07-15 16:58 ` Winiarska, Iwona
2021-07-12 22:04 ` [PATCH 03/14] dt-bindings: Add generic bindings for PECI Iwona Winiarska
2021-07-12 22:04 ` [PATCH 04/14] dt-bindings: Add bindings for peci-aspeed Iwona Winiarska
2021-07-15 16:28 ` Rob Herring
2021-07-16 21:22 ` Winiarska, Iwona
2021-07-12 22:04 ` [PATCH 05/14] ARM: dts: aspeed: Add PECI controller nodes Iwona Winiarska
2021-07-12 22:04 ` [PATCH 06/14] peci: Add core infrastructure Iwona Winiarska
2021-07-14 17:19 ` Williams, Dan J
2021-07-16 21:08 ` Winiarska, Iwona
2021-07-16 21:50 ` Dan Williams
2021-07-17 6:12 ` gregkh
2021-07-17 20:54 ` Dan Williams
2021-07-12 22:04 ` [PATCH 07/14] peci: Add peci-aspeed controller driver Iwona Winiarska
2021-07-13 5:02 ` Randy Dunlap
2021-07-15 16:42 ` Winiarska, Iwona
2021-07-14 17:39 ` Williams, Dan J
2021-07-16 21:17 ` Winiarska, Iwona
2021-07-27 8:49 ` Zev Weiss
2021-07-29 14:03 ` Winiarska, Iwona
2021-07-29 18:15 ` Zev Weiss
2021-07-12 22:04 ` [PATCH 08/14] peci: Add device detection Iwona Winiarska
2021-07-14 21:05 ` Williams, Dan J
2021-07-16 21:20 ` Winiarska, Iwona
2021-07-27 17:49 ` Zev Weiss
2021-07-29 18:55 ` Winiarska, Iwona
2021-07-29 20:50 ` Zev Weiss
2021-07-30 20:10 ` Winiarska, Iwona
2021-07-12 22:04 ` [PATCH 09/14] peci: Add support for PECI device drivers Iwona Winiarska
2021-07-27 20:10 ` Zev Weiss
2021-07-27 21:23 ` Guenter Roeck
2021-07-29 21:17 ` Winiarska, Iwona
2021-07-29 23:22 ` Zev Weiss
2021-07-30 20:13 ` Winiarska, Iwona
2021-07-12 22:04 ` [PATCH 10/14] peci: Add peci-cpu driver Iwona Winiarska
2021-07-27 11:16 ` David Müller (ELSOFT AG)
2021-07-30 20:14 ` Winiarska, Iwona
2021-07-27 21:33 ` Zev Weiss
2021-07-30 21:21 ` Winiarska, Iwona
2021-07-12 22:04 ` [PATCH 11/14] hwmon: peci: Add cputemp driver Iwona Winiarska
2021-07-15 17:45 ` Guenter Roeck
2021-07-19 20:12 ` Winiarska, Iwona
2021-07-19 20:35 ` Guenter Roeck
2021-07-27 7:06 ` Zev Weiss
2021-07-30 21:51 ` Winiarska, Iwona
2021-07-30 22:04 ` Guenter Roeck
2021-07-12 22:04 ` [PATCH 12/14] hwmon: peci: Add dimmtemp driver Iwona Winiarska
2021-07-15 17:56 ` Guenter Roeck
2021-07-19 20:31 ` Winiarska, Iwona
2021-07-19 20:36 ` Guenter Roeck
2021-07-26 22:08 ` Zev Weiss
2021-07-30 22:48 ` Winiarska, Iwona
2021-07-12 22:04 ` [PATCH 13/14] docs: hwmon: Document PECI drivers Iwona Winiarska
2021-07-27 22:58 ` Zev Weiss
2021-07-28 0:49 ` Guenter Roeck [this message]
2021-08-02 11:39 ` Winiarska, Iwona
2021-08-02 11:37 ` Winiarska, Iwona
2021-08-04 17:52 ` Zev Weiss
2021-08-04 18:05 ` Guenter Roeck
2021-08-05 21:42 ` Winiarska, Iwona
2021-07-12 22:04 ` [PATCH 14/14] docs: Add PECI documentation Iwona Winiarska
2021-07-14 16:51 ` [PATCH 00/14] Introduce PECI subsystem Williams, Dan J
2021-07-15 17:33 ` Winiarska, Iwona
2021-07-15 19:34 ` Dan Williams
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=0521a076-9772-532f-2eab-8870464ca211@roeck-us.net \
--to=linux@roeck-us.net \
--cc=andrew@aj.id.au \
--cc=andriy.shevchenko@linux.intel.com \
--cc=bp@alien8.de \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=iwona.winiarska@intel.com \
--cc=jae.hyun.yoo@linux.intel.com \
--cc=jdelvare@suse.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-aspeed@lists.ozlabs.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luto@kernel.org \
--cc=mchehab@kernel.org \
--cc=mingo@redhat.com \
--cc=openbmc@lists.ozlabs.org \
--cc=pierre-louis.bossart@linux.intel.com \
--cc=robh+dt@kernel.org \
--cc=tglx@linutronix.de \
--cc=tony.luck@intel.com \
--cc=x86@kernel.org \
--cc=yazen.ghannam@amd.com \
--cc=zweiss@equinix.com \
/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).