EmuBlockIo.h File Reference

Data Structures
struct	_EMU_BLOCK_IO_PROTOCOL

Macros
#define	EMU_BLOCK_IO_PROTOCOL_GUID   { 0x6888A4AE, 0xAFCE, 0xE84B, { 0x91, 0x02, 0xF7, 0xB9, 0xDA, 0xE6, 0xA0, 0x30 } }

Typedefs
typedef struct _EMU_BLOCK_IO_PROTOCOL	EMU_BLOCK_IO_PROTOCOL
typedef IN BOOLEAN	ExtendedVerification
typedef IN UINT32	MediaId
typedef IN UINT32 IN EFI_LBA	LBA
typedef IN UINT32 IN EFI_LBA IN OUT EFI_BLOCK_IO2_TOKEN *	Token
typedef IN UINT32 IN EFI_LBA IN OUT EFI_BLOCK_IO2_TOKEN IN UINTN	BufferSize
typedef IN UINT32 IN EFI_LBA IN OUT EFI_BLOCK_IO2_TOKEN IN UINTN OUT VOID *	Buffer
typedef IN EFI_BLOCK_IO_MEDIA *	Media

Functions
typedef	EFI_STATUS (EFIAPI *EMU_BLOCK_RESET)(IN EMU_BLOCK_IO_PROTOCOL *This

Variables
EFI_GUID	gEmuBlockIoProtocolGuid

Detailed Description

Emu Block IO2 protocol as defined in the UEFI 2.3.1 specification.

The Block IO2 protocol defines an extension to the Block IO protocol which enables the ability to read and write data at a block level in a non-blocking manner.

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

Macro Definition Documentation

#define EMU_BLOCK_IO_PROTOCOL_GUID   { 0x6888A4AE, 0xAFCE, 0xE84B, { 0x91, 0x02, 0xF7, 0xB9, 0xDA, 0xE6, 0xA0, 0x30 } }

Typedef Documentation

typedef IN UINT32 IN EFI_LBA IN OUT EFI_BLOCK_IO2_TOKEN IN UINTN IN VOID * Buffer

typedef IN UINT32 IN EFI_LBA IN OUT EFI_BLOCK_IO2_TOKEN IN UINTN BufferSize

typedef struct _EMU_BLOCK_IO_PROTOCOL EMU_BLOCK_IO_PROTOCOL

typedef IN BOOLEAN ExtendedVerification

typedef IN UINT32 IN EFI_LBA LBA

typedef IN EFI_BLOCK_IO_MEDIA* Media

typedef IN UINT32 MediaId

typedef IN OUT EFI_BLOCK_IO2_TOKEN * Token

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

EMU_BLOCK_FLUSH

)

Reset the block device hardware.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	ExtendedVerification	Indicates that the driver may perform a more exhausive verfication operation of the device during reset.

Return values

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

Read BufferSize bytes from Lba into Buffer.

This function reads the requested number of blocks from the device. All the blocks are read, or an error is returned. If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_or EFI_MEDIA_CHANGED is returned and non-blocking I/O is being used, the Event associated with this request will not be signaled.

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 Token->Event is not NULL.The data was read correctly from the device if the Token->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.

Write BufferSize bytes from Lba into Buffer.

This function writes the requested number of blocks to the device. All blocks are written, or an error is returned.If EFI_DEVICE_ERROR, EFI_NO_MEDIA, EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED is returned and non-blocking I/O is being used, the Event associated with this request will not be signaled.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	MediaId	The media ID that the write request is for.
[in]	Lba	The starting logical block address to be written. The caller is responsible for writing to only legitimate locations.
[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.
[in]	Buffer	A pointer to the source buffer for the data.

Return values

EFI_SUCCESS	The write request was queued if Event is not NULL. The data was written correctly to the device if the Event is NULL.
EFI_WRITE_PROTECTED	The device can not be written to.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHNAGED	The MediaId does not matched the current device.
EFI_DEVICE_ERROR	The device reported an error while performing the write.
EFI_BAD_BUFFER_SIZE	The Buffer was not a multiple of the block size of the device.
EFI_INVALID_PARAMETER	The write 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.

Flush the Block Device.

If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED is returned and non-blocking I/O is being used, the Event associated with this request will not be signaled.

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	The flush request was queued if Event is not NULL. All outstanding data was written correctly to the device if the Event is NULL.
EFI_DEVICE_ERROR	The device reported an error while writting back the data.
EFI_WRITE_PROTECTED	The device cannot be written to.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId is not for the current media.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.

Variable Documentation

EFI_GUID gEmuBlockIoProtocolGuid