NVME_COMMAND

構造体

サイズx64: 48 バイト / x86: 48 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド	型	サイズ	x64	x86	説明
CDW0	NVME_COMMAND_DWORD0	4	+0	+0	すべての Admin コマンドおよび NVM コマンドに共通するパラメーターを格納する NVME_COMMAND_DWORD0 構造体です。
NSID	DWORD	4	+4	+4	このコマンドが適用される名前空間 ID です。名前空間 ID がコマンドで使用されない場合、このフィールドは `0h` にクリアします。コマンドがこのコントローラーからアクセス可能なすべての名前空間に適用される場合は、このフィールドを `FFFFFFFFh` に設定します。特に記載がない限り、名前空間 ID を使用するコマンドで非アクティブな名前空間 ID を指定すると、コントローラーはステータス NVME_STATUS_INVALID_FIELD_IN_COMMAND でコマンドを中止します。名前空間 ID を使用するコマンドで無効な名前空間 ID を指定すると、コントローラーはステータス NVME_STATUS_INVALID_NAMESPACE_OR_FORMAT でコマンドを中止します。
Reserved0	DWORD	8	+8	+8	将来の拡張用に予約された32ビットフィールドである。
MPTR	ULONGLONG	8	+16	+16	連続した物理メタデータバッファーのアドレスです。このフィールドは、NVME_CDW10_FORMAT_NVM コマンド構造体の MS フィールドで指定されるように、メタデータが論理ブロックデータとインターリーブされていない場合にのみ使用されます。このフィールドは Dword 境界に整列されます。
Anonymous	_Anonymous_e__Union	16	+24	+24	PRPエントリまたはSGL記述子のいずれかでデータ転送先を指定するデータポインタ共用体である。
u	_u_e__Union	8/4	+40	+40	すべてのコマンド構造体の共用体です。

共用体: _Anonymous_e__Union x64 16B / x86 16B

フィールド	型	サイズ	x64	x86	説明
Anonymous	_Anonymous_e__Struct	8/4	+0	+0	PRPエントリまたはSGL記述子のいずれかでデータ転送先を指定するデータポインタ共用体である。
SGL1	ULONGLONG	16	+0	+0

共用体: _u_e__Union x64 8B / x86 4B

