/** Discover all Nvm Express device namespaces, and create child handles for them with BlockIo and DiskInfo protocol instances. @param[in] Private The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure. @retval EFI_SUCCESS All the namespaces in the device are successfully enumerated. @return Others Some error occurs when enumerating the namespaces. **/ EFI_STATUS DiscoverAllNamespaces ( IN NVME_CONTROLLER_PRIVATE_DATA *Private ) { EFI_STATUS Status; UINT32 NamespaceId; EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *Passthru; NamespaceId = 0xFFFFFFFF; Passthru = &Private->Passthru; while (TRUE) { Status = Passthru->GetNextNamespace ( Passthru, (UINT32 *)&NamespaceId ); if (EFI_ERROR (Status)) { break; } Status = EnumerateNvmeDevNamespace ( Private, NamespaceId ); if (EFI_ERROR(Status)) { continue; } } return EFI_SUCCESS; }
/** Discover all Nvm Express device active namespaces. @param[in,out] Private The pointer to the PEI_NVME_CONTROLLER_PRIVATE_DATA data structure. @retval EFI_SUCCESS All the namespaces in the device are successfully enumerated. @return EFI_NOT_FOUND No active namespaces can be found. **/ EFI_STATUS NvmeDiscoverNamespaces ( IN OUT PEI_NVME_CONTROLLER_PRIVATE_DATA *Private ) { UINT32 NamespaceId; Private->ActiveNamespaceNum = 0; Private->NamespaceInfo = AllocateZeroPool (Private->ControllerData->Nn * sizeof (PEI_NVME_NAMESPACE_INFO)); // // According to Nvm Express 1.1 spec Figure 82, the field 'Nn' of the identify // controller data defines the number of valid namespaces present for the // controller. Namespaces shall be allocated in order (starting with 1) and // packed sequentially. // for (NamespaceId = 1; NamespaceId <= Private->ControllerData->Nn; NamespaceId++) { // // For now, we do not care the return status. Since if a valid namespace is inactive, // error status will be returned. But we continue to enumerate other valid namespaces. // EnumerateNvmeDevNamespace (Private, NamespaceId); } if (Private->ActiveNamespaceNum == 0) { return EFI_NOT_FOUND; } return EFI_SUCCESS; }
/** Starts a device controller or a bus controller. The Start() function is designed to be invoked from the EFI boot service ConnectController(). As a result, much of the error checking on the parameters to Start() has been moved into this common boot service. It is legal to call Start() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic. 1. ControllerHandle must be a valid EFI_HANDLE. 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL. 3. Prior to calling Start(), the Supported() function for the driver specified by This must have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. @param[in] ControllerHandle The handle of the controller to start. This handle must support a protocol interface that supplies an I/O abstraction to the driver. @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For a bus driver, if this parameter is NULL, then handles for all the children of Controller are created by this driver. If this parameter is not NULL and the first Device Path Node is not the End of Device Path Node, then only the handle for the child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this driver. @retval EFI_SUCCESS The device was started. @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval Others The driver failded to start the device. **/ EFI_STATUS EFIAPI NvmExpressDriverBindingStart ( IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath ) { EFI_STATUS Status; EFI_PCI_IO_PROTOCOL *PciIo; NVME_CONTROLLER_PRIVATE_DATA *Private; EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; UINT32 NamespaceId; EFI_PHYSICAL_ADDRESS MappedAddr; UINTN Bytes; EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *Passthru; DEBUG ((EFI_D_INFO, "NvmExpressDriverBindingStart: start\n")); Private = NULL; Passthru = NULL; ParentDevicePath = NULL; Status = gBS->OpenProtocol ( Controller, &gEfiDevicePathProtocolGuid, (VOID **) &ParentDevicePath, This->DriverBindingHandle, Controller, EFI_OPEN_PROTOCOL_BY_DRIVER ); if ((EFI_ERROR (Status)) && (Status != EFI_ALREADY_STARTED)) { return Status; } Status = gBS->OpenProtocol ( Controller, &gEfiPciIoProtocolGuid, (VOID **) &PciIo, This->DriverBindingHandle, Controller, EFI_OPEN_PROTOCOL_BY_DRIVER ); if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) { return Status; } // // Check EFI_ALREADY_STARTED to reuse the original NVME_CONTROLLER_PRIVATE_DATA. // if (Status != EFI_ALREADY_STARTED) { Private = AllocateZeroPool (sizeof (NVME_CONTROLLER_PRIVATE_DATA)); if (Private == NULL) { DEBUG ((EFI_D_ERROR, "NvmExpressDriverBindingStart: allocating pool for Nvme Private Data failed!\n")); Status = EFI_OUT_OF_RESOURCES; goto Exit; } // // 6 x 4kB aligned buffers will be carved out of this buffer. // 1st 4kB boundary is the start of the admin submission queue. // 2nd 4kB boundary is the start of the admin completion queue. // 3rd 4kB boundary is the start of I/O submission queue #1. // 4th 4kB boundary is the start of I/O completion queue #1. // 5th 4kB boundary is the start of I/O submission queue #2. // 6th 4kB boundary is the start of I/O completion queue #2. // // Allocate 6 pages of memory, then map it for bus master read and write. // Status = PciIo->AllocateBuffer ( PciIo, AllocateAnyPages, EfiBootServicesData, 6, (VOID**)&Private->Buffer, 0 ); if (EFI_ERROR (Status)) { goto Exit; } Bytes = EFI_PAGES_TO_SIZE (6); Status = PciIo->Map ( PciIo, EfiPciIoOperationBusMasterCommonBuffer, Private->Buffer, &Bytes, &MappedAddr, &Private->Mapping ); if (EFI_ERROR (Status) || (Bytes != EFI_PAGES_TO_SIZE (6))) { goto Exit; } Private->BufferPciAddr = (UINT8 *)(UINTN)MappedAddr; Private->Signature = NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE; Private->ControllerHandle = Controller; Private->ImageHandle = This->DriverBindingHandle; Private->DriverBindingHandle = This->DriverBindingHandle; Private->PciIo = PciIo; Private->ParentDevicePath = ParentDevicePath; Private->Passthru.Mode = &Private->PassThruMode; Private->Passthru.PassThru = NvmExpressPassThru; Private->Passthru.GetNextNamespace = NvmExpressGetNextNamespace; Private->Passthru.BuildDevicePath = NvmExpressBuildDevicePath; Private->Passthru.GetNamespace = NvmExpressGetNamespace; CopyMem (&Private->PassThruMode, &gEfiNvmExpressPassThruMode, sizeof (EFI_NVM_EXPRESS_PASS_THRU_MODE)); InitializeListHead (&Private->AsyncPassThruQueue); InitializeListHead (&Private->UnsubmittedSubtasks); Status = NvmeControllerInit (Private); if (EFI_ERROR(Status)) { goto Exit; } // // Start the asynchronous I/O completion monitor // Status = gBS->CreateEvent ( EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_NOTIFY, ProcessAsyncTaskList, Private, &Private->TimerEvent ); if (EFI_ERROR (Status)) { goto Exit; } Status = gBS->SetTimer ( Private->TimerEvent, TimerPeriodic, NVME_HC_ASYNC_TIMER ); if (EFI_ERROR (Status)) { goto Exit; } Status = gBS->InstallMultipleProtocolInterfaces ( &Controller, &gEfiNvmExpressPassThruProtocolGuid, &Private->Passthru, NULL ); if (EFI_ERROR (Status)) { goto Exit; } NvmeRegisterShutdownNotification (); } else { Status = gBS->OpenProtocol ( Controller, &gEfiNvmExpressPassThruProtocolGuid, (VOID **) &Passthru, This->DriverBindingHandle, Controller, EFI_OPEN_PROTOCOL_GET_PROTOCOL ); if (EFI_ERROR (Status)) { goto Exit; } Private = NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU (Passthru); } if (RemainingDevicePath == NULL) { // // Enumerate all NVME namespaces in the controller // Status = DiscoverAllNamespaces ( Private ); } else if (!IsDevicePathEnd (RemainingDevicePath)) { // // Enumerate the specified NVME namespace // Status = Private->Passthru.GetNamespace ( &Private->Passthru, RemainingDevicePath, &NamespaceId ); if (!EFI_ERROR (Status)) { Status = EnumerateNvmeDevNamespace ( Private, NamespaceId ); } } DEBUG ((EFI_D_INFO, "NvmExpressDriverBindingStart: end successfully\n")); return EFI_SUCCESS; Exit: if ((Private != NULL) && (Private->Mapping != NULL)) { PciIo->Unmap (PciIo, Private->Mapping); } if ((Private != NULL) && (Private->Buffer != NULL)) { PciIo->FreeBuffer (PciIo, 6, Private->Buffer); } if ((Private != NULL) && (Private->ControllerData != NULL)) { FreePool (Private->ControllerData); } if (Private != NULL) { if (Private->TimerEvent != NULL) { gBS->CloseEvent (Private->TimerEvent); } FreePool (Private); } gBS->CloseProtocol ( Controller, &gEfiPciIoProtocolGuid, This->DriverBindingHandle, Controller ); gBS->CloseProtocol ( Controller, &gEfiDevicePathProtocolGuid, This->DriverBindingHandle, Controller ); DEBUG ((EFI_D_INFO, "NvmExpressDriverBindingStart: end with %r\n", Status)); return Status; }