MdePkg[all]  1.08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
EraseBlock.h File Reference

Data Structures

struct  EFI_ERASE_BLOCK_TOKEN
 
struct  _EFI_ERASE_BLOCK_PROTOCOL
 

Macros

#define EFI_ERASE_BLOCK_PROTOCOL_GUID
 
#define EFI_ERASE_BLOCK_PROTOCOL_REVISION   ((2<<16) | (60))
 

Typedefs

typedef struct
_EFI_ERASE_BLOCK_PROTOCOL 
EFI_ERASE_BLOCK_PROTOCOL
 
typedef IN UINT32 MediaId
 
typedef IN UINT32 IN EFI_LBA LBA
 
typedef IN UINT32 IN EFI_LBA
IN OUT EFI_ERASE_BLOCK_TOKEN
Token
 
typedef IN UINT32 IN EFI_LBA
IN OUT EFI_ERASE_BLOCK_TOKEN
IN UINTN 
Size
 

Functions

typedef EFI_STATUS (EFIAPI *EFI_BLOCK_ERASE)(IN EFI_ERASE_BLOCK_PROTOCOL *This
 

Variables

EFI_GUID gEfiEraseBlockProtocolGuid
 

Detailed Description

This file defines the EFI Erase Block Protocol.

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

Revision Reference:
This Protocol is introduced in UEFI Specification 2.6

Macro Definition Documentation

#define EFI_ERASE_BLOCK_PROTOCOL_GUID
Value:
{ \
0x95a9a93e, 0xa86e, 0x4926, { 0xaa, 0xef, 0x99, 0x18, 0xe7, 0x72, 0xd9, 0x87 } \
}
#define EFI_ERASE_BLOCK_PROTOCOL_REVISION   ((2<<16) | (60))

Typedef Documentation

typedef IN UINT32 IN EFI_LBA LBA
typedef IN UINT32 MediaId

Function Documentation

typedef EFI_STATUS ( EFIAPI EFI_BLOCK_ERASE)

Erase a specified number of device blocks.

Parameters
[in]ThisIndicates a pointer to the calling context.
[in]MediaIdThe media ID that the erase request is for.
[in]LBAThe starting logical block address to be erased. The caller is responsible for erasing only legitimate locations.
[in,out]TokenA pointer to the token associated with the transaction.
[in]SizeThe size in bytes to be erased. This must be a multiple of the physical block size of the device.
Return values
EFI_SUCCESSThe 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_PROTECTEDThe device cannot be erased due to write protection.
EFI_DEVICE_ERRORThe device reported an error while attempting to perform the erase operation.
EFI_INVALID_PARAMETERThe erase request contains LBAs that are not valid.
EFI_NO_MEDIAThere is no media in the device.
EFI_MEDIA_CHANGEDThe MediaId is not for the current media.

Variable Documentation

EFI_GUID gEfiEraseBlockProtocolGuid