1 files changed, 179 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-vs-temperature-stats.1 b/Documentation/nvme-wdc-vs-temperature-stats.1
new file mode 100644
index 0000000..4206337
--- /dev/null
+++ b/Documentation/nvme-wdc-vs-temperature-stats.1
@@ -0,0 +1,179 @@
+'\" t
+.\"     Title: nvme-wdc-vs-temperature-stats
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 02/14/2024
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-WDC\-VS\-TEMPE" "1" "02/14/2024" "NVMe" "NVMe Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nvme-wdc-vs-temperature-stats \- Display temperature\-related statistics
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme wdc vs\-temperature\-stats\fR <device>
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, displays temperature statistics\&.
+.sp
+The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
+.sp
+This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
+.sp
+Expected status and description :\-
+.TS
+allbox tab(:);
+ltB ltB.
+T{
+Statistic
+T}:T{
+Description
+T}
+.T&
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt.
+T{
+.sp
+The current composite temperature
+T}:T{
+.sp
+device temperature
+T}
+T{
+.sp
+Warning Composite TEMPerature threshold
+T}:T{
+.sp
+temp of overheating
+T}
+T{
+.sp
+Critical Composite TEMPerature threshold
+T}:T{
+.sp
+temp of critical overheating
+T}
+T{
+.sp
+Device Initiated Thermal Throttling support status
+T}:T{
+.sp
+0 = unsupported, 1 = supported
+T}
+T{
+.sp
+Host Controlled Thermal Management support
+T}:T{
+.sp
+0 = unsupported, 1 = supported
+T}
+T{
+.sp
+Thermal Management Temperature 1 (Light throttle)
+T}:T{
+.sp
+temp to start light throttle
+T}
+T{
+.sp
+Thermal Management Temperature 1 Transition Counter
+T}:T{
+.sp
+# times switched into light throttle
+T}
+T{
+.sp
+Thermal Management Temperature 1 Total Time
+T}:T{
+.sp
+# seconds spent in light throttle
+T}
+T{
+.sp
+Thermal Management Temperature 2 (Heavy throttle)
+T}:T{
+.sp
+temp to start heavy throttle
+T}
+T{
+.sp
+Thermal Management Temperature 2 Transition Counter
+T}:T{
+.sp
+# times switched into heavy throttle
+T}
+T{
+.sp
+Thermal Management Temperature 2 Total Time
+T}:T{
+.sp
+# seconds spent in heavy throttle
+T}
+T{
+.sp
+Thermal Shutdown Threshold
+T}:T{
+.sp
+temp of device shutdown
+T}
+.TE
+.sp 1
+.sp
+On success it returns 0, error code otherwise\&.
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Displays the temperature stats for the device:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme wdc vs\-temperature\-stats /dev/nvme0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of the nvme\-user suite\&.