| 1 |
.TH "libnvme" 9 "struct nvme_error_log_page" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_error_log_page \- Error Information Log Entry (Log Identifier 01h) |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_error_log_page { |
| 6 |
.br |
| 7 |
.BI " __le64 error_count;" |
| 8 |
.br |
| 9 |
.BI " __le16 sqid;" |
| 10 |
.br |
| 11 |
.BI " __le16 cmdid;" |
| 12 |
.br |
| 13 |
.BI " __le16 status_field;" |
| 14 |
.br |
| 15 |
.BI " __le16 parm_error_location;" |
| 16 |
.br |
| 17 |
.BI " __le64 lba;" |
| 18 |
.br |
| 19 |
.BI " __le32 nsid;" |
| 20 |
.br |
| 21 |
.BI " __u8 vs;" |
| 22 |
.br |
| 23 |
.BI " __u8 trtype;" |
| 24 |
.br |
| 25 |
.BI " __u8 csi;" |
| 26 |
.br |
| 27 |
.BI " __u8 opcode;" |
| 28 |
.br |
| 29 |
.BI " __le64 cs;" |
| 30 |
.br |
| 31 |
.BI " __le16 trtype_spec_info;" |
| 32 |
.br |
| 33 |
.BI " __u8 rsvd[21];" |
| 34 |
.br |
| 35 |
.BI " __u8 log_page_version;" |
| 36 |
.br |
| 37 |
.BI " |
| 38 |
}; |
| 39 |
.br |
| 40 |
|
| 41 |
.SH Members |
| 42 |
.IP "error_count" 12 |
| 43 |
Error Count: a 64-bit incrementing error count, |
| 44 |
indicating a unique identifier for this error. The error |
| 45 |
count starts at 1h, is incremented for each unique error |
| 46 |
log entry, and is retained across power off conditions. |
| 47 |
A value of 0h indicates an invalid entry; this value |
| 48 |
is used when there are lost entries or when there are |
| 49 |
fewer errors than the maximum number of entries the |
| 50 |
controller supports. If the value of this field is |
| 51 |
FFFFFFFFh, then the field shall be set to 1h when |
| 52 |
incremented (i.e., rolls over to 1h). Prior to NVMe |
| 53 |
1.4, processing of incrementing beyond FFFFFFFFh is |
| 54 |
unspecified. |
| 55 |
.IP "sqid" 12 |
| 56 |
Submission Queue ID: indicates the Submission Queue |
| 57 |
Identifier of the command that the error information is |
| 58 |
associated with. If the error is not specific to |
| 59 |
a particular command, then this field shall be set to |
| 60 |
FFFFh. |
| 61 |
.IP "cmdid" 12 |
| 62 |
Command ID: indicates the Command Identifier of the |
| 63 |
command that the error is associated with. If the error |
| 64 |
is not specific to a particular command, then this field |
| 65 |
shall be set to FFFFh. |
| 66 |
.IP "status_field" 12 |
| 67 |
Bits 15-1: Status Field: indicates the Status Field for |
| 68 |
the command that completed. If the error is not specific |
| 69 |
to a particular command, then this field reports the most |
| 70 |
applicable status value. |
| 71 |
Bit 0: Phase Tag: may indicate the Phase Tag posted for |
| 72 |
the command. |
| 73 |
.IP "parm_error_location" 12 |
| 74 |
Parameter Error Location: indicates the byte and bit of |
| 75 |
the command parameter that the error is associated with, |
| 76 |
if applicable. If the parameter spans multiple bytes or |
| 77 |
bits, then the location indicates the first byte and bit |
| 78 |
of the parameter. |
| 79 |
Bits 10-8: Bit in command that contained the error. |
| 80 |
Valid values are 0 to 7. |
| 81 |
Bits 7-0: Byte in command that contained the error. |
| 82 |
Valid values are 0 to 63. |
| 83 |
.IP "lba" 12 |
| 84 |
LBA: This field indicates the first LBA that experienced |
| 85 |
the error condition, if applicable. |
| 86 |
.IP "nsid" 12 |
| 87 |
Namespace: This field indicates the NSID of the namespace |
| 88 |
that the error is associated with, if applicable. |
| 89 |
.IP "vs" 12 |
| 90 |
Vendor Specific Information Available: If there is |
| 91 |
additional vendor specific error information available, |
| 92 |
this field provides the log page identifier associated |
| 93 |
with that page. A value of 0h indicates that no additional |
| 94 |
information is available. Valid values are in the range |
| 95 |
of 80h to FFh. |
| 96 |
.IP "trtype" 12 |
| 97 |
Transport Type (TRTYPE): indicates the Transport Type of |
| 98 |
the transport associated with the error. The values in |
| 99 |
this field are the same as the TRTYPE values in the |
| 100 |
Discovery Log Page Entry. If the error is not transport |
| 101 |
related, this field shall be cleared to 0h. If the error |
| 102 |
is transport related, this field shall be set to the type |
| 103 |
of the transport - see \fIenum nvme_trtype\fP. |
| 104 |
.IP "csi" 12 |
| 105 |
Command Set Indicator: This field contains command set |
| 106 |
indicator for the command that the error is associated |
| 107 |
with. |
| 108 |
.IP "opcode" 12 |
| 109 |
Opcode: This field contains opcode for the command that |
| 110 |
the error is associated with. |
| 111 |
.IP "cs" 12 |
| 112 |
Command Specific Information: This field contains command |
| 113 |
specific information. If used, the command definition |
| 114 |
specifies the information returned. |
| 115 |
.IP "trtype_spec_info" 12 |
| 116 |
Transport Type Specific Information |
| 117 |
.IP "rsvd" 12 |
| 118 |
Reserved: [62:42] |
| 119 |
.IP "log_page_version" 12 |
| 120 |
This field shall be set to 1h. If set, \fIcsi\fP and \fIopcode\fP |
| 121 |
will have valid values. |