libnvme(9)

💅 libnvme(9) — the API Manual, bestie edition ✨

Okay so listen. This is a page straight out of libnvme (that's the API Manual, iykyk), and today we're doing a deep dive on one very specific little enum. Grab your iced coffee 🍓, because she's niche but she matters.

---

🎀 NAME 🎀

enum nvme_sanitize_sstat — the Sanitize Status, aka SSTAT. That's it. That's her. 👑

---

✨ SYNOPSIS ✨

Here's the whole squad, exactly as declared, no edits, no cap:

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_PROGRESS ,
    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 ,
    NVME_SANITIZE_SSTAT_PRGD_SHIFT ,
    NVME_SANITIZE_SSTAT_PRGD_MASK ,
    NVME_SANITIZE_SSTAT_PRGD

};

---

🌸 Constants 🌸

Every single one of these, coming right up. No skips, no shortcuts, we don't do that here 💖

• NVME_SANITIZE_SSTAT_STATUS_SHIFT — the shift amount 💫 you use to pull the status value of the most recent sanitize operation out of the struct nvme_sanitize_log_page.sstat field. Like, that's literally its whole job.
• NVME_SANITIZE_SSTAT_STATUS_MASK — the mask 🎭 that gets you the status value of the most recent sanitize operation.
• NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED — okay so this one means the NVM subsystem has never been sanitized. Never ever. Not once. Fresh out the box energy 🍼
• NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS — the most recent sanitize operation completed successfully 🎉 including any additional media modification. She ate and left no crumbs.
• NVME_SANITIZE_SSTAT_STATUS_IN_PROGRESS — a sanitize operation is currently in progress. It's happening. Right now. Main character moment, we're mid-scene ⏳
• NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED — the most recent sanitize operation failed 😭. It's giving flop era. We don't talk about it.
• 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 ✅. Extremely thorough, we love a queen who finishes the job.
• NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT — shift amount 💫 to get the number of completed passes if the most recent sanitize operation was an Overwrite. Heads up though: this value shall be cleared to 0h if the most recent sanitize operation was not an Overwrite. Not optional, bestie, that's just the rule.
• NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK — the mask for getting the number of completed passes 🎯
• NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFT — shift amount 💫 to get the Global Data Erased value out of the struct nvme_sanitize_log_page.sstat field.
• NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASK — the mask that gets you the Global Data Erased value 🧼
• NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED — Global Data Erased: if this is 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. Read that one twice, it's a whole sentence 😅 Basically: pristine or freshly cleansed, nothing in between.
• NVME_SANITIZE_SSTAT_MVCNCLD_SHIFT — shift amount to get the value of the Media Verification Canceled bit of the Sanitize status field 🚫
• NVME_SANITIZE_SSTAT_MVCNCLD_MASK — mask to get the value of the Media Verification Canceled bit of the Sanitize status field.
• NVME_SANITIZE_SSTAT_PRGD_SHIFT — shift amount to get the Purged (PRGD) bit of the Sanitize status field 🧹
• NVME_SANITIZE_SSTAT_PRGD_MASK — mask to get the Purged (PRGD) bit of the Sanitize status field.
• NVME_SANITIZE_SSTAT_PRGD — Purged: if this is set, then the most recent sanitize operation purged user data, as defined by IEEE Std 2883, because the Purge Required (PREQ) bit was set to sanitize operation. Iconic. Certified clean 💅

---

Heads up bestie 🫶 — these are bit-level *_SHIFT / *_MASK pairs, so always shift-then-mask on the actual sstat field. Don't freestyle it, the manual says what it says and we're not adding lore that isn't there 🙈

---

🌈 Sign-off 🌈

That's the whole page, babes! This little beauty is the enum nvme_sanitize_sstat page from the libnvme API Manual, dated October 2026 — go forth, mask your bits, and slay ✨🦋💜