フィールド	型	サイズ	x64	x86	説明
GENERAL	_GENERAL_e__Struct	8/4	+0	+0	General コマンドのデータフィールドを格納する構造体です。
IDENTIFY	_IDENTIFY_e__Struct	8/4	+0	+0	Identify コマンドのパラメーターを格納する構造体です。Identify コマンドは、NVM サブシステム、コントローラー、または名前空間に関する情報を記述するデータバッファーを返す Admin コマンドです。 Identify コマンドは、PRP Entry 1 (PRP1)、PRP Entry 2 (PRP2)、Command Dword 10 (CDW10)、および Command Dword 11 (CDW11) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
ABORT	_ABORT_e__Struct	8/4	+0	+0	Abort コマンドのパラメーターを格納する構造体です。Abort コマンドは、Admin Submission Queue または I/O Submission Queue に以前送信された特定のコマンドを中止するために使用される Admin コマンドです。 Abort コマンドは、Command Dword 10 (CDW10) フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
GETFEATURES	_GETFEATURES_e__Struct	8/4	+0	+0	Get Features コマンドのパラメーターを格納する構造体です。Get Features コマンドは、指定された機能の属性を取得する Admin コマンドです。 Get Features コマンドは、PRP Entry 1 (PRP1)、PRP Entry 2 (PRP2)、Command Dword 10 (CDW10)、および Command Dword 11 (CDW11) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
SETFEATURES	_SETFEATURES_e__Struct	8/4	+0	+0	Set Features コマンドのパラメーターを格納する構造体です。Set Features コマンドは、指定された機能の属性を設定する Admin コマンドです。 Set Features コマンドは、PRP Entry 1 (PRP1)、PRP Entry 2 (PRP2)、Command Dword 10 (CDW10)、Command Dword 11 (CDW11)、Command Dword 12 (CDW12)、Command Dword 13 (CDW13)、Command Dword 14 (CDW14)、および Command Dword 15 (CDW15) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
GETLOGPAGE	_GETLOGPAGE_e__Struct	8/4	+0	+0	Get Log Page コマンドのパラメーターを格納する構造体です。Get Log Page コマンドは、要求されたログページを格納したデータバッファーを返す Admin コマンドです。 Get Log Page コマンドは、PRP Entry 1 (PRP1)、PRP Entry 2 (PRP2)、Command Dword 10 (CDW10 および CDW10_V13)、Command Dword 11 (CDW11)、Command Dword 12 (CDW12)、および Command Dword 13 (CDW13) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
CREATEIOCQ	_CREATEIOCQ_e__Struct	8/4	+0	+0	Create IO Completion Queue コマンドのパラメーターを格納する構造体です。Create IO Completion Queue コマンドは、Admin Completion Queue を除くすべての I/O Completion Queue を作成するために使用される Admin コマンドです。 Create IO Completion Queue コマンドは、PRP Entry 1 (PRP1)、Command Dword 10 (CDW10)、および Command Dword 11 (CDW11) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
CREATEIOSQ	_CREATEIOSQ_e__Struct	8/4	+0	+0	Create IO Submission Queue コマンドのパラメーターを格納する構造体です。Create IO Submission Queue コマンドは、I/O Submission Queue を作成するために使用される Admin コマンドです。 Create IO Submission Queue コマンドは、PRP Entry 1 (PRP1)、Command Dword 10 (CDW10)、および Command Dword 11 (CDW11) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
DELETEIOQUEUE	_DELETEIOQUEUE_e__Struct	8/4	+0	+0
DATASETMANAGEMENT	_DATASETMANAGEMENT_e__Struct	8/4	+0	+0	Dataset Management コマンドのパラメーターを格納する構造体です。Dataset Management コマンドは、論理ブロックの範囲に対する属性をホストが示すために使用する NVM コマンドです。 Dataset Management コマンドは、Command Dword 10 (CDW10) および Command Dword 11 (CDW11) のフィールドを使用します。コマンドがデータ転送に PRP を使用する場合は、PRP Entry 1 (PRP1) および PRP Entry 2 (PRP2) のフィールドが使用されます。その他のコマンド固有のフィールドはすべて予約済みです。
SECURITYSEND	_SECURITYSEND_e__Struct	8/4	+0	+0	Security Send コマンドのパラメーターを格納する構造体です。Security Send コマンドは、セキュリティプロトコルデータをコントローラーに転送するために使用される Admin コマンドです。 Security Send コマンドは、PRP Entry 1 (PRP1)、PRP Entry 2 (PRP2)、Command Dword 10 (CDW10)、および Command Dword 11 (CDW11) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
SECURITYRECEIVE	_SECURITYRECEIVE_e__Struct	8/4	+0	+0	Security Receive コマンドのパラメーターを格納する構造体です。Security Receive コマンドは、以前にコントローラーへ送信された 1 つ以上の Security Send コマンドのステータスとデータ結果を転送する Admin コマンドです。 Security Receive コマンドは、PRP Entry 1 (PRP1)、PRP Entry 2 (PRP2)、Command Dword 10 (CDW10)、および Command Dword 11 (CDW11) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
FIRMWAREDOWNLOAD	_FIRMWAREDOWNLOAD_e__Struct	8/4	+0	+0	Firmware Image Download コマンドのパラメーターを格納する構造体です。Firmware Image Download コマンドは、新しいファームウェアイメージの全体または一部をコントローラーにコピーするために使用される Admin コマンドです。 Firmware Image Download コマンドは、PRP Entry 1 (PRP1)、PRP Entry 2 (PRP2)、Command Dword 10 (CDW10)、および Command Dword 11 (CDW11) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
FIRMWAREACTIVATE	_FIRMWAREACTIVATE_e__Struct	8/4	+0	+0	Firmware Commit コマンドのパラメーターを格納する構造体です。Firmware Commit コマンドは、有効なファームウェアイメージがダウンロードされたことを検証し、そのリビジョンを特定のファームウェアスロットにコミットするために使用される Admin コマンドです。メモ Firmware Commit コマンドは、以前のバージョンの NVM Express では Firmware Activate と呼ばれていました。 Firmware Commit コマンドは、Command Dword 10 (CDW10) フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
FORMATNVM	_FORMATNVM_e__Struct	8/4	+0	+0	Format NVM コマンドのパラメーターを格納する構造体です。Format NVM コマンドは、NVM メディアをローレベルフォーマットするために使用される Admin コマンドです。 Format NVM コマンドは、Command Dword 10 (CDW10) フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
DIRECTIVERECEIVE	_DIRECTIVERECEIVE_e__Struct	8/4	+0	+0	Admin コマンド Directive Receive のパラメーターを格納する構造体です。 Directive Receive コマンドは、Command Dword 10 (CDW10)、Command Dword 11 (CDW11)、および Command Dword 12 (CDW12) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
DIRECTIVESEND	_DIRECTIVESEND_e__Struct	8/4	+0	+0	Admin コマンド Directive Send のパラメーターを格納する構造体です。 Directive Send コマンドは、Command Dword 10 (CDW10)、Command Dword 11 (CDW11)、および Command Dword 12 (CDW12) の各フィールドを使用します。その他のコマンド固有のフィールドはすべて予約済みです。
SANITIZE	_SANITIZE_e__Struct	8/4	+0	+0
READWRITE	_READWRITE_e__Struct	8/4	+0	+0	指定された論理ブロックアドレス (LBA) について、データおよび該当する場合はメタデータを NVM コントローラーとの間で読み取りまたは書き込みする NVME Read コマンドおよび NVME Write コマンドのパラメーターを格納する構造体です。 NVME Read コマンドおよび NVME Write コマンドは、Command Dword 12 (CDW12)、Command Dword 13 (CDW13)、および Command Dword 14 (CDW14) の各フィールドを使用します。
RESERVATIONACQUIRE	_RESERVATIONACQUIRE_e__Struct	8/4	+0	+0
RESERVATIONREGISTER	_RESERVATIONREGISTER_e__Struct	8/4	+0	+0
RESERVATIONRELEASE	_RESERVATIONRELEASE_e__Struct	8/4	+0	+0
RESERVATIONREPORT	_RESERVATIONREPORT_e__Struct	8/4	+0	+0
ZONEMANAGEMENTSEND	_ZONEMANAGEMENTSEND_e__Struct	8/4	+0	+0
ZONEMANAGEMENTRECEIVE	_ZONEMANAGEMENTRECEIVE_e__Struct	8/4	+0	+0
ZONEAPPEND	_ZONEAPPEND_e__Struct	8/4	+0	+0
DEVICESELFTEST	_DEVICESELFTEST_e__Struct	8/4	+0	+0
DISCOVERYINFOMGMT	_DISCOVERYINFOMGMT_e__Struct	8/4	+0	+0
VENDORSPECIFIC	_VENDORSPECIFIC_e__Struct	8/4	+0	+0
VERIFYCOMMAND	_VERIFYCOMMAND_e__Struct	8/4	+0	+0

