This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Classes | |
| struct | EFI_BLOCK_IO_MEDIA |
| struct | _EFI_BLOCK_IO_PROTOCOL |
Typedefs | |
| typedef struct _EFI_BLOCK_IO_PROTOCOL | EFI_BLOCK_IO_PROTOCOL |
| typedef EFI_BLOCK_IO_PROTOCOL | EFI_BLOCK_IO |
| typedef EFI_STATUS(EFIAPI * | EFI_BLOCK_RESET) (IN EFI_BLOCK_IO_PROTOCOL *This, IN BOOLEAN ExtendedVerification) |
| typedef EFI_STATUS(EFIAPI * | EFI_BLOCK_READ) (IN EFI_BLOCK_IO_PROTOCOL *This, IN UINT32 MediaId, IN EFI_LBA Lba, IN UINTN BufferSize, OUT VOID *Buffer) |
| typedef EFI_STATUS(EFIAPI * | EFI_BLOCK_WRITE) (IN EFI_BLOCK_IO_PROTOCOL *This, IN UINT32 MediaId, IN EFI_LBA Lba, IN UINTN BufferSize, IN VOID *Buffer) |
| typedef EFI_STATUS(EFIAPI * | EFI_BLOCK_FLUSH) (IN EFI_BLOCK_IO_PROTOCOL *This) |
Variables | |
| EFI_GUID | gEfiBlockIoProtocolGuid |
Detailed Description
Block IO protocol as defined in the UEFI 2.0 specification.
The Block IO protocol is used to abstract block devices like hard drives, DVD-ROMs and floppy drives.
Copyright (c) 2006 - 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 BlockIo.h.
Macro Definition Documentation
◆ BLOCK_IO_PROTOCOL
| #define BLOCK_IO_PROTOCOL EFI_BLOCK_IO_PROTOCOL_GUID |
◆ EFI_BLOCK_IO_INTERFACE_REVISION
| #define EFI_BLOCK_IO_INTERFACE_REVISION EFI_BLOCK_IO_PROTOCOL_REVISION |
◆ EFI_BLOCK_IO_PROTOCOL_GUID
| #define EFI_BLOCK_IO_PROTOCOL_GUID |
◆ EFI_BLOCK_IO_PROTOCOL_REVISION
◆ EFI_BLOCK_IO_PROTOCOL_REVISION2
◆ EFI_BLOCK_IO_PROTOCOL_REVISION3
Typedef Documentation
◆ EFI_BLOCK_FLUSH
| typedef EFI_STATUS(EFIAPI * EFI_BLOCK_FLUSH) (IN EFI_BLOCK_IO_PROTOCOL *This) |
Flush the Block Device.
- Parameters
-
This Indicates a pointer to the calling context.
- Return values
-
EFI_SUCCESS All outstanding data was written to the device EFI_DEVICE_ERROR The device reported an error while writting back the data EFI_NO_MEDIA There is no media in the device.
◆ EFI_BLOCK_IO
| typedef EFI_BLOCK_IO_PROTOCOL EFI_BLOCK_IO |
◆ EFI_BLOCK_IO_PROTOCOL
◆ EFI_BLOCK_READ
| typedef EFI_STATUS(EFIAPI * EFI_BLOCK_READ) (IN EFI_BLOCK_IO_PROTOCOL *This, IN UINT32 MediaId, IN EFI_LBA Lba, IN UINTN BufferSize, OUT VOID *Buffer) |
Read BufferSize bytes from Lba into Buffer.
- Parameters
-
This Indicates a pointer to the calling context. MediaId Id of the media, changes every time the media is replaced. Lba The starting Logical Block Address to read from BufferSize Size of Buffer, must be a multiple of device block size. 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 data was read correctly from the device. 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 does not matched the current device. EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the 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_BLOCK_RESET
| typedef EFI_STATUS(EFIAPI * EFI_BLOCK_RESET) (IN EFI_BLOCK_IO_PROTOCOL *This, IN BOOLEAN ExtendedVerification) |
Reset the Block Device.
- Parameters
-
This Indicates a pointer to the calling context. ExtendedVerification Driver may perform diagnostics on reset.
- Return values
-
EFI_SUCCESS The device was reset. EFI_DEVICE_ERROR The device is not functioning properly and could not be reset.
◆ EFI_BLOCK_WRITE
| typedef EFI_STATUS(EFIAPI * EFI_BLOCK_WRITE) (IN EFI_BLOCK_IO_PROTOCOL *This, IN UINT32 MediaId, IN EFI_LBA Lba, IN UINTN BufferSize, IN VOID *Buffer) |
Write BufferSize bytes from Lba into Buffer.
- Parameters
-
This Indicates a pointer to the calling context. MediaId The media ID that the write request is for. Lba The starting logical block address to be written. The caller is responsible for writing to only legitimate locations. BufferSize Size of Buffer, must be a multiple of device block size. Buffer A pointer to the source buffer for the data.
- Return values
-
EFI_SUCCESS The data was written correctly to the device. EFI_WRITE_PROTECTED The device can not be written to. EFI_DEVICE_ERROR The device reported an error while performing the write. EFI_NO_MEDIA There is no media in the device. EFI_MEDIA_CHNAGED The MediaId does not matched the current device. 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.
Variable Documentation
◆ gEfiBlockIoProtocolGuid
|
extern |
