Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 3.5 KB

ns-nvme-nvme_cdw10_create_io_queue.md

File metadata and controls

81 lines (60 loc) · 3.5 KB
UID tech.root title ms.date ms.topic targetos description req.construct-type req.ddi-compliance req.dll req.header req.include-header req.kmdf-ver req.lib req.max-support req.redist req.target-min-winverclnt req.target-min-winversvr req.target-type req.typenames req.umdf-ver req.unicode-ansi topic_type api_type api_location api_name f1_keywords dev_langs
NS:nvme.NVME_CDW10_CREATE_IO_QUEUE
fs
NVME_CDW10_CREATE_IO_QUEUE
02/19/2021
language-reference
Windows
Contains parameters that are used in the Create I/O Completion Queue and Create IO Submission Queue commands.
structure
nvme.h
Windows 10
NVME_CDW10_CREATE_IO_QUEUE, *PNVME_CDW10_CREATE_IO_QUEUE
apiref
HeaderDef
nvme.h
PNVME_CDW10_CREATE_IO_QUEUE
NVME_CDW10_CREATE_IO_QUEUE
PNVME_CDW10_CREATE_IO_QUEUE
nvme/PNVME_CDW10_CREATE_IO_QUEUE
NVME_CDW10_CREATE_IO_QUEUE
nvme/NVME_CDW10_CREATE_IO_QUEUE
c++

NVME_CDW10_CREATE_IO_QUEUE structure

-description

Contains parameters that are used in the Create I/O Completion Queue and Create IO Submission Queue commands. The Create I/O Completion Queue command is used to create all I/O Completion Queues with the exception of the Admin Completion Queue and the Create I/O Submission Queue command is used to create I/O Submission Queues.

The NVME_CDW10_CREATE_IO_QUEUE structure is used in the CDW10 field of the CREATEIOCQ and CREATEIOSQ parameters of the Command structure.

-struct-fields

-field DUMMYSTRUCTNAME

-field DUMMYSTRUCTNAME.QID

The Queue Identifier (QID) field indicates the identifier to assign to the Completion Queue or Submission Queue to be created.

This identifier corresponds to either the Completion Queue Head Doorbell used for the Completion Queue command or the Submission Queue Tail Doorbell used for the Submission Queue command.

This 16-bit ID value should not exceed the value reported in the NVME_FEATURE_NUMBER_OF_QUEUES feature for I/O Completion Queues or I/O Submission Queues. If the value specified is 0h, exceeds the Number of Queues reported, or corresponds to an identifier already in use, the controller should return an error of NVME_STATUS_INVALID_QUEUE_IDENTIFIER.

-field DUMMYSTRUCTNAME.QSIZE

The Queue Size (QSIZE) field indicates the size of the Completion Queue or Submission Queue to be created. The Queue Size is indicated in a 16-bit 0’s based field that specifies the number of entries in the queue.

The minimum size for a queue is two entries. The maximum size for either an I/O Submission Queue or an I/O Completion Queue is 64K entries, limited by the maximum queue size supported by the controller that is reported in the Maximum Queue Entries Supported (MQES) field of the NVME_CONTROLLER_CAPABILITIES structure.

The maximum size for the Admin Submission and Admin Completion Queue is defined as 4K entries. One entry in each queue is not available for use due to Head and Tail entry pointer definition.

If the size is 0h or larger than the controller supports, the controller should return an error of Invalid Queue Size.

-field AsUlong

-remarks

-see-also