公式ドキュメント

Admin コマンドセットおよび NVM コマンドセットのすべてのコマンドのパラメーターを格納します。

解説(Remarks)

Admin コマンドセットは、Admin Submission Queue に送信できるコマンドを定義します。

すべての Admin コマンドにおいて、DWord 14 および DWord 15 は I/O コマンドセット固有です。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// NVME_COMMAND_DWORD0  (x64 4 / x86 4 バイト)
typedef struct NVME_COMMAND_DWORD0 {
    _Anonymous_e__Struct Anonymous;
    DWORD AsUlong;
} NVME_COMMAND_DWORD0;

// NVME_COMMAND  (x64 48 / x86 48 バイト)
typedef struct NVME_COMMAND {
    NVME_COMMAND_DWORD0 CDW0;
    DWORD NSID;
    DWORD Reserved0[2];
    ULONGLONG MPTR;
    _Anonymous_e__Union Anonymous;
    _u_e__Union u;
} NVME_COMMAND;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct NVME_COMMAND_DWORD0
{
    public _Anonymous_e__Struct Anonymous;
    public uint AsUlong;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct NVME_COMMAND
{
    public NVME_COMMAND_DWORD0 CDW0;
    public uint NSID;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 2)] public uint[] Reserved0;
    public ulong MPTR;
    public _Anonymous_e__Union Anonymous;
    public _u_e__Union u;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure NVME_COMMAND_DWORD0
    Public Anonymous As _Anonymous_e__Struct
    Public AsUlong As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure NVME_COMMAND
    Public CDW0 As NVME_COMMAND_DWORD0
    Public NSID As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=2)> Public Reserved0() As UInteger
    Public MPTR As ULong
    Public Anonymous As _Anonymous_e__Union
    Public u As _u_e__Union
End Structure

import ctypes
from ctypes import wintypes

