UfsPciHcDxe.c File Reference

#include "UfsPciHcDxe.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	UfsHcGetMmioBar (IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, OUT UINTN *MmioBar)
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)
EFI_STATUS EFIAPI	UfsHcUnmap (IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, IN VOID *Mapping)
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)
EFI_STATUS EFIAPI	UfsHcFreeBuffer (IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This, IN UINTN Pages, IN VOID *HostAddress)
EFI_STATUS EFIAPI	UfsHcFlush (IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This)
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)
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)
EFI_STATUS EFIAPI	UfsHcDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath)
EFI_STATUS EFIAPI	UfsHcDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath)
EFI_STATUS EFIAPI	UfsHcDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer)
EFI_STATUS EFIAPI	UfsHcDriverEntry (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gUfsHcDriverBinding
UFS_HOST_CONTROLLER_PRIVATE_DATA	gUfsHcTemplate

Detailed Description

UfsHcDxe driver is used to provide platform-dependent info, mainly UFS host controller MMIO base, to upper layer UFS drivers.

Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UfsPciHcDxe.c.

Function Documentation

UfsHcAllocateBuffer()

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
	)

Allocates pages that are suitable for an EfiUfsHcOperationBusMasterCommonBuffer mapping.

Parameters

This	A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.
Type	This parameter is not used and must be ignored.
MemoryType	The type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData.
Pages	The number of pages to allocate.
HostAddress	A pointer to store the base system memory address of the allocated range.
Attributes	The requested bit mask of attributes for the allocated range.

Return values

EFI_SUCCESS	The requested memory pages were allocated.
EFI_UNSUPPORTED	Attributes is unsupported. The only legal attribute bits are MEMORY_WRITE_COMBINE and MEMORY_CACHED.
EFI_INVALID_PARAMETER	One or more parameters are invalid.
EFI_OUT_OF_RESOURCES	The memory pages could not be allocated.

Definition at line 191 of file UfsPciHcDxe.c.

UfsHcDriverBindingStart()

