---
name: "nvme_sanitize_sstat"
section: "2"
platform: "linux"
package: "libnvme-dev"
version: "1.13-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/nvme_sanitize_sstat"
---

# nvme\_sanitize\_sstat(2)

Sanitize Status (SSTAT)

## NAME

enum nvme\_sanitize\_sstat - Sanitize Status (SSTAT)

## SYNOPSIS

enum nvme\_sanitize\_sstat {\
     **NVME\_SANITIZE\_SSTAT\_STATUS\_SHIFT** , \
\
     **NVME\_SANITIZE\_SSTAT\_STATUS\_MASK** , \
\
     **NVME\_SANITIZE\_SSTAT\_STATUS\_NEVER\_SANITIZED** , \
\
     **NVME\_SANITIZE\_SSTAT\_STATUS\_COMPLETE\_SUCCESS** , \
\
     **NVME\_SANITIZE\_SSTAT\_STATUS\_IN\_PROGESS** , \
\
     **NVME\_SANITIZE\_SSTAT\_STATUS\_COMPLETED\_FAILED** , \
\
     **NVME\_SANITIZE\_SSTAT\_STATUS\_ND\_COMPLETE\_SUCCESS** , \
\
     **NVME\_SANITIZE\_SSTAT\_COMPLETED\_PASSES\_SHIFT** , \
\
     **NVME\_SANITIZE\_SSTAT\_COMPLETED\_PASSES\_MASK** , \
\
     **NVME\_SANITIZE\_SSTAT\_GLOBAL\_DATA\_ERASED\_SHIFT** , \
\
     **NVME\_SANITIZE\_SSTAT\_GLOBAL\_DATA\_ERASED\_MASK** , \
\
     **NVME\_SANITIZE\_SSTAT\_GLOBAL\_DATA\_ERASED** , \
\
     **NVME\_SANITIZE\_SSTAT\_MVCNCLD\_SHIFT** , \
\
     **NVME\_SANITIZE\_SSTAT\_MVCNCLD\_MASK**

};

## Constants

- NVME\_SANITIZE\_SSTAT\_STATUS\_SHIFT

  Shift amount to get the status value of the most recent sanitize operation from the *struct nvme\_sanitize\_log\_page*.sstat field.

- NVME\_SANITIZE\_SSTAT\_STATUS\_MASK

  Mask to get the status value of the most recent sanitize operation.

- NVME\_SANITIZE\_SSTAT\_STATUS\_NEVER\_SANITIZED

  The NVM subsystem has never been sanitized.

- NVME\_SANITIZE\_SSTAT\_STATUS\_COMPLETE\_SUCCESS

  The most recent sanitize operation completed successfully including any additional media modification.

- NVME\_SANITIZE\_SSTAT\_STATUS\_IN\_PROGESS

  A sanitize operation is currently in progress.

- NVME\_SANITIZE\_SSTAT\_STATUS\_COMPLETED\_FAILED

  The most recent sanitize operation failed.

- NVME\_SANITIZE\_SSTAT\_STATUS\_ND\_COMPLETE\_SUCCESS

  The most recent sanitize operation for which No-Deallocate After Sanitize was requested has completed successfully with deallocation of all user data.

- NVME\_SANITIZE\_SSTAT\_COMPLETED\_PASSES\_SHIFT

  Shift amount to get the number of completed passes if the most recent sanitize operation was an Overwrite. This value shall be cleared to 0h if the most recent sanitize operation was not an Overwrite.

- NVME\_SANITIZE\_SSTAT\_COMPLETED\_PASSES\_MASK

  Mask to get the number of completed passes.

- NVME\_SANITIZE\_SSTAT\_GLOBAL\_DATA\_ERASED\_SHIFT

  Shift amount to get the Global Data Erased value from the *struct nvme\_sanitize\_log\_page*.sstat field.

- NVME\_SANITIZE\_SSTAT\_GLOBAL\_DATA\_ERASED\_MASK

  Mask to get the Global Data Erased value.

- NVME\_SANITIZE\_SSTAT\_GLOBAL\_DATA\_ERASED

  Global Data Erased: if set, then no namespace user data in the NVM subsystem has been written to and no Persistent Memory Region in the NVM subsystem has been enabled since being manufactured and the NVM subsystem has never been sanitized; or since the most recent successful sanitize operation.

- NVME\_SANITIZE\_SSTAT\_MVCNCLD\_SHIFT

  Shift amount to get the value of Media Verification Canceled bit of Sanitize status field.

- NVME\_SANITIZE\_SSTAT\_MVCNCLD\_MASK

  Mask to get the value of Media Verification Canceled bit of Sanitize status field.