diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-07-02 20:49:35 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-07-02 20:49:35 +0000 |
commit | f2c543b4ccad3b9f8871d952cddf66b3b438595b (patch) | |
tree | c3c363d1cc72514221685c42a79a19b320114acc /Documentation/nvme-wdc-vs-temperature-stats.txt | |
parent | Adding debian version 1.12-8. (diff) | |
download | nvme-cli-f2c543b4ccad3b9f8871d952cddf66b3b438595b.tar.xz nvme-cli-f2c543b4ccad3b9f8871d952cddf66b3b438595b.zip |
Merging upstream version 1.14.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-wdc-vs-temperature-stats.txt')
-rw-r--r-- | Documentation/nvme-wdc-vs-temperature-stats.txt | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-vs-temperature-stats.txt b/Documentation/nvme-wdc-vs-temperature-stats.txt new file mode 100644 index 0000000..1d000e3 --- /dev/null +++ b/Documentation/nvme-wdc-vs-temperature-stats.txt @@ -0,0 +1,78 @@ +nvme-wdc-vs-temperature-stats(1) +================================ + +NAME +---- +nvme-wdc-vs-temperature-stats - Display temperature-related statistics + +SYNOPSIS +-------- +[verse] +'nvme wdc vs-temperature-stats' <device> + +DESCRIPTION +----------- + +For the NVMe device given, displays temperature statistics. + +The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0). + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +Expected status and description :- + +[cols="2*", options="header"] +|=== +|Statistic |Description + +|The current composite temperature +|device temperature + +|Warning Composite TEMPerature threshold +|temp of overheating + +|Critical Composite TEMPerature threshold +|temp of critical overheating + +|Device Initiated Thermal Throttling support status +|0 = unsupported, 1 = supported + +|Host Controlled Thermal Management support +|0 = unsupported, 1 = supported + +|Thermal Management Temperature 1 (Light throttle) +|temp to start light throttle + +|Thermal Management Temperature 1 Transition Counter +|# times switched into light throttle + +|Thermal Management Temperature 1 Total Time +|# seconds spent in light throttle + +|Thermal Management Temperature 2 (Heavy throttle) +|temp to start heavy throttle + +|Thermal Management Temperature 2 Transition Counter +|# times switched into heavy throttle + +|Thermal Management Temperature 2 Total Time +|# seconds spent in heavy throttle + +|Thermal Shutdown Threshold +|temp of device shutdown +|=== + +On success it returns 0, error code otherwise. + +EXAMPLES +-------- +* Displays the temperature stats for the device: ++ +------------ +# nvme wdc vs-temperature-stats /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. |