From: jae.hyun.yoo@linux.intel.com (Jae Hyun Yoo)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH v2 6/8] [PATCH 6/8] Documentation: hwmon: Add a document for PECI hwmon client driver
Date: Wed, 21 Feb 2018 08:16:04 -0800 [thread overview]
Message-ID: <20180221161606.32247-7-jae.hyun.yoo@linux.intel.com> (raw)
In-Reply-To: <20180221161606.32247-1-jae.hyun.yoo@linux.intel.com>
This commit adds a hwmon document for a generic PECI hwmon client driver.
Signed-off-by: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
---
Documentation/hwmon/peci-hwmon | 73 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 73 insertions(+)
create mode 100644 Documentation/hwmon/peci-hwmon
diff --git a/Documentation/hwmon/peci-hwmon b/Documentation/hwmon/peci-hwmon
new file mode 100644
index 000000000000..93e587498536
--- /dev/null
+++ b/Documentation/hwmon/peci-hwmon
@@ -0,0 +1,73 @@
+Kernel driver peci-hwmon
+===============================
+
+Supported chips:
+ Any recent Intel CPU which is connected through a PECI bus.
+ Addresses scanned: PECI client address 0x30 - 0x37
+ 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, CPU cores and DIMM
+components that are accessible using the PECI Client Command Suite via the
+processor PECI client.
+
+All temperature values are given in millidegree Celsius and will be measurable
+only when the target CPU is powered on.
+
+sysfs attributes
+----------------
+
+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_input Provides current DTS thermal margin to Tcontrol of the
+ CPU package. Value 0 means it reaches to Tcontrol
+ temperature. Sub-zero value means the die temperature
+ goes across Tconrtol to Tjmax.
+temp2_min Provides the minimum DTS thermal margin to Tcontrol of
+ the CPU package.
+temp2_lcrit Provides the value when the CPU package temperature
+ reaches to Tjmax.
+
+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_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_input Provides the maximum junction temperature, Tjmax of the
+ CPU package.
+
+temp<n>_label Provides core temperature if this label indicates
+ 'Core #'.
+temp[n]_input Provides current temperature of each core.
+temp[n]_max Provides thermal control temperature of the core.
+temp[n]_crit Provides shutdown temperature of the core.
+temp[n]_crit_hyst Provides the hysteresis value from Tcontrol to Tjmax of
+ the core.
+
+temp<n>_label Provides DDR DIMM temperature if this label indicates
+ 'DIMM #'.
+temp<n>_input Provides current temperature of the DDR DIMM.
+
+Note:
+ DIMM temperature group will be appeared when the client CPU's BIOS
+ completes memory training and testing.
--
2.16.1
next prev parent reply other threads:[~2018-02-21 16:16 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-21 16:15 [PATCH v2 0/8] PECI device driver introduction Jae Hyun Yoo
2018-02-21 16:15 ` [PATCH v2 1/8] [PATCH 1/8] drivers/peci: Add support for PECI bus driver core Jae Hyun Yoo
2018-02-21 17:04 ` Andrew Lunn
2018-02-21 20:31 ` Jae Hyun Yoo
2018-02-21 21:51 ` Andrew Lunn
2018-02-21 22:03 ` Jae Hyun Yoo
2018-02-21 17:58 ` Greg KH
2018-02-21 20:42 ` Jae Hyun Yoo
2018-02-22 6:54 ` Greg KH
2018-02-22 17:20 ` Jae Hyun Yoo
2018-02-22 7:01 ` kbuild test robot
2018-02-22 7:01 ` [RFC PATCH] drivers/peci: peci_match_id() can be static kbuild test robot
2018-02-22 17:25 ` Jae Hyun Yoo
2018-03-07 3:19 ` [PATCH v2 1/8] [PATCH 1/8] drivers/peci: Add support for PECI bus driver core Julia Cartwright
2018-03-07 19:03 ` Jae Hyun Yoo
2018-02-21 16:16 ` [PATCH v2 2/8] [PATCH 2/8] Documentations: dt-bindings: Add a document of PECI adapter driver for Aspeed AST24xx/25xx SoCs Jae Hyun Yoo
2018-02-21 17:13 ` Andrew Lunn
2018-02-21 20:35 ` Jae Hyun Yoo
2018-03-06 12:40 ` Pavel Machek
2018-03-06 12:54 ` Andrew Lunn
2018-03-06 13:05 ` Pavel Machek
2018-03-06 13:19 ` Arnd Bergmann
2018-03-06 19:05 ` Jae Hyun Yoo
2018-03-07 22:11 ` Pavel Machek
2018-03-09 23:41 ` Milton Miller II
2018-03-09 23:47 ` Jae Hyun Yoo
2018-02-21 16:16 ` [PATCH v2 3/8] [PATCH 3/8] ARM: dts: aspeed: peci: Add PECI node Jae Hyun Yoo
2018-02-21 16:16 ` [PATCH v2 4/8] [PATCH 4/8] drivers/peci: Add a PECI adapter driver for Aspeed AST24xx/AST25xx Jae Hyun Yoo
2018-02-21 16:16 ` [PATCH v2 5/8] [PATCH [5/8] Documentation: dt-bindings: Add a document for PECI hwmon client driver Jae Hyun Yoo
2018-02-21 16:16 ` Jae Hyun Yoo [this message]
2018-03-06 20:28 ` [PATCH v2 6/8] [PATCH 6/8] Documentation: hwmon: " Randy Dunlap
2018-03-06 21:08 ` Jae Hyun Yoo
2018-02-21 16:16 ` [PATCH v2 7/8] [PATCH 7/8] drivers/hwmon: Add a generic " Jae Hyun Yoo
2018-02-21 18:26 ` Guenter Roeck
2018-02-21 21:24 ` Jae Hyun Yoo
2018-02-21 21:48 ` Guenter Roeck
2018-02-21 23:07 ` Jae Hyun Yoo
2018-02-22 0:37 ` Andrew Lunn
2018-02-22 1:29 ` Jae Hyun Yoo
2018-02-24 0:00 ` Miguel Ojeda
2018-02-24 9:32 ` Jae Hyun Yoo
2018-03-13 9:32 ` Stef van Os
2018-03-13 18:56 ` Jae Hyun Yoo
2018-02-21 16:16 ` [PATCH v2 8/8] [PATCH 8/8] Add a maintainer for the PECI subsystem Jae Hyun Yoo
2018-03-06 12:40 ` [PATCH v2 0/8] PECI device driver introduction Pavel Machek
2018-03-06 19:21 ` Jae Hyun Yoo
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=20180221161606.32247-7-jae.hyun.yoo@linux.intel.com \
--to=jae.hyun.yoo@linux.intel.com \
--cc=linux-arm-kernel@lists.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).