Scroll to navigation

libnvme(2) API Manual libnvme(2)

NAME

enum nvme_status_field - Defines all parts of the nvme status field: status code, status code type, and additional flags.

SYNOPSIS

enum nvme_status_field {
NVME_SCT_GENERIC ,
NVME_SCT_CMD_SPECIFIC ,
NVME_SCT_MEDIA ,
NVME_SCT_PATH ,
NVME_SCT_VS ,
NVME_SCT_MASK ,
NVME_SCT_SHIFT ,
NVME_SC_MASK ,
NVME_SC_SHIFT ,
NVME_SC_SUCCESS ,
NVME_SC_INVALID_OPCODE ,
NVME_SC_INVALID_FIELD ,
NVME_SC_CMDID_CONFLICT ,
NVME_SC_DATA_XFER_ERROR ,
NVME_SC_POWER_LOSS ,
NVME_SC_INTERNAL ,
NVME_SC_ABORT_REQ ,
NVME_SC_ABORT_QUEUE ,
NVME_SC_FUSED_FAIL ,
NVME_SC_FUSED_MISSING ,
NVME_SC_INVALID_NS ,
NVME_SC_CMD_SEQ_ERROR ,
NVME_SC_SGL_INVALID_LAST ,
NVME_SC_SGL_INVALID_COUNT ,
NVME_SC_SGL_INVALID_DATA ,
NVME_SC_SGL_INVALID_METADATA ,
NVME_SC_SGL_INVALID_TYPE ,
NVME_SC_CMB_INVALID_USE ,
NVME_SC_PRP_INVALID_OFFSET ,
NVME_SC_AWU_EXCEEDED ,
NVME_SC_OP_DENIED ,
NVME_SC_SGL_INVALID_OFFSET ,
NVME_SC_HOSTID_FORMAT ,
NVME_SC_KAT_EXPIRED ,
NVME_SC_KAT_INVALID ,
NVME_SC_CMD_ABORTED_PREMEPT ,
NVME_SC_SANITIZE_FAILED ,
NVME_SC_SANITIZE_IN_PROGRESS ,
NVME_SC_SGL_INVALID_GRANULARITY ,
NVME_SC_CMD_IN_CMBQ_NOT_SUPP ,
NVME_SC_NS_WRITE_PROTECTED ,
NVME_SC_CMD_INTERRUPTED ,
NVME_SC_TRAN_TPORT_ERROR ,
NVME_SC_PROHIBITED_BY_CMD_AND_FEAT ,
NVME_SC_ADMIN_CMD_MEDIA_NOT_READY ,
NVME_SC_FDP_DISABLED ,
NVME_SC_INVALID_PLACEMENT_HANDLE_LIST ,
NVME_SC_LBA_RANGE ,
NVME_SC_CAP_EXCEEDED ,
NVME_SC_NS_NOT_READY ,
NVME_SC_RESERVATION_CONFLICT ,
NVME_SC_FORMAT_IN_PROGRESS ,
NVME_SC_CQ_INVALID ,
NVME_SC_QID_INVALID ,
NVME_SC_QUEUE_SIZE ,
NVME_SC_ABORT_LIMIT ,
NVME_SC_ABORT_MISSING ,
NVME_SC_ASYNC_LIMIT ,
NVME_SC_FIRMWARE_SLOT ,
NVME_SC_FIRMWARE_IMAGE ,
NVME_SC_INVALID_VECTOR ,
NVME_SC_INVALID_LOG_PAGE ,
NVME_SC_INVALID_FORMAT ,
NVME_SC_FW_NEEDS_CONV_RESET ,
NVME_SC_INVALID_QUEUE ,
NVME_SC_FEATURE_NOT_SAVEABLE ,
NVME_SC_FEATURE_NOT_CHANGEABLE ,
NVME_SC_FEATURE_NOT_PER_NS ,
NVME_SC_FW_NEEDS_SUBSYS_RESET ,
NVME_SC_FW_NEEDS_RESET ,
NVME_SC_FW_NEEDS_MAX_TIME ,
NVME_SC_FW_ACTIVATE_PROHIBITED ,
NVME_SC_OVERLAPPING_RANGE ,
NVME_SC_NS_INSUFFICIENT_CAP ,
NVME_SC_NS_ID_UNAVAILABLE ,
NVME_SC_NS_ALREADY_ATTACHED ,
NVME_SC_NS_IS_PRIVATE ,
NVME_SC_NS_NOT_ATTACHED ,
NVME_SC_THIN_PROV_NOT_SUPP ,
NVME_SC_CTRL_LIST_INVALID ,
NVME_SC_SELF_TEST_IN_PROGRESS ,
NVME_SC_BP_WRITE_PROHIBITED ,
NVME_SC_INVALID_CTRL_ID ,
NVME_SC_INVALID_SEC_CTRL_STATE ,
NVME_SC_INVALID_CTRL_RESOURCES ,
NVME_SC_INVALID_RESOURCE_ID ,
NVME_SC_PMR_SAN_PROHIBITED ,
NVME_SC_ANA_GROUP_ID_INVALID ,
NVME_SC_ANA_ATTACH_FAILED ,
NVME_SC_INSUFFICIENT_CAP ,
NVME_SC_NS_ATTACHMENT_LIMIT_EXCEEDED ,
NVME_SC_PROHIBIT_CMD_EXEC_NOT_SUPPORTED ,
NVME_SC_IOCS_NOT_SUPPORTED ,
NVME_SC_IOCS_NOT_ENABLED ,
NVME_SC_IOCS_COMBINATION_REJECTED ,
NVME_SC_INVALID_IOCS ,
NVME_SC_ID_UNAVAILABLE ,
NVME_SC_INVALID_DISCOVERY_INFO ,
NVME_SC_ZONING_DATA_STRUCT_LOCKED ,
NVME_SC_ZONING_DATA_STRUCT_NOTFND ,
NVME_SC_INSUFFICIENT_DISC_RES ,
NVME_SC_REQSTD_FUNCTION_DISABLED ,
NVME_SC_ZONEGRP_ORIGINATOR_INVLD ,
NVME_SC_BAD_ATTRIBUTES ,
NVME_SC_INVALID_PI ,
NVME_SC_READ_ONLY ,
NVME_SC_CMD_SIZE_LIMIT_EXCEEDED ,
NVME_SC_INCOMPATIBLE_NS ,
NVME_SC_FAST_COPY_NOT_POSSIBLE ,
NVME_SC_OVERLAPPING_IO_RANGE ,
NVME_SC_INSUFFICIENT_RESOURCES ,
NVME_SC_CONNECT_FORMAT ,
NVME_SC_CONNECT_CTRL_BUSY ,
NVME_SC_CONNECT_INVALID_PARAM ,
NVME_SC_CONNECT_RESTART_DISC ,
NVME_SC_CONNECT_INVALID_HOST ,
NVME_SC_DISCONNECT_INVALID_QTYPE ,
NVME_SC_DISCOVERY_RESTART ,
NVME_SC_AUTH_REQUIRED ,
NVME_SC_ZNS_INVALID_OP_REQUEST ,
NVME_SC_ZNS_ZRWA_RESOURCES_UNAVAILABLE ,
NVME_SC_ZNS_BOUNDARY_ERROR ,
NVME_SC_ZNS_FULL ,
NVME_SC_ZNS_READ_ONLY ,
NVME_SC_ZNS_OFFLINE ,
NVME_SC_ZNS_INVALID_WRITE ,
NVME_SC_ZNS_TOO_MANY_ACTIVE ,
NVME_SC_ZNS_TOO_MANY_OPENS ,
NVME_SC_ZNS_INVAL_TRANSITION ,
NVME_SC_WRITE_FAULT ,
NVME_SC_READ_ERROR ,
NVME_SC_GUARD_CHECK ,
NVME_SC_APPTAG_CHECK ,
NVME_SC_REFTAG_CHECK ,
NVME_SC_COMPARE_FAILED ,
NVME_SC_ACCESS_DENIED ,
NVME_SC_UNWRITTEN_BLOCK ,
NVME_SC_STORAGE_TAG_CHECK ,
NVME_SC_ANA_INTERNAL_PATH_ERROR ,
NVME_SC_ANA_PERSISTENT_LOSS ,
NVME_SC_ANA_INACCESSIBLE ,
NVME_SC_ANA_TRANSITION ,
NVME_SC_CTRL_PATH_ERROR ,
NVME_SC_HOST_PATH_ERROR ,
NVME_SC_CMD_ABORTED_BY_HOST ,
NVME_SC_CRD ,
NVME_SC_MORE ,
NVME_SC_DNR

};

