2 Implements functions to read firmware file
4 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "FwVolDriver.h"
19 Required Alignment Alignment Value in FFS Alignment Value in
20 (bytes) Attributes Field Firmware Volume Interfaces
30 UINT8 mFvAttributes
[] = {0, 4, 7, 9, 10, 12, 15, 16};
33 Convert the FFS File Attributes to FV File Attributes
35 @param FfsAttributes The attributes of UINT8 type.
37 @return The attributes of EFI_FV_FILE_ATTRIBUTES
40 EFI_FV_FILE_ATTRIBUTES
41 FfsAttributes2FvFileAttributes (
42 IN EFI_FFS_FILE_ATTRIBUTES FfsAttributes
46 EFI_FV_FILE_ATTRIBUTES FileAttribute
;
48 DataAlignment
= (UINT8
) ((FfsAttributes
& FFS_ATTRIB_DATA_ALIGNMENT
) >> 3);
49 ASSERT (DataAlignment
< 8);
51 FileAttribute
= (EFI_FV_FILE_ATTRIBUTES
) mFvAttributes
[DataAlignment
];
53 if ((FfsAttributes
& FFS_ATTRIB_FIXED
) == FFS_ATTRIB_FIXED
) {
54 FileAttribute
|= EFI_FV_FILE_ATTRIB_FIXED
;
61 Given the input key, search for the next matching file in the volume.
63 @param This Indicates the calling context.
64 @param Key Key is a pointer to a caller allocated
65 buffer that contains implementation specific
66 data that is used to track where to begin
67 the search for the next file. The size of
68 the buffer must be at least This->KeySize
69 bytes long. To reinitialize the search and
70 begin from the beginning of the firmware
71 volume, the entire buffer must be cleared to
72 zero. Other than clearing the buffer to
73 initiate a new search, the caller must not
74 modify the data in the buffer between calls
76 @param FileType FileType is a pointer to a caller allocated
77 EFI_FV_FILETYPE. The GetNextFile() API can
78 filter it's search for files based on the
79 value of *FileType input. A *FileType input
80 of 0 causes GetNextFile() to search for
81 files of all types. If a file is found, the
82 file's type is returned in *FileType.
83 *FileType is not modified if no file is
85 @param NameGuid NameGuid is a pointer to a caller allocated
86 EFI_GUID. If a file is found, the file's
87 name is returned in *NameGuid. *NameGuid is
88 not modified if no file is found.
89 @param Attributes Attributes is a pointer to a caller
90 allocated EFI_FV_FILE_ATTRIBUTES. If a file
91 is found, the file's attributes are returned
92 in *Attributes. *Attributes is not modified
94 @param Size Size is a pointer to a caller allocated
95 UINTN. If a file is found, the file's size
96 is returned in *Size. *Size is not modified
99 @retval EFI_SUCCESS Successfully find the file.
100 @retval EFI_DEVICE_ERROR Device error.
101 @retval EFI_ACCESS_DENIED Fv could not read.
102 @retval EFI_NOT_FOUND No matching file found.
103 @retval EFI_INVALID_PARAMETER Invalid parameter
109 IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL
*This
,
111 IN OUT EFI_FV_FILETYPE
*FileType
,
112 OUT EFI_GUID
*NameGuid
,
113 OUT EFI_FV_FILE_ATTRIBUTES
*Attributes
,
119 EFI_FV_ATTRIBUTES FvAttributes
;
120 EFI_FFS_FILE_HEADER
*FfsFileHeader
;
123 FFS_FILE_LIST_ENTRY
*FfsFileEntry
;
125 FvDevice
= FV_DEVICE_FROM_THIS (This
);
127 Status
= FvGetVolumeAttributes (This
, &FvAttributes
);
128 if (EFI_ERROR (Status
)){
133 // Check if read operation is enabled
135 if ((FvAttributes
& EFI_FV2_READ_STATUS
) == 0) {
136 return EFI_ACCESS_DENIED
;
139 if (*FileType
> EFI_FV_FILETYPE_SMM_CORE
) {
141 // File type needs to be in 0 - 0x0D
143 return EFI_NOT_FOUND
;
146 KeyValue
= (UINTN
*)Key
;
148 if (*KeyValue
== 0) {
150 // Search for 1st matching file
152 Link
= &FvDevice
->FfsFileListHeader
;
155 // Key is pointer to FFsFileEntry, so get next one
157 Link
= (LIST_ENTRY
*)(*KeyValue
);
160 if (Link
->ForwardLink
== &FvDevice
->FfsFileListHeader
) {
162 // Next is end of list so we did not find data
164 return EFI_NOT_FOUND
;
167 FfsFileEntry
= (FFS_FILE_LIST_ENTRY
*)Link
->ForwardLink
;
168 FfsFileHeader
= (EFI_FFS_FILE_HEADER
*)FfsFileEntry
->FfsHeader
;
173 *KeyValue
= (UINTN
)FfsFileEntry
;
175 if (FfsFileHeader
->Type
== EFI_FV_FILETYPE_FFS_PAD
) {
177 // we ignore pad files
182 if (*FileType
== EFI_FV_FILETYPE_ALL
) {
184 // Process all file types so we have a match
189 if (*FileType
== FfsFileHeader
->Type
) {
191 // Found a matching file type
199 // Return FileType, NameGuid, and Attributes
201 *FileType
= FfsFileHeader
->Type
;
202 CopyGuid (NameGuid
, &FfsFileHeader
->Name
);
203 *Attributes
= FfsAttributes2FvFileAttributes (FfsFileHeader
->Attributes
);
204 if ((FvDevice
->FwVolHeader
->Attributes
& EFI_FVB2_MEMORY_MAPPED
) == EFI_FVB2_MEMORY_MAPPED
) {
205 *Attributes
|= EFI_FV_FILE_ATTRIB_MEMORY_MAPPED
;
209 // we need to substract the header size
211 if (IS_FFS_FILE2 (FfsFileHeader
)) {
212 *Size
= FFS_FILE2_SIZE (FfsFileHeader
) - sizeof (EFI_FFS_FILE_HEADER2
);
214 *Size
= FFS_FILE_SIZE (FfsFileHeader
) - sizeof (EFI_FFS_FILE_HEADER
);
223 Locates a file in the firmware volume and
224 copies it to the supplied buffer.
226 @param This Indicates the calling context.
227 @param NameGuid Pointer to an EFI_GUID, which is the
229 @param Buffer Buffer is a pointer to pointer to a buffer
230 in which the file or section contents or are
232 @param BufferSize BufferSize is a pointer to caller allocated
233 UINTN. On input *BufferSize indicates the
234 size in bytes of the memory region pointed
235 to by Buffer. On output, *BufferSize
236 contains the number of bytes required to
238 @param FoundType FoundType is a pointer to a caller allocated
239 EFI_FV_FILETYPE that on successful return
240 from Read() contains the type of file read.
241 This output reflects the file type
242 irrespective of the value of the SectionType
244 @param FileAttributes FileAttributes is a pointer to a caller
245 allocated EFI_FV_FILE_ATTRIBUTES. On
246 successful return from Read(),
247 *FileAttributes contains the attributes of
249 @param AuthenticationStatus AuthenticationStatus is a pointer to a
250 caller allocated UINTN in which the
251 authentication status is returned.
253 @retval EFI_SUCCESS Successfully read to memory buffer.
254 @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.
255 @retval EFI_NOT_FOUND Not found.
256 @retval EFI_DEVICE_ERROR Device error.
257 @retval EFI_ACCESS_DENIED Could not read.
258 @retval EFI_INVALID_PARAMETER Invalid parameter.
259 @retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.
265 IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL
*This
,
266 IN CONST EFI_GUID
*NameGuid
,
267 IN OUT VOID
**Buffer
,
268 IN OUT UINTN
*BufferSize
,
269 OUT EFI_FV_FILETYPE
*FoundType
,
270 OUT EFI_FV_FILE_ATTRIBUTES
*FileAttributes
,
271 OUT UINT32
*AuthenticationStatus
276 EFI_GUID SearchNameGuid
;
277 EFI_FV_FILETYPE LocalFoundType
;
278 EFI_FV_FILE_ATTRIBUTES LocalAttributes
;
281 EFI_FFS_FILE_HEADER
*FfsHeader
;
282 UINTN InputBufferSize
;
285 if (NameGuid
== NULL
) {
286 return EFI_INVALID_PARAMETER
;
289 FvDevice
= FV_DEVICE_FROM_THIS (This
);
293 // Keep looking until we find the matching NameGuid.
294 // The Key is really a FfsFileEntry
296 FvDevice
->LastKey
= 0;
299 Status
= FvGetNextFile (
307 if (EFI_ERROR (Status
)) {
308 return EFI_NOT_FOUND
;
310 } while (!CompareGuid (&SearchNameGuid
, NameGuid
));
313 // Get a pointer to the header
315 FfsHeader
= FvDevice
->LastKey
->FfsHeader
;
316 if (FvDevice
->IsMemoryMapped
) {
318 // Memory mapped FV has not been cached, so here is to cache by file.
320 if (!FvDevice
->LastKey
->FileCached
) {
322 // Cache FFS file to memory buffer.
324 WholeFileSize
= IS_FFS_FILE2 (FfsHeader
) ? FFS_FILE2_SIZE (FfsHeader
): FFS_FILE_SIZE (FfsHeader
);
325 FfsHeader
= AllocateCopyPool (WholeFileSize
, FfsHeader
);
326 if (FfsHeader
== NULL
) {
327 return EFI_OUT_OF_RESOURCES
;
330 // Let FfsHeader in FfsFileEntry point to the cached file buffer.
332 FvDevice
->LastKey
->FfsHeader
= FfsHeader
;
333 FvDevice
->LastKey
->FileCached
= TRUE
;
338 // Remember callers buffer size
340 InputBufferSize
= *BufferSize
;
343 // Calculate return values
345 *FoundType
= FfsHeader
->Type
;
346 *FileAttributes
= FfsAttributes2FvFileAttributes (FfsHeader
->Attributes
);
347 if ((FvDevice
->FwVolHeader
->Attributes
& EFI_FVB2_MEMORY_MAPPED
) == EFI_FVB2_MEMORY_MAPPED
) {
348 *FileAttributes
|= EFI_FV_FILE_ATTRIB_MEMORY_MAPPED
;
350 *AuthenticationStatus
= 0;
351 *BufferSize
= FileSize
;
353 if (Buffer
== NULL
) {
355 // If Buffer is NULL, we only want to get the information collected so far
361 // Skip over file header
363 if (IS_FFS_FILE2 (FfsHeader
)) {
364 SrcPtr
= ((UINT8
*) FfsHeader
) + sizeof (EFI_FFS_FILE_HEADER2
);
366 SrcPtr
= ((UINT8
*) FfsHeader
) + sizeof (EFI_FFS_FILE_HEADER
);
369 Status
= EFI_SUCCESS
;
370 if (*Buffer
== NULL
) {
372 // Caller passed in a pointer so allocate buffer for them
374 *Buffer
= AllocatePool (FileSize
);
375 if (*Buffer
== NULL
) {
376 return EFI_OUT_OF_RESOURCES
;
378 } else if (FileSize
> InputBufferSize
) {
380 // Callers buffer was not big enough
382 Status
= EFI_WARN_BUFFER_TOO_SMALL
;
383 FileSize
= InputBufferSize
;
387 // Copy data into callers buffer
389 CopyMem (*Buffer
, SrcPtr
, FileSize
);
397 Locates a section in a given FFS File and
398 copies it to the supplied buffer (not including section header).
400 @param This Indicates the calling context.
401 @param NameGuid Pointer to an EFI_GUID, which is the
403 @param SectionType Indicates the section type to return.
404 @param SectionInstance Indicates which instance of sections with a
405 type of SectionType to return.
406 @param Buffer Buffer is a pointer to pointer to a buffer
407 in which the file or section contents or are
409 @param BufferSize BufferSize is a pointer to caller allocated
411 @param AuthenticationStatus AuthenticationStatus is a pointer to a
412 caller allocated UINT32 in which the
413 authentication status is returned.
415 @retval EFI_SUCCESS Successfully read the file section into
417 @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.
418 @retval EFI_NOT_FOUND Section not found.
419 @retval EFI_DEVICE_ERROR Device error.
420 @retval EFI_ACCESS_DENIED Could not read.
421 @retval EFI_INVALID_PARAMETER Invalid parameter.
427 IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL
*This
,
428 IN CONST EFI_GUID
*NameGuid
,
429 IN EFI_SECTION_TYPE SectionType
,
430 IN UINTN SectionInstance
,
431 IN OUT VOID
**Buffer
,
432 IN OUT UINTN
*BufferSize
,
433 OUT UINT32
*AuthenticationStatus
438 EFI_FV_FILETYPE FileType
;
439 EFI_FV_FILE_ATTRIBUTES FileAttributes
;
442 FFS_FILE_LIST_ENTRY
*FfsEntry
;
444 if (NameGuid
== NULL
|| Buffer
== NULL
) {
445 return EFI_INVALID_PARAMETER
;
448 FvDevice
= FV_DEVICE_FROM_THIS (This
);
453 Status
= FvReadFile (
463 // Get the last key used by our call to FvReadFile as it is the FfsEntry for this file.
465 FfsEntry
= (FFS_FILE_LIST_ENTRY
*) FvDevice
->LastKey
;
467 if (EFI_ERROR (Status
)) {
470 if (IS_FFS_FILE2 (FfsEntry
->FfsHeader
)) {
471 FileBuffer
= ((UINT8
*) FfsEntry
->FfsHeader
) + sizeof (EFI_FFS_FILE_HEADER2
);
473 FileBuffer
= ((UINT8
*) FfsEntry
->FfsHeader
) + sizeof (EFI_FFS_FILE_HEADER
);
476 // Check to see that the file actually HAS sections before we go any further.
478 if (FileType
== EFI_FV_FILETYPE_RAW
) {
479 Status
= EFI_NOT_FOUND
;
484 // Use FfsEntry to cache Section Extraction Protocol Information
486 if (FfsEntry
->StreamHandle
== 0) {
487 Status
= OpenSectionStream (
490 &FfsEntry
->StreamHandle
492 if (EFI_ERROR (Status
)) {
498 // If SectionType == 0 We need the whole section stream
500 Status
= GetSection (
501 FfsEntry
->StreamHandle
,
502 (SectionType
== 0) ? NULL
: &SectionType
,
504 (SectionType
== 0) ? 0 : SectionInstance
,
507 AuthenticationStatus
,
511 if (!EFI_ERROR (Status
)) {
513 // Inherit the authentication status.
515 *AuthenticationStatus
|= FvDevice
->AuthenticationStatus
;
519 // Close of stream defered to close of FfsHeader list to allow SEP to cache data