Skip to content

Commit

Permalink
types: Add enum nvme_csts documentation
Browse files Browse the repository at this point in the history
Since missed to add the documentatin.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
  • Loading branch information
ikegami-t authored and igaw committed Apr 23, 2024
1 parent f877f5c commit 090130c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions src/nvme/types.h
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,23 @@ enum nvme_cc {
#define NVME_CC_IOCQES(cc) NVME_GET(cc, CC_IOCQES)
#define NVME_CC_CRIME(cc) NVME_GET(cc, CC_CRIME)

/**
* enum nvme_csts - This field indicates the controller status register
* @NVME_CSTS_RDY_SHIFT: Shift amount to get the ready
* @NVME_CSTS_CFS_SHIFT: Shift amount to get the controller fatal status
* @NVME_CSTS_SHST_SHIFT: Shift amount to get the shutdown status
* @NVME_CSTS_NSSRO_SHIFT: Shift amount to get the NVM subsystem reset occurred
* @NVME_CSTS_PP_SHIFT: Shift amount to get the processing paused
* @NVME_CSTS_RDY_MASK: Mask to get the ready
* @NVME_CSTS_CFS_MASK: Mask to get the controller fatal status
* @NVME_CSTS_SHST_MASK: Mask to get the shutdown status
* @NVME_CSTS_NSSRO_MASK: Mask to get the NVM subsystem reset occurred
* @NVME_CSTS_PP_MASK: Mask to get the processing paused
* @NVME_CSTS_SHST_NORMAL: Normal operation
* @NVME_CSTS_SHST_OCCUR: Shutdown processing occurring
* @NVME_CSTS_SHST_CMPLT: Shutdown processing complete
* @NVME_CSTS_SHN_MASK: Deprecated mask to get the shutdown status
*/
enum nvme_csts {
NVME_CSTS_RDY_SHIFT = 0,
NVME_CSTS_CFS_SHIFT = 1,
Expand Down

0 comments on commit 090130c

Please sign in to comment.