Debian Codegraph @

doc/man/nvme_smart_log.2

raw
1 .TH "libnvme" 9 "struct nvme_smart_log" "November 2025" "API Manual" LINUX
2 .SH NAME
3 struct nvme_smart_log \- SMART / Health Information Log (Log Identifier 02h)
4 .SH SYNOPSIS
5 struct nvme_smart_log {
6 .br
7 .BI " __u8 critical_warning;"
8 .br
9 .BI " __u8 temperature[2];"
10 .br
11 .BI " __u8 avail_spare;"
12 .br
13 .BI " __u8 spare_thresh;"
14 .br
15 .BI " __u8 percent_used;"
16 .br
17 .BI " __u8 endu_grp_crit_warn_sumry;"
18 .br
19 .BI " __u8 rsvd7[25];"
20 .br
21 .BI " __u8 data_units_read[16];"
22 .br
23 .BI " __u8 data_units_written[16];"
24 .br
25 .BI " __u8 host_reads[16];"
26 .br
27 .BI " __u8 host_writes[16];"
28 .br
29 .BI " __u8 ctrl_busy_time[16];"
30 .br
31 .BI " __u8 power_cycles[16];"
32 .br
33 .BI " __u8 power_on_hours[16];"
34 .br
35 .BI " __u8 unsafe_shutdowns[16];"
36 .br
37 .BI " __u8 media_errors[16];"
38 .br
39 .BI " __u8 num_err_log_entries[16];"
40 .br
41 .BI " __le32 warning_temp_time;"
42 .br
43 .BI " __le32 critical_comp_time;"
44 .br
45 .BI " __le16 temp_sensor[8];"
46 .br
47 .BI " __le32 thm_temp1_trans_count;"
48 .br
49 .BI " __le32 thm_temp2_trans_count;"
50 .br
51 .BI " __le32 thm_temp1_total_time;"
52 .br
53 .BI " __le32 thm_temp2_total_time;"
54 .br
55 .BI " __u8 rsvd232[280];"
56 .br
57 .BI "
58 };
59 .br
60
61 .SH Members
62 .IP "critical_warning" 12
63 This field indicates critical warnings for the state
64 of the controller. Critical warnings may result in an
65 asynchronous event notification to the host. Bits in
66 this field represent the current associated state and
67 are not persistent (see \fIenum nvme_smart_crit\fP).
68 .IP "temperature" 12
69 Composite Temperature: Contains a value corresponding
70 to a temperature in Kelvins that represents the current
71 composite temperature of the controller and namespace(s)
72 associated with that controller. The manner in which
73 this value is computed is implementation specific and
74 may not represent the actual temperature of any physical
75 point in the NVM subsystem. Warning and critical
76 overheating composite temperature threshold values are
77 reported by the WCTEMP and CCTEMP fields in the Identify
78 Controller data structure.
79 .IP "avail_spare" 12
80 Available Spare: Contains a normalized percentage (0%
81 to 100%) of the remaining spare capacity available.
82 .IP "spare_thresh" 12
83 Available Spare Threshold: When the Available Spare
84 falls below the threshold indicated in this field, an
85 asynchronous event completion may occur. The value is
86 indicated as a normalized percentage (0% to 100%).
87 The values 101 to 255 are reserved.
88 .IP "percent_used" 12
89 Percentage Used: Contains a vendor specific estimate
90 of the percentage of NVM subsystem life used based on
91 the actual usage and the manufacturer's prediction of
92 NVM life. A value of 100 indicates that the estimated
93 endurance of the NVM in the NVM subsystem has been
94 consumed, but may not indicate an NVM subsystem failure.
95 The value is allowed to exceed 100. Percentages greater
96 than 254 shall be represented as 255. This value shall
97 be updated once per power-on hour (when the controller
98 is not in a sleep state).
99 .IP "endu_grp_crit_warn_sumry" 12
100 Endurance Group Critical Warning Summary: This field
101 indicates critical warnings for the state of Endurance
102 Groups. Bits in this field represent the current associated
103 state and are not persistent (see \fIenum nvme_smart_egcw\fP).
104 .IP "rsvd7" 12
105 Reserved
106 .IP "data_units_read" 12
107 Data Units Read: Contains the number of 512 byte data
108 units the host has read from the controller; this value
109 does not include metadata. This value is reported in
110 thousands (i.e., a value of 1 corresponds to 1000
111 units of 512 bytes read) and is rounded up (e.g., one
112 indicates the that number of 512 byte data units read
113 is from 1 to 1000, three indicates that the number of
114 512 byte data units read is from 2001 to 3000). When
115 the LBA size is a value other than 512 bytes, the
116 controller shall convert the amount of data read to
117 512 byte units. For the NVM command set, logical blocks
118 read as part of Compare, Read, and Verify operations
119 shall be included in this value. A value of 0h in
120 this field indicates that the number of Data Units Read
121 is not reported.
122 .IP "data_units_written" 12
123 Data Units Written: Contains the number of 512 byte
124 data units the host has written to the controller;
125 this value does not include metadata. This value is
126 reported in thousands (i.e., a value of 1 corresponds
127 to 1000 units of 512 bytes written) and is rounded up
128 (e.g., one indicates that the number of 512 byte data
129 units written is from 1 to 1,000, three indicates that
130 the number of 512 byte data units written is from 2001
131 to 3000). When the LBA size is a value other than 512
132 bytes, the controller shall convert the amount of data
133 written to 512 byte units. For the NVM command set,
134 logical blocks written as part of Write operations shall
135 be included in this value. Write Uncorrectable commands
136 and Write Zeroes commands shall not impact this value.
137 A value of 0h in this field indicates that the number
138 of Data Units Written is not reported.
139 .IP "host_reads" 12
140 Host Read Commands: Contains the number of read commands
141 completed by the controller. For the NVM command set,
142 this value is the sum of the number of Compare commands
143 and the number of Read commands.
144 .IP "host_writes" 12
145 Host Write Commands: Contains the number of write
146 commands completed by the controller. For the NVM
147 command set, this is the number of Write commands.
148 .IP "ctrl_busy_time" 12
149 Controller Busy Time: Contains the amount of time the
150 controller is busy with I/O commands. The controller
151 is busy when there is a command outstanding to an I/O
152 Queue (specifically, a command was issued via an I/O
153 Submission Queue Tail doorbell write and the corresponding
154 completion queue entry has not been posted yet to the
155 associated I/O Completion Queue). This value is
156 reported in minutes.
157 .IP "power_cycles" 12
158 Power Cycles: Contains the number of power cycles.
159 .IP "power_on_hours" 12
160 Power On Hours: Contains the number of power-on hours.
161 This may not include time that the controller was
162 powered and in a non-operational power state.
163 .IP "unsafe_shutdowns" 12
164 Unsafe Shutdowns: Contains the number of unsafe
165 shutdowns. This count is incremented when a Shutdown
166 Notification (CC.SHN) is not received prior to loss of power.
167 .IP "media_errors" 12
168 Media and Data Integrity Errors: Contains the number
169 of occurrences where the controller detected an
170 unrecovered data integrity error. Errors such as
171 uncorrectable ECC, CRC checksum failure, or LBA tag
172 mismatch are included in this field. Errors introduced
173 as a result of a Write Uncorrectable command may or
174 may not be included in this field.
175 .IP "num_err_log_entries" 12
176 Number of Error Information Log Entries: Contains the
177 number of Error Information log entries over the life
178 of the controller.
179 .IP "warning_temp_time" 12
180 Warning Composite Temperature Time: Contains the amount
181 of time in minutes that the controller is operational
182 and the Composite Temperature is greater than or equal
183 to the Warning Composite Temperature Threshold (WCTEMP)
184 field and less than the Critical Composite Temperature
185 Threshold (CCTEMP) field in the Identify Controller
186 data structure. If the value of the WCTEMP or CCTEMP
187 field is 0h, then this field is always cleared to 0h
188 regardless of the Composite Temperature value.
189 .IP "critical_comp_time" 12
190 Critical Composite Temperature Time: Contains the amount
191 of time in minutes that the controller is operational
192 and the Composite Temperature is greater than or equal
193 to the Critical Composite Temperature Threshold (CCTEMP)
194 field in the Identify Controller data structure. If
195 the value of the CCTEMP field is 0h, then this field
196 is always cleared to 0h regardless of the Composite
197 Temperature value.
198 .IP "temp_sensor" 12
199 Temperature Sensor 1-8: Contains the current temperature
200 in degrees Kelvin reported by temperature sensors 1-8.
201 The physical point in the NVM subsystem whose temperature
202 is reported by the temperature sensor and the temperature
203 accuracy is implementation specific. An implementation
204 that does not implement the temperature sensor reports
205 a value of 0h.
206 .IP "thm_temp1_trans_count" 12
207 Thermal Management Temperature 1 Transition Count:
208 Contains the number of times the controller transitioned
209 to lower power active power states or performed vendor
210 specific thermal management actions while minimizing
211 the impact on performance in order to attempt to reduce
212 the Composite Temperature because of the host controlled
213 thermal management feature (i.e., the Composite
214 Temperature rose above the Thermal Management
215 Temperature 1). This counter shall not wrap once the
216 value FFFFFFFFh is reached. A value of 0h, indicates
217 that this transition has never occurred or this field
218 is not implemented.
219 .IP "thm_temp2_trans_count" 12
220 Thermal Management Temperature 2 Transition Count
221 .IP "thm_temp1_total_time" 12
222 Total Time For Thermal Management Temperature 1:
223 Contains the number of seconds that the controller
224 had transitioned to lower power active power states or
225 performed vendor specific thermal management actions
226 while minimizing the impact on performance in order to
227 attempt to reduce the Composite Temperature because of
228 the host controlled thermal management feature. This
229 counter shall not wrap once the value FFFFFFFFh is
230 reached. A value of 0h, indicates that this transition
231 has never occurred or this field is not implemented.
232 .IP "thm_temp2_total_time" 12
233 Total Time For Thermal Management Temperature 2
234 .IP "rsvd232" 12
235 Reserved