1libnvme(9)                        API Manual                        libnvme(9)
2
3
4

NAME

6       enum nvme_sanitize_sstat - Sanitize Status (SSTAT)
7

SYNOPSIS

9       enum nvme_sanitize_sstat {
10           NVME_SANITIZE_SSTAT_STATUS_SHIFT ,
11           NVME_SANITIZE_SSTAT_STATUS_MASK ,
12           NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED ,
13           NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS ,
14           NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS ,
15           NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED ,
16           NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESS ,
17           NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT ,
18           NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK ,
19           NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFT ,
20           NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASK ,
21           NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED
22
23       };
24

Constants

26       NVME_SANITIZE_SSTAT_STATUS_SHIFT
27                   Shift  amount  to  get  the status value of the most recent
28                   sanitize   operation    from    the    struct    nvme_sani‐
29                   tize_log_page.sstat field.
30
31       NVME_SANITIZE_SSTAT_STATUS_MASK
32                   Mask  to  get  the status value of the most recent sanitize
33                   operation.
34
35       NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED
36                   The NVM subsystem has never been sanitized.
37
38       NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS
39                   The most recent sanitize operation  completed  successfully
40                   including any additional media modification.
41
42       NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS
43                   A sanitize operation is currently in progress.
44
45       NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED
46                   The most recent sanitize operation failed.
47
48       NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESS
49                   The  most recent sanitize operation for which No-Deallocate
50                   After Sanitize was  requested  has  completed  successfully
51                   with deallocation of all user data.
52
53       NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT
54                   Shift  amount  to get the number of completed passes if the
55                   most recent sanitize operation was an Overwrite. This value
56                   shall  be  cleared to 0h if the most recent sanitize opera‐
57                   tion was not an Overwrite.
58
59       NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK
60                   Mask to get the number of completed passes.
61
62       NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFT
63                   Shift amount to get the Global Data Erased value  from  the
64                   struct nvme_sanitize_log_page.sstat field.
65
66       NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASK
67                   Mask to get the Global Data Erased value.
68
69       NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED
70                   Global  Data Erased: if set, then no namespace user data in
71                   the NVM subsystem has been written  to  and  no  Persistent
72                   Memory  Region  in the NVM subsystem has been enabled since
73                   being manufactured and the NVM  subsystem  has  never  been
74                   sanitized; or since the most recent successful sanitize op‐
75                   eration.
76
77
78
79November 2022              enum nvme_sanitize_sstat                 libnvme(9)
Impressum