nvme.h ヘッダー

このヘッダーは、データ アクセスとストレージで使用されます。 詳細については、次のトピックを参照してください。

• データ アクセスとストレージ
• NVMe ドライブの操作

nvme.h には、次のプログラミング インターフェイスが含まれています。

構造体

NVM_SET_LIST NVME 属性の設定コマンドのエントリの配列が含まれています。
NVME_ADMIN_COMPLETION_QUEUE_BASE_ADDRESS 管理完了キューのベース メモリ アドレスを格納します。
NVME_ADMIN_QUEUE_ATTRIBUTES 管理送信キューと管理完了キューの管理 キュー属性 (AQA) が含まれます。
NVME_ADMIN_SUBMISSION_QUEUE_BASE_ADDRESS 管理送信キューのベース メモリ アドレスを格納します。
NVME_AUTO_POWER_STATE_TRANSITION_ENTRY 許容される 32 の各電源状態のアイドル時間と電源状態遷移に関する情報を指定する 64 ビット エントリが含まれています。
NVME_CDW10_ABORT 管理送信キューまたは I/O 送信キューに送信された特定のコマンドを中止するために使用される Abort コマンドのパラメーターが含まれています。
NVME_CDW10_CREATE_IO_QUEUE I/O 完了キューの作成コマンドおよび IO 送信キューの作成コマンドで使用されるパラメーターが含まれています。
NVME_CDW10_DATASET_MANAGEMENT NVME_CDW10_DATASET_MANAGEMENT構造体には、論理ブロックの範囲の属性を示す Dataset Management コマンドのパラメーターが含まれています。
NVME_CDW10_DIRECTIVE_RECEIVE ディレクティブ受信コマンドのパラメーターが含まれています。
NVME_CDW10_DIRECTIVE_SEND ディレクティブ送信コマンドのパラメーターが含まれています。
NVME_CDW10_FIRMWARE_ACTIVATE ファームウェア コミット コマンドで使用されるパラメーターが含まれています。
NVME_CDW10_FIRMWARE_DOWNLOAD NVME_CDW10_FIRMWARE_DOWNLOAD構造体には、新しいファームウェア イメージをコントローラーにコピーする Firmware Image Download コマンドのパラメーターが含まれています。
NVME_CDW10_FORMAT_NVM NVM メディアの低レベルの書式設定に使用される [NVM の書式設定] コマンドのパラメーターが含まれています。
NVME_CDW10_GET_FEATURES 指定した機能の属性を取得する [機能の取得] コマンドのパラメーターが含まれています。
NVME_CDW10_GET_LOG_PAGE NVME_CDW10_GET_LOG_PAGE構造体には、要求されたログ ページを含むデータ バッファーを返す Get Log Page コマンドのパラメーターが含まれています。
NVME_CDW10_GET_LOG_PAGE_V13 NVME_CDW10_GET_LOG_PAGE_V13構造体には、要求されたログ ページを含むデータ バッファーを返す Get Log Page コマンドのパラメーターが含まれています。
NVME_CDW10_IDENTIFY NVM サブシステム、コントローラー、または名前空間に関する情報を記述するデータ バッファーを返す Identify コマンドのパラメーターが含まれています。
NVME_CDW10_SECURITY_SEND_RECEIVE セキュリティ送信とセキュリティ受信の管理 コマンドで使用されるパラメーターが含まれています。
NVME_CDW10_SET_FEATURES NVME_CDW10_SET_FEATURES構造体には、指定したフィーチャの属性を設定する [機能の設定] コマンドのパラメーターが含まれています。
NVME_CDW11_CREATE_IO_CQ I/O 入力候補キューの作成コマンドのパラメーターが含まれます。これは、管理完了キューを除くすべての I/O 完了キューを作成するために使用されます。
NVME_CDW11_CREATE_IO_SQ IO 送信キューの作成コマンドのパラメーターが含まれています。これは、IO 送信キューの作成に使用されます。
NVME_CDW11_DATASET_MANAGEMENT NVME_CDW11_DATASET_MANAGEMENT構造体には、論理ブロックの範囲の属性を示すデータセット管理コマンドのパラメーターが含まれています。
NVME_CDW11_DIRECTIVE_RECEIVE ディレクティブ受信コマンドのパラメーターが含まれています。
NVME_CDW11_DIRECTIVE_SEND ディレクティブ送信コマンドのパラメーターが含まれています。
NVME_CDW11_FEATURE_ARBITRATION コマンド アービトレーションを制御する Arbitration Feature の値が含まれます。
NVME_CDW11_FEATURE_ASYNC_EVENT_CONFIG ホストへの非同期イベント通知をトリガーするイベントを制御する非同期イベント構成機能のパラメーターが含まれています。
NVME_CDW11_FEATURE_AUTO_POWER_STATE_TRANSITION 自律電源状態遷移の設定を構成する自律電源状態遷移機能のパラメーターが含まれています。
NVME_CDW11_FEATURE_HOST_MEMORY_BUFFER ホスト メモリ バッファー機能のパラメーターが含まれています。この機能は、コントローラーが排他的に使用するためにホスト メモリの一部を割り当てるメカニズムをホストに提供します。
NVME_CDW11_FEATURE_INTERRUPT_COALESCING 割り込みの合体設定を構成する割り込み合体機能のパラメーターが含まれています。
NVME_CDW11_FEATURE_INTERRUPT_VECTOR_CONFIG 特定の割り込みベクトルに固有の設定を構成する割り込みベクトル構成機能のパラメーターが含まれています。
NVME_CDW11_FEATURE_LBA_RANGE_TYPE [機能の設定] コマンドの LBA 範囲タイプ フィーチャーの LBA 範囲の数を指定するパラメーターが含まれます。
NVME_CDW11_FEATURE_NON_OPERATIONAL_POWER_STATE 非運用電源状態機能のパラメーターが含まれています。これは、非運用電源状態に対して制限モードが有効になっているかどうかを示します。
NVME_CDW11_FEATURE_NUMBER_OF_QUEUES ホストがこのコントローラーに対して要求する I/O 完了キューと I/O 送信キューの数を示すキュー数機能のパラメーターが含まれています。
NVME_CDW11_FEATURE_POWER_MANAGEMENT ホストが電源状態を構成できるようにする電源管理機能の値が含まれています。
NVME_CDW11_FEATURE_SUPPORTED_CAPABILITY 指定した機能のサポートされている機能を説明する [機能の取得] コマンドによって返される値が含まれます。
NVME_CDW11_FEATURE_TEMPERATURE_THRESHOLD 温度しきい値を超えるしきい値と、最大 9 つの温度値の温度しきい値以下を設定するために使用される温度しきい値機能のパラメーターが含まれています。
NVME_CDW11_FEATURE_VOLATILE_WRITE_CACHE 揮発性書き込みキャッシュがサポートされていて、コントローラーに存在する場合は、揮発性書き込みキャッシュを制御する揮発性書き込みキャッシュ機能のパラメーターが含まれています。
NVME_CDW11_FEATURE_WRITE_ATOMICITY_NORMAL アトミック操作に対するコントローラーのサポートを定義する Atomic Write Unit Normal (AWUN) パラメーターと Namespace Atomic Write Unit Normal (NAWUN) パラメーターの操作を制御する書き込み原子性標準機能のパラメーターが含まれています。
NVME_CDW11_FEATURES 指定したフィーチャの属性を取得または設定する [機能の取得] コマンドと [機能の設定] コマンドのパラメーターが含まれています。
NVME_CDW11_FIRMWARE_DOWNLOAD 新しいファームウェア イメージ (全体または一部) をコントローラーにコピーするために使用される Firmware Image Download コマンドのパラメーターが含まれています。
NVME_CDW11_GET_LOG_PAGE NVME_CDW11_GET_LOG_PAGE構造体には、要求されたログ ページを含むデータ バッファーを返す Get Log Page コマンドのパラメーターが含まれています。
NVME_CDW11_IDENTIFY Identify コマンドのパラメーターが含まれています。
NVME_CDW11_SECURITY_RECEIVE Security Receive コマンドで使用されるパラメーターが含まれています。
NVME_CDW11_SECURITY_SEND Security Send コマンドで使用されるパラメーターが含まれています。
NVME_CDW12_DIRECTIVE_RECEIVE ディレクティブ受信コマンドのストリーム リソースを割り当てるパラメーターが含まれています。
NVME_CDW12_DIRECTIVE_RECEIVE_STREAMS_ALLOCATE_RESOURCES ディレクティブ受信コマンドでストリーム リソースの割り当てに使用される名前空間ストリームを要求するためのパラメーターを含みます。
NVME_CDW12_DIRECTIVE_SEND ディレクティブ送信コマンドのディレクティブを有効にするパラメーターが含まれています。
NVME_CDW12_DIRECTIVE_SEND_IDENTIFY_ENABLE_DIRECTIVE ディレクティブ送信コマンドでディレクティブを指定および有効化するためのパラメーターが含まれます。
NVME_CDW12_FEATURE_HOST_MEMORY_BUFFER ホスト メモリ バッファーのサイズを指定するホスト メモリ バッファー機能のパラメーターが含まれています。
NVME_CDW12_FEATURES 指定したフィーチャの属性を設定する [機能の設定] コマンドのパラメーターが含まれます。
NVME_CDW12_GET_LOG_PAGE
NVME_CDW12_READ_WRITE 指定された論理ブロック アドレス (LBA) の NVM コントローラーとの間でデータとメタデータを読み取りまたは書き込む NVME 読み取りおよび NVME 書き込みコマンドのパラメーターが含まれます (該当する場合)。
NVME_CDW13_FEATURE_HOST_MEMORY_BUFFER ホスト メモリ記述子リストの物理位置の下位 32 ビットを指定するホスト メモリ バッファー機能のパラメーターが含まれています。
NVME_CDW13_FEATURES 指定したフィーチャの属性を設定する [機能の設定] コマンドのパラメーターが含まれます。
NVME_CDW13_GET_LOG_PAGE
NVME_CDW13_READ_WRITE 指定された論理ブロック アドレス (LBA) の NVM コントローラーとの間でデータとメタデータを読み取りまたは書き込む NVME 読み取りおよび NVME 書き込みコマンドのパラメーターが含まれます (該当する場合)。
NVME_CDW14_FEATURE_HOST_MEMORY_BUFFER ホスト メモリ記述子リストの物理位置の上位 32 ビットを指定するホスト メモリ バッファー機能のパラメーターを含みます。
NVME_CDW14_FEATURES NVME_CDW14_FEATURES構造体には、指定したフィーチャの属性を設定する [フィーチャの設定] コマンドのパラメーターが含まれています。
NVME_CDW15_FEATURE_HOST_MEMORY_BUFFER ホスト メモリ記述子リスト内のエントリの数を指定するホスト メモリ バッファー機能のパラメーターが含まれています。
NVME_CDW15_FEATURES NVME_CDW15_FEATURES構造体には、指定したフィーチャの属性を設定する [フィーチャの設定] コマンドのパラメーターが含まれています。
NVME_CDW15_READ_WRITE 指定された論理ブロック アドレス (LBA) の NVM コントローラーとの間でデータとメタデータを読み取りまたは書き込む NVME 読み取りおよび NVME 書き込みコマンドのパラメーターが含まれます (該当する場合)。
NVME_CHANGED_NAMESPACE_LIST_LOG 最後にログ ページを読み取った後に名前空間の識別情報を変更したコントローラー内の名前空間を記述する[変更された 名前空間 リスト] ログ ページのデータが含まれます。
NVME_COMMAND 管理 コマンド セットと NVM コマンド セット内のすべてのコマンドのパラメーターが含まれます。
NVME_COMMAND_DWORD0 すべての管理コマンドと NVM コマンドに共通のパラメーターが含まれています。
NVME_COMMAND_EFFECTS_DATA コマンドのオプション機能など、管理または I/O コマンドの全体的な影響を説明する情報が含まれます。
NVME_COMMAND_EFFECTS_LOG コントローラーがサポートするコマンドと、それらのコマンドが NVM サブシステムの状態に及ぼす影響について説明する情報が含まれます。
NVME_COMMAND_STATUS コマンドの状態に関する情報が含まれます。
NVME_COMPLETION_DW0_ASYNC_EVENT_REQUEST 完了キュー エントリの DWord 0 の管理完了キューにポストされる非同期イベントに関する情報が含まれます。 非同期イベントは、状態、エラー、正常性情報をホスト ソフトウェアに通知するために使用されます。
NVME_COMPLETION_DW0_DIRECTIVE_RECEIVE_STREAMS_ALLOCATE_RESOURCES ディレクティブ受信コマンドで割り当てられたストリーム リソースの数に関する情報を格納します。
NVME_COMPLETION_ENTRY 完了キューのサイズが 16 バイトのエントリを指定します。
NVME_COMPLETION_QUEUE_HEAD_DOORBELL 完了キュー y のヘッド エントリ ポインターを更新するドアベル レジスタ を定義します。
NVME_CONTEXT_ATTRIBUTES 論理ブロック範囲 (LBA 範囲) の省略可能なコンテキスト属性を指定します。
NVME_CONTROLLER_CAPABILITIES ソフトウェアをホストするコントローラーの基本的な機能を指定する読み取り専用の値が含まれます。
NVME_CONTROLLER_CONFIGURATION コントローラーの読み取り/書き込み構成設定が含まれます。
NVME_CONTROLLER_LIST コントローラー識別子の順序付きリストが含まれます。
NVME_CONTROLLER_MEMORY_BUFFER_LOCATION NVME_CONTROLLER_REGISTERS構造体の CMBLOC フィールドに、省略可能なコントローラー メモリ バッファーの場所レジスタの場所を定義します。
NVME_CONTROLLER_MEMORY_BUFFER_SIZE 省略可能なコントローラー メモリ バッファー レジスタのサイズを定義し、NVME_CONTROLLER_REGISTERS構造体の CMBSZ フィールドで使用されます。
NVME_CONTROLLER_REGISTERS コントローラーのレジスタ マップを指定します。
NVME_CONTROLLER_STATUS コントローラーの状態を示す値が含まれます。
NVME_DEVICE_SELF_TEST_LOG デバイス自己テストの状態、完了率、および結果を説明するデバイス自己テスト ログ ページの情報を指定するフィールドが含まれます。
NVME_DEVICE_SELF_TEST_RESULT_DATA Device Self-Test 操作の結果に関するデータが含まれます。
NVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS Identify ディレクティブの戻り値パラメーターを記述するフィールドが含まれます。
NVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS_DESCRIPTOR Identify ディレクティブの戻り値パラメーターを記述する値を格納します。
NVME_DIRECTIVE_STREAMS_GET_STATUS_DATA 現在開いているストリームの識別子を格納します。
NVME_DIRECTIVE_STREAMS_RETURN_PARAMETERS Streams ディレクティブの戻り値パラメーターを格納します。
NVME_ENDURANCE_GROUP_LOG [耐久グループ情報] ログ ページの情報を指定するフィールドが含まれます。このページでは、耐久グループとの間で読み取りおよび書き込まれるデータの量を示します。
NVME_ERROR_INFO_LOG エラー情報ログ ページの情報を指定するフィールドが含まれます。
NVME_FIRMWARE_SLOT_INFO_LOG [ファームウェア スロット情報] ログ ページの情報を指定するフィールドが含まれます。
NVME_HEALTH_INFO_LOG SMART /正常性情報ログ ページに含まれる情報を指定するフィールドが含まれます。
NVME_HOST_MEMORY_BUFFER_DESCRIPTOR_ENTRY ホスト メモリ記述子リストの 1 つのエントリのパラメーターを定義します。
NVME_IDENTIFY_CONTROLLER_DATA コントローラーの機能、機能、コマンド セット属性、および電源状態記述子を示す値が含まれます。
NVME_IDENTIFY_NAMESPACE_DATA 特定の名前空間に固有の機能と設定を示す値が含まれます。
NVME_LBA_FORMAT NVM 形式コマンドの一部として NVM メディアに適用する LBA 形式を指定するパラメーターが含まれます。
NVME_LBA_RANGE 開始 LBA で指定された連続する論理ブロックのコレクションと論理ブロックの数を定義するパラメーターが含まれます。
NVME_LBA_RANGET_TYPE_ENTRY [機能の設定] コマンドの [LBA 範囲の種類] 機能の論理ブロック アドレス (LBA) 範囲の一覧に 1 つのエントリを指定するパラメーターが含まれます。
NVME_NVM_SUBSYSTEM_RESET NVM サブシステム リセットを開始する機能をホスト ソフトウェアに提供するパラメーターを指定します。
NVME_POWER_STATE_DESC 各電源状態の属性を記述するフィールドが含まれます。
NVME_PRP_ENTRY 物理メモリ ページへのポインターのページ ベース アドレスとオフセット (PBAO) を指定するフィールドが含まれます。
NVME_RESERVATION_NOTIFICATION_LOG [予約通知ログ] ページの情報を指定するフィールドが含まれます。
NVME_SCSI_NAME_STRING SCSI 名文字列識別子の構築に使用される情報が含まれます。
NVME_SET_ATTRIBUTES_ENTRY 属性を設定するための情報を指定するフィールドが含まれます。
NVME_SUBMISSION_QUEUE_TAIL_DOORBELL 送信キュー y の Tail エントリ ポインターを更新するドアベル レジスタ を定義します。
NVME_TELEMETRY_HOST_INITIATED_LOG [テレメトリ] Host-Initiated [ログ] ページの情報を指定するフィールドが含まれます。
NVME_VERSION コントローラーの実装でサポートされる NVM Express 仕様のバージョン番号を指定するフィールドが含まれます。

