/** @file | |
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.<BR> | |
SPDX-License-Identifier: BSD-2-Clause-Patent | |
**/ | |
#ifndef __EMU_BLOCK_IO_H__ | |
#define __EMU_BLOCK_IO_H__ | |
#include <Protocol/BlockIo.h> | |
#include <Protocol/BlockIo2.h> | |
#define EMU_BLOCK_IO_PROTOCOL_GUID \ | |
{ 0x6888A4AE, 0xAFCE, 0xE84B, { 0x91, 0x02, 0xF7, 0xB9, 0xDA, 0xE6, 0xA0, 0x30 } } | |
typedef struct _EMU_BLOCK_IO_PROTOCOL EMU_BLOCK_IO_PROTOCOL; | |
/** | |
Reset the block device hardware. | |
@param[in] This Indicates a pointer to the calling context. | |
@param[in] ExtendedVerification Indicates that the driver may perform a more | |
exhausive verfication operation of the device | |
during reset. | |
@retval EFI_SUCCESS The device was reset. | |
@retval EFI_DEVICE_ERROR The device is not functioning properly and could | |
not be reset. | |
**/ | |
typedef | |
EFI_STATUS | |
(EFIAPI *EMU_BLOCK_RESET)( | |
IN EMU_BLOCK_IO_PROTOCOL *This, | |
IN BOOLEAN ExtendedVerification | |
); | |
/** | |
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. | |
@param[in] This Indicates a pointer to the calling context. | |
@param[in] MediaId Id of the media, changes every time the media is | |
replaced. | |
@param[in] Lba The starting Logical Block Address to read from. | |
@param[in, out] Token A pointer to the token associated with the transaction. | |
@param[in] BufferSize Size of Buffer, must be a multiple of device block size. | |
@param[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. | |
@retval 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. | |
@retval EFI_DEVICE_ERROR The device reported an error while performing | |
the read. | |
@retval EFI_NO_MEDIA There is no media in the device. | |
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media. | |
@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the | |
intrinsic block size of the device. | |
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, | |
or the buffer is not on proper alignment. | |
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack | |
of resources. | |
**/ | |
typedef | |
EFI_STATUS | |
(EFIAPI *EMU_BLOCK_READ)( | |
IN EMU_BLOCK_IO_PROTOCOL *This, | |
IN UINT32 MediaId, | |
IN EFI_LBA LBA, | |
IN OUT EFI_BLOCK_IO2_TOKEN *Token, | |
IN UINTN BufferSize, | |
OUT VOID *Buffer | |
); | |
/** | |
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. | |
@param[in] This Indicates a pointer to the calling context. | |
@param[in] MediaId The media ID that the write request is for. | |
@param[in] Lba The starting logical block address to be written. The | |
caller is responsible for writing to only legitimate | |
locations. | |
@param[in, out] Token A pointer to the token associated with the transaction. | |
@param[in] BufferSize Size of Buffer, must be a multiple of device block size. | |
@param[in] Buffer A pointer to the source buffer for the data. | |
@retval 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. | |
@retval EFI_WRITE_PROTECTED The device can not be written to. | |
@retval EFI_NO_MEDIA There is no media in the device. | |
@retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. | |
@retval EFI_DEVICE_ERROR The device reported an error while performing the write. | |
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. | |
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, | |
or the buffer is not on proper alignment. | |
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack | |
of resources. | |
**/ | |
typedef | |
EFI_STATUS | |
(EFIAPI *EMU_BLOCK_WRITE)( | |
IN EMU_BLOCK_IO_PROTOCOL *This, | |
IN UINT32 MediaId, | |
IN EFI_LBA LBA, | |
IN OUT EFI_BLOCK_IO2_TOKEN *Token, | |
IN UINTN BufferSize, | |
IN VOID *Buffer | |
); | |
/** | |
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. | |
@param[in] This Indicates a pointer to the calling context. | |
@param[in,out] Token A pointer to the token associated with the transaction | |
@retval 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. | |
@retval EFI_DEVICE_ERROR The device reported an error while writting back | |
the data. | |
@retval EFI_WRITE_PROTECTED The device cannot be written to. | |
@retval EFI_NO_MEDIA There is no media in the device. | |
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media. | |
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack | |
of resources. | |
**/ | |
typedef | |
EFI_STATUS | |
(EFIAPI *EMU_BLOCK_FLUSH)( | |
IN EMU_BLOCK_IO_PROTOCOL *This, | |
IN OUT EFI_BLOCK_IO2_TOKEN *Token | |
); | |
typedef | |
EFI_STATUS | |
(EFIAPI *EMU_BLOCK_CREATE_MAPPING)( | |
IN EMU_BLOCK_IO_PROTOCOL *This, | |
IN EFI_BLOCK_IO_MEDIA *Media | |
); | |
/// | |
/// The Block I/O2 protocol defines an extension to the Block I/O protocol which | |
/// enables the ability to read and write data at a block level in a non-blocking | |
// manner. | |
/// | |
struct _EMU_BLOCK_IO_PROTOCOL { | |
EMU_BLOCK_RESET Reset; | |
EMU_BLOCK_READ ReadBlocks; | |
EMU_BLOCK_WRITE WriteBlocks; | |
EMU_BLOCK_FLUSH FlushBlocks; | |
EMU_BLOCK_CREATE_MAPPING CreateMapping; | |
}; | |
extern EFI_GUID gEmuBlockIoProtocolGuid; | |
#endif |