NVMe Sanitize call returns unexpected error 0x13D

DawidW-5205 11

Hi,

I'm trying to send NVME Sanitize/BlockErase command to NVMe disk which supports that. This shall be available on regular Win11 OS and I'm running 10.0.22000.1098 (10.0.22000.1042 StorNvm driver). I'm receiving absurd last error after DeviceIoControl call: 0x013D which normally would be ERROR_MR_MID_NOT_FOUND ("The system cannot find message text for message number 0x%1 in the message file for %2."). How to understand such error code, what am I doing incorrectly? Example code:

void Msft_StorageProtocolCommand_Sanitize_Nvme(HANDLE devHandle)  
{  
    printf("\n*** STORAGE PROTOCOL COMMAND - SANITIZE (block erase) NVMe ***\n");  
  
    const size_t bufSize = offsetof(STORAGE_PROTOCOL_COMMAND, Command) + STORAGE_PROTOCOL_COMMAND_LENGTH_NVME;  
    unsigned char inBuffer[bufSize] = { 0 };  
    STORAGE_PROTOCOL_COMMAND* header = (STORAGE_PROTOCOL_COMMAND*)inBuffer;  
    header->Version = STORAGE_PROTOCOL_STRUCTURE_VERSION;  
    header->Length = sizeof(STORAGE_PROTOCOL_COMMAND);  
    header->ProtocolType = STORAGE_PROTOCOL_TYPE::ProtocolTypeNvme;  
    header->CommandLength = STORAGE_PROTOCOL_COMMAND_LENGTH_NVME;  
    header->CommandSpecific = STORAGE_PROTOCOL_SPECIFIC_NVME_ADMIN_COMMAND;  
    header->TimeOutValue = 10;  
  
    ADMIN_COMMAND* formatCommand = (ADMIN_COMMAND*)(header->Command);  
    formatCommand->CDW0.OPC.Raw = ADMIN_COMMAND_SANITIZE;  
    formatCommand->NSID = 0; // or 0  
    formatCommand->SanitizeCommand.AUSE = 0;  
    formatCommand->SanitizeCommand.NDAS = 0;  
    formatCommand->SanitizeCommand.OIPBP = 0;  
    formatCommand->SanitizeCommand.OWPASS = 0;  
    formatCommand->SanitizeCommand.SANACT = 2;  
  
    DWORD recievedLen = 0;  
    if (!DeviceIoControl(devHandle, IOCTL_STORAGE_PROTOCOL_COMMAND, inBuffer, sizeof(inBuffer), inBuffer, sizeof(inBuffer), &recievedLen, NULL))  
    {  
        DWORD err = GetLastError();  
        printf("DeviceIo err: %d\n", err);  
        return;  
    }  
  
  
    printf("Executed.\n");  
    printf("Return status: 0x%X\n", header->ReturnStatus);  
    printf("Error code: 0x%X\n", header->ErrorCode);  
    printf("Protocol return data: 0x%X\n", header->FixedProtocolReturnData);  
    printf("\n");  
}

Viorel 118K Reputation points

2022-11-03T14:55:41.22+00:00

Is ADMIN_COMMAND documented?

DawidW-5205 11

This is our own implementation of standard NVMe command struct. Nothing extraordinary.

struct ADMIN_COMMAND {  
    COMMAND_DWORD_0  CDW0;  
    U32              NSID;  
    U64              Reserved;  
    U64              MPTR;  
    U64              PRP1;  
    U64              PRP2;  
  
    union {  
        ADMIN_ABORT AdminAbort;  
        ADMIN_ASYNCHRONOUS_EVENT_INFORMATION AsynchronousEventInformation;  
        ADMIN_CREATE_IO_COMPLETION_QUEUE CreateIoCompletionQueue;  
        ADMIN_CREATE_IO_SUBMISSION_QUEUE CreateIoSubmissionQueue;  
        ADMIN_DELETE_IO_COMPLETION_QUEUE DeleteIoCompletionQueue;  
        ADMIN_DELETE_IO_SUBMISSION_QUEUE DeleteIoSubmissionQueue;  
        ADMIN_FIRMWARE_COMMIT FirmwareCommit;  
        ADMIN_FIRMWARE_IMAGE_DOWNLOAD FirmwareImageDownload;  
        ADMIN_GET_FEATURES GetFeatures;  
        ADMIN_GET_LOG_PAGE GetLogPage;  
        ADMIN_IDENTIFY Identify;  
        ADMIN_SET_FEATURES SetFeatures;  
        ADMIN_FORMAT_NVM_COMMAND FormatNvmCommand;  
        ADMIN_SECURITY_SEND_COMMAND SecuritySendCommand;  
        ADMIN_SECURITY_RECEIVE_COMMAND SecurityReceiveCommand;  
        ADMIN_SANITIZE_COMMAND SanitizeCommand;  
        ADMIN_DEVICE_SELF_TEST_COMMAND DeviceSelfTest;  
  
        struct {  
            U32 CDW10;  
            U32 CDW11;  
            U32 CDW12;  
            U32 CDW13;  
            U32 CDW14;  
            U32 CDW15;  
        } Raw;  
    };  
  
};

Viorel 118K Reputation points

2022-11-03T20:30:30.66+00:00

Is STORAGE_PROTOCOL_COMMAND_LENGTH_NVME large enough to hold an ADMIN_COMMAND?
DawidW-5205 11 Reputation points

2022-11-04T09:58:21.167+00:00
We hope so.

But still the point is that we receive meaningless error code. Even if we made some mistake in a inBuffer or IO code it shall not return 0x13d code. That's why I suspect some issue in MSFT code handling this.

On our side:

static_assert(sizeof(ADMIN_COMMAND) == 64, "Admin Command struct is incorrect size");

MSFT header:

// // Command Length for Storage Protocols. // #define STORAGE_PROTOCOL_COMMAND_LENGTH_NVME 0x40 // NVMe commands are always 64 bytes.

6 answers

MaoliWolf 0 Reputation points

2024-08-15T08:05:35.23+00:00

I'm also getting the same error 13D, but something is weird:

The program about sanitizing the NVMe device we built runs successfully once and the SSD was sanitized, then the program got the error 13D forever, if the sanitize command can only send in Win PE, how can that happen?

Did I miss something?
Please sign in to rate this answer.

0 comments No comments
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

NVMe Sanitize call returns unexpected error 0x13D

6 answers

Your answer