| 1 |
.TH "libnvme" 9 "struct nvme_telemetry_log" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_telemetry_log \- Retrieve internal data specific to the manufacturer. |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_telemetry_log { |
| 6 |
.br |
| 7 |
.BI " __u8 lpi;" |
| 8 |
.br |
| 9 |
.BI " __u8 rsvd1[4];" |
| 10 |
.br |
| 11 |
.BI " __u8 ieee[3];" |
| 12 |
.br |
| 13 |
.BI " __le16 dalb1;" |
| 14 |
.br |
| 15 |
.BI " __le16 dalb2;" |
| 16 |
.br |
| 17 |
.BI " __le16 dalb3;" |
| 18 |
.br |
| 19 |
.BI " __u8 rsvd14[2];" |
| 20 |
.br |
| 21 |
.BI " __le32 dalb4;" |
| 22 |
.br |
| 23 |
.BI " __u8 rsvd20[360];" |
| 24 |
.br |
| 25 |
.BI " __u8 ths;" |
| 26 |
.br |
| 27 |
.BI " union {" |
| 28 |
.br |
| 29 |
.BI " __u8 hostdgn;" |
| 30 |
.br |
| 31 |
.BI " __u8 tcs;" |
| 32 |
.br |
| 33 |
.BI " };" |
| 34 |
.br |
| 35 |
.BI " __u8 ctrlavail;" |
| 36 |
.br |
| 37 |
.BI " __u8 ctrldgn;" |
| 38 |
.br |
| 39 |
.BI " __u8 rsnident[128];" |
| 40 |
.br |
| 41 |
.BI " __u8 data_area[];" |
| 42 |
.br |
| 43 |
.BI " |
| 44 |
}; |
| 45 |
.br |
| 46 |
|
| 47 |
.SH Members |
| 48 |
.IP "lpi" 12 |
| 49 |
Log Identifier, either NVME_LOG_LID_TELEMETRY_HOST or |
| 50 |
NVME_LOG_LID_TELEMETRY_CTRL |
| 51 |
.IP "rsvd1" 12 |
| 52 |
Reserved |
| 53 |
.IP "ieee" 12 |
| 54 |
IEEE OUI Identifier is the Organization Unique Identifier (OUI) |
| 55 |
for the controller vendor that is able to interpret the data. |
| 56 |
.IP "dalb1" 12 |
| 57 |
Telemetry Host/Controller Initiated Data Area 1 Last Block is |
| 58 |
the value of the last block in this area. |
| 59 |
.IP "dalb2" 12 |
| 60 |
Telemetry Host/Controller Initiated Data Area 1 Last Block is |
| 61 |
the value of the last block in this area. |
| 62 |
.IP "dalb3" 12 |
| 63 |
Telemetry Host/ControllerInitiated Data Area 1 Last Block is |
| 64 |
the value of the last block in this area. |
| 65 |
.IP "rsvd14" 12 |
| 66 |
Reserved |
| 67 |
.IP "dalb4" 12 |
| 68 |
Telemetry Host/Controller Initiated Data Area 4 Last Block is |
| 69 |
the value of the last block in this area. |
| 70 |
.IP "rsvd20" 12 |
| 71 |
Reserved |
| 72 |
.IP "ths" 12 |
| 73 |
Telemetry Host-Initiated Scope |
| 74 |
.IP "{unnamed_union}" 12 |
| 75 |
anonymous |
| 76 |
.IP "hostdgn" 12 |
| 77 |
Telemetry Host-Initiated Data Generation Number is a |
| 78 |
value that is incremented each time the host initiates a |
| 79 |
capture of its internal controller state in the controller. |
| 80 |
.IP "tcs" 12 |
| 81 |
Telemetry Controller-Initiated Scope |
| 82 |
.IP "ctrlavail" 12 |
| 83 |
Telemetry Controller-Initiated Data Available, if cleared, |
| 84 |
then the controller telemetry log does not contain saved |
| 85 |
internal controller state. If this field is set to 1h, the |
| 86 |
controller log contains saved internal controller state. If |
| 87 |
this field is set to 1h, the data will be latched until the |
| 88 |
host releases it by reading the log with RAE cleared. |
| 89 |
.IP "ctrldgn" 12 |
| 90 |
Telemetry Controller-Initiated Data Generation Number is |
| 91 |
a value that is incremented each time the controller initiates a |
| 92 |
capture of its internal controller state in the controller . |
| 93 |
.IP "rsnident" 12 |
| 94 |
Reason Identifiers a vendor specific identifier that describes |
| 95 |
the operating conditions of the controller at the time of |
| 96 |
capture. |
| 97 |
.IP "data_area" 12 |
| 98 |
Telemetry data blocks, vendor specific information data. |
| 99 |
.SH "Description" |
| 100 |
This log consists of a header describing the log and zero or more Telemetry |
| 101 |
Data Blocks. All Telemetry Data Blocks are NVME_LOG_TELEM_BLOCK_SIZE, 512 |
| 102 |
bytes, in size. This log captures the controller’s internal state. |