summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-vs-temperature-stats.1
blob: c7fc3e3f125f20efbed8d4b8af62deab6c5b641d (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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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: 07/14/2022
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-WDC\-VS\-TEMPE" "1" "07/14/2022" "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\&.