EraseBlock.h File Reference

Go to the source code of this file.

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 EFI_STATUS(EFIAPI *	EFI_BLOCK_ERASE) (IN EFI_ERASE_BLOCK_PROTOCOL *This, IN UINT32 MediaId, IN EFI_LBA LBA, IN OUT EFI_ERASE_BLOCK_TOKEN *Token, IN UINTN Size)

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

Definition in file EraseBlock.h.

Macro Definition Documentation

EFI_ERASE_BLOCK_PROTOCOL_GUID

#define EFI_ERASE_BLOCK_PROTOCOL_GUID

Value:

  { \
    0x95a9a93e, 0xa86e, 0x4926, { 0xaa, 0xef, 0x99, 0x18, 0xe7, 0x72, 0xd9, 0x87 } \
  }

Definition at line 15 of file EraseBlock.h.

EFI_ERASE_BLOCK_PROTOCOL_REVISION

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

Definition at line 22 of file EraseBlock.h.

Typedef Documentation

EFI_BLOCK_ERASE

typedef EFI_STATUS(EFIAPI * EFI_BLOCK_ERASE) (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 68 of file EraseBlock.h.

EFI_ERASE_BLOCK_PROTOCOL

typedef struct _EFI_ERASE_BLOCK_PROTOCOL EFI_ERASE_BLOCK_PROTOCOL

Definition at line 20 of file EraseBlock.h.