Skip to content

Commit 090130c

Browse files
ikegami-tigaw
authored andcommitted
types: Add enum nvme_csts documentation
Since missed to add the documentatin. Signed-off-by: Tokunori Ikegami <[email protected]>
1 parent f877f5c commit 090130c

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

src/nvme/types.h

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,23 @@ enum nvme_cc {
336336
#define NVME_CC_IOCQES(cc) NVME_GET(cc, CC_IOCQES)
337337
#define NVME_CC_CRIME(cc) NVME_GET(cc, CC_CRIME)
338338

339+
/**
340+
* enum nvme_csts - This field indicates the controller status register
341+
* @NVME_CSTS_RDY_SHIFT: Shift amount to get the ready
342+
* @NVME_CSTS_CFS_SHIFT: Shift amount to get the controller fatal status
343+
* @NVME_CSTS_SHST_SHIFT: Shift amount to get the shutdown status
344+
* @NVME_CSTS_NSSRO_SHIFT: Shift amount to get the NVM subsystem reset occurred
345+
* @NVME_CSTS_PP_SHIFT: Shift amount to get the processing paused
346+
* @NVME_CSTS_RDY_MASK: Mask to get the ready
347+
* @NVME_CSTS_CFS_MASK: Mask to get the controller fatal status
348+
* @NVME_CSTS_SHST_MASK: Mask to get the shutdown status
349+
* @NVME_CSTS_NSSRO_MASK: Mask to get the NVM subsystem reset occurred
350+
* @NVME_CSTS_PP_MASK: Mask to get the processing paused
351+
* @NVME_CSTS_SHST_NORMAL: Normal operation
352+
* @NVME_CSTS_SHST_OCCUR: Shutdown processing occurring
353+
* @NVME_CSTS_SHST_CMPLT: Shutdown processing complete
354+
* @NVME_CSTS_SHN_MASK: Deprecated mask to get the shutdown status
355+
*/
339356
enum nvme_csts {
340357
NVME_CSTS_RDY_SHIFT = 0,
341358
NVME_CSTS_CFS_SHIFT = 1,

0 commit comments

Comments
 (0)