Expand description
NVMe specification definitions (NVMe Base 2.0c and PCIe Transport 1.0c).
Provides bitfield structs, command/completion queue entry formats, status
codes, and register definitions. The nvm submodule defines the NVM
command set (read, write, flush, DSM, reservations, namespace identification).
Base 2.0c: https://nvmexpress.org/wp-content/uploads/NVM-Express-Base-Specification-2.0c-2022.10.04-Ratified.pdf PCIe transport 1.0c: https://nvmexpress.org/wp-content/uploads/NVM-Express-PCIe-Transport-Specification-1.0c-2022.10.03-Ratified.pdf
Modules§
- nvm
- NVM command set definitions
Structs§
- Admin
Opcode - Aqa
- Asynchronous
Event Information Notice - Asynchronous
Event Request Dw0 - Asynchronous
Event Type - Broadcast
Flush Behavior - Cap
- Cc
- Cdw0
- Cdw10
Create IoQueue - Cdw10
Delete IoQueue - Cdw10
GetFeatures - Cdw10
GetLog Page - Cdw10
Identify - Cdw10
SetFeatures - Cdw11
Create IoCompletion Queue - Cdw11
Create IoSubmission Queue - Cdw11
Feature Arbitration - Arbitration feature (01h). See NVMe Base 2.3 Figure 404.
- Cdw11
Feature Async Event Config - CDW11 layout for Set/Get Features - Asynchronous Event Configuration (Feature Identifier 0Bh).
- Cdw11
Feature Error Recovery - Error Recovery feature (05h). See NVM Command Set 1.2 Figure 96.
- Cdw11
Feature Interrupt Coalescing - Interrupt Coalescing feature (08h). See NVMe Base 2.3 Figure 474.
- Cdw11
Feature Interrupt Vector Config - Interrupt Vector Configuration feature (09h). See NVMe Base 2.3 Figure 475.
- Cdw11
Feature Number OfQueues - Cdw11
Feature Power Management - Power Management feature (02h). See NVMe Base 2.3 Figure 405.
- Cdw11
Feature Reservation Persistence - Cdw11
Feature Temperature Threshold - Temperature Threshold feature (04h). See NVMe Base 2.3 Figure 407.
- Cdw11
Feature Volatile Write Cache - Cdw11
GetLog Page - Cns
- Command
- Completion
- Completion
Status - Controller
Type - Csts
- Feature
- Firmware
Updates - Identify
Controller - LidSupported
AndEffects - LID Supported and Effects Data Structure, one per LID in the Supported Log Pages log page (LID 00h). See NVMe Base 2.3 Figure 208.
- LogPage
Identifier - Oaes
- Optional asynchronous events supported
- Oncs
- Optional NVM command support
- Opcode
- Optional
Admin Command Support - Queue
Entry Size - Register
- Status
- Status
Code Type - Volatile
Write Cache