]>
Commit | Line | Data |
---|---|---|
99c9b949 PA |
1 | /** @file\r |
2 | UDF/ECMA-167 file system driver.\r | |
3 | \r | |
4 | Copyright (C) 2014-2017 Paulo Alcantara <pcacjr@zytor.com>\r | |
5 | \r | |
6 | This program and the accompanying materials are licensed and made available\r | |
7 | under the terms and conditions of the BSD License which accompanies this\r | |
8 | distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r | |
12 | WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _UDF_H_\r | |
16 | #define _UDF_H_\r | |
17 | \r | |
18 | #include <Uefi.h>\r | |
19 | #include <Base.h>\r | |
20 | \r | |
21 | #include <Protocol/BlockIo.h>\r | |
22 | #include <Protocol/ComponentName.h>\r | |
23 | #include <Protocol/DevicePath.h>\r | |
24 | #include <Protocol/DriverBinding.h>\r | |
25 | #include <Protocol/DiskIo.h>\r | |
26 | #include <Protocol/SimpleFileSystem.h>\r | |
27 | \r | |
28 | #include <Guid/FileInfo.h>\r | |
29 | #include <Guid/FileSystemInfo.h>\r | |
30 | #include <Guid/FileSystemVolumeLabelInfo.h>\r | |
31 | \r | |
32 | #include <Library/DebugLib.h>\r | |
33 | #include <Library/UefiDriverEntryPoint.h>\r | |
34 | #include <Library/BaseLib.h>\r | |
35 | #include <Library/UefiLib.h>\r | |
36 | #include <Library/BaseMemoryLib.h>\r | |
37 | #include <Library/MemoryAllocationLib.h>\r | |
38 | #include <Library/UefiBootServicesTableLib.h>\r | |
39 | #include <Library/DevicePathLib.h>\r | |
40 | \r | |
41 | #include <IndustryStandard/ElTorito.h>\r | |
42 | #include <IndustryStandard/Udf.h>\r | |
43 | \r | |
44 | //\r | |
45 | // C5BD4D42-1A76-4996-8956-73CDA326CD0A\r | |
46 | //\r | |
47 | #define EFI_UDF_DEVICE_PATH_GUID \\r | |
48 | { 0xC5BD4D42, 0x1A76, 0x4996, \\r | |
49 | { 0x89, 0x56, 0x73, 0xCD, 0xA3, 0x26, 0xCD, 0x0A } \\r | |
50 | }\r | |
51 | \r | |
52 | #define UDF_DEFAULT_LV_NUM 0\r | |
53 | \r | |
54 | #define IS_PVD(_Pointer) \\r | |
55 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 1))\r | |
56 | #define IS_PD(_Pointer) \\r | |
57 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 5))\r | |
58 | #define IS_LVD(_Pointer) \\r | |
59 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 6))\r | |
60 | #define IS_TD(_Pointer) \\r | |
61 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 8))\r | |
62 | #define IS_FSD(_Pointer) \\r | |
63 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 256))\r | |
64 | #define IS_FE(_Pointer) \\r | |
65 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 261))\r | |
66 | #define IS_EFE(_Pointer) \\r | |
67 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 266))\r | |
68 | #define IS_FID(_Pointer) \\r | |
69 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 257))\r | |
70 | #define IS_AED(_Pointer) \\r | |
71 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 258))\r | |
72 | #define IS_LVID(_Pointer) \\r | |
73 | ((BOOLEAN)(_GET_TAG_ID (_Pointer) == 9))\r | |
74 | \r | |
75 | #define _GET_FILETYPE(_Pointer) \\r | |
76 | (IS_FE (_Pointer) ? \\r | |
77 | (((UDF_FILE_ENTRY *)(_Pointer))->IcbTag.FileType) \\r | |
78 | : \\r | |
79 | (((UDF_EXTENDED_FILE_ENTRY *)(_Pointer))->IcbTag.FileType))\r | |
80 | \r | |
81 | #define IS_FE_DIRECTORY(_Pointer) \\r | |
82 | ((BOOLEAN)(_GET_FILETYPE (_Pointer) == 4))\r | |
83 | #define IS_FE_STANDARD_FILE(_Pointer) \\r | |
84 | ((BOOLEAN)(_GET_FILETYPE (_Pointer) == 5))\r | |
85 | #define IS_FE_SYMLINK(_Pointer) \\r | |
86 | ((BOOLEAN)(_GET_FILETYPE (_Pointer) == 12))\r | |
87 | \r | |
88 | #define HIDDEN_FILE (1 << 0)\r | |
89 | #define DIRECTORY_FILE (1 << 1)\r | |
90 | #define DELETED_FILE (1 << 2)\r | |
91 | #define PARENT_FILE (1 << 3)\r | |
92 | \r | |
93 | #define _GET_FILE_CHARS(_Pointer) \\r | |
94 | (((UDF_FILE_IDENTIFIER_DESCRIPTOR *)(_Pointer))->FileCharacteristics)\r | |
95 | \r | |
96 | #define IS_FID_HIDDEN_FILE(_Pointer) \\r | |
97 | ((BOOLEAN)(_GET_FILE_CHARS (_Pointer) & HIDDEN_FILE))\r | |
98 | #define IS_FID_DIRECTORY_FILE(_Pointer) \\r | |
99 | ((BOOLEAN)(_GET_FILE_CHARS (_Pointer) & DIRECTORY_FILE))\r | |
100 | #define IS_FID_DELETED_FILE(_Pointer) \\r | |
101 | ((BOOLEAN)(_GET_FILE_CHARS (_Pointer) & DELETED_FILE))\r | |
102 | #define IS_FID_PARENT_FILE(_Pointer) \\r | |
103 | ((BOOLEAN)(_GET_FILE_CHARS (_Pointer) & PARENT_FILE))\r | |
104 | #define IS_FID_NORMAL_FILE(_Pointer) \\r | |
105 | ((BOOLEAN)(!IS_FID_DIRECTORY_FILE (_Pointer) && \\r | |
106 | !IS_FID_PARENT_FILE (_Pointer)))\r | |
107 | \r | |
108 | typedef enum {\r | |
109 | SHORT_ADS_SEQUENCE,\r | |
110 | LONG_ADS_SEQUENCE,\r | |
111 | EXTENDED_ADS_SEQUENCE,\r | |
112 | INLINE_DATA\r | |
113 | } UDF_FE_RECORDING_FLAGS;\r | |
114 | \r | |
115 | #define GET_FE_RECORDING_FLAGS(_Fe) \\r | |
116 | ((UDF_FE_RECORDING_FLAGS)((UDF_ICB_TAG *)( \\r | |
117 | (UINT8 *)(_Fe) + \\r | |
118 | sizeof (UDF_DESCRIPTOR_TAG)))->Flags & 0x07)\r | |
119 | \r | |
120 | typedef enum {\r | |
121 | EXTENT_RECORDED_AND_ALLOCATED,\r | |
122 | EXTENT_NOT_RECORDED_BUT_ALLOCATED,\r | |
123 | EXTENT_NOT_RECORDED_NOT_ALLOCATED,\r | |
124 | EXTENT_IS_NEXT_EXTENT,\r | |
125 | } UDF_EXTENT_FLAGS;\r | |
126 | \r | |
127 | #define AD_LENGTH(_RecFlags) \\r | |
128 | ((_RecFlags) == SHORT_ADS_SEQUENCE ? \\r | |
129 | ((UINT64)(sizeof (UDF_SHORT_ALLOCATION_DESCRIPTOR))) : \\r | |
130 | ((UINT64)(sizeof (UDF_LONG_ALLOCATION_DESCRIPTOR))))\r | |
131 | \r | |
132 | #define GET_EXTENT_FLAGS(_RecFlags, _Ad) \\r | |
133 | ((_RecFlags) == SHORT_ADS_SEQUENCE ? \\r | |
134 | ((UDF_EXTENT_FLAGS)((((UDF_SHORT_ALLOCATION_DESCRIPTOR *)(_Ad))->ExtentLength >> \\r | |
135 | 30) & 0x3)) : \\r | |
136 | ((UDF_EXTENT_FLAGS)((((UDF_LONG_ALLOCATION_DESCRIPTOR *)(_Ad))->ExtentLength >> \\r | |
137 | 30) & 0x3)))\r | |
138 | \r | |
139 | #define GET_EXTENT_LENGTH(_RecFlags, _Ad) \\r | |
140 | ((_RecFlags) == SHORT_ADS_SEQUENCE ? \\r | |
141 | ((UINT32)((((UDF_SHORT_ALLOCATION_DESCRIPTOR *)(_Ad))->ExtentLength & \\r | |
142 | ~0xC0000000UL))) : \\r | |
143 | ((UINT32)((((UDF_LONG_ALLOCATION_DESCRIPTOR *)(_Ad))->ExtentLength & \\r | |
144 | ~0xC0000000UL))))\r | |
145 | \r | |
146 | #define UDF_FILENAME_LENGTH 128\r | |
147 | #define UDF_PATH_LENGTH 512\r | |
148 | \r | |
149 | #define GET_FID_FROM_ADS(_Data, _Offs) \\r | |
150 | ((UDF_FILE_IDENTIFIER_DESCRIPTOR *)((UINT8 *)(_Data) + (_Offs)))\r | |
151 | \r | |
152 | #define IS_VALID_COMPRESSION_ID(_CompId) \\r | |
153 | ((BOOLEAN)((_CompId) == 8 || (_CompId) == 16))\r | |
154 | \r | |
155 | #define LV_BLOCK_SIZE(_Vol, _LvNum) \\r | |
156 | (_Vol)->LogicalVolDescs[(_LvNum)]->LogicalBlockSize\r | |
157 | \r | |
158 | #define UDF_STANDARD_IDENTIFIER_LENGTH 5\r | |
159 | \r | |
160 | #define LV_UDF_REVISION(_Lv) \\r | |
161 | *(UINT16 *)(UINTN)(_Lv)->DomainIdentifier.IdentifierSuffix\r | |
162 | \r | |
163 | #pragma pack(1)\r | |
164 | \r | |
165 | typedef struct {\r | |
166 | UINT8 StandardIdentifier[UDF_STANDARD_IDENTIFIER_LENGTH];\r | |
167 | } UDF_STANDARD_IDENTIFIER;\r | |
168 | \r | |
169 | #pragma pack()\r | |
170 | \r | |
171 | typedef enum {\r | |
172 | READ_FILE_GET_FILESIZE,\r | |
173 | READ_FILE_ALLOCATE_AND_READ,\r | |
174 | READ_FILE_SEEK_AND_READ,\r | |
175 | } UDF_READ_FILE_FLAGS;\r | |
176 | \r | |
177 | typedef struct {\r | |
178 | VOID *FileData;\r | |
179 | UDF_READ_FILE_FLAGS Flags;\r | |
180 | UINT64 FileDataSize;\r | |
181 | UINT64 FilePosition;\r | |
182 | UINT64 FileSize;\r | |
183 | UINT64 ReadLength;\r | |
184 | } UDF_READ_FILE_INFO;\r | |
185 | \r | |
186 | #pragma pack(1)\r | |
187 | \r | |
188 | typedef struct {\r | |
189 | UINT8 CharacterSetType;\r | |
190 | UINT8 CharacterSetInfo[63];\r | |
191 | } UDF_CHAR_SPEC;\r | |
192 | \r | |
193 | typedef struct {\r | |
194 | UINT8 Flags;\r | |
195 | UINT8 Identifier[23];\r | |
196 | UINT8 IdentifierSuffix[8];\r | |
197 | } UDF_ENTITY_ID;\r | |
198 | \r | |
199 | typedef struct {\r | |
200 | UINT16 TypeAndTimezone;\r | |
201 | INT16 Year;\r | |
202 | UINT8 Month;\r | |
203 | UINT8 Day;\r | |
204 | UINT8 Hour;\r | |
205 | UINT8 Minute;\r | |
206 | UINT8 Second;\r | |
207 | UINT8 Centiseconds;\r | |
208 | UINT8 HundredsOfMicroseconds;\r | |
209 | UINT8 Microseconds;\r | |
210 | } UDF_TIMESTAMP;\r | |
211 | \r | |
212 | typedef struct {\r | |
213 | UINT32 LogicalBlockNumber;\r | |
214 | UINT16 PartitionReferenceNumber;\r | |
215 | } UDF_LB_ADDR;\r | |
216 | \r | |
217 | typedef struct {\r | |
218 | UINT32 ExtentLength;\r | |
219 | UDF_LB_ADDR ExtentLocation;\r | |
220 | UINT8 ImplementationUse[6];\r | |
221 | } UDF_LONG_ALLOCATION_DESCRIPTOR;\r | |
222 | \r | |
223 | typedef struct {\r | |
224 | UDF_DESCRIPTOR_TAG DescriptorTag;\r | |
225 | UINT32 PrevAllocationExtentDescriptor;\r | |
226 | UINT32 LengthOfAllocationDescriptors;\r | |
227 | } UDF_ALLOCATION_EXTENT_DESCRIPTOR;\r | |
228 | \r | |
229 | typedef struct {\r | |
230 | UINT8 StructureType;\r | |
231 | UINT8 StandardIdentifier[UDF_STANDARD_IDENTIFIER_LENGTH];\r | |
232 | UINT8 StructureVersion;\r | |
233 | UINT8 Reserved;\r | |
234 | UINT8 StructureData[2040];\r | |
235 | } UDF_VOLUME_DESCRIPTOR;\r | |
236 | \r | |
237 | typedef struct {\r | |
238 | UDF_DESCRIPTOR_TAG DescriptorTag;\r | |
239 | UINT32 VolumeDescriptorSequenceNumber;\r | |
240 | UINT16 PartitionFlags;\r | |
241 | UINT16 PartitionNumber;\r | |
242 | UDF_ENTITY_ID PartitionContents;\r | |
243 | UINT8 PartitionContentsUse[128];\r | |
244 | UINT32 AccessType;\r | |
245 | UINT32 PartitionStartingLocation;\r | |
246 | UINT32 PartitionLength;\r | |
247 | UDF_ENTITY_ID ImplementationIdentifier;\r | |
248 | UINT8 ImplementationUse[128];\r | |
249 | UINT8 Reserved[156];\r | |
250 | } UDF_PARTITION_DESCRIPTOR;\r | |
251 | \r | |
252 | typedef struct {\r | |
253 | UDF_DESCRIPTOR_TAG DescriptorTag;\r | |
254 | UINT32 VolumeDescriptorSequenceNumber;\r | |
255 | UDF_CHAR_SPEC DescriptorCharacterSet;\r | |
256 | UINT8 LogicalVolumeIdentifier[128];\r | |
257 | UINT32 LogicalBlockSize;\r | |
258 | UDF_ENTITY_ID DomainIdentifier;\r | |
259 | UDF_LONG_ALLOCATION_DESCRIPTOR LogicalVolumeContentsUse;\r | |
260 | UINT32 MapTableLength;\r | |
261 | UINT32 NumberOfPartitionMaps;\r | |
262 | UDF_ENTITY_ID ImplementationIdentifier;\r | |
263 | UINT8 ImplementationUse[128];\r | |
264 | UDF_EXTENT_AD IntegritySequenceExtent;\r | |
265 | UINT8 PartitionMaps[6];\r | |
266 | } UDF_LOGICAL_VOLUME_DESCRIPTOR;\r | |
267 | \r | |
268 | typedef struct {\r | |
269 | UDF_DESCRIPTOR_TAG DescriptorTag;\r | |
270 | UDF_TIMESTAMP RecordingDateTime;\r | |
271 | UINT32 IntegrityType;\r | |
272 | UDF_EXTENT_AD NextIntegrityExtent;\r | |
273 | UINT8 LogicalVolumeContentsUse[32];\r | |
274 | UINT32 NumberOfPartitions;\r | |
275 | UINT32 LengthOfImplementationUse;\r | |
276 | UINT8 Data[0];\r | |
277 | } UDF_LOGICAL_VOLUME_INTEGRITY;\r | |
278 | \r | |
279 | typedef struct {\r | |
280 | UDF_DESCRIPTOR_TAG DescriptorTag;\r | |
281 | UDF_TIMESTAMP RecordingDateAndTime;\r | |
282 | UINT16 InterchangeLevel;\r | |
283 | UINT16 MaximumInterchangeLevel;\r | |
284 | UINT32 CharacterSetList;\r | |
285 | UINT32 MaximumCharacterSetList;\r | |
286 | UINT32 FileSetNumber;\r | |
287 | UINT32 FileSetDescriptorNumber;\r | |
288 | UDF_CHAR_SPEC LogicalVolumeIdentifierCharacterSet;\r | |
289 | UINT8 LogicalVolumeIdentifier[128];\r | |
290 | UDF_CHAR_SPEC FileSetCharacterSet;\r | |
291 | UINT8 FileSetIdentifier[32];\r | |
292 | UINT8 CopyrightFileIdentifier[32];\r | |
293 | UINT8 AbstractFileIdentifier[32];\r | |
294 | UDF_LONG_ALLOCATION_DESCRIPTOR RootDirectoryIcb;\r | |
295 | UDF_ENTITY_ID DomainIdentifier;\r | |
296 | UDF_LONG_ALLOCATION_DESCRIPTOR NextExtent;\r | |
297 | UDF_LONG_ALLOCATION_DESCRIPTOR SystemStreamDirectoryIcb;\r | |
298 | UINT8 Reserved[32];\r | |
299 | } UDF_FILE_SET_DESCRIPTOR;\r | |
300 | \r | |
301 | typedef struct {\r | |
302 | UINT32 ExtentLength;\r | |
303 | UINT32 ExtentPosition;\r | |
304 | } UDF_SHORT_ALLOCATION_DESCRIPTOR;\r | |
305 | \r | |
306 | typedef struct {\r | |
307 | UDF_DESCRIPTOR_TAG DescriptorTag;\r | |
308 | UINT16 FileVersionNumber;\r | |
309 | UINT8 FileCharacteristics;\r | |
310 | UINT8 LengthOfFileIdentifier;\r | |
311 | UDF_LONG_ALLOCATION_DESCRIPTOR Icb;\r | |
312 | UINT16 LengthOfImplementationUse;\r | |
313 | UINT8 Data[0];\r | |
314 | } UDF_FILE_IDENTIFIER_DESCRIPTOR;\r | |
315 | \r | |
316 | typedef struct {\r | |
317 | UINT32 PriorRecordNumberOfDirectEntries;\r | |
318 | UINT16 StrategyType;\r | |
319 | UINT16 StrategyParameter;\r | |
320 | UINT16 MaximumNumberOfEntries;\r | |
321 | UINT8 Reserved;\r | |
322 | UINT8 FileType;\r | |
323 | UDF_LB_ADDR ParentIcbLocation;\r | |
324 | UINT16 Flags;\r | |
325 | } UDF_ICB_TAG;\r | |
326 | \r | |
327 | typedef struct {\r | |
328 | UDF_DESCRIPTOR_TAG DescriptorTag;\r | |
329 | UDF_ICB_TAG IcbTag;\r | |
330 | UINT32 Uid;\r | |
331 | UINT32 Gid;\r | |
332 | UINT32 Permissions;\r | |
333 | UINT16 FileLinkCount;\r | |
334 | UINT8 RecordFormat;\r | |
335 | UINT8 RecordDisplayAttributes;\r | |
336 | UINT32 RecordLength;\r | |
337 | UINT64 InformationLength;\r | |
338 | UINT64 LogicalBlocksRecorded;\r | |
339 | UDF_TIMESTAMP AccessTime;\r | |
340 | UDF_TIMESTAMP ModificationTime;\r | |
341 | UDF_TIMESTAMP AttributeTime;\r | |
342 | UINT32 CheckPoint;\r | |
343 | UDF_LONG_ALLOCATION_DESCRIPTOR ExtendedAttributeIcb;\r | |
344 | UDF_ENTITY_ID ImplementationIdentifier;\r | |
345 | UINT64 UniqueId;\r | |
346 | UINT32 LengthOfExtendedAttributes;\r | |
347 | UINT32 LengthOfAllocationDescriptors;\r | |
348 | UINT8 Data[0]; // L_EA + L_AD\r | |
349 | } UDF_FILE_ENTRY;\r | |
350 | \r | |
351 | typedef struct {\r | |
352 | UDF_DESCRIPTOR_TAG DescriptorTag;\r | |
353 | UDF_ICB_TAG IcbTag;\r | |
354 | UINT32 Uid;\r | |
355 | UINT32 Gid;\r | |
356 | UINT32 Permissions;\r | |
357 | UINT16 FileLinkCount;\r | |
358 | UINT8 RecordFormat;\r | |
359 | UINT8 RecordDisplayAttributes;\r | |
360 | UINT32 RecordLength;\r | |
361 | UINT64 InformationLength;\r | |
362 | UINT64 ObjectSize;\r | |
363 | UINT64 LogicalBlocksRecorded;\r | |
364 | UDF_TIMESTAMP AccessTime;\r | |
365 | UDF_TIMESTAMP ModificationTime;\r | |
366 | UDF_TIMESTAMP CreationTime;\r | |
367 | UDF_TIMESTAMP AttributeTime;\r | |
368 | UINT32 CheckPoint;\r | |
369 | UINT32 Reserved;\r | |
370 | UDF_LONG_ALLOCATION_DESCRIPTOR ExtendedAttributeIcb;\r | |
371 | UDF_LONG_ALLOCATION_DESCRIPTOR StreamDirectoryIcb;\r | |
372 | UDF_ENTITY_ID ImplementationIdentifier;\r | |
373 | UINT64 UniqueId;\r | |
374 | UINT32 LengthOfExtendedAttributes;\r | |
375 | UINT32 LengthOfAllocationDescriptors;\r | |
376 | UINT8 Data[0]; // L_EA + L_AD\r | |
377 | } UDF_EXTENDED_FILE_ENTRY;\r | |
378 | \r | |
379 | typedef struct {\r | |
380 | UINT8 ComponentType;\r | |
381 | UINT8 LengthOfComponentIdentifier;\r | |
382 | UINT16 ComponentFileVersionNumber;\r | |
383 | UINT8 ComponentIdentifier[0];\r | |
384 | } UDF_PATH_COMPONENT;\r | |
385 | \r | |
386 | #pragma pack()\r | |
387 | \r | |
388 | //\r | |
389 | // UDF filesystem driver's private data\r | |
390 | //\r | |
391 | typedef struct {\r | |
392 | UDF_LOGICAL_VOLUME_DESCRIPTOR **LogicalVolDescs;\r | |
393 | UINTN LogicalVolDescsNo;\r | |
394 | UDF_PARTITION_DESCRIPTOR **PartitionDescs;\r | |
395 | UINTN PartitionDescsNo;\r | |
396 | UDF_FILE_SET_DESCRIPTOR **FileSetDescs;\r | |
397 | UINTN FileSetDescsNo;\r | |
398 | UINTN FileEntrySize;\r | |
399 | } UDF_VOLUME_INFO;\r | |
400 | \r | |
401 | typedef struct {\r | |
402 | VOID *FileEntry;\r | |
403 | UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc;\r | |
404 | } UDF_FILE_INFO;\r | |
405 | \r | |
406 | typedef struct {\r | |
407 | VOID *DirectoryData;\r | |
408 | UINT64 DirectoryLength;\r | |
409 | UINT64 FidOffset;\r | |
410 | } UDF_READ_DIRECTORY_INFO;\r | |
411 | \r | |
412 | #define PRIVATE_UDF_FILE_DATA_SIGNATURE SIGNATURE_32 ('U', 'd', 'f', 'f')\r | |
413 | \r | |
414 | #define PRIVATE_UDF_FILE_DATA_FROM_THIS(a) \\r | |
415 | CR ( \\r | |
416 | a, \\r | |
417 | PRIVATE_UDF_FILE_DATA, \\r | |
418 | FileIo, \\r | |
419 | PRIVATE_UDF_FILE_DATA_SIGNATURE \\r | |
420 | )\r | |
421 | \r | |
422 | typedef struct {\r | |
423 | UINTN Signature;\r | |
424 | BOOLEAN IsRootDirectory;\r | |
425 | UDF_FILE_INFO *Root;\r | |
426 | UDF_FILE_INFO File;\r | |
427 | UDF_READ_DIRECTORY_INFO ReadDirInfo;\r | |
428 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *SimpleFs;\r | |
429 | EFI_FILE_PROTOCOL FileIo;\r | |
430 | CHAR16 AbsoluteFileName[UDF_PATH_LENGTH];\r | |
431 | CHAR16 FileName[UDF_FILENAME_LENGTH];\r | |
432 | UINT64 FileSize;\r | |
433 | UINT64 FilePosition;\r | |
434 | } PRIVATE_UDF_FILE_DATA;\r | |
435 | \r | |
436 | #define PRIVATE_UDF_SIMPLE_FS_DATA_SIGNATURE SIGNATURE_32 ('U', 'd', 'f', 's')\r | |
437 | \r | |
438 | #define PRIVATE_UDF_SIMPLE_FS_DATA_FROM_THIS(a) \\r | |
439 | CR ( \\r | |
440 | a, \\r | |
441 | PRIVATE_UDF_SIMPLE_FS_DATA, \\r | |
442 | SimpleFs, \\r | |
443 | PRIVATE_UDF_SIMPLE_FS_DATA_SIGNATURE \\r | |
444 | )\r | |
445 | \r | |
446 | typedef struct {\r | |
447 | UINTN Signature;\r | |
448 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
449 | EFI_DISK_IO_PROTOCOL *DiskIo;\r | |
450 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL SimpleFs;\r | |
451 | UDF_VOLUME_INFO Volume;\r | |
452 | UDF_FILE_INFO Root;\r | |
453 | UINTN OpenFiles;\r | |
454 | EFI_HANDLE Handle;\r | |
455 | } PRIVATE_UDF_SIMPLE_FS_DATA;\r | |
456 | \r | |
457 | //\r | |
458 | // Global Variables\r | |
459 | //\r | |
460 | extern EFI_DRIVER_BINDING_PROTOCOL gUdfDriverBinding;\r | |
461 | extern EFI_COMPONENT_NAME_PROTOCOL gUdfComponentName;\r | |
462 | extern EFI_COMPONENT_NAME2_PROTOCOL gUdfComponentName2;\r | |
463 | \r | |
464 | //\r | |
465 | // Function Prototypes\r | |
466 | //\r | |
467 | \r | |
468 | /**\r | |
469 | Open the root directory on a volume.\r | |
470 | \r | |
471 | @param This Protocol instance pointer.\r | |
472 | @param Root Returns an Open file handle for the root directory\r | |
473 | \r | |
474 | @retval EFI_SUCCESS The device was opened.\r | |
475 | @retval EFI_UNSUPPORTED This volume does not support the file system.\r | |
476 | @retval EFI_NO_MEDIA The device has no media.\r | |
477 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
478 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
479 | @retval EFI_ACCESS_DENIED The service denied access to the file.\r | |
480 | @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.\r | |
481 | \r | |
482 | **/\r | |
483 | EFI_STATUS\r | |
484 | EFIAPI\r | |
485 | UdfOpenVolume (\r | |
486 | IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r | |
487 | OUT EFI_FILE_PROTOCOL **Root\r | |
488 | );\r | |
489 | \r | |
490 | /**\r | |
491 | Opens a new file relative to the source file's location.\r | |
492 | \r | |
493 | @param This The protocol instance pointer.\r | |
494 | @param NewHandle Returns File Handle for FileName.\r | |
495 | @param FileName Null terminated string. "\", ".", and ".." are supported.\r | |
496 | @param OpenMode Open mode for file.\r | |
497 | @param Attributes Only used for EFI_FILE_MODE_CREATE.\r | |
498 | \r | |
499 | @retval EFI_SUCCESS The device was opened.\r | |
500 | @retval EFI_NOT_FOUND The specified file could not be found on the device.\r | |
501 | @retval EFI_NO_MEDIA The device has no media.\r | |
502 | @retval EFI_MEDIA_CHANGED The media has changed.\r | |
503 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
504 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
505 | @retval EFI_ACCESS_DENIED The service denied access to the file.\r | |
506 | @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.\r | |
507 | @retval EFI_VOLUME_FULL The volume is full.\r | |
508 | \r | |
509 | **/\r | |
510 | EFI_STATUS\r | |
511 | EFIAPI\r | |
512 | UdfOpen (\r | |
513 | IN EFI_FILE_PROTOCOL *This,\r | |
514 | OUT EFI_FILE_PROTOCOL **NewHandle,\r | |
515 | IN CHAR16 *FileName,\r | |
516 | IN UINT64 OpenMode,\r | |
517 | IN UINT64 Attributes\r | |
518 | );\r | |
519 | \r | |
520 | /**\r | |
521 | Read data from the file.\r | |
522 | \r | |
523 | @param This Protocol instance pointer.\r | |
524 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
525 | @param Buffer The buffer in which data is read.\r | |
526 | \r | |
527 | @retval EFI_SUCCESS Data was read.\r | |
528 | @retval EFI_NO_MEDIA The device has no media.\r | |
529 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
530 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
531 | @retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size.\r | |
532 | \r | |
533 | **/\r | |
534 | EFI_STATUS\r | |
535 | EFIAPI\r | |
536 | UdfRead (\r | |
537 | IN EFI_FILE_PROTOCOL *This,\r | |
538 | IN OUT UINTN *BufferSize,\r | |
539 | OUT VOID *Buffer\r | |
540 | );\r | |
541 | \r | |
542 | /**\r | |
543 | Close the file handle.\r | |
544 | \r | |
545 | @param This Protocol instance pointer.\r | |
546 | \r | |
547 | @retval EFI_SUCCESS The file was closed.\r | |
548 | \r | |
549 | **/\r | |
550 | EFI_STATUS\r | |
551 | EFIAPI\r | |
552 | UdfClose (\r | |
553 | IN EFI_FILE_PROTOCOL *This\r | |
554 | );\r | |
555 | \r | |
556 | /**\r | |
557 | Close and delete the file handle.\r | |
558 | \r | |
559 | @param This Protocol instance pointer.\r | |
560 | \r | |
561 | @retval EFI_SUCCESS The file was closed and deleted.\r | |
562 | @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not\r | |
563 | deleted.\r | |
564 | \r | |
565 | **/\r | |
566 | EFI_STATUS\r | |
567 | EFIAPI\r | |
568 | UdfDelete (\r | |
569 | IN EFI_FILE_PROTOCOL *This\r | |
570 | );\r | |
571 | \r | |
572 | /**\r | |
573 | Write data to a file.\r | |
574 | \r | |
575 | @param This Protocol instance pointer.\r | |
576 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
577 | @param Buffer The buffer in which data to write.\r | |
578 | \r | |
579 | @retval EFI_SUCCESS Data was written.\r | |
580 | @retval EFI_UNSUPPORTED Writes to Open directory are not supported.\r | |
581 | @retval EFI_NO_MEDIA The device has no media.\r | |
582 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
583 | @retval EFI_DEVICE_ERROR An attempt was made to write to a deleted file.\r | |
584 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
585 | @retval EFI_WRITE_PROTECTED The device is write protected.\r | |
586 | @retval EFI_ACCESS_DENIED The file was open for read only.\r | |
587 | @retval EFI_VOLUME_FULL The volume is full.\r | |
588 | \r | |
589 | **/\r | |
590 | EFI_STATUS\r | |
591 | EFIAPI\r | |
592 | UdfWrite (\r | |
593 | IN EFI_FILE_PROTOCOL *This,\r | |
594 | IN OUT UINTN *BufferSize,\r | |
595 | IN VOID *Buffer\r | |
596 | );\r | |
597 | \r | |
598 | /**\r | |
599 | Get file's current position.\r | |
600 | \r | |
601 | @param This Protocol instance pointer.\r | |
602 | @param Position Byte position from the start of the file.\r | |
603 | \r | |
604 | @retval EFI_SUCCESS Position was updated.\r | |
605 | @retval EFI_UNSUPPORTED Seek request for directories is not valid.\r | |
606 | \r | |
607 | **/\r | |
608 | EFI_STATUS\r | |
609 | EFIAPI\r | |
610 | UdfGetPosition (\r | |
611 | IN EFI_FILE_PROTOCOL *This,\r | |
612 | OUT UINT64 *Position\r | |
613 | );\r | |
614 | \r | |
615 | /**\r | |
616 | Set file's current position.\r | |
617 | \r | |
618 | @param This Protocol instance pointer.\r | |
619 | @param Position Byte position from the start of the file.\r | |
620 | \r | |
621 | @retval EFI_SUCCESS Position was updated.\r | |
622 | @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r | |
623 | \r | |
624 | **/\r | |
625 | EFI_STATUS\r | |
626 | EFIAPI\r | |
627 | UdfSetPosition (\r | |
628 | IN EFI_FILE_PROTOCOL *This,\r | |
629 | IN UINT64 Position\r | |
630 | );\r | |
631 | \r | |
632 | /**\r | |
633 | Get information about a file.\r | |
634 | \r | |
635 | @param This Protocol instance pointer.\r | |
636 | @param InformationType Type of information to return in Buffer.\r | |
637 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
638 | @param Buffer The buffer to return data.\r | |
639 | \r | |
640 | @retval EFI_SUCCESS Data was returned.\r | |
641 | @retval EFI_UNSUPPORTED InformationType is not supported.\r | |
642 | @retval EFI_NO_MEDIA The device has no media.\r | |
643 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
644 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
645 | @retval EFI_WRITE_PROTECTED The device is write protected.\r | |
646 | @retval EFI_ACCESS_DENIED The file was open for read only.\r | |
647 | @retval EFI_BUFFER_TOO_SMALL Buffer was too small; required size returned in BufferSize.\r | |
648 | \r | |
649 | **/\r | |
650 | EFI_STATUS\r | |
651 | EFIAPI\r | |
652 | UdfGetInfo (\r | |
653 | IN EFI_FILE_PROTOCOL *This,\r | |
654 | IN EFI_GUID *InformationType,\r | |
655 | IN OUT UINTN *BufferSize,\r | |
656 | OUT VOID *Buffer\r | |
657 | );\r | |
658 | \r | |
659 | /**\r | |
660 | Set information about a file.\r | |
661 | \r | |
662 | @param File Protocol instance pointer.\r | |
663 | @param InformationType Type of information in Buffer.\r | |
664 | @param BufferSize Size of buffer.\r | |
665 | @param Buffer The data to write.\r | |
666 | \r | |
667 | @retval EFI_SUCCESS Data was set.\r | |
668 | @retval EFI_UNSUPPORTED InformationType is not supported.\r | |
669 | @retval EFI_NO_MEDIA The device has no media.\r | |
670 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
671 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
672 | @retval EFI_WRITE_PROTECTED The device is write protected.\r | |
673 | @retval EFI_ACCESS_DENIED The file was open for read only.\r | |
674 | \r | |
675 | **/\r | |
676 | EFI_STATUS\r | |
677 | EFIAPI\r | |
678 | UdfSetInfo (\r | |
679 | IN EFI_FILE_PROTOCOL *This,\r | |
680 | IN EFI_GUID *InformationType,\r | |
681 | IN UINTN BufferSize,\r | |
682 | IN VOID *Buffer\r | |
683 | );\r | |
684 | \r | |
685 | /**\r | |
686 | Flush data back for the file handle.\r | |
687 | \r | |
688 | @param This Protocol instance pointer.\r | |
689 | \r | |
690 | @retval EFI_SUCCESS Data was flushed.\r | |
691 | @retval EFI_UNSUPPORTED Writes to Open directory are not supported.\r | |
692 | @retval EFI_NO_MEDIA The device has no media.\r | |
693 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
694 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
695 | @retval EFI_WRITE_PROTECTED The device is write protected.\r | |
696 | @retval EFI_ACCESS_DENIED The file was open for read only.\r | |
697 | @retval EFI_VOLUME_FULL The volume is full.\r | |
698 | \r | |
699 | **/\r | |
700 | EFI_STATUS\r | |
701 | EFIAPI\r | |
702 | UdfFlush (\r | |
703 | IN EFI_FILE_PROTOCOL *This\r | |
704 | );\r | |
705 | \r | |
706 | /**\r | |
707 | Read volume information on a medium which contains a valid UDF file system.\r | |
708 | \r | |
709 | @param[in] BlockIo BlockIo interface.\r | |
710 | @param[in] DiskIo DiskIo interface.\r | |
711 | @param[out] Volume UDF volume information structure.\r | |
712 | \r | |
713 | @retval EFI_SUCCESS Volume information read.\r | |
714 | @retval EFI_NO_MEDIA The device has no media.\r | |
715 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
716 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
717 | @retval EFI_OUT_OF_RESOURCES The volume was not read due to lack of resources.\r | |
718 | \r | |
719 | **/\r | |
720 | EFI_STATUS\r | |
721 | ReadUdfVolumeInformation (\r | |
722 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
723 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
724 | OUT UDF_VOLUME_INFO *Volume\r | |
725 | );\r | |
726 | \r | |
727 | /**\r | |
728 | Find the root directory on an UDF volume.\r | |
729 | \r | |
730 | @param[in] BlockIo BlockIo interface.\r | |
731 | @param[in] DiskIo DiskIo interface.\r | |
732 | @param[in] Volume UDF volume information structure.\r | |
733 | @param[out] File Root directory file.\r | |
734 | \r | |
735 | @retval EFI_SUCCESS Root directory found.\r | |
736 | @retval EFI_NO_MEDIA The device has no media.\r | |
737 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
738 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
739 | @retval EFI_OUT_OF_RESOURCES The root directory was not found due to lack of\r | |
740 | resources.\r | |
741 | \r | |
742 | **/\r | |
743 | EFI_STATUS\r | |
744 | FindRootDirectory (\r | |
745 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
746 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
747 | IN UDF_VOLUME_INFO *Volume,\r | |
748 | OUT UDF_FILE_INFO *File\r | |
749 | );\r | |
750 | \r | |
751 | /**\r | |
752 | Find either a File Entry or a Extended File Entry from a given ICB.\r | |
753 | \r | |
754 | @param[in] BlockIo BlockIo interface.\r | |
755 | @param[in] DiskIo DiskIo interface.\r | |
756 | @param[in] Volume UDF volume information structure.\r | |
757 | @param[in] Icb ICB of the FID.\r | |
758 | @param[out] FileEntry File Entry or Extended File Entry.\r | |
759 | \r | |
760 | @retval EFI_SUCCESS File Entry or Extended File Entry found.\r | |
761 | @retval EFI_NO_MEDIA The device has no media.\r | |
762 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
763 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
764 | @retval EFI_OUT_OF_RESOURCES The FE/EFE entry was not found due to lack of\r | |
765 | resources.\r | |
766 | \r | |
767 | **/\r | |
768 | EFI_STATUS\r | |
769 | FindFileEntry (\r | |
770 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
771 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
772 | IN UDF_VOLUME_INFO *Volume,\r | |
773 | IN UDF_LONG_ALLOCATION_DESCRIPTOR *Icb,\r | |
774 | OUT VOID **FileEntry\r | |
775 | );\r | |
776 | \r | |
777 | /**\r | |
778 | Find a file given its absolute path on an UDF volume.\r | |
779 | \r | |
780 | @param[in] BlockIo BlockIo interface.\r | |
781 | @param[in] DiskIo DiskIo interface.\r | |
782 | @param[in] Volume UDF volume information structure.\r | |
783 | @param[in] FilePath File's absolute path.\r | |
784 | @param[in] Root Root directory file.\r | |
785 | @param[in] Parent Parent directory file.\r | |
786 | @param[out] File Found file.\r | |
787 | \r | |
788 | @retval EFI_SUCCESS @p FilePath was found.\r | |
789 | @retval EFI_NO_MEDIA The device has no media.\r | |
790 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
791 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
792 | @retval EFI_OUT_OF_RESOURCES The @p FilePath file was not found due to lack of\r | |
793 | resources.\r | |
794 | \r | |
795 | **/\r | |
796 | EFI_STATUS\r | |
797 | FindFile (\r | |
798 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
799 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
800 | IN UDF_VOLUME_INFO *Volume,\r | |
801 | IN CHAR16 *FilePath,\r | |
802 | IN UDF_FILE_INFO *Root,\r | |
803 | IN UDF_FILE_INFO *Parent,\r | |
804 | IN UDF_LONG_ALLOCATION_DESCRIPTOR *Icb,\r | |
805 | OUT UDF_FILE_INFO *File\r | |
806 | );\r | |
807 | \r | |
808 | /**\r | |
809 | Read a directory entry at a time on an UDF volume.\r | |
810 | \r | |
811 | @param[in] BlockIo BlockIo interface.\r | |
812 | @param[in] DiskIo DiskIo interface.\r | |
813 | @param[in] Volume UDF volume information structure.\r | |
814 | @param[in] ParentIcb ICB of the parent file.\r | |
815 | @param[in] FileEntryData FE/EFE of the parent file.\r | |
816 | @param[in out] ReadDirInfo Next read directory listing structure\r | |
817 | information.\r | |
818 | @param[out] FoundFid File Identifier Descriptor pointer.\r | |
819 | \r | |
820 | @retval EFI_SUCCESS Directory entry read.\r | |
821 | @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.\r | |
822 | @retval EFI_NO_MEDIA The device has no media.\r | |
823 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
824 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
825 | @retval EFI_OUT_OF_RESOURCES The directory entry was not read due to lack of\r | |
826 | resources.\r | |
827 | \r | |
828 | **/\r | |
829 | EFI_STATUS\r | |
830 | ReadDirectoryEntry (\r | |
831 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
832 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
833 | IN UDF_VOLUME_INFO *Volume,\r | |
834 | IN UDF_LONG_ALLOCATION_DESCRIPTOR *ParentIcb,\r | |
835 | IN VOID *FileEntryData,\r | |
836 | IN OUT UDF_READ_DIRECTORY_INFO *ReadDirInfo,\r | |
837 | OUT UDF_FILE_IDENTIFIER_DESCRIPTOR **FoundFid\r | |
838 | );\r | |
839 | \r | |
840 | /**\r | |
841 | Get a filename (encoded in OSTA-compressed format) from a File Identifier\r | |
842 | Descriptor on an UDF volume.\r | |
843 | \r | |
844 | @param[in] FileIdentifierDesc File Identifier Descriptor pointer.\r | |
845 | @param[out] FileName Decoded filename.\r | |
846 | \r | |
847 | @retval EFI_SUCCESS Filename decoded and read.\r | |
848 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
849 | **/\r | |
850 | EFI_STATUS\r | |
851 | GetFileNameFromFid (\r | |
852 | IN UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc,\r | |
853 | OUT CHAR16 *FileName\r | |
854 | );\r | |
855 | \r | |
856 | /**\r | |
857 | Resolve a symlink file on an UDF volume.\r | |
858 | \r | |
859 | @param[in] BlockIo BlockIo interface.\r | |
860 | @param[in] DiskIo DiskIo interface.\r | |
861 | @param[in] Volume UDF volume information structure.\r | |
862 | @param[in] Parent Parent file.\r | |
863 | @param[in] FileEntryData FE/EFE structure pointer.\r | |
864 | @param[out] File Resolved file.\r | |
865 | \r | |
866 | @retval EFI_SUCCESS Symlink file resolved.\r | |
867 | @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.\r | |
868 | @retval EFI_NO_MEDIA The device has no media.\r | |
869 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
870 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
871 | @retval EFI_OUT_OF_RESOURCES The symlink file was not resolved due to lack of\r | |
872 | resources.\r | |
873 | \r | |
874 | **/\r | |
875 | EFI_STATUS\r | |
876 | ResolveSymlink (\r | |
877 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
878 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
879 | IN UDF_VOLUME_INFO *Volume,\r | |
880 | IN UDF_FILE_INFO *Parent,\r | |
881 | IN VOID *FileEntryData,\r | |
882 | OUT UDF_FILE_INFO *File\r | |
883 | );\r | |
884 | \r | |
885 | /**\r | |
886 | Clean up in-memory UDF volume information.\r | |
887 | \r | |
888 | @param[in] Volume Volume information pointer.\r | |
889 | \r | |
890 | **/\r | |
891 | VOID\r | |
892 | CleanupVolumeInformation (\r | |
893 | IN UDF_VOLUME_INFO *Volume\r | |
894 | );\r | |
895 | \r | |
896 | /**\r | |
897 | Clean up in-memory UDF file information.\r | |
898 | \r | |
899 | @param[in] File File information pointer.\r | |
900 | \r | |
901 | **/\r | |
902 | VOID\r | |
903 | CleanupFileInformation (\r | |
904 | IN UDF_FILE_INFO *File\r | |
905 | );\r | |
906 | \r | |
907 | /**\r | |
908 | Find a file from its absolute path on an UDF volume.\r | |
909 | \r | |
910 | @param[in] BlockIo BlockIo interface.\r | |
911 | @param[in] DiskIo DiskIo interface.\r | |
912 | @param[in] Volume UDF volume information structure.\r | |
913 | @param[in] File File information structure.\r | |
914 | @param[out] Size Size of the file.\r | |
915 | \r | |
916 | @retval EFI_SUCCESS File size calculated and set in @p Size.\r | |
917 | @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.\r | |
918 | @retval EFI_NO_MEDIA The device has no media.\r | |
919 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
920 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
921 | @retval EFI_OUT_OF_RESOURCES The file size was not calculated due to lack of\r | |
922 | resources.\r | |
923 | \r | |
924 | **/\r | |
925 | EFI_STATUS\r | |
926 | GetFileSize (\r | |
927 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
928 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
929 | IN UDF_VOLUME_INFO *Volume,\r | |
930 | IN UDF_FILE_INFO *File,\r | |
931 | OUT UINT64 *Size\r | |
932 | );\r | |
933 | \r | |
934 | /**\r | |
935 | Set information about a file on an UDF volume.\r | |
936 | \r | |
937 | @param[in] File File pointer.\r | |
938 | @param[in] FileSize Size of the file.\r | |
939 | @param[in] FileName Filename of the file.\r | |
940 | @param[in out] BufferSize Size of the returned file infomation.\r | |
941 | @param[out] Buffer Data of the returned file information.\r | |
942 | \r | |
943 | @retval EFI_SUCCESS File information set.\r | |
944 | @retval EFI_NO_MEDIA The device has no media.\r | |
945 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
946 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
947 | @retval EFI_OUT_OF_RESOURCES The file information was not set due to lack of\r | |
948 | resources.\r | |
949 | \r | |
950 | **/\r | |
951 | EFI_STATUS\r | |
952 | SetFileInfo (\r | |
953 | IN UDF_FILE_INFO *File,\r | |
954 | IN UINT64 FileSize,\r | |
955 | IN CHAR16 *FileName,\r | |
956 | IN OUT UINTN *BufferSize,\r | |
957 | OUT VOID *Buffer\r | |
958 | );\r | |
959 | \r | |
960 | /**\r | |
961 | Get volume and free space size information of an UDF volume.\r | |
962 | \r | |
963 | @param[in] BlockIo BlockIo interface.\r | |
964 | @param[in] DiskIo DiskIo interface.\r | |
965 | @param[in] Volume UDF volume information structure.\r | |
966 | @param[out] VolumeSize Volume size.\r | |
967 | @param[out] FreeSpaceSize Free space size.\r | |
968 | \r | |
969 | @retval EFI_SUCCESS Volume and free space size calculated.\r | |
970 | @retval EFI_NO_MEDIA The device has no media.\r | |
971 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
972 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
973 | @retval EFI_OUT_OF_RESOURCES The volume and free space size were not\r | |
974 | calculated due to lack of resources.\r | |
975 | \r | |
976 | **/\r | |
977 | EFI_STATUS\r | |
978 | GetVolumeSize (\r | |
979 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
980 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
981 | IN UDF_VOLUME_INFO *Volume,\r | |
982 | OUT UINT64 *VolumeSize,\r | |
983 | OUT UINT64 *FreeSpaceSize\r | |
984 | );\r | |
985 | \r | |
986 | /**\r | |
987 | Seek a file and read its data into memory on an UDF volume.\r | |
988 | \r | |
989 | @param[in] BlockIo BlockIo interface.\r | |
990 | @param[in] DiskIo DiskIo interface.\r | |
991 | @param[in] Volume UDF volume information structure.\r | |
992 | @param[in] File File information structure.\r | |
993 | @param[in] FileSize Size of the file.\r | |
994 | @param[in out] FilePosition File position.\r | |
995 | @param[in out] Buffer File data.\r | |
996 | @param[in out] BufferSize Read size.\r | |
997 | \r | |
998 | @retval EFI_SUCCESS File seeked and read.\r | |
999 | @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.\r | |
1000 | @retval EFI_NO_MEDIA The device has no media.\r | |
1001 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
1002 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
1003 | @retval EFI_OUT_OF_RESOURCES The file's recorded data was not read due to lack\r | |
1004 | of resources.\r | |
1005 | \r | |
1006 | **/\r | |
1007 | EFI_STATUS\r | |
1008 | ReadFileData (\r | |
1009 | IN EFI_BLOCK_IO_PROTOCOL *BlockIo,\r | |
1010 | IN EFI_DISK_IO_PROTOCOL *DiskIo,\r | |
1011 | IN UDF_VOLUME_INFO *Volume,\r | |
1012 | IN UDF_FILE_INFO *File,\r | |
1013 | IN UINT64 FileSize,\r | |
1014 | IN OUT UINT64 *FilePosition,\r | |
1015 | IN OUT VOID *Buffer,\r | |
1016 | IN OUT UINT64 *BufferSize\r | |
1017 | );\r | |
1018 | \r | |
1019 | /**\r | |
1020 | Check if ControllerHandle supports an UDF file system.\r | |
1021 | \r | |
1022 | @param[in] This Protocol instance pointer.\r | |
1023 | @param[in] ControllerHandle Handle of device to test.\r | |
1024 | \r | |
1025 | @retval EFI_SUCCESS UDF file system found.\r | |
1026 | @retval EFI_UNSUPPORTED UDF file system not found.\r | |
1027 | \r | |
1028 | **/\r | |
1029 | EFI_STATUS\r | |
1030 | SupportUdfFileSystem (\r | |
1031 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1032 | IN EFI_HANDLE ControllerHandle\r | |
1033 | );\r | |
1034 | \r | |
1035 | /**\r | |
1036 | Mangle a filename by cutting off trailing whitespaces, "\\", "." and "..".\r | |
1037 | \r | |
1038 | @param[in] FileName Filename.\r | |
1039 | \r | |
1040 | @retval @p FileName Filename mangled.\r | |
1041 | \r | |
1042 | **/\r | |
1043 | CHAR16 *\r | |
1044 | MangleFileName (\r | |
1045 | IN CHAR16 *FileName\r | |
1046 | );\r | |
1047 | \r | |
1048 | /**\r | |
1049 | Test to see if this driver supports ControllerHandle. Any ControllerHandle\r | |
1050 | than contains a BlockIo and DiskIo protocol can be supported.\r | |
1051 | \r | |
1052 | @param This Protocol instance pointer.\r | |
1053 | @param ControllerHandle Handle of device to test\r | |
1054 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
1055 | device to start.\r | |
1056 | \r | |
1057 | @retval EFI_SUCCESS This driver supports this device\r | |
1058 | @retval EFI_ALREADY_STARTED This driver is already running on this device\r | |
1059 | @retval other This driver does not support this device\r | |
1060 | \r | |
1061 | **/\r | |
1062 | EFI_STATUS\r | |
1063 | EFIAPI\r | |
1064 | UdfDriverBindingSupported (\r | |
1065 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1066 | IN EFI_HANDLE ControllerHandle,\r | |
1067 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
1068 | );\r | |
1069 | \r | |
1070 | /**\r | |
1071 | Start this driver on ControllerHandle by opening a Block IO and Disk IO\r | |
1072 | protocol, reading Device Path, and creating a child handle with a\r | |
1073 | Disk IO and device path protocol.\r | |
1074 | \r | |
1075 | @param This Protocol instance pointer.\r | |
1076 | @param ControllerHandle Handle of device to bind driver to\r | |
1077 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
1078 | device to start.\r | |
1079 | \r | |
1080 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
1081 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
1082 | @retval other This driver does not support this device\r | |
1083 | \r | |
1084 | **/\r | |
1085 | EFI_STATUS\r | |
1086 | EFIAPI\r | |
1087 | UdfDriverBindingStart (\r | |
1088 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1089 | IN EFI_HANDLE ControllerHandle,\r | |
1090 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
1091 | );\r | |
1092 | \r | |
1093 | /**\r | |
1094 | Stop this driver on ControllerHandle. Support stopping any child handles\r | |
1095 | created by this driver.\r | |
1096 | \r | |
1097 | @param This Protocol instance pointer.\r | |
1098 | @param ControllerHandle Handle of device to stop driver on\r | |
1099 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
1100 | children is zero stop the entire bus driver.\r | |
1101 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
1102 | \r | |
1103 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
1104 | @retval other This driver was not removed from this device\r | |
1105 | \r | |
1106 | **/\r | |
1107 | EFI_STATUS\r | |
1108 | EFIAPI\r | |
1109 | UdfDriverBindingStop (\r | |
1110 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1111 | IN EFI_HANDLE ControllerHandle,\r | |
1112 | IN UINTN NumberOfChildren,\r | |
1113 | IN EFI_HANDLE *ChildHandleBuffer\r | |
1114 | );\r | |
1115 | \r | |
1116 | //\r | |
1117 | // EFI Component Name Functions\r | |
1118 | //\r | |
1119 | /**\r | |
1120 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
1121 | \r | |
1122 | This function retrieves the user readable name of a driver in the form of a\r | |
1123 | Unicode string. If the driver specified by This has a user readable name in\r | |
1124 | the language specified by Language, then a pointer to the driver name is\r | |
1125 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
1126 | by This does not support the language specified by Language,\r | |
1127 | then EFI_UNSUPPORTED is returned.\r | |
1128 | \r | |
1129 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
1130 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
1131 | \r | |
1132 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
1133 | array indicating the language. This is the\r | |
1134 | language of the driver name that the caller is\r | |
1135 | requesting, and it must match one of the\r | |
1136 | languages specified in SupportedLanguages. The\r | |
1137 | number of languages supported by a driver is up\r | |
1138 | to the driver writer. Language is specified\r | |
1139 | in RFC 4646 or ISO 639-2 language code format.\r | |
1140 | \r | |
1141 | @param DriverName[out] A pointer to the Unicode string to return.\r | |
1142 | This Unicode string is the name of the\r | |
1143 | driver specified by This in the language\r | |
1144 | specified by Language.\r | |
1145 | \r | |
1146 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
1147 | This and the language specified by Language was\r | |
1148 | returned in DriverName.\r | |
1149 | \r | |
1150 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
1151 | \r | |
1152 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
1153 | \r | |
1154 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
1155 | the language specified by Language.\r | |
1156 | \r | |
1157 | **/\r | |
1158 | EFI_STATUS\r | |
1159 | EFIAPI\r | |
1160 | UdfComponentNameGetDriverName (\r | |
1161 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
1162 | IN CHAR8 *Language,\r | |
1163 | OUT CHAR16 **DriverName\r | |
1164 | );\r | |
1165 | \r | |
1166 | /**\r | |
1167 | Retrieves a Unicode string that is the user readable name of the controller\r | |
1168 | that is being managed by a driver.\r | |
1169 | \r | |
1170 | This function retrieves the user readable name of the controller specified by\r | |
1171 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
1172 | driver specified by This has a user readable name in the language specified by\r | |
1173 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
1174 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
1175 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
1176 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
1177 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
1178 | \r | |
1179 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
1180 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
1181 | \r | |
1182 | @param ControllerHandle[in] The handle of a controller that the driver\r | |
1183 | specified by This is managing. This handle\r | |
1184 | specifies the controller whose name is to be\r | |
1185 | returned.\r | |
1186 | \r | |
1187 | @param ChildHandle[in] The handle of the child controller to retrieve\r | |
1188 | the name of. This is an optional parameter that\r | |
1189 | may be NULL. It will be NULL for device\r | |
1190 | drivers. It will also be NULL for a bus drivers\r | |
1191 | that wish to retrieve the name of the bus\r | |
1192 | controller. It will not be NULL for a bus\r | |
1193 | driver that wishes to retrieve the name of a\r | |
1194 | child controller.\r | |
1195 | \r | |
1196 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
1197 | array indicating the language. This is the\r | |
1198 | language of the driver name that the caller is\r | |
1199 | requesting, and it must match one of the\r | |
1200 | languages specified in SupportedLanguages. The\r | |
1201 | number of languages supported by a driver is up\r | |
1202 | to the driver writer. Language is specified in\r | |
1203 | RFC 4646 or ISO 639-2 language code format.\r | |
1204 | \r | |
1205 | @param ControllerName[out] A pointer to the Unicode string to return.\r | |
1206 | This Unicode string is the name of the\r | |
1207 | controller specified by ControllerHandle and\r | |
1208 | ChildHandle in the language specified by\r | |
1209 | Language from the point of view of the driver\r | |
1210 | specified by This.\r | |
1211 | \r | |
1212 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
1213 | the language specified by Language for the\r | |
1214 | driver specified by This was returned in\r | |
1215 | DriverName.\r | |
1216 | \r | |
1217 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r | |
1218 | \r | |
1219 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
1220 | EFI_HANDLE.\r | |
1221 | \r | |
1222 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
1223 | \r | |
1224 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
1225 | \r | |
1226 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
1227 | managing the controller specified by\r | |
1228 | ControllerHandle and ChildHandle.\r | |
1229 | \r | |
1230 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
1231 | the language specified by Language.\r | |
1232 | \r | |
1233 | **/\r | |
1234 | EFI_STATUS\r | |
1235 | EFIAPI\r | |
1236 | UdfComponentNameGetControllerName (\r | |
1237 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
1238 | IN EFI_HANDLE ControllerHandle,\r | |
1239 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
1240 | IN CHAR8 *Language,\r | |
1241 | OUT CHAR16 **ControllerName\r | |
1242 | );\r | |
1243 | \r | |
1244 | #endif // _UDF_H_\r |