From: Sagi Grimberg <sagi@grimberg.me>

Date: Wed, 22 Jul 2020 16:32:18 -0700

Subject: [PATCH] nvme: document nvme controller states

Git-commit: 4212f4e94633f3403c3871d11213badc50b3f6e4

Patch-mainline: v5.9-rc1

References: git-fixes

We are starting to see some non-trivial states

so lets start documenting them.

Signed-off-by: Sagi Grimberg <sagi@grimberg.me>

Signed-off-by: Christoph Hellwig <hch@lst.de>

Acked-by: Hannes Reinecke <hare@suse.com>

---

 drivers/nvme/host/nvme.h | 14 ++++++++++++++

 1 file changed, 14 insertions(+)

diff --git a/drivers/nvme/host/nvme.h b/drivers/nvme/host/nvme.h

index 2ee91a3dd8e0..92629758b77c 100644

--- a/drivers/nvme/host/nvme.h

+++ b/drivers/nvme/host/nvme.h

@@ -181,6 +181,20 @@ static inline u16 nvme_req_qid(struct request *req)

  */

 #define NVME_QUIRK_DELAY_AMOUNT		2300

+/*

+ * enum nvme_ctrl_state: Controller state

+ *

+ * @NVME_CTRL_NEW:		New controller just allocated, initial state

+ * @NVME_CTRL_LIVE:		Controller is connected and I/O capable

+ * @NVME_CTRL_RESETTING:	Controller is resetting (or scheduled reset)

+ * @NVME_CTRL_CONNECTING:	Controller is disconnected, now connecting the

+ *				transport

+ * @NVME_CTRL_DELETING:		Controller is deleting (or scheduled deletion)

+ * @NVME_CTRL_DEAD:		Controller is non-present/unresponsive during

+ *				shutdown or removal. In this case we forcibly

+ *				kill all inflight I/O as they have no chance to

+ *				complete

+ */

 enum nvme_ctrl_state {

 	NVME_CTRL_NEW,

 	NVME_CTRL_LIVE,

-- 

2.29.2