]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressHci.c
MdeModulePkg/NvmExpressDxe: Expose EFI_NVM_EXPRESS_PASS_THRU protocol
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / NvmExpressDxe / NvmExpressHci.c
index 7b46870d5ad33d922fbe2f2205098098a974d4d1..0e35694c39a84ab3a9ef454e33822e3422f3bdb5 100644 (file)
@@ -2,7 +2,7 @@
   NvmExpressDxe driver is used to manage non-volatile memory subsystem which follows\r
   NVM Express specification.\r
 \r
-  Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -430,6 +430,8 @@ NvmeDisableController (
   NVME_CC                Cc;\r
   NVME_CSTS              Csts;\r
   EFI_STATUS             Status;\r
+  UINT32                 Index;\r
+  UINT8                  Timeout;\r
 \r
   //\r
   // Read Controller Configuration Register.\r
@@ -450,19 +452,35 @@ NvmeDisableController (
     return Status;\r
   }\r
 \r
-  gBS->Stall(10000);\r
-\r
   //\r
-  // Check if the controller is reset\r
+  // Cap.To specifies max delay time in 500ms increments for Csts.Rdy to transition from 1 to 0 after\r
+  // Cc.Enable transition from 1 to 0. Loop produces a 1 millisecond delay per itteration, up to 500 * Cap.To.\r
   //\r
-  Status = ReadNvmeControllerStatus (Private, &Csts);\r
+  if (Private->Cap.To == 0) {\r
+    Timeout = 1;\r
+  } else {\r
+    Timeout = Private->Cap.To;\r
+  }\r
 \r
-  if (EFI_ERROR(Status)) {\r
-    return Status;\r
+  for(Index = (Timeout * 500); Index != 0; --Index) {\r
+    gBS->Stall(1000);\r
+\r
+    //\r
+    // Check if the controller is initialized\r
+    //\r
+    Status = ReadNvmeControllerStatus (Private, &Csts);\r
+\r
+    if (EFI_ERROR(Status)) {\r
+      return Status;\r
+    }\r
+\r
+    if (Csts.Rdy == 0) {\r
+      break;\r
+    }\r
   }\r
 \r
-  if (Csts.Rdy != 0) {\r
-    return EFI_DEVICE_ERROR;\r
+  if (Index == 0) {\r
+    Status = EFI_DEVICE_ERROR;\r
   }\r
 \r
   DEBUG ((EFI_D_INFO, "NVMe controller is disabled with status [%r].\n", Status));\r
@@ -491,13 +509,12 @@ NvmeEnableController (
   UINT8                  Timeout;\r
 \r
   //\r
-  // Enable the controller\r
+  // Enable the controller.\r
+  // CC.AMS, CC.MPS and CC.CSS are all set to 0.\r
   //\r
   ZeroMem (&Cc, sizeof (NVME_CC));\r
-  Cc.En     = 1;\r
-  Cc.Iosqes = 6;\r
-  Cc.Iocqes = 4;\r
-  Status    = WriteNvmeControllerConfiguration (Private, &Cc);\r
+  Cc.En  = 1;\r
+  Status = WriteNvmeControllerConfiguration (Private, &Cc);\r
 \r
   if (EFI_ERROR(Status)) {\r
     return Status;\r
@@ -554,17 +571,16 @@ NvmeIdentifyController (
   IN VOID                               *Buffer\r
   )\r
 {\r
-  NVM_EXPRESS_PASS_THRU_COMMAND_PACKET     CommandPacket;\r
-  NVM_EXPRESS_COMMAND                      Command;\r
-  NVM_EXPRESS_RESPONSE                     Response;\r
+  EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;\r
+  EFI_NVM_EXPRESS_COMMAND                  Command;\r
+  EFI_NVM_EXPRESS_COMPLETION               Completion;\r
   EFI_STATUS                               Status;\r
 \r
-  ZeroMem (&CommandPacket, sizeof(NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
-  ZeroMem (&Command, sizeof(NVM_EXPRESS_COMMAND));\r
-  ZeroMem (&Response, sizeof(NVM_EXPRESS_RESPONSE));\r
+  ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
+  ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));\r
+  ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));\r
 \r
   Command.Cdw0.Opcode = NVME_ADMIN_IDENTIFY_OPC;\r
-  Command.Cdw0.Cid    = Private->Cid[0]++;\r
   //\r
   // According to Nvm Express 1.1 spec Figure 38, When not used, the field shall be cleared to 0h.\r
   // For the Identify command, the Namespace Identifier is only used for the Namespace data structure.\r
@@ -572,11 +588,11 @@ NvmeIdentifyController (
   Command.Nsid        = 0;\r
 \r
   CommandPacket.NvmeCmd        = &Command;\r
-  CommandPacket.NvmeResponse   = &Response;\r
+  CommandPacket.NvmeCompletion = &Completion;\r
   CommandPacket.TransferBuffer = Buffer;\r
   CommandPacket.TransferLength = sizeof (NVME_ADMIN_CONTROLLER_DATA);\r
   CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;\r
-  CommandPacket.QueueId        = NVME_ADMIN_QUEUE;\r
+  CommandPacket.QueueType      = NVME_ADMIN_QUEUE;\r
   //\r
   // Set bit 0 (Cns bit) to 1 to identify a controller\r
   //\r
@@ -586,7 +602,6 @@ NvmeIdentifyController (
   Status = Private->Passthru.PassThru (\r
                                &Private->Passthru,\r
                                NVME_CONTROLLER_ID,\r
-                               0,\r
                                &CommandPacket,\r
                                NULL\r
                                );\r
@@ -612,25 +627,24 @@ NvmeIdentifyNamespace (
   IN VOID                              *Buffer\r
   )\r
 {\r
-  NVM_EXPRESS_PASS_THRU_COMMAND_PACKET     CommandPacket;\r
-  NVM_EXPRESS_COMMAND                      Command;\r
-  NVM_EXPRESS_RESPONSE                     Response;\r
+  EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;\r
+  EFI_NVM_EXPRESS_COMMAND                  Command;\r
+  EFI_NVM_EXPRESS_COMPLETION               Completion;\r
   EFI_STATUS                               Status;\r
 \r
-  ZeroMem (&CommandPacket, sizeof(NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
-  ZeroMem (&Command, sizeof(NVM_EXPRESS_COMMAND));\r
-  ZeroMem (&Response, sizeof(NVM_EXPRESS_RESPONSE));\r
+  ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
+  ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));\r
+  ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));\r
 \r
-  CommandPacket.NvmeCmd      = &Command;\r
-  CommandPacket.NvmeResponse = &Response;\r
+  CommandPacket.NvmeCmd        = &Command;\r
+  CommandPacket.NvmeCompletion = &Completion;\r
 \r
   Command.Cdw0.Opcode = NVME_ADMIN_IDENTIFY_OPC;\r
-  Command.Cdw0.Cid    = Private->Cid[0]++;\r
   Command.Nsid        = NamespaceId;\r
   CommandPacket.TransferBuffer = Buffer;\r
   CommandPacket.TransferLength = sizeof (NVME_ADMIN_NAMESPACE_DATA);\r
   CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;\r
-  CommandPacket.QueueId        = NVME_ADMIN_QUEUE;\r
+  CommandPacket.QueueType      = NVME_ADMIN_QUEUE;\r
   //\r
   // Set bit 0 (Cns bit) to 1 to identify a namespace\r
   //\r
@@ -640,7 +654,6 @@ NvmeIdentifyNamespace (
   Status = Private->Passthru.PassThru (\r
                                &Private->Passthru,\r
                                NamespaceId,\r
-                               0,\r
                                &CommandPacket,\r
                                NULL\r
                                );\r
@@ -662,26 +675,25 @@ NvmeCreateIoCompletionQueue (
   IN NVME_CONTROLLER_PRIVATE_DATA      *Private\r
   )\r
 {\r
-  NVM_EXPRESS_PASS_THRU_COMMAND_PACKET     CommandPacket;\r
-  NVM_EXPRESS_COMMAND                      Command;\r
-  NVM_EXPRESS_RESPONSE                     Response;\r
+  EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;\r
+  EFI_NVM_EXPRESS_COMMAND                  Command;\r
+  EFI_NVM_EXPRESS_COMPLETION               Completion;\r
   EFI_STATUS                               Status;\r
   NVME_ADMIN_CRIOCQ                        CrIoCq;\r
 \r
-  ZeroMem (&CommandPacket, sizeof(NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
-  ZeroMem (&Command, sizeof(NVM_EXPRESS_COMMAND));\r
-  ZeroMem (&Response, sizeof(NVM_EXPRESS_RESPONSE));\r
+  ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
+  ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));\r
+  ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));\r
   ZeroMem (&CrIoCq, sizeof(NVME_ADMIN_CRIOCQ));\r
 \r
-  CommandPacket.NvmeCmd      = &Command;\r
-  CommandPacket.NvmeResponse = &Response;\r
+  CommandPacket.NvmeCmd        = &Command;\r
+  CommandPacket.NvmeCompletion = &Completion;\r
 \r
   Command.Cdw0.Opcode = NVME_ADMIN_CRIOCQ_OPC;\r
-  Command.Cdw0.Cid    = Private->Cid[0]++;\r
   CommandPacket.TransferBuffer = Private->CqBufferPciAddr[1];\r
   CommandPacket.TransferLength = EFI_PAGE_SIZE;\r
   CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;\r
-  CommandPacket.QueueId        = NVME_ADMIN_QUEUE;\r
+  CommandPacket.QueueType      = NVME_ADMIN_QUEUE;\r
 \r
   CrIoCq.Qid   = NVME_IO_QUEUE;\r
   CrIoCq.Qsize = NVME_CCQ_SIZE;\r
@@ -692,7 +704,6 @@ NvmeCreateIoCompletionQueue (
   Status = Private->Passthru.PassThru (\r
                                &Private->Passthru,\r
                                0,\r
-                               0,\r
                                &CommandPacket,\r
                                NULL\r
                                );\r
@@ -714,26 +725,25 @@ NvmeCreateIoSubmissionQueue (
   IN NVME_CONTROLLER_PRIVATE_DATA      *Private\r
   )\r
 {\r
-  NVM_EXPRESS_PASS_THRU_COMMAND_PACKET     CommandPacket;\r
-  NVM_EXPRESS_COMMAND                      Command;\r
-  NVM_EXPRESS_RESPONSE                     Response;\r
+  EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;\r
+  EFI_NVM_EXPRESS_COMMAND                  Command;\r
+  EFI_NVM_EXPRESS_COMPLETION               Completion;\r
   EFI_STATUS                               Status;\r
   NVME_ADMIN_CRIOSQ                        CrIoSq;\r
 \r
-  ZeroMem (&CommandPacket, sizeof(NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
-  ZeroMem (&Command, sizeof(NVM_EXPRESS_COMMAND));\r
-  ZeroMem (&Response, sizeof(NVM_EXPRESS_RESPONSE));\r
+  ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
+  ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));\r
+  ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));\r
   ZeroMem (&CrIoSq, sizeof(NVME_ADMIN_CRIOSQ));\r
 \r
-  CommandPacket.NvmeCmd      = &Command;\r
-  CommandPacket.NvmeResponse = &Response;\r
+  CommandPacket.NvmeCmd        = &Command;\r
+  CommandPacket.NvmeCompletion = &Completion;\r
 \r
   Command.Cdw0.Opcode = NVME_ADMIN_CRIOSQ_OPC;\r
-  Command.Cdw0.Cid    = Private->Cid[0]++;\r
   CommandPacket.TransferBuffer = Private->SqBufferPciAddr[1];\r
   CommandPacket.TransferLength = EFI_PAGE_SIZE;\r
   CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;\r
-  CommandPacket.QueueId        = NVME_ADMIN_QUEUE;\r
+  CommandPacket.QueueType      = NVME_ADMIN_QUEUE;\r
 \r
   CrIoSq.Qid   = NVME_IO_QUEUE;\r
   CrIoSq.Qsize = NVME_CSQ_SIZE;\r
@@ -746,7 +756,6 @@ NvmeCreateIoSubmissionQueue (
   Status = Private->Passthru.PassThru (\r
                                &Private->Passthru,\r
                                0,\r
-                               0,\r
                                &CommandPacket,\r
                                NULL\r
                                );\r
@@ -798,7 +807,7 @@ NvmeControllerInit (
                     );\r
 \r
   if (!EFI_ERROR (Status)) {\r
-    Supports &= EFI_PCI_DEVICE_ENABLE;\r
+    Supports &= (UINT64)EFI_PCI_DEVICE_ENABLE;\r
     Status    = PciIo->Attributes (\r
                          PciIo,\r
                          EfiPciIoAttributeOperationEnable,\r
@@ -842,8 +851,10 @@ NvmeControllerInit (
   //\r
   // set number of entries admin submission & completion queues.\r
   //\r
-  Aqa.Asqs = NVME_ASQ_SIZE;\r
-  Aqa.Acqs = NVME_ACQ_SIZE;\r
+  Aqa.Asqs  = NVME_ASQ_SIZE;\r
+  Aqa.Rsvd1 = 0;\r
+  Aqa.Acqs  = NVME_ACQ_SIZE;\r
+  Aqa.Rsvd2 = 0;\r
 \r
   //\r
   // Address of admin submission queue.\r
@@ -909,22 +920,6 @@ NvmeControllerInit (
     return Status;\r
   }\r
 \r
-  //\r
-  // Create one I/O completion queue.\r
-  //\r
-  Status = NvmeCreateIoCompletionQueue (Private);\r
-  if (EFI_ERROR(Status)) {\r
-   return Status;\r
-  }\r
-\r
-  //\r
-  // Create one I/O Submission queue.\r
-  //\r
-  Status = NvmeCreateIoSubmissionQueue (Private);\r
-  if (EFI_ERROR(Status)) {\r
-   return Status;\r
-  }\r
-\r
   //\r
   // Allocate buffer for Identify Controller data\r
   //\r
@@ -957,12 +952,28 @@ NvmeControllerInit (
   DEBUG ((EFI_D_INFO, "    MN        : %a\n",   (CHAR8 *)(Private->ControllerData->Mn)));\r
   DEBUG ((EFI_D_INFO, "    FR        : 0x%x\n", *((UINT64*)Private->ControllerData->Fr)));\r
   DEBUG ((EFI_D_INFO, "    RAB       : 0x%x\n", Private->ControllerData->Rab));\r
-  DEBUG ((EFI_D_INFO, "    IEEE      : 0x%x\n", *(UINT32*)Private->ControllerData->Ieee_oiu));\r
+  DEBUG ((EFI_D_INFO, "    IEEE      : 0x%x\n", *(UINT32*)Private->ControllerData->Ieee_oui));\r
   DEBUG ((EFI_D_INFO, "    AERL      : 0x%x\n", Private->ControllerData->Aerl));\r
   DEBUG ((EFI_D_INFO, "    SQES      : 0x%x\n", Private->ControllerData->Sqes));\r
   DEBUG ((EFI_D_INFO, "    CQES      : 0x%x\n", Private->ControllerData->Cqes));\r
   DEBUG ((EFI_D_INFO, "    NN        : 0x%x\n", Private->ControllerData->Nn));\r
 \r
+  //\r
+  // Create one I/O completion queue.\r
+  //\r
+  Status = NvmeCreateIoCompletionQueue (Private);\r
+  if (EFI_ERROR(Status)) {\r
+   return Status;\r
+  }\r
+\r
+  //\r
+  // Create one I/O Submission queue.\r
+  //\r
+  Status = NvmeCreateIoSubmissionQueue (Private);\r
+  if (EFI_ERROR(Status)) {\r
+   return Status;\r
+  }\r
+\r
   return Status;\r
 }\r
 \r