NVMe Shutdown (Shutdown Notification (SHN))

在 NVMe 设备中，Shutdown Notification (SHN) 是用于控制设备电源状态的寄存器位。

修改 Shutdown Notification (SHN)

Shutdown Notification (SHN)：

SHN 字段用于在预计电源关闭时启动关闭处理。其值定义如下：

• 00b (No notification; no effect)：不通知；无效果。
• 01b (Normal shutdown notification)：正常关机通知。控制器预期有时间处理关闭通知。
• 10b (Abrupt shutdown notification)：突发关机通知。主机可能不会等待关闭处理完成就会断电。
• 11b (Reserved)：保留值。

使用说明：

1. 正常关机通知 (01b)：

• 主机在电源关闭之前写入 01b 以通知控制器进行正常的关机处理。
• 控制器会处理所有未完成的命令并将数据安全写入非易失性存储器。
• 主机可以通过读取 CSTS.SHST 字段来确定关闭处理是否完成。

2. 突发关机通知 (10b)：

• 主机在电源突然关闭之前写入 10b 以通知控制器进行突发关机处理。
• 控制器会立即停止处理命令，未完成的命令可能会中断。

正常关机步骤

1. 停止提交新的 I/O 命令并完成所有未完成的命令：

• 确保所有已提交的 I/O 命令完成。

// 停止提交新的 I/O 命令
// 在 NVMe 协议中，通常不会有一个明确的方法来停止提交新命令，
// 但我们可以通过不再发送新的命令来达到这一点。
// 确保所有已提交的 I/O 命令完成
EFI_STATUS
WaitForCompletion (
  IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *NvmePassThru,
  IN UINT32                              NamespaceId
  )
{
  EFI_STATUS Status;
  EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
  EFI_NVM_EXPRESS_COMPLETION               Completion;
  
  ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
  ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));
  
  CommandPacket.QueueType      = NVME_ADMIN_QUEUE;
  CommandPacket.NvmeCompletion = &Completion;
  
  // 检查所有命令完成的方式可能依赖于具体实现
  // 假设通过查询队列状态来实现
  while (HasPendingCommands(NvmePassThru, NamespaceId)) {
    // 等待或进行其他操作以确保命令完成
  }
  
  return EFI_SUCCESS;
}

2. 删除所有 I/O 提交队列：

• 使用 Delete I/O Submission Queue 命令删除所有 I/O 提交队列。这将中止所有剩余的未完成命令。

EFI_STATUS
DeleteIOSubmissionQueue (
  IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *NvmePassThru,
  IN UINT16                              QueueId
  )
{
  EFI_STATUS Status;
  EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
  EFI_NVM_EXPRESS_COMMAND                  Command;
  EFI_NVM_EXPRESS_COMPLETION               Completion;
  
  ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
  ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));
  ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));
  
  Command.Cdw0.Opcode = NVME_ADMIN_DELETE_IOSQ_CMD;
  Command.Cdw10 = QueueId;
  
  CommandPacket.NvmeCmd        = &Command;
  CommandPacket.NvmeCompletion = &Completion;
  CommandPacket.CommandTimeout = NVME_TIMEOUT_60;
  CommandPacket.QueueType      = NVME_ADMIN_QUEUE;
  
  Status = NvmePassThru->PassThru(NvmePassThru, 0, &CommandPacket, NULL);
  
  return Status;
}

// 删除所有 I/O 提交队列
EFI_STATUS
DeleteAllIOSubmissionQueues (
  IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *NvmePassThru
  )
{
  EFI_STATUS Status;
  UINT16     QueueId;
  
  for (QueueId = 1; QueueId < MAX_IO_SUBMISSION_QUEUES; QueueId++) {
    Status = DeleteIOSubmissionQueue(NvmePassThru, QueueId);
    if (EFI_ERROR(Status)) {
      // 处理错误，例如记录日志或终止操作
      break;
    }
  }
  
  return Status;
}

3. 删除所有 I/O 完成队列：

• 使用 Delete I/O Completion Queue 命令删除所有 I/O 完成队列。

EFI_STATUS
DeleteIOCompletionQueue (
  IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *NvmePassThru,
  IN UINT16                              QueueId
  )
{
  EFI_STATUS Status;
  EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
  EFI_NVM_EXPRESS_COMMAND                  Command;
  EFI_NVM_EXPRESS_COMPLETION               Completion;
  
  ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
  ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));
  ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));
  
  Command.Cdw0.Opcode = NVME_ADMIN_DELETE_IOCQ_CMD;
  Command.Cdw10 = QueueId;
  
  CommandPacket.NvmeCmd        = &Command;
  CommandPacket.NvmeCompletion = &Completion;
  CommandPacket.CommandTimeout = NVME_TIMEOUT_60;
  CommandPacket.QueueType      = NVME_ADMIN_QUEUE;
  
  Status = NvmePassThru->PassThru(NvmePassThru, 0, &CommandPacket, NULL);
  
  return Status;
}

// 删除所有 I/O 完成队列
EFI_STATUS
DeleteAllIOCompletionQueues (
  IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *NvmePassThru
  )
{
  EFI_STATUS Status;
  UINT16     QueueId;
  
  for (QueueId = 1; QueueId < MAX_IO_COMPLETION_QUEUES; QueueId++) {
    Status = DeleteIOCompletionQueue(NvmePassThru, QueueId);
    if (EFI_ERROR(Status)) {
      // 处理错误，例如记录日志或终止操作
      break;
    }
  }
  
  return Status;
}

4. 设置关闭通知 (CC.SHN) 字段为 01b：

• 设置 Shutdown Notification 字段为 01b 以表示正常关机操作。
• 控制器将通过更新 Shutdown Status (CSTS.SHST) 字段为 10b 来指示关闭处理已完成。

突发关机步骤

1. 停止提交新的 I/O 命令：

• 确保不再提交新的 I/O 命令。

2. 设置关闭通知 (CC.SHN) 字段为 10b：

• 设置 Shutdown Notification 字段为 10b 以表示突发关机操作。
• 控制器将通过更新 Shutdown Status (CSTS.SHST) 字段为 10b 来指示关闭处理已完成。

重要提示

• 主机应至少等待 Identify Controller 数据结构中报告的 RTD3 进入延迟时间，若 RTD3 进入延迟值为 0h，则应等待至少一秒钟，以完成关机操作。
• 不推荐通过 CC.EN 字段禁用控制器，因为这会导致控制器复位，从而可能影响关机处理所需的时间。
• 当 CSTS.SHST 表示关机处理已完成时，可以安全地关闭控制器电源（无论 CC.EN 的值如何）。

重启控制器

在关机操作后要重新执行命令，需要执行控制器复位 (将 CC.EN 从 1 清除为 0)。
然后执行初始化序列。