summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-vs-temperature-stats.txt
blob: 1d000e30374f210a4ad67e03bdbbfafe390eda4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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.