列挙型

NVME_ACCESS_FREQUENCIES 論理ブロック アドレス指定 (LBA) 範囲への読み取りと書き込みアクセスの頻度を示す値を定義します。
NVME_ACCESS_LATENCIES 読み取りおよび書き込み操作の待機時間を示す値を定義します。
NVME_ADMIN_COMMANDS 管理 コマンド セットでコマンドを指定する値を定義します。 管理 コマンド セットには、管理送信キューに送信できるコマンドが含まれています。
NVME_ASYNC_EVENT_ERROR_STATUS_CODES 一般的なエラー イベントの種類を示す値を格納します。
NVME_ASYNC_EVENT_HEALTH_STATUS_CODES SMART/Health Status イベントの種類を示す値が含まれます。
NVME_ASYNC_EVENT_IO_COMMAND_SET_STATUS_CODES I/O コマンド セット イベントの種類を示す値が含まれます。
NVME_ASYNC_EVENT_NOTICE_CODES Notice イベントの種類を示す値を格納します。
NVME_ASYNC_EVENT_TYPES 非同期イベントの種類を示す値を格納します。
NVME_CC_SHN_SHUTDOWN_NOTIFICATIONS コントローラー構成 (CC) シャットダウン通知を示す値が含まれます。
NVME_CMBSZ_SIZE_UNITS コントローラー メモリ バッファーのサイズを示すサイズ単位を指定する値が含まれます。
NVME_COMMAND_EFFECT_SBUMISSION_EXECUTION_LIMITS 関連付けられたコマンドのコマンド送信と実行に関する推奨事項を示す値が含まれます。
NVME_CSTS_SHST_SHUTDOWN_STATUS NVME_CONTROLLER_CONFIGURATION構造体の SHN フィールドを設定するホストによって開始されるシャットダウン処理の状態を示す値が含まれます。
NVME_DIRECTIVE_RECEIVE_IDENTIFY_OPERATIONS Identify 操作のディレクティブの種類を指定する値を格納します。
NVME_DIRECTIVE_RECEIVE_STREAMS_OPERATIONS Streams 操作のディレクティブの種類を示す値を格納します。
NVME_DIRECTIVE_SEND_IDENTIFY_OPERATIONS Identify 操作に送信されるディレクティブの種類を指定する値を格納します。
NVME_DIRECTIVE_SEND_STREAMS_OPERATIONS Streams 操作に送信されるディレクティブの種類を示す値を格納します。
NVME_DIRECTIVE_TYPES ディレクティブの種類を示す値を格納します。
NVME_FEATURE_VALUE_CODES NVME_ADMIN_COMMAND_GET_FEATURESおよび管理 コマンドで取得または構成する必要がある機能の値NVME_ADMIN_COMMAND_SET_FEATURES示す値が含まれます。
NVME_FEATURES NVME_ADMIN_COMMAND_GET_FEATURESおよび管理 コマンドで取得または構成する必要がある機能NVME_ADMIN_COMMAND_SET_FEATURES示す値が含まれます。
NVME_FIRMWARE_ACTIVATE_ACTIONS [Firmware Image Download]\(ファームウェア イメージのダウンロード\) コマンドによってダウンロードされたイメージ、または以前にダウンロードして配置したイメージで実行されるアクションを示す値が含まれます。
NVME_FUSED_OPERATION_CODES コマンドが融合操作の 1 番目または 2 番目のコマンドであるかどうかを示す値を格納します。
NVME_IDENTIFY_CNS_CODES NVME_CDW10_IDENTIFY構造体の Controller または Namespace Structure (CNS) メンバーで返されるコントローラーまたは名前空間情報の種類を示す値が含まれます。
NVME_LBA_RANGE_TYPES NVME_LBA_RANGET_TYPE_ENTRY構造体の論理ブロック アドレス指定 (LBA) 範囲の種類を示す値が含まれます。
NVME_LOG_PAGES [ログ ページの取得] NVME_ADMIN_COMMAND_GET_LOG_PAGE 管理 コマンドで取得できるログ ページを示す値が含まれます。
NVME_NVM_COMMANDS NVM コマンド セット内のコマンドを示す値が含まれます。
NVME_NVM_QUEUE_PRIORITIES コントローラーでサポートされている場合、アービトレーション メカニズムによって考慮される I/O 送信キューに割り当てることができる優先度を示す値が含まれます。
NVME_PROTECTION_INFORMATION_TYPES エンド ツー エンドのデータ保護が有効かどうかを示す値を格納し、有効な場合は保護情報の種類を指定します。
NVME_RESERVATION_NOTIFICATION_TYPES 予約通知ログ ページの予約通知の種類を示す値が含まれます。
NVME_SECURE_ERASE_SETTINGS NVM 形式コマンドの一部として、セキュリティで保護された消去操作を実行するかどうかを指定する値が含まれます。
NVME_STATUS_COMMAND_SPECIFIC_CODES 特定のコマンドに固有の状態を示す値が含まれます。
NVME_STATUS_GENERIC_COMMAND_CODES さまざまな種類のコマンドで汎用のコマンドに関連付けられている状態を示す値が含まれます。
NVME_STATUS_MEDIA_ERROR_CODES NVM メディアに関連付けられたエラーを示す値、またはデータ整合性の種類のエラーを示す値が含まれます。
NVME_STATUS_TYPES コマンドの完了時に完了キュー エントリにコントローラーによってポストされる状態コードの種類を示す値が含まれます。
NVME_TEMPERATURE_THRESHOLD_TYPES デバイス全体 (コントローラーと NVM を含む) の温度のしきい値の種類を示す値が含まれます。