培训
nvme.h 标头
此标头由数据访问和存储使用。 有关详细信息,请参阅:
nvme.h 包含以下编程接口:
NVM_SET_LIST 包含 NVME Set Attributes 命令的条目数组。 |
NVME_ADMIN_COMPLETION_QUEUE_BASE_ADDRESS 包含管理员完成队列的基内存地址。 |
NVME_ADMIN_QUEUE_ATTRIBUTES 包含管理员提交队列和管理员完成队列 (AQA) 管理员队列属性。 |
NVME_ADMIN_SUBMISSION_QUEUE_BASE_ADDRESS 包含管理员提交队列的基本内存地址。 |
NVME_AUTO_POWER_STATE_TRANSITION_ENTRY 包含一个 64 位条目,用于指定有关每个允许的 32 个电源状态的空闲时间和电源状态转换的信息。 |
NVME_CDW10_ABORT 包含 Abort 命令的参数,该命令用于中止之前提交到管理员提交队列或 I/O 提交队列的特定命令。 |
NVME_CDW10_CREATE_IO_QUEUE 包含“创建 I/O 完成队列”和“创建 IO 提交队列”命令中使用的参数。 |
NVME_CDW10_DATASET_MANAGEMENT NVME_CDW10_DATASET_MANAGEMENT 结构包含数据集管理命令的参数,该命令指示逻辑块范围的属性。 |
NVME_CDW10_DIRECTIVE_RECEIVE 包含指令接收命令的参数。 |
NVME_CDW10_DIRECTIVE_SEND 包含指令发送命令的参数。 |
NVME_CDW10_FIRMWARE_ACTIVATE 包含固件提交命令中使用的参数。 |
NVME_CDW10_FIRMWARE_DOWNLOAD NVME_CDW10_FIRMWARE_DOWNLOAD 结构包含用于将新固件映像复制到控制器的固件映像下载命令的参数。 |
NVME_CDW10_FORMAT_NVM 包含格式 NVM 命令的参数,该命令用于对 NVM 媒体进行低级别格式设置。 |
NVME_CDW10_GET_FEATURES 包含用于检索指定特征的属性的“获取功能”命令的参数。 |
NVME_CDW10_GET_LOG_PAGE NVME_CDW10_GET_LOG_PAGE 结构包含“获取日志页”命令的参数,该命令返回包含所请求日志页的数据缓冲区。 |
NVME_CDW10_GET_LOG_PAGE_V13 NVME_CDW10_GET_LOG_PAGE_V13 结构包含“获取日志页”命令的参数,该命令返回包含所请求日志页的数据缓冲区。 |
NVME_CDW10_IDENTIFY 包含 Identify 命令的参数,该命令返回一个数据缓冲区,该缓冲区描述有关 NVM 子系统、控制器或命名空间 () 的信息。 |
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 包含控制命令仲裁的仲裁功能的值。 |
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 包含用于控制原子写入单元法线 (AWUN) 和命名空间原子写入单元法线 (NAWUN) 参数的参数,这些参数定义控制器对原子操作的支持。 |
NVME_CDW11_FEATURES 包含用于检索或设置指定特征的属性的“获取功能”和“设置功能”命令的参数。 |
NVME_CDW11_FIRMWARE_DOWNLOAD 包含固件映像下载命令的参数,该命令用于将新固件映像 () 全部或部分复制到控制器。 |
NVME_CDW11_GET_LOG_PAGE NVME_CDW11_GET_LOG_PAGE 结构包含“获取日志页”命令的参数,该命令返回包含所请求日志页的数据缓冲区。 |
NVME_CDW11_IDENTIFY 包含 Identify 命令的参数。 |
NVME_CDW11_SECURITY_RECEIVE 包含安全接收命令中使用的参数。 |
NVME_CDW11_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 包含 NVME 读取和 NVME 写入命令的参数,这些命令在指定的逻辑块地址 (LBA) 读取或写入数据以及元数据(如果适用)。 |
NVME_CDW13_FEATURE_HOST_MEMORY_BUFFER 包含主机内存缓冲区功能的参数,该参数指定主机内存描述符列表的物理位置的较低 32 位。 |
NVME_CDW13_FEATURES 包含设置功能命令的参数,用于设置指定特征的属性。 |
NVME_CDW13_GET_LOG_PAGE |
NVME_CDW13_READ_WRITE 包含 NVME 读取和 NVME 写入命令的参数,这些命令在指定的逻辑块地址 (LBA) 读取或写入数据以及元数据(如果适用)。 |
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 包含 NVME 读取和 NVME 写入命令的参数,这些命令在指定的逻辑块地址 (LBA) 读取或写入数据以及元数据(如果适用)。 |
NVME_CHANGED_NAMESPACE_LIST_LOG 包含已更改的命名空间列表日志页的数据,该页描述自上次读取日志页以来已更改 标识命名空间 信息的控制器中的命名空间。 |
NVME_COMMAND 包含 管理员 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 的 Head 条目指针的门铃寄存器。 |
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 包含有关设备Self-Test操作结果的数据。 |
NVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS 包含描述标识指令的返回参数的字段。 |
NVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS_DESCRIPTOR 包含描述标识指令的返回参数的值。 |
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/Health Information Log 页中包含的信息的字段。 |
NVME_HOST_MEMORY_BUFFER_DESCRIPTOR_ENTRY 定义主机内存描述符列表中的单个条目的参数。 |
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) 范围。 |
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 包含的值指示对固件映像下载命令下载的映像或以前下载并放置的映像执行的操作。 |
NVME_FUSED_OPERATION_CODES 包含指示命令是融合操作中的第一个命令还是第二个命令的值。 |
NVME_IDENTIFY_CNS_CODES 包含的值指示将在控制器或命名空间结构 (CNS) NVME_CDW10_IDENTIFY 结构的成员中返回的控制器或命名空间信息的类型。 |
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 包含一些值,这些值指定是否应在 Format 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 的温度的阈值类型。 |