Functions
EFI_STATUS EFIAPI	EmmcReset (IN EFI_BLOCK_IO_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

EFI_STATUS EFIAPI	EmmcReadBlocks (IN EFI_BLOCK_IO_PROTOCOL This, IN UINT32 MediaId, IN EFI_LBA Lba, IN UINTN BufferSize, OUT VOID Buffer)

EFI_STATUS EFIAPI	EmmcWriteBlocks (IN EFI_BLOCK_IO_PROTOCOL This, IN UINT32 MediaId, IN EFI_LBA Lba, IN UINTN BufferSize, IN VOID Buffer)

EFI_STATUS EFIAPI	EmmcFlushBlocks (IN EFI_BLOCK_IO_PROTOCOL *This)

EFI_STATUS EFIAPI	EmmcResetEx (IN EFI_BLOCK_IO2_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

EFI_STATUS EFIAPI	EmmcReadBlocksEx (IN EFI_BLOCK_IO2_PROTOCOL This, IN UINT32 MediaId, IN EFI_LBA Lba, IN OUT EFI_BLOCK_IO2_TOKEN Token, IN UINTN BufferSize, OUT VOID *Buffer)

EFI_STATUS EFIAPI	EmmcWriteBlocksEx (IN EFI_BLOCK_IO2_PROTOCOL This, IN UINT32 MediaId, IN EFI_LBA Lba, IN OUT EFI_BLOCK_IO2_TOKEN Token, IN UINTN BufferSize, IN VOID *Buffer)

EFI_STATUS EFIAPI	EmmcFlushBlocksEx (IN EFI_BLOCK_IO2_PROTOCOL This, IN OUT EFI_BLOCK_IO2_TOKEN Token)

EFI_STATUS EFIAPI	EmmcSecurityProtocolInOut (IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Timeout, IN UINT8 SecurityProtocolId, IN UINT16 SecurityProtocolSpecificData, IN UINTN PayloadBufferSize, OUT VOID PayloadBuffer, OUT UINTN *PayloadTransferSize, IN BOOLEAN IsRead)

EFI_STATUS EFIAPI	EmmcSecurityProtocolIn (IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Timeout, IN UINT8 SecurityProtocolId, IN UINT16 SecurityProtocolSpecificData, IN UINTN PayloadBufferSize, OUT VOID PayloadBuffer, OUT UINTN *PayloadTransferSize)

EFI_STATUS EFIAPI	EmmcSecurityProtocolOut (IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Timeout, IN UINT8 SecurityProtocolId, IN UINT16 SecurityProtocolSpecificData, IN UINTN PayloadBufferSize, IN VOID PayloadBuffer)

EFI_STATUS EFIAPI	EmmcEraseBlocks (IN EFI_ERASE_BLOCK_PROTOCOL This, IN UINT32 MediaId, IN EFI_LBA Lba, IN OUT EFI_ERASE_BLOCK_TOKEN Token, IN UINTN Size)

Detailed Description

Header file for EmmcDxe Driver.

This file defines common data structures, macro definitions and some module internal function header files.

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

Definition in file EmmcBlockIo.h.

Function Documentation

◆ EmmcEraseBlocks()

EFI_STATUS EFIAPI EmmcEraseBlocks	(	IN EFI_ERASE_BLOCK_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN EFI_LBA	Lba,
		IN OUT EFI_ERASE_BLOCK_TOKEN *	Token,
		IN UINTN	Size
	)

Erase a specified number of device blocks.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	MediaId	The media ID that the erase request is for.
[in]	Lba	The starting logical block address to be erased. The caller is responsible for erasing only legitimate locations.
[in,out]	Token	A pointer to the token associated with the transaction.
[in]	Size	The size in bytes to be erased. This must be a multiple of the physical block size of the device.

Return values

EFI_SUCCESS	The erase request was queued if Event is not NULL. The data was erased correctly to the device if the Event is NULL.to the device.
EFI_WRITE_PROTECTED	The device cannot be erased due to write protection.
EFI_DEVICE_ERROR	The device reported an error while attempting to perform the erase operation.
EFI_INVALID_PARAMETER	The erase request contains LBAs that are not valid.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId is not for the current media.

Definition at line 2010 of file EmmcBlockIo.c.

◆ EmmcFlushBlocks()

EFI_STATUS EFIAPI EmmcFlushBlocks ( IN EFI_BLOCK_IO_PROTOCOL * This )

Flush the Block Device.

Parameters

This	Indicates a pointer to the calling context.

Return values

EFI_SUCCESS	All outstanding data was written to the device
EFI_DEVICE_ERROR	The device reported an error while writing back the data
EFI_NO_MEDIA	There is no media in the device.

Definition at line 1053 of file EmmcBlockIo.c.

◆ EmmcFlushBlocksEx()

EFI_STATUS EFIAPI EmmcFlushBlocksEx	(	IN EFI_BLOCK_IO2_PROTOCOL *	This,
		IN OUT EFI_BLOCK_IO2_TOKEN *	Token
	)

Flush the Block Device.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in,out]	Token	A pointer to the token associated with the transaction.

Return values

EFI_SUCCESS	All outstanding data was written to the device
EFI_DEVICE_ERROR	The device reported an error while writing back the data
EFI_NO_MEDIA	There is no media in the device.

Definition at line 1215 of file EmmcBlockIo.c.

◆ EmmcReadBlocks()

EFI_STATUS EFIAPI EmmcReadBlocks	(	IN EFI_BLOCK_IO_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN EFI_LBA	Lba,
		IN UINTN	BufferSize,
		OUT VOID *	Buffer
	)

Read BufferSize bytes from Lba into Buffer.

Parameters

This	Indicates a pointer to the calling context.
MediaId	Id of the media, changes every time the media is replaced.
Lba	The starting Logical Block Address to read from
BufferSize	Size of Buffer, must be a multiple of device block size.
Buffer	A pointer to the destination buffer for the data. The caller is responsible for either having implicit or explicit ownership of the buffer.

Return values

EFI_SUCCESS	The data was read correctly from the device.
EFI_DEVICE_ERROR	The device reported an error while performing the read.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId does not match the current device.
EFI_BAD_BUFFER_SIZE	The Buffer was not a multiple of the block size of the device.
EFI_INVALID_PARAMETER	The read request contains LBAs that are not valid, or the buffer is not on proper alignment.

Definition at line 985 of file EmmcBlockIo.c.

◆ EmmcReadBlocksEx()

EFI_STATUS EFIAPI EmmcReadBlocksEx	(	IN EFI_BLOCK_IO2_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN EFI_LBA	Lba,
		IN OUT EFI_BLOCK_IO2_TOKEN *	Token,
		IN UINTN	BufferSize,
		OUT VOID *	Buffer
	)

Read BufferSize bytes from Lba into Buffer.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	MediaId	Id of the media, changes every time the media is replaced.
[in]	Lba	The starting Logical Block Address to read from.
[in,out]	Token	A pointer to the token associated with the transaction.
[in]	BufferSize	Size of Buffer, must be a multiple of device block size.
[out]	Buffer	A pointer to the destination buffer for the data. The caller is responsible for either having implicit or explicit ownership of the buffer.

Return values

EFI_SUCCESS	The read request was queued if Event is not NULL. The data was read correctly from the device if the Event is NULL.
EFI_DEVICE_ERROR	The device reported an error while performing the read.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId is not for the current media.
EFI_BAD_BUFFER_SIZE	The BufferSize parameter is not a multiple of the intrinsic block size of the device.
EFI_INVALID_PARAMETER	The read request contains LBAs that are not valid, or the buffer is not on proper alignment.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.

Definition at line 1142 of file EmmcBlockIo.c.

◆ EmmcReset()

EFI_STATUS EFIAPI EmmcReset	(	IN EFI_BLOCK_IO_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Reset the Block Device.

Parameters

This	Indicates a pointer to the calling context.
ExtendedVerification	Driver may perform diagnostics on reset.

Return values

EFI_SUCCESS	The device was reset.
EFI_DEVICE_ERROR	The device is not functioning properly and could not be reset.

Definition at line 944 of file EmmcBlockIo.c.

◆ EmmcResetEx()

EFI_STATUS EFIAPI EmmcResetEx	(	IN EFI_BLOCK_IO2_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Reset the Block Device.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	ExtendedVerification	Driver may perform diagnostics on reset.

Return values

EFI_SUCCESS	The device was reset.
EFI_DEVICE_ERROR	The device is not functioning properly and could not be reset.

Definition at line 1076 of file EmmcBlockIo.c.

◆ EmmcSecurityProtocolIn()

EFI_STATUS EFIAPI EmmcSecurityProtocolIn	(	IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN UINT64	Timeout,
		IN UINT8	SecurityProtocolId,
		IN UINT16	SecurityProtocolSpecificData,
		IN UINTN	PayloadBufferSize,
		OUT VOID *	PayloadBuffer,
		OUT UINTN *	PayloadTransferSize
	)

Send a security protocol command to a device that receives data and/or the result of one or more commands sent by SendData.

The ReceiveData function sends a security protocol command to the given MediaId. The security protocol command sent is defined by SecurityProtocolId and contains the security protocol specific data SecurityProtocolSpecificData. The function returns the data from the security protocol command in PayloadBuffer.

For devices supporting the SCSI command set, the security protocol command is sent using the SECURITY PROTOCOL IN command defined in SPC-4.

For devices supporting the ATA command set, the security protocol command is sent using one of the TRUSTED RECEIVE commands defined in ATA8-ACS if PayloadBufferSize is non-zero.

If the PayloadBufferSize is zero, the security protocol command is sent using the Trusted Non-Data command defined in ATA8-ACS.

If PayloadBufferSize is too small to store the available data from the security protocol command, the function shall copy PayloadBufferSize bytes into the PayloadBuffer and return EFI_WARN_BUFFER_TOO_SMALL.

If PayloadBuffer or PayloadTransferSize is NULL and PayloadBufferSize is non-zero, the function shall return EFI_INVALID_PARAMETER.

If the given MediaId does not support security protocol commands, the function shall return EFI_UNSUPPORTED. If there is no media in the device, the function returns EFI_NO_MEDIA. If the MediaId is not the ID for the current media in the device, the function returns EFI_MEDIA_CHANGED.

If the security protocol fails to complete within the Timeout period, the function shall return EFI_TIMEOUT.

If the security protocol command completes without an error, the function shall return EFI_SUCCESS. If the security protocol command completes with an error, the function shall return EFI_DEVICE_ERROR.

Parameters

This	Indicates a pointer to the calling context.
MediaId	ID of the medium to receive data from. If there is no block IO protocol supported by the physical device, the value of MediaId is undefined.
Timeout	The timeout, in 100ns units, to use for the execution of the security protocol command. A Timeout value of 0 means that this function will wait indefinitely for the security protocol command to execute. If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the receive data command is greater than Timeout.
SecurityProtocolId	The value of the "Security Protocol" parameter of the security protocol command to be sent.
SecurityProtocolSpecificData	The value of the "Security Protocol Specific" parameter of the security protocol command to be sent.
PayloadBufferSize	Size in bytes of the payload data buffer.
PayloadBuffer	A pointer to a destination buffer to store the security protocol command specific payload data for the security protocol command. The caller is responsible for having either implicit or explicit ownership of the buffer.
PayloadTransferSize	A pointer to a buffer to store the size in bytes of the data written to the payload data buffer.

Return values

EFI_SUCCESS	The security protocol command completed successfully.
EFI_WARN_BUFFER_TOO_SMALL	The PayloadBufferSize was too small to store the available data from the device. The PayloadBuffer contains the truncated data.
EFI_UNSUPPORTED	The given MediaId does not support security protocol commands.
EFI_DEVICE_ERROR	The security protocol command completed with an error.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId is not for the current media.
EFI_INVALID_PARAMETER	The PayloadBuffer or PayloadTransferSize is NULL and PayloadBufferSize is non-zero.
EFI_TIMEOUT	A timeout occurred while waiting for the security protocol command to execute.

Definition at line 1496 of file EmmcBlockIo.c.

◆ EmmcSecurityProtocolInOut()

EFI_STATUS EFIAPI EmmcSecurityProtocolInOut	(	IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN UINT64	Timeout,
		IN UINT8	SecurityProtocolId,
		IN UINT16	SecurityProtocolSpecificData,
		IN UINTN	PayloadBufferSize,
		OUT VOID *	PayloadBuffer,
		OUT UINTN *	PayloadTransferSize,
		IN BOOLEAN	IsRead
	)