Constants

Generic errors applicable to multiple opcodes
Errors associated to a specific opcode
Errors associated with media and data integrity
Errors associated with the paths connection
Vendor specific errors
Mask to get the value of the Status Code Type
Shift value to get the value of the Status Code Type
Mask to get the value of the status code.
Shift value to get the value of the status code.
Successful Completion: The command completed without error.
Invalid Command Opcode: A reserved coded value or an unsupported value in the command opcode field.
Invalid Field in Command: A reserved coded value or an unsupported value in a defined field.
Command ID Conflict: The command identifier is already in use.
Data Transfer Error: Transferring the data or metadata associated with a command experienced an error.
Commands Aborted due to Power Loss Notification: Indicates that the command was aborted due to a power loss notification.
Internal Error: The command was not completed successfully due to an internal error.
Command Abort Requested: The command was aborted due to an Abort command being received that specified the Submission Queue Identifier and Command Identifier of this command.
Command Aborted due to SQ Deletion: The command was aborted due to a Delete I/O Submission Queue request received for the Submission Queue to which the command was submitted.
Command Aborted due to Failed Fused Command: The command was aborted due to the other command in a fused operation failing.
Aborted due to Missing Fused Command: The fused command was aborted due to the adjacent submission queue entry not containing a fused command that is the other command.
Invalid Namespace or Format: The namespace or the format of that namespace is invalid.
Command Sequence Error: The command was aborted due to a protocol violation in a multi-command sequence.
Invalid SGL Segment Descriptor: The command includes an invalid SGL Last Segment or SGL Segment descriptor.
Invalid Number of SGL Descriptors: There is an SGL Last Segment descriptor or an SGL Segment descriptor in a location other than the last descriptor of a segment based on the length indicated.
Data SGL Length Invalid: This may occur if the length of a Data SGL is too short. This may occur if the length of a Data SGL is too long and the controller does not support SGL transfers longer than the amount of data to be transferred as indicated in the SGL Support field of the Identify Controller data structure.
Metadata SGL Length Invalid: This may occur if the length of a Metadata SGL is too short. This may occur if the length of a Metadata SGL is too long and the controller does not support SGL transfers longer than the amount of data to be transferred as indicated in the SGL Support field of the Identify Controller data structure.
SGL Descriptor Type Invalid: The type of an SGL Descriptor is a type that is not supported by the controller.
Invalid Use of Controller Memory Buffer: The attempted use of the Controller Memory Buffer is not supported by the controller.
PRP Offset Invalid: The Offset field for a PRP entry is invalid.
Atomic Write Unit Exceeded: The length specified exceeds the atomic write unit size.
Operation Denied: The command was denied due to lack of access rights. Refer to the appropriate security specification.
SGL Offset Invalid: The offset specified in a descriptor is invalid. This may occur when using capsules for data transfers in NVMe over Fabrics implementations and an invalid offset in the capsule is specified.
Host Identifier Inconsistent Format: The NVM subsystem detected the simultaneous use of 64- bit and 128-bit Host Identifier values on different controllers.
Keep Alive Timer Expired: The Keep Alive Timer expired.
Keep Alive Timeout Invalid: The Keep Alive Timeout value specified is invalid.
Command Aborted due to Preempt and Abort: The command was aborted due to a Reservation Acquire command.
Sanitize Failed: The most recent sanitize operation failed and no recovery action has been successfully completed.
Sanitize In Progress: The requested function (e.g., command) is prohibited while a sanitize operation is in progress.
SGL Data Block Granularity Invalid: The Address alignment or Length granularity for an SGL Data Block descriptor is invalid.
Command Not Supported for Queue in CMB: The implementation does not support submission of the command to a Submission Queue in the Controller Memory Buffer or command completion to a Completion Queue in the Controller Memory Buffer.
Namespace is Write Protected: The command is prohibited while the namespace is write protected as a result of a change in the namespace write protection state as defined by the Namespace Write Protection State Machine.
Command Interrupted: Command processing was interrupted and the controller is unable to successfully complete the command. The host should retry the command.
Transient Transport Error: A transient transport error was detected. If the command is retried on the same controller, the command is likely to succeed. A command that fails with a transient transport error four or more times should be treated as a persistent transport error that is not likely to succeed if retried on the same controller.
Command Prohibited by Command and Feature Lockdown: The command was aborted due to command execution being prohibited by the Command and Feature Lockdown.
Admin Command Media Not Ready: The Admin command requires access to media and the media is not ready.
Command is not allowed when Flexible Data Placement is disabled.
The Placement Handle List is invalid due to invalid Reclaim Unit Handle Identifier or valid Reclaim Unit Handle Identifier but restricted or the Placement Handle List number of entries exceeded the maximum number allowed.
LBA Out of Range: The command references an LBA that exceeds the size of the namespace.
Capacity Exceeded: Execution of the command has caused the capacity of the namespace to be exceeded.
Namespace Not Ready: The namespace is not ready to be accessed as a result of a condition other than a condition that is reported as an Asymmetric Namespace Access condition.
Reservation Conflict: The command was aborted due to a conflict with a reservation held on the accessed namespace.
Format In Progress: A Format NVM command is in progress on the namespace.
Completion Queue Invalid: The Completion Queue identifier specified in the command does not exist.
Invalid Queue Identifier: The creation of the I/O Completion Queue failed due to an invalid queue identifier specified as part of the command. An invalid queue identifier is one that is currently in use or one that is outside the range supported by the controller.
Invalid Queue Size: The host attempted to create an I/O Completion Queue with an invalid number of entries.
Abort Command Limit Exceeded: The number of concurrently outstanding Abort commands has exceeded the limit indicated in the Identify Controller data structure.
Abort Command is missing: The abort command is missing.
Asynchronous Event Request Limit Exceeded: The number of concurrently outstanding Asynchronous Event Request commands has been exceeded.
Invalid Firmware Slot: The firmware slot indicated is invalid or read only. This error is indicated if the firmware slot exceeds the number supported.
Invalid Firmware Image: The firmware image specified for activation is invalid and not loaded by the controller.
Invalid Interrupt Vector: The creation of the I/O Completion Queue failed due to an invalid interrupt vector specified as part of the command.
Invalid Log Page: The log page indicated is invalid. This error condition is also returned if a reserved log page is requested.
Invalid Format: The LBA Format specified is not supported.
Firmware Activation Requires Conventional Reset: The firmware commit was successful, however, activation of the firmware image requires a conventional reset.
Invalid Queue Deletion: Invalid I/O Completion Queue specified to delete.
Feature Identifier Not Saveable: The Feature Identifier specified does not support a saveable value.
Feature Not Changeable: The Feature Identifier is not able to be changed.
Feature Not Namespace Specific: The Feature Identifier specified is not namespace specific. The Feature Identifier settings apply across all namespaces.
Firmware Activation Requires NVM Subsystem Reset: The firmware commit was successful, however, activation of the firmware image requires an NVM Subsystem.
Firmware Activation Requires Controller Level Reset: The firmware commit was successful; however, the image specified does not support being activated without a reset.
Firmware Activation Requires Maximum Time Violation: The image specified if activated immediately would exceed the Maximum Time for Firmware Activation (MTFA) value reported in Identify Controller.
Firmware Activation Prohibited: The image specified is being prohibited from activation by the controller for vendor specific reasons.
Overlapping Range: The downloaded firmware image has overlapping ranges.
Namespace Insufficient Capacity: Creating the namespace requires more free space than is currently available.
Namespace Identifier Unavailable: The number of namespaces supported has been exceeded.
Namespace Already Attached: The controller is already attached to the namespace specified.
Namespace Is Private: The namespace is private and is already attached to one controller.
Namespace Not Attached: The request to detach the controller could not be completed because the controller is not attached to the namespace.
Thin Provisioning Not Supported: Thin provisioning is not supported by the controller.
Controller List Invalid: The controller list provided contains invalid controller ids.
Device Self-test In Progress: The controller or NVM subsystem already has a device self-test operation in process.
Boot Partition Write Prohibited: The command is trying to modify a locked Boot Partition.
Invalid Controller Identifier:
Invalid Secondary Controller State
Invalid Number of Controller Resources
Invalid Resource Identifier
Sanitize Prohibited While Persistent Memory Region is Enabled
ANA Group Identifier Invalid: The specified ANA Group Identifier (ANAGRPID) is not supported in the submitted command.
ANA Attach Failed: The controller is not attached to the namespace as a result of an ANA condition.
Insufficient Capacity: Requested operation requires more free space than is currently available.
Namespace Attachment Limit Exceeded: Attaching the ns to a controller causes max number of ns attachments allowed to be exceeded.
Prohibition of Command Execution Not Supported
I/O Command Set Not Supported
I/O Command Set Not Enabled
I/O Command Set Combination Rejected
Invalid I/O Command Set
Identifier Unavailable
The discovery information provided in one or more extended discovery information entries is not applicable for the type of entity selected in the Entity Type (ETYPE) field of the Discovery Information Management command data portion’s header.
The requested Zoning data structure is locked on the CDC.
The requested Zoning data structure does not exist on the CDC.
The number of discover information entries provided in the data portion of the Discovery Information Management command for a registration task (i.e., TAS field cleared to 0h) exceeds the available capacity for new discovery information entries on the CDC or DDC. This may be a transient condition.
Fabric Zoning is not enabled on the CDC
The NQN contained in the ZoneGroup Originator field does not match the Host NQN used by the DDC to connect to the CDC.
Conflicting Dataset Management Attributes
Invalid Protection Information
Attempted Write to Read Only Range
Command Size Limit Exceeded
Incompatible Namespace or Format: At least one source namespace and the destination namespace have incompatible formats.
Fast Copy Not Possible: The Fast Copy Only (FCO) bit was set to ‘1’ in a Source Range entry and the controller was not able to use fast copy operations to copy the specified data.
Overlapping I/O Range: A source logical block range overlaps the destination logical block range.
Insufficient Resources: A resource shortage prevented the controller from performing the requested copy.
Incompatible Format: The NVM subsystem does not support the record format specified by the host.
Controller Busy: The controller is already associated with a host.
Connect Invalid Parameters: One or more of the command parameters.
Connect Restart Discovery: The NVM subsystem requested is not available.
Connect Invalid Host: The host is either not allowed to establish an association to any controller in the NVM subsystem or the host is not allowed to establish an association to the specified controller
Invalid Queue Type: The command was sent on the wrong queue type.
Discover Restart: The snapshot of the records is now invalid or out of date.
Authentication Required: NVMe in-band authentication is required and the queue has not yet been authenticated.
Invalid Zone Operation Request: The operation requested is invalid. This may be due to various conditions, including: attempting to allocate a ZRWA when a zone is not in the ZSE:Empty state; or invalid Flush Explicit ZRWA Range Send Zone Action operation.
ZRWA Resources Unavailable: No ZRWAs are available.
Zone Boundary Error: The command specifies logical blocks in more than one zone.
Zone Is Full: The accessed zone is in the ZSF:Full state.
Zone Is Read Only: The accessed zone is in the ZSRO:Read Only state.
Zone Is Offline: The accessed zone is in the ZSO:Offline state.
Zone Invalid Write: The write to a zone was not at the write pointer.
Too Many Active Zones: The controller does not allow additional active zones.
Too Many Open Zones: The controller does not allow additional open zones.
Invalid Zone State Transition: The request is not a valid zone state transition.
Write Fault: The write data could not be committed to the media.
Unrecovered Read Error: The read data could not be recovered from the media.
End-to-end Guard Check Error: The command was aborted due to an end-to-end guard check failure.
End-to-end Application Tag Check Error: The command was aborted due to an end-to-end application tag check failure.
End-to-end Reference Tag Check Error: The command was aborted due to an end-to-end reference tag check failure.
Compare Failure: The command failed due to a miscompare during a Compare command.
Access Denied: Access to the namespace and/or LBA range is denied due to lack of access rights.
Deallocated or Unwritten Logical Block: The command failed due to an attempt to read from or verify an LBA range containing a deallocated or unwritten logical block.
End-to-End Storage Tag Check Error: The command was aborted due to an end-to-end storage tag check failure.
Internal Path Error: The command was not completed as the result of a controller internal error that is specific to the controller processing the command.
Asymmetric Access Persistent Loss: The requested function (e.g., command) is not able to be performed as a result of the relationship between the controller and the namespace being in the ANA Persistent Loss state.
Asymmetric Access Inaccessible: The requested function (e.g., command) is not able to be performed as a result of the relationship between the controller and the namespace being in the ANA Inaccessible state.
Asymmetric Access Transition: The requested function (e.g., command) is not able to be performed as a result of the relationship between the controller and the namespace transitioning between Asymmetric Namespace Access states.
Controller Pathing Error: A pathing error was detected by the controller.
Host Pathing Error: A pathing error was detected by the host.
Command Aborted By Host: The command was aborted as a result of host action.
Mask to get value of Command Retry Delay index
More bit. If set, more status information for this command as part of the Error Information log that may be retrieved with the Get Log Page command.
Do Not Retry bit. If set, if the same command is re-submitted to any controller in the NVM subsystem, then that re-submitted command is expected to fail.
enum nvme_status_field February 2024