| 1 |
.TH "libnvme" 9 "enum nvme_sanitize_ssi" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
enum nvme_sanitize_ssi \- Sanitize State Information (SSI) |
| 4 |
.SH SYNOPSIS |
| 5 |
enum nvme_sanitize_ssi { |
| 6 |
.br |
| 7 |
.BI " NVME_SANITIZE_SSI_SANS_SHIFT" |
| 8 |
, |
| 9 |
.br |
| 10 |
.br |
| 11 |
.BI " NVME_SANITIZE_SSI_SANS_MASK" |
| 12 |
, |
| 13 |
.br |
| 14 |
.br |
| 15 |
.BI " NVME_SANITIZE_SSI_FAILS_SHIFT" |
| 16 |
, |
| 17 |
.br |
| 18 |
.br |
| 19 |
.BI " NVME_SANITIZE_SSI_FAILS_MASK" |
| 20 |
, |
| 21 |
.br |
| 22 |
.br |
| 23 |
.BI " NVME_SANITIZE_SSI_IDLE" |
| 24 |
, |
| 25 |
.br |
| 26 |
.br |
| 27 |
.BI " NVME_SANITIZE_SSI_RESTRICT_PROCESSING" |
| 28 |
, |
| 29 |
.br |
| 30 |
.br |
| 31 |
.BI " NVME_SANITIZE_SSI_RESTRICT_FAILURE" |
| 32 |
, |
| 33 |
.br |
| 34 |
.br |
| 35 |
.BI " NVME_SANITIZE_SSI_UNRESTRICT_PROCESSING" |
| 36 |
, |
| 37 |
.br |
| 38 |
.br |
| 39 |
.BI " NVME_SANITIZE_SSI_UNRESTRICT_FAILURE" |
| 40 |
, |
| 41 |
.br |
| 42 |
.br |
| 43 |
.BI " NVME_SANITIZE_SSI_MEDIA_VERIFICATION" |
| 44 |
, |
| 45 |
.br |
| 46 |
.br |
| 47 |
.BI " NVME_SANITIZE_SSI_POST_VERIF_DEALLOC" |
| 48 |
|
| 49 |
}; |
| 50 |
.SH Constants |
| 51 |
.IP "NVME_SANITIZE_SSI_SANS_SHIFT" 12 |
| 52 |
Shift amount to get the value of Sanitize State |
| 53 |
from Sanitize State Information (SSI) field. |
| 54 |
.IP "NVME_SANITIZE_SSI_SANS_MASK" 12 |
| 55 |
Mask to get the value of Sanitize State from |
| 56 |
Sanitize State Information (SSI) field. |
| 57 |
.IP "NVME_SANITIZE_SSI_FAILS_SHIFT" 12 |
| 58 |
Shift amount to get the value of Failure State |
| 59 |
from Sanitize State Information (SSI) field. |
| 60 |
.IP "NVME_SANITIZE_SSI_FAILS_MASK" 12 |
| 61 |
Mask to get the value of Failure State from |
| 62 |
Sanitize State Information (SSI) field. |
| 63 |
.IP "NVME_SANITIZE_SSI_IDLE" 12 |
| 64 |
No sanitize operation is in process. |
| 65 |
.IP "NVME_SANITIZE_SSI_RESTRICT_PROCESSING" 12 |
| 66 |
The Sanitize operation is in Restricted Processing |
| 67 |
State. |
| 68 |
.IP "NVME_SANITIZE_SSI_RESTRICT_FAILURE" 12 |
| 69 |
The Sanitize operation is in Restricted Failure |
| 70 |
State. This state is entered if sanitize processing |
| 71 |
was performed in the Restricted Processing state and |
| 72 |
sanitize processing failed or a failure occurred |
| 73 |
during deallocation of media allocated for user data |
| 74 |
in the Post-Verification Deallocation state. |
| 75 |
.IP "NVME_SANITIZE_SSI_UNRESTRICT_PROCESSING" 12 |
| 76 |
The Sanitize operation is in Unrestricted Processing |
| 77 |
State. |
| 78 |
.IP "NVME_SANITIZE_SSI_UNRESTRICT_FAILURE" 12 |
| 79 |
The Sanitize operation is in Unrestricted Failure |
| 80 |
State. This state is entered if sanitize processing |
| 81 |
was performed in the Unrestricted Processing state |
| 82 |
and sanitize processing failed or a failure occurred |
| 83 |
during deallocation of media allocated for user data |
| 84 |
in the Post-Verification. |
| 85 |
.IP "NVME_SANITIZE_SSI_MEDIA_VERIFICATION" 12 |
| 86 |
The Sanitize operation is in Media Verification |
| 87 |
State. In this state, the sanitize processing |
| 88 |
completed successfully, and all media allocated for |
| 89 |
user data in the sanitization target is readable by |
| 90 |
the host for purposes of verifying sanitization. |
| 91 |
.IP "NVME_SANITIZE_SSI_POST_VERIF_DEALLOC" 12 |
| 92 |
The Sanitize operation is in Post-Verification |
| 93 |
Deallocation State. In this state, the controller |
| 94 |
shall deallocate all media allocated for user data |
| 95 |
in the sanitization target. |