2 Disk IO protocol as defined in the UEFI 2.0 specification.
4 The Disk IO protocol is used to convert block oriented devices into byte
5 oriented devices. The Disk IO protocol is intended to layer on top of the
8 Copyright (c) 2006 - 2008, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #define EFI_DISK_IO_PROTOCOL_GUID \
24 0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
28 /// Protocol GUID name defined in EFI1.1.
30 #define DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL_GUID
32 typedef struct _EFI_DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL
;
35 /// Protocol defined in EFI1.1.
37 typedef EFI_DISK_IO_PROTOCOL EFI_DISK_IO
;
40 Read BufferSize bytes from Offset into Buffer.
42 @param This Protocol instance pointer.
43 @param MediaId Id of the media, changes every time the media is replaced.
44 @param Offset The starting byte offset to read from
45 @param BufferSize Size of Buffer
46 @param Buffer Buffer containing read data
48 @retval EFI_SUCCESS The data was read correctly from the device.
49 @retval EFI_DEVICE_ERROR The device reported an error while performing the read.
50 @retval EFI_NO_MEDIA There is no media in the device.
51 @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
52 @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not
58 (EFIAPI
*EFI_DISK_READ
)(
59 IN EFI_DISK_IO_PROTOCOL
*This
,
68 Read BufferSize bytes from Offset into Buffer.
70 @param This Protocol instance pointer.
71 @param MediaId Id of the media, changes every time the media is replaced.
72 @param Offset The starting byte offset to read from
73 @param BufferSize Size of Buffer
74 @param Buffer Buffer containing read data
76 @retval EFI_SUCCESS The data was written correctly to the device.
77 @retval EFI_WRITE_PROTECTED The device can not be written to.
78 @retval EFI_DEVICE_ERROR The device reported an error while performing the write.
79 @retval EFI_NO_MEDIA There is no media in the device.
80 @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
81 @retval EFI_INVALID_PARAMETER The write request contains device addresses that are not
87 (EFIAPI
*EFI_DISK_WRITE
)(
88 IN EFI_DISK_IO_PROTOCOL
*This
,
96 #define EFI_DISK_IO_PROTOCOL_REVISION 0x00010000
99 /// Revision defined in EFI1.1
101 #define EFI_DISK_IO_INTERFACE_REVISION EFI_DISK_IO_PROTOCOL_REVISION
104 @par Protocol Description:
105 This protocol is used to abstract Block I/O interfaces.
108 The revision to which the disk I/O interface adheres. All future
109 revisions must be backwards compatible. If a future version is not
110 backwards compatible, it is not the same GUID.
113 Reads data from the disk.
116 Writes data to the disk.
119 struct _EFI_DISK_IO_PROTOCOL
{
121 EFI_DISK_READ ReadDisk
;
122 EFI_DISK_WRITE WriteDisk
;
125 extern EFI_GUID gEfiDiskIoProtocolGuid
;