class NVME_COMMAND_DWORD0(ctypes.Structure):
    _fields_ = [
        ("Anonymous", _Anonymous_e__Struct),
        ("AsUlong", wintypes.DWORD),
    ]

class NVME_COMMAND(ctypes.Structure):
    _fields_ = [
        ("CDW0", NVME_COMMAND_DWORD0),
        ("NSID", wintypes.DWORD),
        ("Reserved0", wintypes.DWORD * 2),
        ("MPTR", ctypes.c_ulonglong),
        ("Anonymous", _Anonymous_e__Union),
        ("u", _u_e__Union),
    ]

#[repr(C)]
pub struct NVME_COMMAND_DWORD0 {
    pub Anonymous: _Anonymous_e__Struct,
    pub AsUlong: u32,
}

#[repr(C)]
pub struct NVME_COMMAND {
    pub CDW0: NVME_COMMAND_DWORD0,
    pub NSID: u32,
    pub Reserved0: [u32; 2],
    pub MPTR: u64,
    pub Anonymous: _Anonymous_e__Union,
    pub u: _u_e__Union,
}

import "golang.org/x/sys/windows"

type NVME_COMMAND_DWORD0 struct {
	Anonymous _Anonymous_e__Struct
	AsUlong uint32
}

type NVME_COMMAND struct {
	CDW0 NVME_COMMAND_DWORD0
	NSID uint32
	Reserved0 [2]uint32
	MPTR uint64
	Anonymous _Anonymous_e__Union
	u _u_e__Union
}

type
  NVME_COMMAND_DWORD0 = record
    Anonymous: _Anonymous_e__Struct;
    AsUlong: DWORD;
  end;

  NVME_COMMAND = record
    CDW0: NVME_COMMAND_DWORD0;
    NSID: DWORD;
    Reserved0: array[0..1] of DWORD;
    MPTR: UInt64;
    Anonymous: _Anonymous_e__Union;
    u: _u_e__Union;
  end;

const NVME_COMMAND_DWORD0 = extern struct {
    Anonymous: _Anonymous_e__Struct,
    AsUlong: u32,
};

const NVME_COMMAND = extern struct {
    CDW0: NVME_COMMAND_DWORD0,
    NSID: u32,
    Reserved0: [2]u32,
    MPTR: u64,
    Anonymous: _Anonymous_e__Union,
    u: _u_e__Union,
};

type
  NVME_COMMAND_DWORD0 {.bycopy.} = object
    Anonymous: _Anonymous_e__Struct
    AsUlong: uint32

  NVME_COMMAND {.bycopy.} = object
    CDW0: NVME_COMMAND_DWORD0
    NSID: uint32
    Reserved0: array[2, uint32]
    MPTR: uint64
    Anonymous: _Anonymous_e__Union
    u: _u_e__Union

struct NVME_COMMAND_DWORD0
{
    _Anonymous_e__Struct Anonymous;
    uint AsUlong;
}

struct NVME_COMMAND
{
    NVME_COMMAND_DWORD0 CDW0;
    uint NSID;
    uint[2] Reserved0;
    ulong MPTR;
    _Anonymous_e__Union Anonymous;
    _u_e__Union u;
}

HSP用定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; NVME_COMMAND サイズ: 48 バイト(x86)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; CDW0 : NVME_COMMAND_DWORD0 (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; NSID : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Reserved0 : DWORD (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; MPTR : ULONGLONG (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; Anonymous : _Anonymous_e__Union (+24, 16byte)  varptr(st)+24 を基点に操作(16byte:入れ子/配列)
; u : _u_e__Union (+40, 4byte)  varptr(st)+40 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; NVME_COMMAND サイズ: 48 バイト(x64)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; CDW0 : NVME_COMMAND_DWORD0 (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; NSID : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Reserved0 : DWORD (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; MPTR : ULONGLONG (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; Anonymous : _Anonymous_e__Union (+24, 16byte)  varptr(st)+24 を基点に操作(16byte:入れ子/配列)
; u : _u_e__Union (+40, 8byte)  varptr(st)+40 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global NVME_COMMAND
    #field byte CDW0 4
    #field int NSID
    #field int Reserved0 2
    #field int64 MPTR
    #field byte Anonymous 16
    #field byte u 8
#endstruct

stdim st, NVME_COMMAND        ; NSTRUCT 変数を確保
st->NSID = 100
mes "NSID=" + st->NSID
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。