MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpress.c

   1 /** @file
   2   NvmExpressDxe driver is used to manage non-volatile memory subsystem which follows
   3   NVM Express specification.
   4
   5   Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php.
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #include "NvmExpress.h"
  17
  18 //
  19 // NVM Express Driver Binding Protocol Instance
  20 //
  21 EFI_DRIVER_BINDING_PROTOCOL gNvmExpressDriverBinding = {
  22   NvmExpressDriverBindingSupported,
  23   NvmExpressDriverBindingStart,
  24   NvmExpressDriverBindingStop,
  25   0x10,
  26   NULL,
  27   NULL
  28 };
  29
  30 //
  31 // NVM Express EFI Driver Supported EFI Version Protocol Instance
  32 //
  33 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL gNvmExpressDriverSupportedEfiVersion = {
  34   sizeof (EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL), // Size of Protocol structure.
  35   0                                                   // Version number to be filled at start up.
  36 };
  37
  38 //
  39 // Template for NVM Express Pass Thru Mode data structure.
  40 //
  41 GLOBAL_REMOVE_IF_UNREFERENCED EFI_NVM_EXPRESS_PASS_THRU_MODE gEfiNvmExpressPassThruMode = {
  42   EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_PHYSICAL | EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_LOGICAL | EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_CMD_SET_NVM,
  43   sizeof (UINTN),
  44   0x10100
  45 };
  46
  47 /**
  48   Check if the specified Nvm Express device namespace is active, and create child handles
  49   for them with BlockIo and DiskInfo protocol instances.
  50
  51   @param[in] Private         The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure.
  52   @param[in] NamespaceId     The NVM Express namespace ID  for which a device path node is to be
  53                              allocated and built. Caller must set the NamespaceId to zero if the
  54                              device path node will contain a valid UUID.
  55
  56   @retval EFI_SUCCESS        All the namespaces in the device are successfully enumerated.
  57   @return Others             Some error occurs when enumerating the namespaces.
  58
  59 **/
  60 EFI_STATUS
  61 EnumerateNvmeDevNamespace (
  62   IN NVME_CONTROLLER_PRIVATE_DATA       *Private,
  63   UINT32                                NamespaceId
  64   )
  65 {
  66   NVME_ADMIN_NAMESPACE_DATA             *NamespaceData;
  67   EFI_DEVICE_PATH_PROTOCOL              *NewDevicePathNode;
  68   EFI_DEVICE_PATH_PROTOCOL              *DevicePath;
  69   EFI_HANDLE                            DeviceHandle;
  70   EFI_DEVICE_PATH_PROTOCOL              *ParentDevicePath;
  71   EFI_DEVICE_PATH_PROTOCOL              *RemainingDevicePath;
  72   NVME_DEVICE_PRIVATE_DATA              *Device;
  73   EFI_STATUS                            Status;
  74   UINT32                                Lbads;
  75   UINT32                                Flbas;
  76   UINT32                                LbaFmtIdx;
  77
  78   NewDevicePathNode = NULL;
  79   DevicePath        = NULL;
  80   Device            = NULL;
  81
  82   //
  83   // Allocate a buffer for Identify Namespace data
  84   //
  85   NamespaceData = AllocateZeroPool(sizeof (NVME_ADMIN_NAMESPACE_DATA));
  86   if(NamespaceData == NULL) {
  87     return EFI_OUT_OF_RESOURCES;
  88   }
  89
  90   ParentDevicePath = Private->ParentDevicePath;
  91   //
  92   // Identify Namespace
  93   //
  94   Status = NvmeIdentifyNamespace (
  95              Private,
  96              NamespaceId,
  97              (VOID *)NamespaceData
  98              );
  99   if (EFI_ERROR(Status)) {
 100     goto Exit;
 101   }
 102   //
 103   // Validate Namespace
 104   //
 105   if (NamespaceData->Ncap == 0) {
 106     Status = EFI_DEVICE_ERROR;
 107   } else {
 108     //
 109     // allocate device private data for each discovered namespace
 110     //
 111     Device = AllocateZeroPool(sizeof(NVME_DEVICE_PRIVATE_DATA));
 112     if (Device == NULL) {
 113       Status = EFI_OUT_OF_RESOURCES;
 114       goto Exit;
 115     }
 116
 117     //
 118     // Initialize SSD namespace instance data
 119     //
 120     Device->Signature           = NVME_DEVICE_PRIVATE_DATA_SIGNATURE;
 121     Device->NamespaceId         = NamespaceId;
 122     Device->NamespaceUuid       = NamespaceData->Eui64;
 123
 124     Device->ControllerHandle    = Private->ControllerHandle;
 125     Device->DriverBindingHandle = Private->DriverBindingHandle;
 126     Device->Controller          = Private;
 127
 128     //
 129     // Build BlockIo media structure
 130     //
 131     Device->Media.MediaId        = 0;
 132     Device->Media.RemovableMedia = FALSE;
 133     Device->Media.MediaPresent   = TRUE;
 134     Device->Media.LogicalPartition = FALSE;
 135     Device->Media.ReadOnly       = FALSE;
 136     Device->Media.WriteCaching   = FALSE;
 137
 138     Flbas     = NamespaceData->Flbas;
 139     LbaFmtIdx = Flbas & 0xF;
 140     Lbads     = NamespaceData->LbaFormat[LbaFmtIdx].Lbads;
 141     Device->Media.BlockSize = (UINT32)1 << Lbads;
 142
 143     Device->Media.LastBlock                     = NamespaceData->Nsze - 1;
 144     Device->Media.LogicalBlocksPerPhysicalBlock = 1;
 145     Device->Media.LowestAlignedLba              = 1;
 146
 147     //
 148     // Create BlockIo Protocol instance
 149     //
 150     Device->BlockIo.Revision     = EFI_BLOCK_IO_PROTOCOL_REVISION2;
 151     Device->BlockIo.Media        = &Device->Media;
 152     Device->BlockIo.Reset        = NvmeBlockIoReset;
 153     Device->BlockIo.ReadBlocks   = NvmeBlockIoReadBlocks;
 154     Device->BlockIo.WriteBlocks  = NvmeBlockIoWriteBlocks;
 155     Device->BlockIo.FlushBlocks  = NvmeBlockIoFlushBlocks;
 156
 157     //
 158     // Create DiskInfo Protocol instance
 159     //
 160     InitializeDiskInfo (Device);
 161
 162     //
 163     // Create a Nvm Express Namespace Device Path Node
 164     //
 165     Status = Private->Passthru.BuildDevicePath (
 166                                  &Private->Passthru,
 167                                  Device->NamespaceId,
 168                                  &NewDevicePathNode
 169                                  );
 170
 171     if (EFI_ERROR(Status)) {
 172       goto Exit;
 173     }
 174
 175     //
 176     // Append the SSD node to the controller's device path
 177     //
 178     DevicePath = AppendDevicePathNode (ParentDevicePath, NewDevicePathNode);
 179     if (DevicePath == NULL) {
 180       Status = EFI_OUT_OF_RESOURCES;
 181       goto Exit;
 182     }
 183
 184     DeviceHandle = NULL;
 185     RemainingDevicePath = DevicePath;
 186     Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &DeviceHandle);
 187     if (!EFI_ERROR (Status) && (DeviceHandle != NULL) && IsDevicePathEnd(RemainingDevicePath)) {
 188       Status = EFI_ALREADY_STARTED;
 189       FreePool (DevicePath);
 190       goto Exit;
 191     }
 192
 193     Device->DevicePath = DevicePath;
 194
 195     //
 196     // Make sure the handle is NULL so we create a new handle
 197     //
 198     Device->DeviceHandle = NULL;
 199
 200     Status = gBS->InstallMultipleProtocolInterfaces (
 201                     &Device->DeviceHandle,
 202                     &gEfiDevicePathProtocolGuid,
 203                     Device->DevicePath,
 204                     &gEfiBlockIoProtocolGuid,
 205                     &Device->BlockIo,
 206                     &gEfiDiskInfoProtocolGuid,
 207                     &Device->DiskInfo,
 208                     NULL
 209                     );
 210
 211     if(EFI_ERROR(Status)) {
 212       goto Exit;
 213     }
 214     gBS->OpenProtocol (
 215            Private->ControllerHandle,
 216            &gEfiPciIoProtocolGuid,
 217            (VOID **) &Private->PciIo,
 218            Private->DriverBindingHandle,
 219            Device->DeviceHandle,
 220            EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
 221            );
 222
 223     //
 224     // Dump NvmExpress Identify Namespace Data
 225     //
 226     DEBUG ((EFI_D_INFO, " == NVME IDENTIFY NAMESPACE [%d] DATA ==\n", NamespaceId));
 227     DEBUG ((EFI_D_INFO, "    NSZE        : 0x%x\n", NamespaceData->Nsze));
 228     DEBUG ((EFI_D_INFO, "    NCAP        : 0x%x\n", NamespaceData->Ncap));
 229     DEBUG ((EFI_D_INFO, "    NUSE        : 0x%x\n", NamespaceData->Nuse));
 230     DEBUG ((EFI_D_INFO, "    LBAF0.LBADS : 0x%x\n", (NamespaceData->LbaFormat[0].Lbads)));
 231
 232     //
 233     // Build controller name for Component Name (2) protocol.
 234     //
 235     UnicodeSPrintAsciiFormat (Device->ModelName, sizeof (Device->ModelName), "%a-%a-%x", Private->ControllerData->Sn, Private->ControllerData->Mn, NamespaceData->Eui64);
 236
 237     AddUnicodeString2 (
 238       "eng",
 239       gNvmExpressComponentName.SupportedLanguages,
 240       &Device->ControllerNameTable,
 241       Device->ModelName,
 242       TRUE
 243       );
 244
 245     AddUnicodeString2 (
 246       "en",
 247       gNvmExpressComponentName2.SupportedLanguages,
 248       &Device->ControllerNameTable,
 249       Device->ModelName,
 250       FALSE
 251       );
 252   }
 253
 254 Exit:
 255   if(NamespaceData != NULL) {
 256     FreePool (NamespaceData);
 257   }
 258
 259   if (NewDevicePathNode != NULL) {
 260     FreePool (NewDevicePathNode);
 261   }
 262
 263   if(EFI_ERROR(Status) && (Device != NULL) && (Device->DevicePath != NULL)) {
 264     FreePool (Device->DevicePath);
 265   }
 266   if(EFI_ERROR(Status) && (Device != NULL)) {
 267     FreePool (Device);
 268   }
 269   return Status;
 270 }
 271
 272 /**
 273   Discover all Nvm Express device namespaces, and create child handles for them with BlockIo
 274   and DiskInfo protocol instances.
 275
 276   @param[in] Private         The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure.
 277
 278   @retval EFI_SUCCESS        All the namespaces in the device are successfully enumerated.
 279   @return Others             Some error occurs when enumerating the namespaces.
 280
 281 **/
 282 EFI_STATUS
 283 DiscoverAllNamespaces (
 284   IN NVME_CONTROLLER_PRIVATE_DATA       *Private
 285   )
 286 {
 287   EFI_STATUS                            Status;
 288   UINT32                                NamespaceId;
 289   EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL    *Passthru;
 290
 291   NamespaceId   = 0xFFFFFFFF;
 292   Passthru      = &Private->Passthru;
 293
 294   while (TRUE) {
 295     Status = Passthru->GetNextNamespace (
 296                          Passthru,
 297                          (UINT32 *)&NamespaceId
 298                          );
 299
 300     if (EFI_ERROR (Status)) {
 301       break;
 302     }
 303
 304     Status = EnumerateNvmeDevNamespace (
 305                Private,
 306                NamespaceId
 307                );
 308
 309     if (EFI_ERROR(Status)) {
 310       continue;
 311     }
 312   }
 313
 314   return EFI_SUCCESS;
 315 }
 316
 317 /**
 318   Unregisters a Nvm Express device namespace.
 319
 320   This function removes the protocols installed on the controller handle and
 321   frees the resources allocated for the namespace.
 322
 323   @param  This                  The pointer to EFI_DRIVER_BINDING_PROTOCOL instance.
 324   @param  Controller            The controller handle of the namespace.
 325   @param  Handle                The child handle.
 326
 327   @retval EFI_SUCCESS           The namespace is successfully unregistered.
 328   @return Others                Some error occurs when unregistering the namespace.
 329
 330 **/
 331 EFI_STATUS
 332 UnregisterNvmeNamespace (
 333   IN  EFI_DRIVER_BINDING_PROTOCOL    *This,
 334   IN  EFI_HANDLE                     Controller,
 335   IN  EFI_HANDLE                     Handle
 336   )
 337 {
 338   EFI_STATUS                               Status;
 339   EFI_PCI_IO_PROTOCOL                      *PciIo;
 340   EFI_BLOCK_IO_PROTOCOL                    *BlockIo;
 341   NVME_DEVICE_PRIVATE_DATA                 *Device;
 342
 343   BlockIo = NULL;
 344
 345   Status = gBS->OpenProtocol (
 346                   Handle,
 347                   &gEfiBlockIoProtocolGuid,
 348                   (VOID **) &BlockIo,
 349                   This->DriverBindingHandle,
 350                   Controller,
 351                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
 352                   );
 353   if (EFI_ERROR (Status)) {
 354     return Status;
 355   }
 356
 357   Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (BlockIo);
 358
 359   //
 360   // Close the child handle
 361   //
 362   gBS->CloseProtocol (
 363          Controller,
 364          &gEfiPciIoProtocolGuid,
 365          This->DriverBindingHandle,
 366          Handle
 367          );
 368
 369   //
 370   // The Nvm Express driver installs the BlockIo and DiskInfo in the DriverBindingStart().
 371   // Here should uninstall both of them.
 372   //
 373   Status = gBS->UninstallMultipleProtocolInterfaces (
 374                   Handle,
 375                   &gEfiDevicePathProtocolGuid,
 376                   Device->DevicePath,
 377                   &gEfiBlockIoProtocolGuid,
 378                   &Device->BlockIo,
 379                   &gEfiDiskInfoProtocolGuid,
 380                   &Device->DiskInfo,
 381                   NULL
 382                   );
 383
 384   if (EFI_ERROR (Status)) {
 385     gBS->OpenProtocol (
 386            Controller,
 387            &gEfiPciIoProtocolGuid,
 388            (VOID **) &PciIo,
 389            This->DriverBindingHandle,
 390            Handle,
 391            EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
 392            );
 393     return Status;
 394   }
 395
 396   if(Device->DevicePath != NULL) {
 397     FreePool (Device->DevicePath);
 398   }
 399
 400   if (Device->ControllerNameTable != NULL) {
 401     FreeUnicodeStringTable (Device->ControllerNameTable);
 402   }
 403
 404   FreePool (Device);
 405
 406   return EFI_SUCCESS;
 407 }
 408
 409 /**
 410   Tests to see if this driver supports a given controller. If a child device is provided,
 411   it further tests to see if this driver supports creating a handle for the specified child device.
 412
 413   This function checks to see if the driver specified by This supports the device specified by
 414   ControllerHandle. Drivers will typically use the device path attached to
 415   ControllerHandle and/or the services from the bus I/O abstraction attached to
 416   ControllerHandle to determine if the driver supports ControllerHandle. This function
 417   may be called many times during platform initialization. In order to reduce boot times, the tests
 418   performed by this function must be very small, and take as little time as possible to execute. This
 419   function must not change the state of any hardware devices, and this function must be aware that the
 420   device specified by ControllerHandle may already be managed by the same driver or a
 421   different driver. This function must match its calls to AllocatePages() with FreePages(),
 422   AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
 423   Since ControllerHandle may have been previously started by the same driver, if a protocol is
 424   already in the opened state, then it must not be closed with CloseProtocol(). This is required
 425   to guarantee the state of ControllerHandle is not modified by this function.
 426
 427   @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
 428   @param[in]  ControllerHandle     The handle of the controller to test. This handle
 429                                    must support a protocol interface that supplies
 430                                    an I/O abstraction to the driver.
 431   @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This
 432                                    parameter is ignored by device drivers, and is optional for bus
 433                                    drivers. For bus drivers, if this parameter is not NULL, then
 434                                    the bus driver must determine if the bus controller specified
 435                                    by ControllerHandle and the child controller specified
 436                                    by RemainingDevicePath are both supported by this
 437                                    bus driver.
 438
 439   @retval EFI_SUCCESS              The device specified by ControllerHandle and
 440                                    RemainingDevicePath is supported by the driver specified by This.
 441   @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and
 442                                    RemainingDevicePath is already being managed by the driver
 443                                    specified by This.
 444   @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and
 445                                    RemainingDevicePath is already being managed by a different
 446                                    driver or an application that requires exclusive access.
 447                                    Currently not implemented.
 448   @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and
 449                                    RemainingDevicePath is not supported by the driver specified by This.
 450 **/
 451 EFI_STATUS
 452 EFIAPI
 453 NvmExpressDriverBindingSupported (
 454   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
 455   IN EFI_HANDLE                   Controller,
 456   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
 457   )
 458 {
 459   EFI_STATUS                Status;
 460   EFI_DEV_PATH_PTR          DevicePathNode;
 461   EFI_DEVICE_PATH_PROTOCOL  *ParentDevicePath;
 462   EFI_PCI_IO_PROTOCOL       *PciIo;
 463   UINT8                     ClassCode[3];
 464
 465   //
 466   // Check whether device path is valid
 467   //
 468   if (RemainingDevicePath != NULL) {
 469     //
 470     // Check if RemainingDevicePath is the End of Device Path Node,
 471     // if yes, go on checking other conditions
 472     //
 473     if (!IsDevicePathEnd (RemainingDevicePath)) {
 474       //
 475       // If RemainingDevicePath isn't the End of Device Path Node,
 476       // check its validation
 477       //
 478       DevicePathNode.DevPath = RemainingDevicePath;
 479
 480       if ((DevicePathNode.DevPath->Type    != MESSAGING_DEVICE_PATH) ||
 481           (DevicePathNode.DevPath->SubType != MSG_NVME_NAMESPACE_DP) ||
 482            DevicePathNodeLength(DevicePathNode.DevPath) != sizeof(NVME_NAMESPACE_DEVICE_PATH)) {
 483         return EFI_UNSUPPORTED;
 484       }
 485     }
 486   }
 487
 488   //
 489   // Open the EFI Device Path protocol needed to perform the supported test
 490   //
 491   Status = gBS->OpenProtocol (
 492                   Controller,
 493                   &gEfiDevicePathProtocolGuid,
 494                   (VOID **) &ParentDevicePath,
 495                   This->DriverBindingHandle,
 496                   Controller,
 497                   EFI_OPEN_PROTOCOL_BY_DRIVER
 498                   );
 499   if (Status == EFI_ALREADY_STARTED) {
 500     return EFI_SUCCESS;
 501   }
 502
 503   if (EFI_ERROR (Status)) {
 504     return Status;
 505   }
 506
 507   //
 508   // Close protocol, don't use device path protocol in the Support() function
 509   //
 510   gBS->CloseProtocol (
 511          Controller,
 512          &gEfiDevicePathProtocolGuid,
 513          This->DriverBindingHandle,
 514          Controller
 515          );
 516
 517   //
 518   // Attempt to Open PCI I/O Protocol
 519   //
 520   Status = gBS->OpenProtocol (
 521                   Controller,
 522                   &gEfiPciIoProtocolGuid,
 523                   (VOID **) &PciIo,
 524                   This->DriverBindingHandle,
 525                   Controller,
 526                   EFI_OPEN_PROTOCOL_BY_DRIVER
 527                   );
 528   if (Status == EFI_ALREADY_STARTED) {
 529     return EFI_SUCCESS;
 530   }
 531
 532   if (EFI_ERROR (Status)) {
 533     return Status;
 534   }
 535
 536   //
 537   // Now further check the PCI header: Base class (offset 0x0B) and Sub Class (offset 0x0A).
 538   // This controller should be a Nvm Express controller.
 539   //
 540   Status = PciIo->Pci.Read (
 541                         PciIo,
 542                         EfiPciIoWidthUint8,
 543                         PCI_CLASSCODE_OFFSET,
 544                         sizeof (ClassCode),
 545                         ClassCode
 546                         );
 547   if (EFI_ERROR (Status)) {
 548     goto Done;
 549   }
 550
 551   //
 552   // Examine Nvm Express controller PCI Configuration table fields
 553   //
 554   if ((ClassCode[0] != PCI_IF_NVMHCI) || (ClassCode[1] != PCI_CLASS_MASS_STORAGE_NVM) || (ClassCode[2] != PCI_CLASS_MASS_STORAGE)) {
 555     Status = EFI_UNSUPPORTED;
 556   }
 557
 558 Done:
 559   gBS->CloseProtocol (
 560          Controller,
 561          &gEfiPciIoProtocolGuid,
 562          This->DriverBindingHandle,
 563          Controller
 564          );
 565
 566   return Status;
 567 }
 568
 569
 570 /**
 571   Starts a device controller or a bus controller.
 572
 573   The Start() function is designed to be invoked from the EFI boot service ConnectController().
 574   As a result, much of the error checking on the parameters to Start() has been moved into this
 575   common boot service. It is legal to call Start() from other locations,
 576   but the following calling restrictions must be followed or the system behavior will not be deterministic.
 577   1. ControllerHandle must be a valid EFI_HANDLE.
 578   2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
 579      EFI_DEVICE_PATH_PROTOCOL.
 580   3. Prior to calling Start(), the Supported() function for the driver specified by This must
 581      have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
 582
 583   @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
 584   @param[in]  ControllerHandle     The handle of the controller to start. This handle
 585                                    must support a protocol interface that supplies
 586                                    an I/O abstraction to the driver.
 587   @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This
 588                                    parameter is ignored by device drivers, and is optional for bus
 589                                    drivers. For a bus driver, if this parameter is NULL, then handles
 590                                    for all the children of Controller are created by this driver.
 591                                    If this parameter is not NULL and the first Device Path Node is
 592                                    not the End of Device Path Node, then only the handle for the
 593                                    child device specified by the first Device Path Node of
 594                                    RemainingDevicePath is created by this driver.
 595                                    If the first Device Path Node of RemainingDevicePath is
 596                                    the End of Device Path Node, no child handle is created by this
 597                                    driver.
 598
 599   @retval EFI_SUCCESS              The device was started.
 600   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.
 601   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.
 602   @retval Others                   The driver failded to start the device.
 603
 604 **/
 605 EFI_STATUS
 606 EFIAPI
 607 NvmExpressDriverBindingStart (
 608   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
 609   IN EFI_HANDLE                   Controller,
 610   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
 611   )
 612 {
 613   EFI_STATUS                          Status;
 614   EFI_PCI_IO_PROTOCOL                 *PciIo;
 615   NVME_CONTROLLER_PRIVATE_DATA        *Private;
 616   EFI_DEVICE_PATH_PROTOCOL            *ParentDevicePath;
 617   UINT32                              NamespaceId;
 618   EFI_PHYSICAL_ADDRESS                MappedAddr;
 619   UINTN                               Bytes;
 620   EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL  *Passthru;
 621
 622   DEBUG ((EFI_D_INFO, "NvmExpressDriverBindingStart: start\n"));
 623
 624   Private          = NULL;
 625   Passthru         = NULL;
 626   ParentDevicePath = NULL;
 627
 628   Status = gBS->OpenProtocol (
 629                   Controller,
 630                   &gEfiDevicePathProtocolGuid,
 631                   (VOID **) &ParentDevicePath,
 632                   This->DriverBindingHandle,
 633                   Controller,
 634                   EFI_OPEN_PROTOCOL_BY_DRIVER
 635                   );
 636   if ((EFI_ERROR (Status)) && (Status != EFI_ALREADY_STARTED)) {
 637     return Status;
 638   }
 639
 640   Status = gBS->OpenProtocol (
 641                   Controller,
 642                   &gEfiPciIoProtocolGuid,
 643                   (VOID **) &PciIo,
 644                   This->DriverBindingHandle,
 645                   Controller,
 646                   EFI_OPEN_PROTOCOL_BY_DRIVER
 647                   );
 648
 649   if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {
 650     return Status;
 651   }
 652
 653   //
 654   // Check EFI_ALREADY_STARTED to reuse the original NVME_CONTROLLER_PRIVATE_DATA.
 655   //
 656   if (Status != EFI_ALREADY_STARTED) {
 657     Private = AllocateZeroPool (sizeof (NVME_CONTROLLER_PRIVATE_DATA));
 658
 659     if (Private == NULL) {
 660       DEBUG ((EFI_D_ERROR, "NvmExpressDriverBindingStart: allocating pool for Nvme Private Data failed!\n"));
 661       Status = EFI_OUT_OF_RESOURCES;
 662       goto Exit;
 663     }
 664
 665     //
 666     // 4 x 4kB aligned buffers will be carved out of this buffer.
 667     // 1st 4kB boundary is the start of the admin submission queue.
 668     // 2nd 4kB boundary is the start of the admin completion queue.
 669     // 3rd 4kB boundary is the start of I/O submission queue #1.
 670     // 4th 4kB boundary is the start of I/O completion queue #1.
 671     //
 672     // Allocate 4 pages of memory, then map it for bus master read and write.
 673     //
 674     Status = PciIo->AllocateBuffer (
 675                       PciIo,
 676                       AllocateAnyPages,
 677                       EfiBootServicesData,
 678                       4,
 679                       (VOID**)&Private->Buffer,
 680                       0
 681                       );
 682     if (EFI_ERROR (Status)) {
 683       goto Exit;
 684     }
 685
 686     Bytes = EFI_PAGES_TO_SIZE (4);
 687     Status = PciIo->Map (
 688                       PciIo,
 689                       EfiPciIoOperationBusMasterCommonBuffer,
 690                       Private->Buffer,
 691                       &Bytes,
 692                       &MappedAddr,
 693                       &Private->Mapping
 694                       );
 695
 696     if (EFI_ERROR (Status) || (Bytes != EFI_PAGES_TO_SIZE (4))) {
 697       goto Exit;
 698     }
 699
 700     Private->BufferPciAddr = (UINT8 *)(UINTN)MappedAddr;
 701     ZeroMem (Private->Buffer, EFI_PAGES_TO_SIZE (4));
 702
 703     Private->Signature = NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE;
 704     Private->ControllerHandle          = Controller;
 705     Private->ImageHandle               = This->DriverBindingHandle;
 706     Private->DriverBindingHandle       = This->DriverBindingHandle;
 707     Private->PciIo                     = PciIo;
 708     Private->ParentDevicePath          = ParentDevicePath;
 709     Private->Passthru.Mode             = &Private->PassThruMode;
 710     Private->Passthru.PassThru         = NvmExpressPassThru;
 711     Private->Passthru.GetNextNamespace = NvmExpressGetNextNamespace;
 712     Private->Passthru.BuildDevicePath  = NvmExpressBuildDevicePath;
 713     Private->Passthru.GetNamespace     = NvmExpressGetNamespace;
 714     CopyMem (&Private->PassThruMode, &gEfiNvmExpressPassThruMode, sizeof (EFI_NVM_EXPRESS_PASS_THRU_MODE));
 715
 716     Status = NvmeControllerInit (Private);
 717     if (EFI_ERROR(Status)) {
 718       goto Exit;
 719     }
 720
 721     Status = gBS->InstallMultipleProtocolInterfaces (
 722                     &Controller,
 723                     &gEfiNvmExpressPassThruProtocolGuid,
 724                     &Private->Passthru,
 725                     NULL
 726                     );
 727     if (EFI_ERROR (Status)) {
 728       goto Exit;
 729     }
 730   } else {
 731     Status = gBS->OpenProtocol (
 732                     Controller,
 733                     &gEfiNvmExpressPassThruProtocolGuid,
 734                     (VOID **) &Passthru,
 735                     This->DriverBindingHandle,
 736                     Controller,
 737                     EFI_OPEN_PROTOCOL_GET_PROTOCOL
 738                     );
 739     if (EFI_ERROR (Status)) {
 740       goto Exit;
 741     }
 742
 743     Private = NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU (Passthru);
 744   }
 745
 746   if (RemainingDevicePath == NULL) {
 747     //
 748     // Enumerate all NVME namespaces in the controller
 749     //
 750     Status = DiscoverAllNamespaces (
 751                Private
 752                );
 753
 754   } else if (!IsDevicePathEnd (RemainingDevicePath)) {
 755     //
 756     // Enumerate the specified NVME namespace
 757     //
 758     Status = Private->Passthru.GetNamespace (
 759                                  &Private->Passthru,
 760                                  RemainingDevicePath,
 761                                  &NamespaceId
 762                                  );
 763
 764     if (!EFI_ERROR (Status)) {
 765       Status = EnumerateNvmeDevNamespace (
 766                  Private,
 767                  NamespaceId
 768                  );
 769     }
 770   }
 771
 772   DEBUG ((EFI_D_INFO, "NvmExpressDriverBindingStart: end successfully\n"));
 773   return EFI_SUCCESS;
 774
 775 Exit:
 776   if ((Private != NULL) && (Private->Mapping != NULL)) {
 777     PciIo->Unmap (PciIo, Private->Mapping);
 778   }
 779
 780   if ((Private != NULL) && (Private->Buffer != NULL)) {
 781     PciIo->FreeBuffer (PciIo, 4, Private->Buffer);
 782   }
 783
 784   if (Private != NULL) {
 785     FreePool (Private);
 786   }
 787
 788   gBS->CloseProtocol (
 789          Controller,
 790          &gEfiPciIoProtocolGuid,
 791          This->DriverBindingHandle,
 792          Controller
 793          );
 794
 795   gBS->CloseProtocol (
 796          Controller,
 797          &gEfiDevicePathProtocolGuid,
 798          This->DriverBindingHandle,
 799          Controller
 800          );
 801
 802   DEBUG ((EFI_D_INFO, "NvmExpressDriverBindingStart: end with %r\n", Status));
 803
 804   return Status;
 805 }
 806
 807
 808 /**
 809   Stops a device controller or a bus controller.
 810
 811   The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
 812   As a result, much of the error checking on the parameters to Stop() has been moved
 813   into this common boot service. It is legal to call Stop() from other locations,
 814   but the following calling restrictions must be followed or the system behavior will not be deterministic.
 815   1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
 816      same driver's Start() function.
 817   2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
 818      EFI_HANDLE. In addition, all of these handles must have been created in this driver's
 819      Start() function, and the Start() function must have called OpenProtocol() on
 820      ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
 821
 822   @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
 823   @param[in]  ControllerHandle  A handle to the device being stopped. The handle must
 824                                 support a bus specific I/O protocol for the driver
 825                                 to use to stop the device.
 826   @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.
 827   @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL
 828                                 if NumberOfChildren is 0.
 829
 830   @retval EFI_SUCCESS           The device was stopped.
 831   @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.
 832
 833 **/
 834 EFI_STATUS
 835 EFIAPI
 836 NvmExpressDriverBindingStop (
 837   IN  EFI_DRIVER_BINDING_PROTOCOL     *This,
 838   IN  EFI_HANDLE                      Controller,
 839   IN  UINTN                           NumberOfChildren,
 840   IN  EFI_HANDLE                      *ChildHandleBuffer
 841   )
 842 {
 843   EFI_STATUS                          Status;
 844   BOOLEAN                             AllChildrenStopped;
 845   UINTN                               Index;
 846   NVME_CONTROLLER_PRIVATE_DATA        *Private;
 847
 848   if (NumberOfChildren == 0) {
 849     Status = gBS->OpenProtocol (
 850                     Controller,
 851                     &gEfiCallerIdGuid,
 852                     (VOID **) &Private,
 853                     This->DriverBindingHandle,
 854                     Controller,
 855                     EFI_OPEN_PROTOCOL_GET_PROTOCOL
 856                     );
 857
 858     if (!EFI_ERROR (Status)) {
 859       gBS->UninstallMultipleProtocolInterfaces (
 860             Controller,
 861             &gEfiCallerIdGuid,
 862             Private,
 863             NULL
 864             );
 865
 866       if (Private->Mapping != NULL) {
 867         Private->PciIo->Unmap (Private->PciIo, Private->Mapping);
 868       }
 869
 870       if (Private->Buffer != NULL) {
 871         Private->PciIo->FreeBuffer (Private->PciIo, 4, Private->Buffer);
 872       }
 873
 874       FreePool (Private->ControllerData);
 875       FreePool (Private);
 876     }
 877
 878     gBS->CloseProtocol (
 879           Controller,
 880           &gEfiPciIoProtocolGuid,
 881           This->DriverBindingHandle,
 882           Controller
 883           );
 884     gBS->CloseProtocol (
 885           Controller,
 886           &gEfiDevicePathProtocolGuid,
 887           This->DriverBindingHandle,
 888           Controller
 889           );
 890     return EFI_SUCCESS;
 891   }
 892
 893   AllChildrenStopped = TRUE;
 894
 895   for (Index = 0; Index < NumberOfChildren; Index++) {
 896     Status = UnregisterNvmeNamespace (This, Controller, ChildHandleBuffer[Index]);
 897     if (EFI_ERROR (Status)) {
 898       AllChildrenStopped = FALSE;
 899     }
 900   }
 901
 902   if (!AllChildrenStopped) {
 903     return EFI_DEVICE_ERROR;
 904   }
 905
 906   return EFI_SUCCESS;
 907 }
 908
 909 /**
 910   This is the unload handle for the NVM Express driver.
 911
 912   Disconnect the driver specified by ImageHandle from the NVMe device in the handle database.
 913   Uninstall all the protocols installed in the driver.
 914
 915   @param[in]  ImageHandle       The drivers' driver image.
 916
 917   @retval EFI_SUCCESS           The image is unloaded.
 918   @retval Others                Failed to unload the image.
 919
 920 **/
 921 EFI_STATUS
 922 EFIAPI
 923 NvmExpressUnload (
 924   IN EFI_HANDLE             ImageHandle
 925   )
 926 {
 927   EFI_STATUS                        Status;
 928   EFI_HANDLE                        *DeviceHandleBuffer;
 929   UINTN                             DeviceHandleCount;
 930   UINTN                             Index;
 931   EFI_COMPONENT_NAME_PROTOCOL       *ComponentName;
 932   EFI_COMPONENT_NAME2_PROTOCOL      *ComponentName2;
 933
 934   //
 935   // Get the list of the device handles managed by this driver.
 936   // If there is an error getting the list, then means the driver
 937   // doesn't manage any device. At this way, we would only close
 938   // those protocols installed at image handle.
 939   //
 940   DeviceHandleBuffer = NULL;
 941   Status = gBS->LocateHandleBuffer (
 942                   ByProtocol,
 943                   &gEfiCallerIdGuid,
 944                   NULL,
 945                   &DeviceHandleCount,
 946                   &DeviceHandleBuffer
 947                   );
 948
 949   if (!EFI_ERROR (Status)) {
 950     //
 951     // Disconnect the driver specified by ImageHandle from all
 952     // the devices in the handle database.
 953     //
 954     for (Index = 0; Index < DeviceHandleCount; Index++) {
 955       Status = gBS->DisconnectController (
 956                       DeviceHandleBuffer[Index],
 957                       ImageHandle,
 958                       NULL
 959                       );
 960       if (EFI_ERROR (Status)) {
 961         goto EXIT;
 962       }
 963     }
 964   }
 965
 966   //
 967   // Uninstall all the protocols installed in the driver entry point
 968   //
 969   Status = gBS->UninstallMultipleProtocolInterfaces (
 970                   ImageHandle,
 971                   &gEfiDriverBindingProtocolGuid,
 972                   &gNvmExpressDriverBinding,
 973                   &gEfiDriverSupportedEfiVersionProtocolGuid,
 974                   &gNvmExpressDriverSupportedEfiVersion,
 975                   NULL
 976                   );
 977
 978   if (EFI_ERROR (Status)) {
 979     goto EXIT;
 980   }
 981
 982   //
 983   // Note we have to one by one uninstall the following protocols.
 984   // It's because some of them are optionally installed based on
 985   // the following PCD settings.
 986   //   gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable
 987   //   gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable
 988   //   gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable
 989   //   gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable
 990   //
 991   Status = gBS->HandleProtocol (
 992                   ImageHandle,
 993                   &gEfiComponentNameProtocolGuid,
 994                   (VOID **) &ComponentName
 995                   );
 996   if (!EFI_ERROR (Status)) {
 997     gBS->UninstallProtocolInterface (
 998            ImageHandle,
 999            &gEfiComponentNameProtocolGuid,
1000            ComponentName
1001            );
1002   }
1003
1004   Status = gBS->HandleProtocol (
1005                   ImageHandle,
1006                   &gEfiComponentName2ProtocolGuid,
1007                   (VOID **) &ComponentName2
1008                   );
1009   if (!EFI_ERROR (Status)) {
1010     gBS->UninstallProtocolInterface (
1011            ImageHandle,
1012            &gEfiComponentName2ProtocolGuid,
1013            ComponentName2
1014            );
1015   }
1016
1017   Status = EFI_SUCCESS;
1018
1019 EXIT:
1020   //
1021   // Free the buffer containing the list of handles from the handle database
1022   //
1023   if (DeviceHandleBuffer != NULL) {
1024     gBS->FreePool (DeviceHandleBuffer);
1025   }
1026   return Status;
1027 }
1028
1029 /**
1030   The entry point for Nvm Express driver, used to install Nvm Express driver on the ImageHandle.
1031
1032   @param  ImageHandle   The firmware allocated handle for this driver image.
1033   @param  SystemTable   Pointer to the EFI system table.
1034
1035   @retval EFI_SUCCESS   Driver loaded.
1036   @retval other         Driver not loaded.
1037
1038 **/
1039 EFI_STATUS
1040 EFIAPI
1041 NvmExpressDriverEntry (
1042   IN EFI_HANDLE        ImageHandle,
1043   IN EFI_SYSTEM_TABLE  *SystemTable
1044   )
1045 {
1046   EFI_STATUS              Status;
1047
1048   Status = EfiLibInstallDriverBindingComponentName2 (
1049              ImageHandle,
1050              SystemTable,
1051              &gNvmExpressDriverBinding,
1052              ImageHandle,
1053              &gNvmExpressComponentName,
1054              &gNvmExpressComponentName2
1055              );
1056   ASSERT_EFI_ERROR (Status);
1057
1058   //
1059   // Install EFI Driver Supported EFI Version Protocol required for
1060   // EFI drivers that are on PCI and other plug in cards.
1061   //
1062   gNvmExpressDriverSupportedEfiVersion.FirmwareVersion = 0x00020028;
1063   Status = gBS->InstallMultipleProtocolInterfaces (
1064                   &ImageHandle,
1065                   &gEfiDriverSupportedEfiVersionProtocolGuid,
1066                   &gNvmExpressDriverSupportedEfiVersion,
1067                   NULL
1068                   );
1069   ASSERT_EFI_ERROR (Status);
1070   return Status;
1071 }