#include "UfsPassThru.h"

Functions
EFI_STATUS EFIAPI	UfsPassThruPassThru (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN UINT8 Target, IN UINT64 Lun, IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, IN EFI_EVENT Event OPTIONAL)

EFI_STATUS EFIAPI	UfsPassThruGetNextTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN OUT UINT8 Target, IN OUT UINT64 Lun)

EFI_STATUS EFIAPI	UfsPassThruBuildDevicePath (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN UINT8 Target, IN UINT64 Lun, IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath)

EFI_STATUS EFIAPI	UfsPassThruGetTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN EFI_DEVICE_PATH_PROTOCOL DevicePath, OUT UINT8 *Target, OUT UINT64 Lun)

EFI_STATUS EFIAPI	UfsPassThruResetChannel (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This)

EFI_STATUS EFIAPI	UfsPassThruResetTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN UINT8 Target, IN UINT64 Lun)

EFI_STATUS EFIAPI	UfsPassThruGetNextTarget (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN OUT UINT8 *Target)

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

EFI_STATUS	UfsFinishDeviceInitialization (IN UFS_PASS_THRU_PRIVATE_DATA *Private)

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

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

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

Variables
UFS_PASS_THRU_PRIVATE_DATA	gUfsPassThruTemplate

EFI_DRIVER_BINDING_PROTOCOL	gUfsPassThruDriverBinding

UFS_DEVICE_PATH	mUfsDevicePathTemplate

UINT8	mUfsTargetId [TARGET_MAX_BYTES]

GLOBAL_REMOVE_IF_UNREFERENCED EDKII_UFS_HC_PLATFORM_PROTOCOL *	mUfsHcPlatform

Detailed Description

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

Definition in file UfsPassThru.c.

Function Documentation

◆ InitializeUfsPassThru()

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

The user Entry Point for module UfsPassThru. The user code starts with this function.

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
other	Some error occurs when executing this entry point.

Definition at line 1234 of file UfsPassThru.c.

◆ UfsFinishDeviceInitialization()

EFI_STATUS UfsFinishDeviceInitialization ( IN UFS_PASS_THRU_PRIVATE_DATA * Private )

Finishes device initialization by setting fDeviceInit flag and waiting untill device responds by clearing it.

Parameters

[in] Private Pointer to the UFS_PASS_THRU_PRIVATE_DATA.

Return values

EFI_SUCCESS	The operation succeeds.
Others	The operation fails.

Definition at line 753 of file UfsPassThru.c.

◆ UfsPassThruBuildDevicePath()

EFI_STATUS EFIAPI UfsPassThruBuildDevicePath	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun,
		IN OUT EFI_DEVICE_PATH_PROTOCOL **	DevicePath
	)

Used to allocate and build a device path node for a SCSI device on a SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	The Target is an array of size TARGET_MAX_BYTES and it specifies the Target ID of the SCSI device for which a device path node is to be allocated and built. Transport drivers may chose to utilize a subset of this size to suit the representation of targets. For example, a Fibre Channel driver may use only 8 bytes (WWN) in the array to represent a FC target.
Lun	The LUN of the SCSI device for which a device path node is to be allocated and built.
DevicePath	A pointer to a single device path node that describes the SCSI device specified by Target and Lun. This function is responsible for allocating the buffer DevicePath with the boot service AllocatePool(). It is the caller's responsibility to free DevicePath when the caller is finished with DevicePath.

Return values

EFI_SUCCESS	The device path node that describes the SCSI device specified by Target and Lun was allocated and returned in DevicePath.
EFI_INVALID_PARAMETER	DevicePath is NULL.
EFI_NOT_FOUND	The SCSI devices specified by Target and Lun does not exist on the SCSI channel.
EFI_OUT_OF_RESOURCES	There are not enough resources to allocate DevicePath.

Definition at line 384 of file UfsPassThru.c.

◆ UfsPassThruDriverBindingStart()