EFI_STATUS EFIAPI UfsHcDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

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.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[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.
[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.

Return values

EFI_SUCCESS	The device was started.
EFI_DEVICE_ERROR	The device could not be started due to a device error.Currently not implemented.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
Others	The driver failded to start the device.

Install UFS_HOST_CONTROLLER protocol

Definition at line 551 of file UfsPciHcDxe.c.

UfsHcDriverBindingStop()

EFI_STATUS EFIAPI UfsHcDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

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.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[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.
[in]	NumberOfChildren	The number of child device handles in ChildHandleBuffer.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Get private data

Definition at line 721 of file UfsPciHcDxe.c.

UfsHcDriverBindingSupported()

EFI_STATUS EFIAPI UfsHcDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

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.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[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.
[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.

Return values

EFI_SUCCESS	The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This.
EFI_ALREADY_STARTED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
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.
EFI_UNSUPPORTED	The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 406 of file UfsPciHcDxe.c.

UfsHcDriverEntry()

EFI_STATUS EFIAPI UfsHcDriverEntry	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The entry point for UFS host controller driver, used to install this driver on the ImageHandle.

Parameters

[in]	ImageHandle	The firmware allocated handle for this driver image.
[in]	SystemTable	Pointer to the EFI system table.

Return values

EFI_SUCCESS	Driver loaded.
other	Driver not loaded.

Definition at line 795 of file UfsPciHcDxe.c.

UfsHcFlush()

EFI_STATUS EFIAPI UfsHcFlush

(

IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *

This

)

Flushes all posted write transactions from the UFS bus to attached UFS device.

Parameters

This	A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.

Return values

EFI_SUCCESS	The posted write transactions were flushed from the UFS bus to attached UFS device.
EFI_DEVICE_ERROR	The posted write transactions were not flushed from the UFS bus to attached UFS device due to a hardware error.

Definition at line 263 of file UfsPciHcDxe.c.

UfsHcFreeBuffer()

EFI_STATUS EFIAPI UfsHcFreeBuffer	(	IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *	This,
		IN UINTN	Pages,
		IN VOID *	HostAddress
	)

Frees memory that was allocated with AllocateBuffer().

Parameters

This	A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.
Pages	The number of pages to free.
HostAddress	The base system memory address of the allocated range.

Return values

EFI_SUCCESS	The requested memory pages were freed.
EFI_INVALID_PARAMETER	The memory range specified by HostAddress and Pages was not allocated with AllocateBuffer().

Definition at line 229 of file UfsPciHcDxe.c.

UfsHcGetMmioBar()

EFI_STATUS EFIAPI UfsHcGetMmioBar	(	IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *	This,
		OUT UINTN *	MmioBar
	)

Get the MMIO base of the UFS host controller.

Parameters

[in]	This	A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.
[out]	MmioBar	The MMIO base address of UFS host controller.

Return values

EFI_SUCCESS	The operation succeeds.
others	The operation fails.

Definition at line 55 of file UfsPciHcDxe.c.

UfsHcMap()

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
	)

Provides the UFS controller-specific addresses needed to access system memory.

Parameters

This	A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.
Operation	Indicates if the bus master is going to read or write to system memory.
HostAddress	The system memory address to map to the UFS controller.
NumberOfBytes	On input the number of bytes to map. On output the number of bytes that were mapped.
DeviceAddress	The resulting map address for the bus master UFS controller to use to access the hosts HostAddress.
Mapping	A resulting value to pass to Unmap().

Return values

EFI_SUCCESS	The range was mapped for the returned NumberOfBytes.
EFI_UNSUPPORTED	The HostAddress cannot be mapped as a common buffer.
EFI_INVALID_PARAMETER	One or more parameters are invalid.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
EFI_DEVICE_ERROR	The system hardware could not map the requested address.

Definition at line 113 of file UfsPciHcDxe.c.

UfsHcMmioRead()

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
	)

Enable a UFS bus driver to access UFS MMIO registers in the UFS Host Controller memory space.

Parameters

This	A pointer to the EDKII_UFS_HOST_CONTROLLER_PROTOCOL instance.
Width	Signifies the width of the memory operations.
Offset	The offset within the UFS Host Controller MMIO space to start the memory operation.
Count	The number of memory operations to perform.
Buffer	For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from.

Return values

EFI_SUCCESS	The data was read from or written to the UFS host controller.
EFI_UNSUPPORTED	The address range specified by Offset, Width, and Count is not valid for the UFS Host Controller memory space.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER	One or more parameters are invalid.

Definition at line 298 of file UfsPciHcDxe.c.

UfsHcMmioWrite()

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
	)

Enable a UFS bus driver to access UFS MMIO registers in the UFS Host Controller memory space.

Parameters

This	A pointer to the EDKII_UFS_HOST_CONTROLLER_PROTOCOL instance.
Width	Signifies the width of the memory operations.
Offset	The offset within the UFS Host Controller MMIO space to start the memory operation.
Count	The number of memory operations to perform.
Buffer	For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from.

Return values

EFI_SUCCESS	The data was read from or written to the UFS host controller.
EFI_UNSUPPORTED	The address range specified by Offset, Width, and Count is not valid for the UFS Host Controller memory space.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER	One or more parameters are invalid.

Definition at line 340 of file UfsPciHcDxe.c.

UfsHcUnmap()

EFI_STATUS EFIAPI UfsHcUnmap	(	IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *	This,
		IN VOID *	Mapping
	)

Completes the Map() operation and releases any corresponding resources.

Parameters

This	A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.
Mapping	The mapping value returned from Map().

Return values

EFI_SUCCESS	The range was unmapped.
EFI_DEVICE_ERROR	The data was not committed to the target system memory.

Definition at line 149 of file UfsPciHcDxe.c.

Variable Documentation

gUfsHcDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gUfsHcDriverBinding

Initial value:

= {
  UfsHcDriverBindingSupported,
  UfsHcDriverBindingStart,
  UfsHcDriverBindingStop,
  0x10,
  NULL,
  NULL
}

Definition at line 15 of file UfsPciHcDxe.c.

gUfsHcTemplate

UFS_HOST_CONTROLLER_PRIVATE_DATA gUfsHcTemplate

Initial value:

= {
  UFS_HC_PRIVATE_DATA_SIGNATURE,  
  {                               
    UfsHcGetMmioBar,
    UfsHcAllocateBuffer,
    UfsHcFreeBuffer,
    UfsHcMap,
    UfsHcUnmap,
    UfsHcFlush,
    UfsHcMmioRead,
    UfsHcMmioWrite
  },
  NULL,                           
  0,                              
  0                               
}

Definition at line 27 of file UfsPciHcDxe.c.