iPXE
Data Structures | Macros | Typedefs | Functions | Variables
BlockIo2.h File Reference

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

#include <ipxe/efi/Protocol/BlockIo.h>

Go to the source code of this file.

Data Structures

struct  EFI_BLOCK_IO2_TOKEN
 The struct of Block IO2 Token. More...
 
struct  _EFI_BLOCK_IO2_PROTOCOL
 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. More...
 

Macros

#define EFI_BLOCK_IO2_PROTOCOL_GUID
 

Typedefs

typedef struct _EFI_BLOCK_IO2_PROTOCOL EFI_BLOCK_IO2_PROTOCOL
 
typedef EFI_STATUS(EFIAPIEFI_BLOCK_RESET_EX) (IN EFI_BLOCK_IO2_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
 Reset the block device hardware. More...
 
typedef EFI_STATUS(EFIAPIEFI_BLOCK_READ_EX) (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. More...
 
typedef EFI_STATUS(EFIAPIEFI_BLOCK_WRITE_EX) (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)
 Write BufferSize bytes from Lba into Buffer. More...
 
typedef EFI_STATUS(EFIAPIEFI_BLOCK_FLUSH_EX) (IN EFI_BLOCK_IO2_PROTOCOL *This, IN OUT EFI_BLOCK_IO2_TOKEN *Token)
 Flush the Block Device. More...
 

Functions

 FILE_LICENCE (BSD3)
 

Variables

EFI_GUID gEfiBlockIo2ProtocolGuid
 

Detailed Description

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.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file BlockIo2.h.

Macro Definition Documentation

◆ EFI_BLOCK_IO2_PROTOCOL_GUID

#define EFI_BLOCK_IO2_PROTOCOL_GUID
Value:
{ \
0xa77b2472, 0xe282, 0x4e9f, {0xa2, 0x45, 0xc2, 0xc0, 0xe2, 0x7b, 0xbc, 0xc1} \
}

Definition at line 26 of file BlockIo2.h.

Typedef Documentation

◆ EFI_BLOCK_IO2_PROTOCOL

Definition at line 31 of file BlockIo2.h.

◆ EFI_BLOCK_RESET_EX

typedef EFI_STATUS(EFIAPI * EFI_BLOCK_RESET_EX) (IN EFI_BLOCK_IO2_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

Reset the block device hardware.

Parameters
[in]ThisIndicates a pointer to the calling context.
[in]ExtendedVerificationIndicates that the driver may perform a more exhausive verification operation of the device during reset.
Return values
EFI_SUCCESSThe device was reset.
EFI_DEVICE_ERRORThe device is not functioning properly and could not be reset.

Definition at line 67 of file BlockIo2.h.

◆ EFI_BLOCK_READ_EX

typedef EFI_STATUS(EFIAPI * EFI_BLOCK_READ_EX) (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.

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]ThisIndicates a pointer to the calling context.
[in]MediaIdId of the media, changes every time the media is replaced.
[in]LbaThe starting Logical Block Address to read from.
[in,out]TokenA pointer to the token associated with the transaction.
[in]BufferSizeSize of Buffer, must be a multiple of device block size.
[out]BufferA 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_SUCCESSThe 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_ERRORThe device reported an error while performing the read.
EFI_NO_MEDIAThere is no media in the device.
EFI_MEDIA_CHANGEDThe MediaId is not for the current media.
EFI_BAD_BUFFER_SIZEThe BufferSize parameter is not a multiple of the intrinsic block size of the device.
EFI_INVALID_PARAMETERThe read request contains LBAs that are not valid, or the buffer is not on proper alignment.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.

Definition at line 107 of file BlockIo2.h.

◆ EFI_BLOCK_WRITE_EX

typedef EFI_STATUS(EFIAPI * EFI_BLOCK_WRITE_EX) (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)

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]ThisIndicates a pointer to the calling context.
[in]MediaIdThe media ID that the write request is for.
[in]LbaThe starting logical block address to be written. The caller is responsible for writing to only legitimate locations.
[in,out]TokenA pointer to the token associated with the transaction.
[in]BufferSizeSize of Buffer, must be a multiple of device block size.
[in]BufferA pointer to the source buffer for the data.
Return values
EFI_SUCCESSThe write request was queued if Event is not NULL. The data was written correctly to the device if the Event is NULL.
EFI_WRITE_PROTECTEDThe device can not be written to.
EFI_NO_MEDIAThere is no media in the device.
EFI_MEDIA_CHNAGEDThe MediaId does not matched the current device.
EFI_DEVICE_ERRORThe device reported an error while performing the write.
EFI_BAD_BUFFER_SIZEThe Buffer was not a multiple of the block size of the device.
EFI_INVALID_PARAMETERThe write request contains LBAs that are not valid, or the buffer is not on proper alignment.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.

Definition at line 149 of file BlockIo2.h.

◆ EFI_BLOCK_FLUSH_EX

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

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]ThisIndicates a pointer to the calling context.
[in,out]TokenA pointer to the token associated with the transaction
Return values
EFI_SUCCESSThe 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_ERRORThe device reported an error while writting back the data.
EFI_WRITE_PROTECTEDThe device cannot be written to.
EFI_NO_MEDIAThere is no media in the device.
EFI_MEDIA_CHANGEDThe MediaId is not for the current media.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.

Definition at line 182 of file BlockIo2.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD3  )

Variable Documentation

◆ gEfiBlockIo2ProtocolGuid

EFI_GUID gEfiBlockIo2ProtocolGuid