EFI_STATUS EFIAPI UfsPassThruDriverBindingStart	(	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.

ControllerHandle must be a valid EFI_HANDLE.
If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL.
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.

Definition at line 828 of file UfsPassThru.c.

◆ UfsPassThruDriverBindingStop()

EFI_STATUS EFIAPI UfsPassThruDriverBindingStop	(	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.

ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this same driver's Start() function.
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.

Definition at line 1117 of file UfsPassThru.c.

◆ UfsPassThruDriverBindingSupported()

EFI_STATUS EFIAPI UfsPassThruDriverBindingSupported	(	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 674 of file UfsPassThru.c.

◆ UfsPassThruGetNextTarget()

EFI_STATUS EFIAPI UfsPassThruGetNextTarget	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN OUT UINT8 **	Target
	)

Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to see if a SCSI device is actually present at that location on the SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	(TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID (an array of TARGET_MAX_BYTES) of the next SCSI device present on a SCSI channel. An input value of 0xF(all bytes in the array are 0xF) in the Target array retrieves the Target ID of the first SCSI device present on a SCSI channel.

Return values

EFI_SUCCESS	The Target ID of the next SCSI device on the SCSI channel was returned in Target.
EFI_INVALID_PARAMETER	Target or Lun is NULL.
EFI_TIMEOUT	Target array is not all 0xF, and Target was not returned on a previous call to GetNextTarget().
EFI_NOT_FOUND	There are no more SCSI devices on this SCSI channel.

Definition at line 612 of file UfsPassThru.c.

◆ UfsPassThruGetNextTargetLun()

EFI_STATUS EFIAPI UfsPassThruGetNextTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN OUT UINT8 **	Target,
		IN OUT UINT64 *	Lun
	)

Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	On input, a pointer to the Target ID (an array of size TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID (an array of TARGET_MAX_BYTES) of the next SCSI device present on a SCSI channel. An input value of 0xF(all bytes in the array are 0xF) in the Target array retrieves the Target ID of the first SCSI device present on a SCSI channel.
Lun	On input, a pointer to the LUN of a SCSI device present on the SCSI channel. On output, a pointer to the LUN of the next SCSI device present on a SCSI channel.

Return values

EFI_SUCCESS	The Target ID and LUN of the next SCSI device on the SCSI channel was returned in Target and Lun.
EFI_INVALID_PARAMETER	Target array is not all 0xF, and Target and Lun were not returned on a previous call to GetNextTargetLun().
EFI_NOT_FOUND	There are no more SCSI devices on this SCSI channel.

Definition at line 254 of file UfsPassThru.c.

◆ UfsPassThruGetTargetLun()

EFI_STATUS EFIAPI UfsPassThruGetTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		OUT UINT8 **	Target,
		OUT UINT64 *	Lun
	)

Used to translate a device path node to a Target ID and LUN.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
DevicePath	A pointer to a single device path node that describes the SCSI device on the SCSI channel.
Target	A pointer to the Target Array which represents the ID of a SCSI device on the SCSI channel.
Lun	A pointer to the LUN of a SCSI device on the SCSI channel.

Return values

EFI_SUCCESS	DevicePath was successfully translated to a Target ID and LUN, and they were returned in Target and Lun.
EFI_INVALID_PARAMETER	DevicePath or Target or Lun is NULL.
EFI_NOT_FOUND	A valid translation from DevicePath to a Target ID and LUN does not exist.
EFI_UNSUPPORTED	This driver does not support the device path node type in DevicePath.

Definition at line 462 of file UfsPassThru.c.

◆ UfsPassThruPassThru()

EFI_STATUS EFIAPI UfsPassThruPassThru	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun,
		IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *	Packet,
		IN EFI_EVENT Event	OPTIONAL
	)

Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the nonblocking I/O functionality is optional.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	The Target is an array of size TARGET_MAX_BYTES and it represents the id of the SCSI device to send the SCSI Request Packet. Each transport driver may choose to utilize a subset of this size to suit the needs of transport target representation. For example, a Fibre Channel driver may use only 8 bytes (WWN) to represent an FC target.
Lun	The LUN of the SCSI device to send the SCSI Request Packet.
Packet	A pointer to the SCSI Request Packet to send to the SCSI device specified by Target and Lun.
Event	If nonblocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non blocking I/O is supported, then nonblocking I/O is performed, and Event will be signaled when the SCSI Request Packet completes.

Return values

EFI_SUCCESS	The SCSI Request Packet was sent by the host. For bi-directional commands, InTransferLength bytes were transferred from InDataBuffer. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
EFI_BAD_BUFFER_SIZE	The SCSI Request Packet was not executed. The number of bytes that could be transferred is returned in InTransferLength. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
EFI_NOT_READY	The SCSI Request Packet could not be sent because there are too many SCSI Request Packets already queued. The caller may retry again later.
EFI_DEVICE_ERROR	A device error occurred while attempting to send the SCSI Request Packet.
EFI_INVALID_PARAMETER	Target, Lun, or the contents of ScsiRequestPacket are invalid.
EFI_UNSUPPORTED	The command described by the SCSI Request Packet is not supported by the host adapter. This includes the case of Bi-directional SCSI commands not supported by the implementation. The SCSI Request Packet was not sent, so no additional status information is available.
EFI_TIMEOUT	A timeout occurred while waiting for the SCSI Request Packet to execute.

Definition at line 142 of file UfsPassThru.c.

◆ UfsPassThruResetChannel()

EFI_STATUS EFIAPI UfsPassThruResetChannel ( IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * This )

Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.

Return values

EFI_SUCCESS	The SCSI channel was reset.
EFI_DEVICE_ERROR	A device error occurred while attempting to reset the SCSI channel.
EFI_TIMEOUT	A timeout occurred while attempting to reset the SCSI channel.
EFI_UNSUPPORTED	The SCSI channel does not support a channel reset operation.

Definition at line 545 of file UfsPassThru.c.

◆ UfsPassThruResetTargetLun()

EFI_STATUS EFIAPI UfsPassThruResetTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun
	)

