]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
8a7d75b0 | 2 | SimpleFileSystem protocol as defined in the UEFI 2.0 specification.\r |
d1f95000 | 3 | \r |
4 | The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) \r | |
8a7d75b0 | 5 | file system specified in UEFI 2.0. It can also be used to abstract a file \r |
d1f95000 | 6 | system other than FAT.\r |
7 | \r | |
8a7d75b0 | 8 | UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem\r |
d1f95000 | 9 | \r |
4ca9b6c4 | 10 | Copyright (c) 2006 - 2008, Intel Corporation \r |
d1f95000 | 11 | All rights reserved. This program and the accompanying materials \r |
12 | are licensed and made available under the terms and conditions of the BSD License \r | |
13 | which accompanies this distribution. The full text of the license may be found at \r | |
14 | http://opensource.org/licenses/bsd-license.php \r | |
15 | \r | |
16 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
17 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
18 | \r | |
d1f95000 | 19 | **/\r |
20 | \r | |
21 | #ifndef __SIMPLE_FILE_SYSTEM_H__\r | |
22 | #define __SIMPLE_FILE_SYSTEM_H__\r | |
23 | \r | |
24 | #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \\r | |
25 | { \\r | |
26 | 0x964e5b22, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r | |
27 | }\r | |
28 | \r | |
29 | typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL;\r | |
a6508c05 | 30 | \r |
31 | typedef struct _EFI_FILE_PROTOCOL EFI_FILE_PROTOCOL;\r | |
32 | typedef struct _EFI_FILE_PROTOCOL *EFI_FILE_HANDLE;\r | |
33 | \r | |
99e8ed21 | 34 | ///\r |
992f22b9 | 35 | /// Protocol GUID name defined in EFI1.1.\r |
99e8ed21 | 36 | /// \r |
a6508c05 | 37 | #define SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID\r |
38 | \r | |
99e8ed21 | 39 | ///\r |
992f22b9 | 40 | /// Protocol name defined in EFI1.1.\r |
99e8ed21 | 41 | /// \r |
a6508c05 | 42 | typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_FILE_IO_INTERFACE;\r |
43 | typedef struct _EFI_FILE_PROTOCOL EFI_FILE;\r | |
d1f95000 | 44 | \r |
45 | /**\r | |
46 | Open the root directory on a volume.\r | |
47 | \r | |
48 | @param This Protocol instance pointer.\r | |
49 | @param Root Returns an Open file handle for the root directory\r | |
50 | \r | |
51 | @retval EFI_SUCCESS The device was opened.\r | |
52 | @retval EFI_UNSUPPORTED This volume does not suppor the file system.\r | |
53 | @retval EFI_NO_MEDIA The device has no media.\r | |
54 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
55 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
56 | @retval EFI_ACCESS_DENIED The service denied access to the file\r | |
57 | @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources\r | |
58 | \r | |
59 | **/\r | |
60 | typedef\r | |
61 | EFI_STATUS\r | |
8b13229b | 62 | (EFIAPI *EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME)(\r |
d1f95000 | 63 | IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r |
a6508c05 | 64 | OUT EFI_FILE_PROTOCOL **Root\r |
ed66e1bc | 65 | );\r |
d1f95000 | 66 | \r |
67 | #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000\r | |
992f22b9 | 68 | \r |
99e8ed21 | 69 | ///\r |
70 | /// Revision defined in EFI1.1\r | |
71 | /// \r | |
a6508c05 | 72 | #define EFI_FILE_IO_INTERFACE_REVISION EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION\r |
d1f95000 | 73 | \r |
74 | struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {\r | |
992f22b9 LG |
75 | ///\r |
76 | /// The version of the EFI_SIMPLE_FILE_SYSTEM_PROTOCOL. The version\r | |
77 | /// specified by this specification is 0x00010000. All future revisions\r | |
78 | /// must be backwards compatible.\r | |
79 | ///\r | |
d1f95000 | 80 | UINT64 Revision;\r |
81 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME OpenVolume;\r | |
82 | };\r | |
83 | \r | |
84 | /**\r | |
85 | Open the root directory on a volume.\r | |
86 | \r | |
87 | @param This Protocol instance pointer.\r | |
88 | @param NewHandle Returns File Handle for FileName\r | |
89 | @param FileName Null terminated string. "\", ".", and ".." are supported\r | |
90 | @param OpenMode Open mode for file.\r | |
91 | @param Attributes Only used for EFI_FILE_MODE_CREATE\r | |
92 | \r | |
93 | @retval EFI_SUCCESS The device was opened.\r | |
94 | @retval EFI_NOT_FOUND The specified file could not be found on the device\r | |
95 | @retval EFI_NO_MEDIA The device has no media.\r | |
96 | @retval EFI_MEDIA_CHANGED The media has changed\r | |
97 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
98 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
99 | @retval EFI_ACCESS_DENIED The service denied access to the file\r | |
100 | @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources\r | |
101 | @retval EFI_VOLUME_FULL The volume is full.\r | |
102 | \r | |
103 | **/\r | |
104 | typedef\r | |
105 | EFI_STATUS\r | |
8b13229b | 106 | (EFIAPI *EFI_FILE_OPEN)(\r |
a6508c05 | 107 | IN EFI_FILE_PROTOCOL *This,\r |
108 | OUT EFI_FILE_PROTOCOL **NewHandle,\r | |
d1f95000 | 109 | IN CHAR16 *FileName,\r |
110 | IN UINT64 OpenMode,\r | |
111 | IN UINT64 Attributes\r | |
ed66e1bc | 112 | );\r |
d1f95000 | 113 | \r |
114 | //\r | |
115 | // Open modes\r | |
116 | //\r | |
117 | #define EFI_FILE_MODE_READ 0x0000000000000001ULL\r | |
118 | #define EFI_FILE_MODE_WRITE 0x0000000000000002ULL\r | |
119 | #define EFI_FILE_MODE_CREATE 0x8000000000000000ULL\r | |
120 | \r | |
121 | //\r | |
122 | // File attributes\r | |
123 | //\r | |
124 | #define EFI_FILE_READ_ONLY 0x0000000000000001ULL\r | |
125 | #define EFI_FILE_HIDDEN 0x0000000000000002ULL\r | |
126 | #define EFI_FILE_SYSTEM 0x0000000000000004ULL\r | |
127 | #define EFI_FILE_RESERVED 0x0000000000000008ULL\r | |
128 | #define EFI_FILE_DIRECTORY 0x0000000000000010ULL\r | |
129 | #define EFI_FILE_ARCHIVE 0x0000000000000020ULL\r | |
130 | #define EFI_FILE_VALID_ATTR 0x0000000000000037ULL\r | |
131 | \r | |
132 | /**\r | |
133 | Close the file handle\r | |
134 | \r | |
135 | @param This Protocol instance pointer.\r | |
136 | \r | |
137 | @retval EFI_SUCCESS The device was opened.\r | |
138 | \r | |
139 | **/\r | |
140 | typedef\r | |
141 | EFI_STATUS\r | |
8b13229b | 142 | (EFIAPI *EFI_FILE_CLOSE)(\r |
d1f95000 | 143 | IN EFI_FILE *This\r |
ed66e1bc | 144 | );\r |
d1f95000 | 145 | \r |
146 | /**\r | |
147 | Close and delete the file handle\r | |
148 | \r | |
149 | @param This Protocol instance pointer.\r | |
150 | \r | |
151 | @retval EFI_SUCCESS The device was opened.\r | |
152 | @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted\r | |
153 | \r | |
154 | **/\r | |
155 | typedef\r | |
156 | EFI_STATUS\r | |
8b13229b | 157 | (EFIAPI *EFI_FILE_DELETE)(\r |
d1f95000 | 158 | IN EFI_FILE *This\r |
ed66e1bc | 159 | );\r |
d1f95000 | 160 | \r |
161 | /**\r | |
162 | Read data from the file.\r | |
163 | \r | |
164 | @param This Protocol instance pointer.\r | |
165 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
166 | @param Buffer The buffer in which data is read.\r | |
167 | \r | |
168 | @retval EFI_SUCCESS Data was read.\r | |
169 | @retval EFI_NO_MEDIA The device has no media\r | |
170 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
171 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
172 | @retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size\r | |
173 | \r | |
174 | **/\r | |
175 | typedef\r | |
176 | EFI_STATUS\r | |
8b13229b | 177 | (EFIAPI *EFI_FILE_READ)(\r |
a6508c05 | 178 | IN EFI_FILE_PROTOCOL *This,\r |
d1f95000 | 179 | IN OUT UINTN *BufferSize,\r |
180 | OUT VOID *Buffer\r | |
ed66e1bc | 181 | );\r |
d1f95000 | 182 | \r |
183 | /**\r | |
184 | Write data from to the file.\r | |
185 | \r | |
186 | @param This Protocol instance pointer.\r | |
187 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
188 | @param Buffer The buffer in which data to write.\r | |
189 | \r | |
190 | @retval EFI_SUCCESS Data was written.\r | |
191 | @retval EFI_UNSUPPORT Writes to Open directory are not supported\r | |
192 | @retval EFI_NO_MEDIA The device has no media\r | |
193 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
194 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
195 | @retval EFI_WRITE_PROTECTED The device is write protected\r | |
196 | @retval EFI_ACCESS_DENIED The file was open for read only\r | |
197 | @retval EFI_VOLUME_FULL The volume is full\r | |
198 | \r | |
199 | **/\r | |
200 | typedef\r | |
201 | EFI_STATUS\r | |
8b13229b | 202 | (EFIAPI *EFI_FILE_WRITE)(\r |
a6508c05 | 203 | IN EFI_FILE_PROTOCOL *This,\r |
d1f95000 | 204 | IN OUT UINTN *BufferSize,\r |
205 | IN VOID *Buffer\r | |
ed66e1bc | 206 | );\r |
d1f95000 | 207 | \r |
208 | /**\r | |
209 | Set a files current position\r | |
210 | \r | |
211 | @param This Protocol instance pointer.\r | |
212 | @param Position Byte possition from the start of the file\r | |
213 | \r | |
214 | @retval EFI_SUCCESS Data was written.\r | |
215 | @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r | |
216 | \r | |
217 | **/\r | |
218 | typedef\r | |
219 | EFI_STATUS\r | |
8b13229b | 220 | (EFIAPI *EFI_FILE_SET_POSITION)(\r |
a6508c05 | 221 | IN EFI_FILE_PROTOCOL *This,\r |
d1f95000 | 222 | IN UINT64 Position\r |
ed66e1bc | 223 | );\r |
d1f95000 | 224 | \r |
225 | /**\r | |
226 | Get a files current position\r | |
227 | \r | |
228 | @param This Protocol instance pointer.\r | |
229 | @param Position Byte possition from the start of the file\r | |
230 | \r | |
231 | @retval EFI_SUCCESS Data was written.\r | |
232 | @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r | |
233 | \r | |
234 | **/\r | |
235 | typedef\r | |
236 | EFI_STATUS\r | |
8b13229b | 237 | (EFIAPI *EFI_FILE_GET_POSITION)(\r |
a6508c05 | 238 | IN EFI_FILE_PROTOCOL *This,\r |
d1f95000 | 239 | OUT UINT64 *Position\r |
ed66e1bc | 240 | );\r |
d1f95000 | 241 | \r |
242 | /**\r | |
243 | Get information about a file\r | |
244 | \r | |
245 | @param This Protocol instance pointer.\r | |
246 | @param InformationType Type of info to return in Buffer\r | |
247 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
248 | @param Buffer The buffer to return data.\r | |
249 | \r | |
250 | @retval EFI_SUCCESS Data was returned.\r | |
251 | @retval EFI_UNSUPPORT InformationType is not supported\r | |
252 | @retval EFI_NO_MEDIA The device has no media\r | |
253 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
254 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
255 | @retval EFI_WRITE_PROTECTED The device is write protected\r | |
256 | @retval EFI_ACCESS_DENIED The file was open for read only\r | |
257 | @retval EFI_BUFFER_TOO_SMALL Buffer was too small, required size returned in BufferSize\r | |
258 | \r | |
259 | **/\r | |
260 | typedef\r | |
261 | EFI_STATUS\r | |
8b13229b | 262 | (EFIAPI *EFI_FILE_GET_INFO)(\r |
a6508c05 | 263 | IN EFI_FILE_PROTOCOL *This,\r |
d1f95000 | 264 | IN EFI_GUID *InformationType,\r |
265 | IN OUT UINTN *BufferSize,\r | |
266 | OUT VOID *Buffer\r | |
ed66e1bc | 267 | );\r |
d1f95000 | 268 | \r |
269 | /**\r | |
270 | Set information about a file\r | |
271 | \r | |
272 | @param File Protocol instance pointer.\r | |
273 | @param InformationType Type of info in Buffer\r | |
274 | @param BufferSize Size of buffer.\r | |
275 | @param Buffer The data to write.\r | |
276 | \r | |
277 | @retval EFI_SUCCESS Data was returned.\r | |
278 | @retval EFI_UNSUPPORT InformationType is not supported\r | |
279 | @retval EFI_NO_MEDIA The device has no media\r | |
280 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
281 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
282 | @retval EFI_WRITE_PROTECTED The device is write protected\r | |
283 | @retval EFI_ACCESS_DENIED The file was open for read only\r | |
284 | \r | |
285 | **/\r | |
286 | typedef\r | |
287 | EFI_STATUS\r | |
8b13229b | 288 | (EFIAPI *EFI_FILE_SET_INFO)(\r |
a6508c05 | 289 | IN EFI_FILE_PROTOCOL *This,\r |
d1f95000 | 290 | IN EFI_GUID *InformationType,\r |
291 | IN UINTN BufferSize,\r | |
292 | IN VOID *Buffer\r | |
ed66e1bc | 293 | );\r |
d1f95000 | 294 | \r |
295 | /**\r | |
296 | Flush data back for the file handle\r | |
297 | \r | |
298 | @param This Protocol instance pointer.\r | |
299 | \r | |
300 | @retval EFI_SUCCESS Data was written.\r | |
301 | @retval EFI_UNSUPPORT Writes to Open directory are not supported\r | |
302 | @retval EFI_NO_MEDIA The device has no media\r | |
303 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
304 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
305 | @retval EFI_WRITE_PROTECTED The device is write protected\r | |
306 | @retval EFI_ACCESS_DENIED The file was open for read only\r | |
307 | @retval EFI_VOLUME_FULL The volume is full\r | |
308 | \r | |
309 | **/\r | |
310 | typedef\r | |
311 | EFI_STATUS\r | |
8b13229b | 312 | (EFIAPI *EFI_FILE_FLUSH)(\r |
d1f95000 | 313 | IN EFI_FILE *This\r |
ed66e1bc | 314 | );\r |
d1f95000 | 315 | \r |
a6508c05 | 316 | #define EFI_FILE_PROTOCOL_REVISION 0x00010000\r |
317 | //\r | |
318 | // Revision defined in EFI1.1.\r | |
319 | // \r | |
320 | #define EFI_FILE_REVISION EFI_FILE_PROTOCOL_REVISION\r | |
d1f95000 | 321 | \r |
44717a39 | 322 | ///\r |
323 | /// The EFI_FILE_PROTOCOL provides file IO access to supported file systems.\r | |
324 | /// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, \r | |
325 | /// and is also a reference to a location in the directory tree of the file system \r | |
326 | /// in which the file resides. With any given file handle, other files may be opened \r | |
327 | /// relative to this file's location, yielding new file handles.\r | |
328 | ///\r | |
a6508c05 | 329 | struct _EFI_FILE_PROTOCOL {\r |
1f08a159 | 330 | ///\r |
331 | /// The version of the EFI_FILE_PROTOCOL interface. The version specified \r | |
332 | /// by this specification is 0x00010000. Future versions are required \r | |
333 | /// to be backward compatible to version 1.0.\r | |
334 | ///\r | |
d1f95000 | 335 | UINT64 Revision;\r |
336 | EFI_FILE_OPEN Open;\r | |
337 | EFI_FILE_CLOSE Close;\r | |
338 | EFI_FILE_DELETE Delete;\r | |
339 | EFI_FILE_READ Read;\r | |
340 | EFI_FILE_WRITE Write;\r | |
341 | EFI_FILE_GET_POSITION GetPosition;\r | |
342 | EFI_FILE_SET_POSITION SetPosition;\r | |
343 | EFI_FILE_GET_INFO GetInfo;\r | |
344 | EFI_FILE_SET_INFO SetInfo;\r | |
345 | EFI_FILE_FLUSH Flush;\r | |
346 | };\r | |
347 | \r | |
348 | \r | |
349 | extern EFI_GUID gEfiSimpleFileSystemProtocolGuid;\r | |
350 | \r | |
351 | #endif\r |