| /** @file | |
| UfsHcDxe driver is used to provide platform-dependent info, mainly UFS host controller | |
| MMIO base, to upper layer UFS drivers. | |
| Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR> | |
| Copyright (c) 2016 - 2017, Linaro Ltd. All rights reserved. | |
| This program and the accompanying materials | |
| are licensed and made available under the terms and conditions of the BSD License | |
| which accompanies this distribution. The full text of the license may be found at | |
| http://opensource.org/licenses/bsd-license.php. | |
| THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
| **/ | |
| #include "DwUfsHcDxe.h" | |
| // | |
| // Ufs Host Controller Driver Binding Protocol Instance | |
| // | |
| EFI_DRIVER_BINDING_PROTOCOL gUfsHcDriverBinding = { | |
| UfsHcDriverBindingSupported, | |
| UfsHcDriverBindingStart, | |
| UfsHcDriverBindingStop, | |
| 0x10, | |
| NULL, | |
| NULL | |
| }; | |
| // | |
| // Template for Ufs host controller private data. | |
| // | |
| UFS_HOST_CONTROLLER_PRIVATE_DATA gUfsHcTemplate = { | |
| UFS_HC_PRIVATE_DATA_SIGNATURE, // Signature | |
| NULL, // Handle | |
| { // UfsHcProtocol | |
| UfsHcGetMmioBar, | |
| UfsHcAllocateBuffer, | |
| UfsHcFreeBuffer, | |
| UfsHcMap, | |
| UfsHcUnmap, | |
| UfsHcFlush, | |
| UfsHcMmioRead, | |
| UfsHcMmioWrite, | |
| UfsHcPhyInit | |
| }, | |
| 0 // RegBase | |
| }; | |
| STATIC | |
| EFI_STATUS | |
| DwUfsDmeSet ( | |
| IN UINTN RegBase, | |
| IN UINT16 Attr, | |
| IN UINT16 Index, | |
| IN UINT32 Value | |
| ) | |
| { | |
| UINT32 Data; | |
| Data = MmioRead32 (RegBase + UFS_HC_STATUS_OFFSET); | |
| if ((Data & UFS_HC_HCS_UCRDY) == 0) { | |
| return EFI_NOT_READY; | |
| } | |
| MmioWrite32 (RegBase + UFS_HC_IS_OFFSET, ~0); | |
| MmioWrite32 (RegBase + UFS_HC_UCMD_ARG1_OFFSET, (Attr << 16) | Index); | |
| MmioWrite32 (RegBase + UFS_HC_UCMD_ARG2_OFFSET, 0); | |
| MmioWrite32 (RegBase + UFS_HC_UCMD_ARG3_OFFSET, Value); | |
| MmioWrite32 (RegBase + UFS_HC_UIC_CMD_OFFSET, UFS_UIC_DME_SET); | |
| do { | |
| Data = MmioRead32 (RegBase + UFS_HC_IS_OFFSET); | |
| if (Data & UFS_HC_IS_UE) { | |
| return EFI_DEVICE_ERROR; | |
| } | |
| } while ((Data & UFS_HC_IS_UCCS) == 0); | |
| MmioWrite32 (RegBase + UFS_HC_IS_OFFSET, UFS_HC_IS_UCCS); | |
| Data = MmioRead32 (RegBase + UFS_HC_UCMD_ARG2_OFFSET); | |
| if (Data) { | |
| return EFI_DEVICE_ERROR; | |
| } | |
| return EFI_SUCCESS; | |
| } | |
| STATIC | |
| EFI_STATUS | |
| DwUfsDmeGet ( | |
| IN UINTN RegBase, | |
| IN UINT16 Attr, | |
| IN UINT16 Index, | |
| OUT UINT32 *Value | |
| ) | |
| { | |
| UINT32 Data; | |
| Data = MmioRead32 (RegBase + UFS_HC_STATUS_OFFSET); | |
| if ((Data & UFS_HC_HCS_UCRDY) == 0) { | |
| return EFI_NOT_READY; | |
| } | |
| MmioWrite32 (RegBase + UFS_HC_IS_OFFSET, ~0); | |
| MmioWrite32 (RegBase + UFS_HC_UCMD_ARG1_OFFSET, (Attr << 16) | Index); | |
| MmioWrite32 (RegBase + UFS_HC_UCMD_ARG2_OFFSET, 0); | |
| MmioWrite32 (RegBase + UFS_HC_UCMD_ARG3_OFFSET, 0); | |
| MmioWrite32 (RegBase + UFS_HC_UIC_CMD_OFFSET, UFS_UIC_DME_GET); | |
| do { | |
| Data = MmioRead32 (RegBase + UFS_HC_IS_OFFSET); | |
| if (Data & UFS_HC_IS_UE) { | |
| return EFI_DEVICE_ERROR; | |
| } | |
| } while ((Data & UFS_HC_IS_UCCS) == 0); | |
| MmioWrite32 (RegBase + UFS_HC_IS_OFFSET, UFS_HC_IS_UCCS); | |
| Data = MmioRead32 (RegBase + UFS_HC_UCMD_ARG2_OFFSET); | |
| if (Data) { | |
| return EFI_DEVICE_ERROR; | |
| } | |
| *Value = MmioRead32 (RegBase + UFS_HC_UCMD_ARG3_OFFSET); | |
| return EFI_SUCCESS; | |
| } | |
| /** | |
| Get the MMIO base of the UFS host controller. | |
| @param[in] This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance. | |
| @param[out] MmioBar The MMIO base address of UFS host controller. | |
| @retval EFI_SUCCESS The operation succeeds. | |
| @retval others The operation fails. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcGetMmioBar ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, | |
| OUT UINTN *MmioBar | |
| ) | |
| { | |
| UFS_HOST_CONTROLLER_PRIVATE_DATA *Private; | |
| if ((This == NULL) || (MmioBar == NULL)) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| Private = UFS_HOST_CONTROLLER_PRIVATE_DATA_FROM_UFSHC (This); | |
| *MmioBar = Private->RegBase; | |
| return EFI_SUCCESS; | |
| } | |
| /** | |
| Provides the UFS controller-specific addresses needed to access system memory. | |
| @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance. | |
| @param Operation Indicates if the bus master is going to read or write to system memory. | |
| @param HostAddress The system memory address to map to the UFS controller. | |
| @param NumberOfBytes On input the number of bytes to map. On output the number of bytes | |
| that were mapped. | |
| @param DeviceAddress The resulting map address for the bus master UFS controller to use to | |
| access the hosts HostAddress. | |
| @param Mapping A resulting value to pass to Unmap(). | |
| @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes. | |
| @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. | |
| @retval EFI_INVALID_PARAMETER One or more parameters are invalid. | |
| @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. | |
| @retval EFI_DEVICE_ERROR The system hardware could not map the requested address. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcMap ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, | |
| IN EDKII_UFS_HOST_CONTROLLER_OPERATION Operation, | |
| IN VOID *HostAddress, | |
| IN OUT UINTN *NumberOfBytes, | |
| OUT EFI_PHYSICAL_ADDRESS *DeviceAddress, | |
| OUT VOID **Mapping | |
| ) | |
| { | |
| DMA_MAP_OPERATION DmaOperation; | |
| if ((This == NULL) || (HostAddress == NULL) || (NumberOfBytes == NULL) || (DeviceAddress == NULL) || (Mapping == NULL)) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| if (Operation == EdkiiUfsHcOperationBusMasterRead) { | |
| DmaOperation = MapOperationBusMasterRead; | |
| } else if (Operation == EdkiiUfsHcOperationBusMasterWrite) { | |
| DmaOperation = MapOperationBusMasterWrite; | |
| } else if (Operation == EdkiiUfsHcOperationBusMasterCommonBuffer) { | |
| DmaOperation = MapOperationBusMasterCommonBuffer; | |
| } else { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| if ((*NumberOfBytes & (BIT0 | BIT1)) != 0) { | |
| *NumberOfBytes += BIT0 | BIT1; | |
| *NumberOfBytes &= ~(BIT0 | BIT1); | |
| } | |
| return DmaMap (DmaOperation, HostAddress, NumberOfBytes, DeviceAddress, Mapping); | |
| } | |
| /** | |
| Completes the Map() operation and releases any corresponding resources. | |
| @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance. | |
| @param Mapping The mapping value returned from Map(). | |
| @retval EFI_SUCCESS The range was unmapped. | |
| @retval EFI_DEVICE_ERROR The data was not committed to the target system memory. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcUnmap ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, | |
| IN VOID *Mapping | |
| ) | |
| { | |
| if ((This == NULL) || (Mapping == NULL)) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| return DmaUnmap (Mapping); | |
| } | |
| /** | |
| Allocates pages that are suitable for an EfiUfsHcOperationBusMasterCommonBuffer | |
| mapping. | |
| @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance. | |
| @param Type This parameter is not used and must be ignored. | |
| @param MemoryType The type of memory to allocate, EfiBootServicesData or | |
| EfiRuntimeServicesData. | |
| @param Pages The number of pages to allocate. | |
| @param HostAddress A pointer to store the base system memory address of the | |
| allocated range. | |
| @param Attributes The requested bit mask of attributes for the allocated range. | |
| @retval EFI_SUCCESS The requested memory pages were allocated. | |
| @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are | |
| MEMORY_WRITE_COMBINE and MEMORY_CACHED. | |
| @retval EFI_INVALID_PARAMETER One or more parameters are invalid. | |
| @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcAllocateBuffer ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, | |
| IN EFI_ALLOCATE_TYPE Type, | |
| IN EFI_MEMORY_TYPE MemoryType, | |
| IN UINTN Pages, | |
| OUT VOID **HostAddress, | |
| IN UINT64 Attributes | |
| ) | |
| { | |
| if ((This == NULL) || (HostAddress == NULL)) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| return DmaAllocateBuffer (MemoryType, Pages, HostAddress); | |
| } | |
| /** | |
| Frees memory that was allocated with AllocateBuffer(). | |
| @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance. | |
| @param Pages The number of pages to free. | |
| @param HostAddress The base system memory address of the allocated range. | |
| @retval EFI_SUCCESS The requested memory pages were freed. | |
| @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages | |
| was not allocated with AllocateBuffer(). | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcFreeBuffer ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, | |
| IN UINTN Pages, | |
| IN VOID *HostAddress | |
| ) | |
| { | |
| if ((This == NULL) || (HostAddress == NULL)) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| return DmaFreeBuffer (Pages, HostAddress); | |
| } | |
| /** | |
| Flushes all posted write transactions from the UFS bus to attached UFS device. | |
| @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance. | |
| @retval EFI_SUCCESS The posted write transactions were flushed from the UFS bus | |
| to attached UFS device. | |
| @retval EFI_DEVICE_ERROR The posted write transactions were not flushed from the UFS | |
| bus to attached UFS device due to a hardware error. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcFlush ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This | |
| ) | |
| { | |
| return EFI_SUCCESS; | |
| } | |
| /** | |
| Enable a UFS bus driver to access UFS MMIO registers in the UFS Host Controller memory space. | |
| @param This A pointer to the EDKII_UFS_HOST_CONTROLLER_PROTOCOL instance. | |
| @param Width Signifies the width of the memory operations. | |
| @param Offset The offset within the UFS Host Controller MMIO space to start the | |
| memory operation. | |
| @param Count The number of memory operations to perform. | |
| @param Buffer For read operations, the destination buffer to store the results. | |
| For write operations, the source buffer to write data from. | |
| @retval EFI_SUCCESS The data was read from or written to the UFS host controller. | |
| @retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not | |
| valid for the UFS Host Controller memory space. | |
| @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. | |
| @retval EFI_INVALID_PARAMETER One or more parameters are invalid. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcMmioRead ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL_WIDTH Width, | |
| IN UINT64 Offset, | |
| IN UINTN Count, | |
| IN OUT VOID *Buffer | |
| ) | |
| { | |
| UFS_HOST_CONTROLLER_PRIVATE_DATA *Private; | |
| UINTN Index; | |
| Private = UFS_HOST_CONTROLLER_PRIVATE_DATA_FROM_UFSHC (This); | |
| switch (Width) { | |
| case EfiUfsHcWidthUint8: | |
| for (Index = 0; Index < Count; Index++) { | |
| *((UINT8 *)Buffer + Index) = MmioRead8 (Private->RegBase + Offset); | |
| } | |
| break; | |
| case EfiUfsHcWidthUint16: | |
| for (Index = 0; Index < Count; Index++) { | |
| *((UINT16 *)Buffer + Index) = MmioRead16 (Private->RegBase + Offset); | |
| } | |
| break; | |
| case EfiUfsHcWidthUint32: | |
| for (Index = 0; Index < Count; Index++) { | |
| *((UINT32 *)Buffer + Index) = MmioRead32 (Private->RegBase + Offset); | |
| } | |
| break; | |
| case EfiUfsHcWidthUint64: | |
| for (Index = 0; Index < Count; Index++) { | |
| *((UINT64 *)Buffer + Index) = MmioRead64 (Private->RegBase + Offset); | |
| } | |
| break; | |
| default: | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| return EFI_SUCCESS; | |
| } | |
| /** | |
| Enable a UFS bus driver to access UFS MMIO registers in the UFS Host Controller memory space. | |
| @param This A pointer to the EDKII_UFS_HOST_CONTROLLER_PROTOCOL instance. | |
| @param Width Signifies the width of the memory operations. | |
| @param Offset The offset within the UFS Host Controller MMIO space to start the | |
| memory operation. | |
| @param Count The number of memory operations to perform. | |
| @param Buffer For read operations, the destination buffer to store the results. | |
| For write operations, the source buffer to write data from. | |
| @retval EFI_SUCCESS The data was read from or written to the UFS host controller. | |
| @retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not | |
| valid for the UFS Host Controller memory space. | |
| @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. | |
| @retval EFI_INVALID_PARAMETER One or more parameters are invalid. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcMmioWrite ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL_WIDTH Width, | |
| IN UINT64 Offset, | |
| IN UINTN Count, | |
| IN OUT VOID *Buffer | |
| ) | |
| { | |
| UFS_HOST_CONTROLLER_PRIVATE_DATA *Private; | |
| EFI_STATUS Status; | |
| UINTN Index; | |
| Private = UFS_HOST_CONTROLLER_PRIVATE_DATA_FROM_UFSHC (This); | |
| switch (Width) { | |
| case EfiUfsHcWidthUint8: | |
| for (Index = 0; Index < Count; Index++) { | |
| Status = MmioWrite8 (Private->RegBase + Offset, *((UINT8 *)Buffer + Index)); | |
| } | |
| break; | |
| case EfiUfsHcWidthUint16: | |
| for (Index = 0; Index < Count; Index++) { | |
| Status = MmioWrite16 (Private->RegBase + Offset, *((UINT16 *)Buffer + Index)); | |
| } | |
| break; | |
| case EfiUfsHcWidthUint32: | |
| for (Index = 0; Index < Count; Index++) { | |
| Status = MmioWrite32 (Private->RegBase + Offset, *((UINT32 *)Buffer + Index)); | |
| } | |
| break; | |
| case EfiUfsHcWidthUint64: | |
| for (Index = 0; Index < Count; Index++) { | |
| Status = MmioWrite64 (Private->RegBase + Offset, *((UINT64 *)Buffer + Index)); | |
| } | |
| break; | |
| default: | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| return Status; | |
| } | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcPhyInit ( | |
| IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This | |
| ) | |
| { | |
| UFS_HOST_CONTROLLER_PRIVATE_DATA *Private; | |
| EFI_STATUS Status; | |
| UINT32 Data, Fsm0, Fsm1; | |
| Private = UFS_HOST_CONTROLLER_PRIVATE_DATA_FROM_UFSHC (This); | |
| DwUfsDmeSet (Private->RegBase, 0xd0c1, 0, 1); | |
| DwUfsDmeSet (Private->RegBase, 0xd0c1, 0, 1); | |
| DwUfsDmeSet (Private->RegBase, 0x156a, 0, 2); | |
| DwUfsDmeSet (Private->RegBase, 0x8114, 0, 1); | |
| DwUfsDmeSet (Private->RegBase, 0x8121, 0, 0x2d); | |
| DwUfsDmeSet (Private->RegBase, 0x8122, 0, 1); | |
| DwUfsDmeSet (Private->RegBase, 0xd085, 0, 1); | |
| DwUfsDmeSet (Private->RegBase, 0x800d, 4, 0x58); | |
| DwUfsDmeSet (Private->RegBase, 0x800d, 5, 0x58); | |
| DwUfsDmeSet (Private->RegBase, 0x800e, 4, 0xb); | |
| DwUfsDmeSet (Private->RegBase, 0x800e, 5, 0xb); | |
| DwUfsDmeSet (Private->RegBase, 0x8009, 4, 0x1); | |
| DwUfsDmeSet (Private->RegBase, 0x8009, 5, 0x1); | |
| DwUfsDmeSet (Private->RegBase, 0xd085, 0, 1); | |
| DwUfsDmeSet (Private->RegBase, 0x8113, 0, 1); | |
| DwUfsDmeSet (Private->RegBase, 0xd085, 0, 1); | |
| DwUfsDmeSet (Private->RegBase, 0x0095, 4, 0x4a); | |
| DwUfsDmeSet (Private->RegBase, 0x0095, 5, 0x4a); | |
| DwUfsDmeSet (Private->RegBase, 0x0094, 4, 0x4a); | |
| DwUfsDmeSet (Private->RegBase, 0x0094, 5, 0x4a); | |
| DwUfsDmeSet (Private->RegBase, 0x008f, 4, 0x7); | |
| DwUfsDmeSet (Private->RegBase, 0x008f, 5, 0x7); | |
| DwUfsDmeSet (Private->RegBase, 0x000f, 0, 0x5); | |
| DwUfsDmeSet (Private->RegBase, 0x000f, 1, 0x5); | |
| DwUfsDmeSet (Private->RegBase, 0xd085, 0, 1); | |
| Status = DwUfsDmeGet (Private->RegBase, 0xd0c1, 0, &Data); | |
| ASSERT_EFI_ERROR (Status); | |
| ASSERT (Data == 1); | |
| DwUfsDmeSet (Private->RegBase, 0xd0c1, 0, 0); | |
| for (;;) { | |
| Status = DwUfsDmeGet (Private->RegBase, 0x0041, 0, &Fsm0); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = DwUfsDmeGet (Private->RegBase, 0x0041, 1, &Fsm1); | |
| ASSERT_EFI_ERROR (Status); | |
| if ((Fsm0 == 1) && (Fsm1 == 1)) { | |
| break; | |
| } | |
| } | |
| MmioWrite32 (Private->RegBase + UFS_HC_HCLKDIV_OFFSET, 0xE4); | |
| Data = MmioRead32 (Private->RegBase + UFS_HC_AHIT_OFFSET); | |
| Data &= ~0x3FF; | |
| MmioWrite32 (Private->RegBase + UFS_HC_AHIT_OFFSET, Data); | |
| DwUfsDmeSet (Private->RegBase, 0x155e, 0, 0); | |
| DwUfsDmeSet (Private->RegBase, 0xd0ab, 0, 0); | |
| Status = DwUfsDmeGet (Private->RegBase, 0xd0ab, 0, &Data); | |
| ASSERT_EFI_ERROR ((Status) && (Data == 0)); | |
| DwUfsDmeSet (Private->RegBase, 0x2044, 0, 0); | |
| DwUfsDmeSet (Private->RegBase, 0x2045, 0, 0); | |
| DwUfsDmeSet (Private->RegBase, 0x2040, 0, 9); | |
| return EFI_SUCCESS; | |
| } | |
| /** | |
| Tests to see if this driver supports a given controller. If a child device is provided, | |
| it further tests to see if this driver supports creating a handle for the specified child device. | |
| This function checks to see if the driver specified by This supports the device specified by | |
| ControllerHandle. Drivers will typically use the device path attached to | |
| ControllerHandle and/or the services from the bus I/O abstraction attached to | |
| ControllerHandle to determine if the driver supports ControllerHandle. This function | |
| may be called many times during platform initialization. In order to reduce boot times, the tests | |
| performed by this function must be very small, and take as little time as possible to execute. This | |
| function must not change the state of any hardware devices, and this function must be aware that the | |
| device specified by ControllerHandle may already be managed by the same driver or a | |
| different driver. This function must match its calls to AllocatePages() with FreePages(), | |
| AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). | |
| Since ControllerHandle may have been previously started by the same driver, if a protocol is | |
| already in the opened state, then it must not be closed with CloseProtocol(). This is required | |
| to guarantee the state of ControllerHandle is not modified by this function. | |
| @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. | |
| @param[in] ControllerHandle The handle of the controller to test. 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 bus drivers, if this parameter is not NULL, then | |
| the bus driver must determine if the bus controller specified | |
| by ControllerHandle and the child controller specified | |
| by RemainingDevicePath are both supported by this | |
| bus driver. | |
| @retval EFI_SUCCESS The device specified by ControllerHandle and | |
| RemainingDevicePath is supported by the driver specified by This. | |
| @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and | |
| RemainingDevicePath is already being managed by the driver | |
| specified by This. | |
| @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and | |
| RemainingDevicePath is already being managed by a different | |
| driver or an application that requires exclusive access. | |
| Currently not implemented. | |
| @retval EFI_UNSUPPORTED The device specified by ControllerHandle and | |
| RemainingDevicePath is not supported by the driver specified by This. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcDriverBindingSupported ( | |
| IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
| IN EFI_HANDLE Controller, | |
| IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath | |
| ) | |
| { | |
| EFI_STATUS Status; | |
| EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; | |
| ParentDevicePath = NULL; | |
| // | |
| // UfsHcDxe is a device driver, and should ingore the | |
| // "RemainingDevicePath" according to EFI spec | |
| // | |
| Status = gBS->OpenProtocol ( | |
| Controller, | |
| &gEfiDevicePathProtocolGuid, | |
| (VOID *) &ParentDevicePath, | |
| This->DriverBindingHandle, | |
| Controller, | |
| EFI_OPEN_PROTOCOL_BY_DRIVER | |
| ); | |
| if (EFI_ERROR (Status)) { | |
| // | |
| // EFI_ALREADY_STARTED is also an error | |
| // | |
| return Status; | |
| } | |
| // | |
| // Close the protocol because we don't use it here | |
| // | |
| gBS->CloseProtocol ( | |
| Controller, | |
| &gEfiDevicePathProtocolGuid, | |
| This->DriverBindingHandle, | |
| Controller | |
| ); | |
| return Status; | |
| } | |
| /** | |
| 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 | |
| UfsHcDriverBindingStart ( | |
| IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
| IN EFI_HANDLE Controller, | |
| IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath | |
| ) | |
| { | |
| EFI_STATUS Status; | |
| UFS_HOST_CONTROLLER_PRIVATE_DATA *Private; | |
| UINT32 BaseAddress; | |
| BaseAddress = PcdGet32 (PcdDwUfsHcDxeBaseAddress); | |
| Private = AllocateCopyPool (sizeof (UFS_HOST_CONTROLLER_PRIVATE_DATA), &gUfsHcTemplate); | |
| if (Private == NULL) { | |
| Status = EFI_OUT_OF_RESOURCES; | |
| goto Done; | |
| } | |
| Private->RegBase = (UINTN)BaseAddress; | |
| /// | |
| /// Install UFS_HOST_CONTROLLER protocol | |
| /// | |
| Status = gBS->InstallProtocolInterface ( | |
| &Controller, | |
| &gEdkiiUfsHostControllerProtocolGuid, | |
| EFI_NATIVE_INTERFACE, | |
| (VOID*)&(Private->UfsHc) | |
| ); | |
| Done: | |
| if (EFI_ERROR (Status)) { | |
| if (Private != NULL) { | |
| FreePool (Private); | |
| } | |
| } | |
| return Status; | |
| } | |
| /** | |
| Stops a device controller or a bus controller. | |
| The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). | |
| As a result, much of the error checking on the parameters to Stop() has been moved | |
| into this common boot service. It is legal to call Stop() 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 that was used on a previous call to this | |
| same driver's Start() function. | |
| 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid | |
| EFI_HANDLE. In addition, all of these handles must have been created in this driver's | |
| Start() function, and the Start() function must have called OpenProtocol() on | |
| ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. | |
| @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. | |
| @param[in] ControllerHandle A handle to the device being stopped. The handle must | |
| support a bus specific I/O protocol for the driver | |
| to use to stop the device. | |
| @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. | |
| @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL | |
| if NumberOfChildren is 0. | |
| @retval EFI_SUCCESS The device was stopped. | |
| @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcDriverBindingStop ( | |
| IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
| IN EFI_HANDLE Controller, | |
| IN UINTN NumberOfChildren, | |
| IN EFI_HANDLE *ChildHandleBuffer | |
| ) | |
| { | |
| EFI_STATUS Status; | |
| UFS_HOST_CONTROLLER_PRIVATE_DATA *Private; | |
| EDKII_UFS_HOST_CONTROLLER_PROTOCOL *UfsHc; | |
| /// | |
| /// Get private data | |
| /// | |
| Status = gBS->OpenProtocol ( | |
| Controller, | |
| &gEdkiiUfsHostControllerProtocolGuid, | |
| (VOID **) &UfsHc, | |
| This->DriverBindingHandle, | |
| Controller, | |
| EFI_OPEN_PROTOCOL_GET_PROTOCOL | |
| ); | |
| if (EFI_ERROR (Status)) { | |
| return EFI_DEVICE_ERROR; | |
| } | |
| Private = UFS_HOST_CONTROLLER_PRIVATE_DATA_FROM_UFSHC (UfsHc); | |
| Status = gBS->UninstallProtocolInterface ( | |
| Controller, | |
| &gEdkiiUfsHostControllerProtocolGuid, | |
| &(Private->UfsHc) | |
| ); | |
| if (!EFI_ERROR (Status)) { | |
| FreePool (Private); | |
| } | |
| return Status; | |
| } | |
| /** | |
| The entry point for UFS host controller driver, used to install this driver on the ImageHandle. | |
| @param[in] ImageHandle The firmware allocated handle for this driver image. | |
| @param[in] SystemTable Pointer to the EFI system table. | |
| @retval EFI_SUCCESS Driver loaded. | |
| @retval other Driver not loaded. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| UfsHcDriverEntry ( | |
| IN EFI_HANDLE ImageHandle, | |
| IN EFI_SYSTEM_TABLE *SystemTable | |
| ) | |
| { | |
| EFI_STATUS Status; | |
| Status = EfiLibInstallDriverBindingComponentName2 ( | |
| ImageHandle, | |
| SystemTable, | |
| &gUfsHcDriverBinding, | |
| ImageHandle, | |
| &gUfsHcComponentName, | |
| &gUfsHcComponentName2 | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| return Status; | |
| } |