Resets a SCSI logical unit that is connected to a SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	The Target is an array of size TARGET_MAX_BYTE and it represents the target port ID of the SCSI device containing the SCSI logical unit to reset. Transport drivers may chose to utilize a subset of this array to suit the representation of their targets.
Lun	The LUN of the SCSI device to reset.

Return values

EFI_SUCCESS	The SCSI device specified by Target and Lun was reset.
EFI_INVALID_PARAMETER	Target or Lun is NULL.
EFI_TIMEOUT	A timeout occurred while attempting to reset the SCSI device specified by Target and Lun.
EFI_UNSUPPORTED	The SCSI channel does not support a target reset operation.
EFI_DEVICE_ERROR	A device error occurred while attempting to reset the SCSI device specified by Target and Lun.

Definition at line 576 of file UfsPassThru.c.

Variable Documentation

◆ gUfsPassThruDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gUfsPassThruDriverBinding

Initial value:

= {
  UfsPassThruDriverBindingSupported,
  UfsPassThruDriverBindingStart,
  UfsPassThruDriverBindingStop,
  0x10,
  NULL,
  NULL
}

Definition at line 73 of file UfsPassThru.c.

◆ gUfsPassThruTemplate

UFS_PASS_THRU_PRIVATE_DATA gUfsPassThruTemplate

Definition at line 14 of file UfsPassThru.c.

◆ mUfsDevicePathTemplate

UFS_DEVICE_PATH mUfsDevicePathTemplate

Initial value:

= {
  {
    MESSAGING_DEVICE_PATH,
    MSG_UFS_DP,
    {
      (UINT8)(sizeof (UFS_DEVICE_PATH)),
      (UINT8)((sizeof (UFS_DEVICE_PATH)) >> 8)
    }
  },
  0,
  0
}

Definition at line 82 of file UfsPassThru.c.

◆ mUfsHcPlatform

GLOBAL_REMOVE_IF_UNREFERENCED EDKII_UFS_HC_PLATFORM_PROTOCOL* mUfsHcPlatform

Definition at line 97 of file UfsPassThru.c.

◆ mUfsTargetId

UINT8 mUfsTargetId[TARGET_MAX_BYTES]

Definition at line 95 of file UfsPassThru.c.

Functions

Variables

Detailed Description

Function Documentation

◆ InitializeUfsPassThru()

◆ UfsFinishDeviceInitialization()

◆ UfsPassThruBuildDevicePath()

◆ UfsPassThruDriverBindingStart()

◆ UfsPassThruDriverBindingStop()

◆ UfsPassThruDriverBindingSupported()

◆ UfsPassThruGetNextTarget()

◆ UfsPassThruGetNextTargetLun()

◆ UfsPassThruGetTargetLun()

◆ UfsPassThruPassThru()

◆ UfsPassThruResetChannel()

◆ UfsPassThruResetTargetLun()

Variable Documentation

◆ gUfsPassThruDriverBinding

◆ gUfsPassThruTemplate

◆ mUfsDevicePathTemplate

◆ mUfsHcPlatform

◆ mUfsTargetId