]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
8a7d75b0 | 2 | Block IO protocol as defined in the UEFI 2.0 specification.\r |
d1f95000 | 3 | \r |
4 | The Block IO protocol is used to abstract block devices like hard drives,\r | |
5 | DVD-ROMs and floppy drives.\r | |
6 | \r | |
7 | Copyright (c) 2006, Intel Corporation \r | |
8 | All rights reserved. This program and the accompanying materials \r | |
9 | are licensed and made available under the terms and conditions of the BSD License \r | |
10 | which accompanies this distribution. The full text of the license may be found at \r | |
11 | http://opensource.org/licenses/bsd-license.php \r | |
12 | \r | |
13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
15 | \r | |
d1f95000 | 16 | **/\r |
17 | \r | |
18 | #ifndef __BLOCK_IO_H__\r | |
19 | #define __BLOCK_IO_H__\r | |
20 | \r | |
21 | #define EFI_BLOCK_IO_PROTOCOL_GUID \\r | |
22 | { \\r | |
23 | 0x964e5b21, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r | |
24 | }\r | |
25 | \r | |
a6508c05 | 26 | typedef struct _EFI_BLOCK_IO_PROTOCOL EFI_BLOCK_IO_PROTOCOL;\r |
27 | \r | |
d1f95000 | 28 | //\r |
a6508c05 | 29 | // Protocol GUID name defined in EFI1.1.\r |
30 | // \r | |
31 | #define BLOCK_IO_PROTOCOL EFI_BLOCK_IO_PROTOCOL_GUID\r | |
32 | \r | |
d1f95000 | 33 | //\r |
a6508c05 | 34 | // Protocol defined in EFI1.1.\r |
35 | // \r | |
36 | typedef EFI_BLOCK_IO_PROTOCOL EFI_BLOCK_IO;\r | |
d1f95000 | 37 | \r |
38 | /**\r | |
39 | Reset the Block Device.\r | |
40 | \r | |
41 | @param This Protocol instance pointer.\r | |
42 | @param ExtendedVerification Driver may perform diagnostics on reset.\r | |
43 | \r | |
44 | @retval EFI_SUCCESS The device was reset.\r | |
45 | @retval EFI_DEVICE_ERROR The device is not functioning properly and could\r | |
46 | not be reset.\r | |
47 | \r | |
48 | **/\r | |
49 | typedef\r | |
50 | EFI_STATUS\r | |
8b13229b | 51 | (EFIAPI *EFI_BLOCK_RESET)(\r |
d1f95000 | 52 | IN EFI_BLOCK_IO_PROTOCOL *This,\r |
53 | IN BOOLEAN ExtendedVerification\r | |
54 | )\r | |
55 | ;\r | |
56 | \r | |
57 | /**\r | |
58 | Read BufferSize bytes from Lba into Buffer.\r | |
59 | \r | |
60 | @param This Protocol instance pointer.\r | |
61 | @param MediaId Id of the media, changes every time the media is replaced.\r | |
62 | @param Lba The starting Logical Block Address to read from\r | |
63 | @param BufferSize Size of Buffer, must be a multiple of device block size.\r | |
64 | @param Buffer Buffer containing read data\r | |
65 | \r | |
66 | @retval EFI_SUCCESS The data was read correctly from the device.\r | |
67 | @retval EFI_DEVICE_ERROR The device reported an error while performing the read.\r | |
68 | @retval EFI_NO_MEDIA There is no media in the device.\r | |
69 | @retval EFI_MEDIA_CHANGED The MediaId does not matched the current device.\r | |
70 | @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.\r | |
71 | @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not\r | |
72 | valid for the device.\r | |
73 | \r | |
74 | **/\r | |
75 | typedef\r | |
76 | EFI_STATUS\r | |
8b13229b | 77 | (EFIAPI *EFI_BLOCK_READ)(\r |
d1f95000 | 78 | IN EFI_BLOCK_IO_PROTOCOL *This,\r |
79 | IN UINT32 MediaId,\r | |
80 | IN EFI_LBA Lba,\r | |
81 | IN UINTN BufferSize,\r | |
82 | OUT VOID *Buffer\r | |
83 | )\r | |
84 | ;\r | |
85 | \r | |
86 | /**\r | |
87 | Write BufferSize bytes from Lba into Buffer.\r | |
88 | \r | |
89 | @param This Protocol instance pointer.\r | |
90 | @param MediaId Id of the media, changes every time the media is replaced.\r | |
91 | @param Lba The starting Logical Block Address to read from\r | |
92 | @param BufferSize Size of Buffer, must be a multiple of device block size.\r | |
93 | @param Buffer Buffer containing read data\r | |
94 | \r | |
95 | @retval EFI_SUCCESS The data was written correctly to the device.\r | |
96 | @retval EFI_WRITE_PROTECTED The device can not be written to.\r | |
97 | @retval EFI_DEVICE_ERROR The device reported an error while performing the write.\r | |
98 | @retval EFI_NO_MEDIA There is no media in the device.\r | |
99 | @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.\r | |
100 | @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.\r | |
101 | @retval EFI_INVALID_PARAMETER The write request contains a LBA that is not\r | |
102 | valid for the device.\r | |
103 | \r | |
104 | **/\r | |
105 | typedef\r | |
106 | EFI_STATUS\r | |
8b13229b | 107 | (EFIAPI *EFI_BLOCK_WRITE)(\r |
d1f95000 | 108 | IN EFI_BLOCK_IO_PROTOCOL *This,\r |
109 | IN UINT32 MediaId,\r | |
110 | IN EFI_LBA Lba,\r | |
111 | IN UINTN BufferSize,\r | |
112 | IN VOID *Buffer\r | |
113 | )\r | |
114 | ;\r | |
115 | \r | |
116 | /**\r | |
117 | Flush the Block Device.\r | |
118 | \r | |
119 | @param This Protocol instance pointer.\r | |
120 | \r | |
121 | @retval EFI_SUCCESS All outstanding data was written to the device\r | |
122 | @retval EFI_DEVICE_ERROR The device reported an error while writting back the data\r | |
123 | @retval EFI_NO_MEDIA There is no media in the device.\r | |
124 | \r | |
125 | **/\r | |
126 | typedef\r | |
127 | EFI_STATUS\r | |
8b13229b | 128 | (EFIAPI *EFI_BLOCK_FLUSH)(\r |
d1f95000 | 129 | IN EFI_BLOCK_IO_PROTOCOL *This\r |
130 | )\r | |
131 | ;\r | |
132 | \r | |
133 | /**\r | |
134 | Block IO read only mode data and updated only via members of BlockIO\r | |
135 | \r | |
136 | **/\r | |
137 | typedef struct {\r | |
19bee90c LG |
138 | UINT32 MediaId; /**< The curent media Id. If the media changes, this value is changed.**/\r |
139 | BOOLEAN RemovableMedia; /**< TRUE if the media is removable; otherwise, FALSE.**/\r | |
d1f95000 | 140 | BOOLEAN MediaPresent; /**< TRUE if there is a media currently present in the device;\r |
19bee90c LG |
141 | othersise, FALSE. THis field shows the media present status\r |
142 | as of the most recent ReadBlocks() or WriteBlocks() call.\r | |
143 | **/\r | |
d1f95000 | 144 | BOOLEAN LogicalPartition; /**< TRUE if LBA 0 is the first block of a partition; otherwise\r |
19bee90c LG |
145 | FALSE. For media with only one partition this would be TRUE.\r |
146 | **/\r | |
d1f95000 | 147 | BOOLEAN ReadOnly; /**< TRUE if the media is marked read-only otherwise, FALSE.\r |
19bee90c LG |
148 | This field shows the read-only status as of the most recent WriteBlocks () call.\r |
149 | **/\r | |
150 | BOOLEAN WriteCaching; /**< TRUE if the WriteBlock () function caches write data.**/\r | |
d1f95000 | 151 | \r |
152 | UINT32 BlockSize; /**< The intrinsic block size of the device. If the media changes, then\r | |
19bee90c LG |
153 | this field is updated.\r |
154 | **/\r | |
155 | UINT32 IoAlign; /**< Supplies the alignment requirement for any buffer to read or write block(s).**/\r | |
d1f95000 | 156 | \r |
157 | EFI_LBA LastBlock; /**< The last logical block address on the device.\r | |
19bee90c LG |
158 | If the media changes, then this field is updated.\r |
159 | **/\r | |
d1f95000 | 160 | } EFI_BLOCK_IO_MEDIA;\r |
161 | \r | |
162 | #define EFI_BLOCK_IO_PROTOCOL_REVISION 0x00010000\r | |
a6508c05 | 163 | //\r |
164 | // Revision defined in EFI1.1.\r | |
165 | // \r | |
166 | #define EFI_BLOCK_IO_INTERFACE_REVISION EFI_BLOCK_IO_PROTOCOL_REVISION\r | |
d1f95000 | 167 | \r |
168 | struct _EFI_BLOCK_IO_PROTOCOL {\r | |
169 | UINT64 Revision;\r | |
170 | \r | |
171 | EFI_BLOCK_IO_MEDIA *Media;\r | |
172 | \r | |
173 | EFI_BLOCK_RESET Reset;\r | |
174 | EFI_BLOCK_READ ReadBlocks;\r | |
175 | EFI_BLOCK_WRITE WriteBlocks;\r | |
176 | EFI_BLOCK_FLUSH FlushBlocks;\r | |
177 | \r | |
178 | };\r | |
179 | \r | |
180 | extern EFI_GUID gEfiBlockIoProtocolGuid;\r | |
181 | \r | |
182 | #endif\r |