Edit

NVME_SECURE_ERASE_SETTINGS enumeration (nvme.h)

  • Article

Contains values that specify whether or what type of a secure erase operation should be performed as part of a Format NVM command.

The secure erase applies to all user data, regardless of location. For example, user data within an exposed Logical Block Allocation (LBA), within a cache, or within deallocated LBAs.

Syntax

typedef enum {
  NVME_SECURE_ERASE_NONE,
  NVME_SECURE_ERASE_USER_DATA,
  NVME_SECURE_ERASE_CRYPTOGRAPHIC
} NVME_SECURE_ERASE_SETTINGS;

Constants

 
NVME_SECURE_ERASE_NONE
No secure erase operation is requested.
NVME_SECURE_ERASE_USER_DATA
All user data will be erased. Contents of the user data after the erase is indeterminate. For example, the user data may be zero filled or one filled. The controller may perform a cryptographic erase when NVME_SECURE_ERASE_USER_DATA is specified, if all user data is encrypted.
NVME_SECURE_ERASE_CRYPTOGRAPHIC
All user data will be erased cryptographically. This is accomplished by deleting the encryption key.

Remarks

Use this enumeration to specify values in the SES field of the NVME_CDW10_FORMAT_NVM structure that is used in the FORMAT NVM (FORMATNVM) Admin command.

Requirements

Requirement Value
Minimum supported client Windows 10
Header nvme.h