DiskIo.h File Reference

Go to the source code of this file.

Data Structures
struct	_EFI_DISK_IO_PROTOCOL

Macros
#define	EFI_DISK_IO_PROTOCOL_GUID
#define	DISK_IO_PROTOCOL   EFI_DISK_IO_PROTOCOL_GUID
#define	EFI_DISK_IO_PROTOCOL_REVISION   0x00010000
#define	EFI_DISK_IO_INTERFACE_REVISION   EFI_DISK_IO_PROTOCOL_REVISION

Typedefs
typedef struct _EFI_DISK_IO_PROTOCOL	EFI_DISK_IO_PROTOCOL
typedef EFI_DISK_IO_PROTOCOL	EFI_DISK_IO
typedef EFI_STATUS(EFIAPI *	EFI_DISK_READ) (IN EFI_DISK_IO_PROTOCOL *This, IN UINT32 MediaId, IN UINT64 Offset, IN UINTN BufferSize, OUT VOID *Buffer)
typedef EFI_STATUS(EFIAPI *	EFI_DISK_WRITE) (IN EFI_DISK_IO_PROTOCOL *This, IN UINT32 MediaId, IN UINT64 Offset, IN UINTN BufferSize, IN VOID *Buffer)

Variables
EFI_GUID	gEfiDiskIoProtocolGuid

Detailed Description

Disk IO protocol as defined in the UEFI 2.0 specification.

The Disk IO protocol is used to convert block oriented devices into byte oriented devices. The Disk IO protocol is intended to layer on top of the Block IO protocol.

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

Definition in file DiskIo.h.

Macro Definition Documentation

DISK_IO_PROTOCOL

#define DISK_IO_PROTOCOL   EFI_DISK_IO_PROTOCOL_GUID

Protocol GUID name defined in EFI1.1.

Definition at line 24 of file DiskIo.h.

EFI_DISK_IO_INTERFACE_REVISION

#define EFI_DISK_IO_INTERFACE_REVISION   EFI_DISK_IO_PROTOCOL_REVISION

Revision defined in EFI1.1

Definition at line 93 of file DiskIo.h.

EFI_DISK_IO_PROTOCOL_GUID

#define EFI_DISK_IO_PROTOCOL_GUID

Value:

  { \
    0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }

Definition at line 16 of file DiskIo.h.

EFI_DISK_IO_PROTOCOL_REVISION

#define EFI_DISK_IO_PROTOCOL_REVISION   0x00010000

Definition at line 88 of file DiskIo.h.

Typedef Documentation

EFI_DISK_IO

typedef EFI_DISK_IO_PROTOCOL EFI_DISK_IO

Protocol defined in EFI1.1.

Definition at line 31 of file DiskIo.h.

EFI_DISK_IO_PROTOCOL

typedef struct _EFI_DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL

Definition at line 26 of file DiskIo.h.

EFI_DISK_READ

typedef EFI_STATUS(EFIAPI * EFI_DISK_READ) (IN EFI_DISK_IO_PROTOCOL *This, IN UINT32 MediaId, IN UINT64 Offset, IN UINTN BufferSize, OUT VOID *Buffer)

Read BufferSize bytes from Offset into Buffer.

Parameters

This	Protocol instance pointer.
MediaId	Id of the media, changes every time the media is replaced.
Offset	The starting byte offset to read from
BufferSize	Size of Buffer
Buffer	Buffer containing read data

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_CHNAGED	The MediaId does not matched the current device.
EFI_INVALID_PARAMETER	The read request contains device addresses that are not valid for the device.

Definition at line 51 of file DiskIo.h.

EFI_DISK_WRITE

typedef EFI_STATUS(EFIAPI * EFI_DISK_WRITE) (IN EFI_DISK_IO_PROTOCOL *This, IN UINT32 MediaId, IN UINT64 Offset, IN UINTN BufferSize, IN VOID *Buffer)

Writes a specified number of bytes to a device.

Parameters

This	Indicates a pointer to the calling context.
MediaId	ID of the medium to be written.
Offset	The starting byte offset on the logical block I/O device to write.
BufferSize	The size in bytes of Buffer. The number of bytes to write to the device.
Buffer	A pointer to the buffer containing the data to be written.

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_INVALID_PARAMETER	The write request contains device addresses that are not valid for the device.

Definition at line 79 of file DiskIo.h.