This commit adds hwmon documents for PECI cputemp and dimmtemp drivers.

Signed-off-by: Jae Hyun Yoo <jae.hyun....@linux.intel.com>
Reviewed-by: Haiyue Wang <haiyue.w...@linux.intel.com>
Reviewed-by: James Feist <james.fe...@linux.intel.com>
Reviewed-by: Vernon Mauery <vernon.mau...@linux.intel.com>
Cc: Alan Cox <a...@linux.intel.com>
Cc: Andrew Jeffery <and...@aj.id.au>
Cc: Andrew Lunn <and...@lunn.ch>
Cc: Andy Shevchenko <andriy.shevche...@intel.com>
Cc: Arnd Bergmann <a...@arndb.de>
Cc: Benjamin Herrenschmidt <b...@kernel.crashing.org>
Cc: Fengguang Wu <fengguang...@intel.com>
Cc: Greg KH <gre...@linuxfoundation.org>
Cc: Guenter Roeck <li...@roeck-us.net>
Cc: Jason M Biils <jason.m.bi...@linux.intel.com>
Cc: Jean Delvare <jdelv...@suse.com>
Cc: Joel Stanley <j...@jms.id.au>
Cc: Julia Cartwright <jul...@eso.teric.us>
Cc: Miguel Ojeda <miguel.ojeda.sando...@gmail.com>
Cc: Milton Miller II <milt...@us.ibm.com>
Cc: Pavel Machek <pa...@ucw.cz>
Cc: Randy Dunlap <rdun...@infradead.org>
Cc: Stef van Os <stef.van...@prodrive-technologies.com>
Cc: Sumeet R Pawnikar <sumeet.r.pawni...@intel.com>
---
 Documentation/hwmon/peci-cputemp  | 88 +++++++++++++++++++++++++++++++++++++++
 Documentation/hwmon/peci-dimmtemp | 50 ++++++++++++++++++++++
 2 files changed, 138 insertions(+)
 create mode 100644 Documentation/hwmon/peci-cputemp
 create mode 100644 Documentation/hwmon/peci-dimmtemp

diff --git a/Documentation/hwmon/peci-cputemp b/Documentation/hwmon/peci-cputemp
new file mode 100644
index 000000000000..cdd5ea49a4a2
--- /dev/null
+++ b/Documentation/hwmon/peci-cputemp
@@ -0,0 +1,88 @@
+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 Bronze family
+                       Intel Xeon Silver family
+                       Intel Xeon Gold family
+                       Intel Xeon Platinum family
+       Addresses scanned: PECI client address 0x30 - 0x37
+       Datasheet: Available from http://www.intel.com/design/literature.htm
+
+Author:
+       Jae Hyun Yoo <jae.hyun....@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 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_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 margin"
+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_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-*]_label                Provides string "Core X", where X is resolved 
core
+                       number.
+temp[6-*]_input                Provides current temperature of each core.
+temp[6-*]_max          Provides thermal control temperature of the core.
+temp[6-*]_crit         Provides shutdown temperature of the core.
+temp[6-*]_crit_hyst    Provides the hysteresis value from Tcontrol to Tjmax of
+                       the core.
diff --git a/Documentation/hwmon/peci-dimmtemp 
b/Documentation/hwmon/peci-dimmtemp
new file mode 100644
index 000000000000..c54f2526188c
--- /dev/null
+++ b/Documentation/hwmon/peci-dimmtemp
@@ -0,0 +1,50 @@
+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 Bronze family
+                       Intel Xeon Silver family
+                       Intel Xeon Gold family
+                       Intel Xeon Platinum family
+       Addresses scanned: PECI client address 0x30 - 0x37
+       Datasheet: Available from http://www.intel.com/design/literature.htm
+
+Author:
+       Jae Hyun Yoo <jae.hyun....@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
+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
+----------------
+
+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.
+
+Note:
+       DIMM temperature attributes will appear when the client CPU's BIOS
+       completes memory training and testing.
-- 
2.16.2

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to