2 Implements functions to read firmware file
4 Copyright (c) 2006 - 2011, 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
33 UINT8 mFvAttributes
[] = {0, 4, 7, 9, 10, 12, 15, 16};
38 Convert the FFS File Attributes to FV File Attributes
40 @param FfsAttributes The attributes of UINT8 type.
42 @return The attributes of EFI_FV_FILE_ATTRIBUTES
45 EFI_FV_FILE_ATTRIBUTES
46 FfsAttributes2FvFileAttributes (
47 IN EFI_FFS_FILE_ATTRIBUTES FfsAttributes
50 FfsAttributes
= (EFI_FFS_FILE_ATTRIBUTES
)((FfsAttributes
& FFS_ATTRIB_DATA_ALIGNMENT
) >> 3);
51 ASSERT (FfsAttributes
< 8);
53 return (EFI_FV_FILE_ATTRIBUTES
) mFvAttributes
[FfsAttributes
];
59 Given the input key, search for the next matching file in the volume.
61 @param This Indicates the calling context.
62 @param Key Key is a pointer to a caller allocated
63 buffer that contains implementation specific
64 data that is used to track where to begin
65 the search for the next file. The size of
66 the buffer must be at least This->KeySize
67 bytes long. To reinitialize the search and
68 begin from the beginning of the firmware
69 volume, the entire buffer must be cleared to
70 zero. Other than clearing the buffer to
71 initiate a new search, the caller must not
72 modify the data in the buffer between calls
74 @param FileType FileType is a pointer to a caller allocated
75 EFI_FV_FILETYPE. The GetNextFile() API can
76 filter it's search for files based on the
77 value of *FileType input. A *FileType input
78 of 0 causes GetNextFile() to search for
79 files of all types. If a file is found, the
80 file's type is returned in *FileType.
81 *FileType is not modified if no file is
83 @param NameGuid NameGuid is a pointer to a caller allocated
84 EFI_GUID. If a file is found, the file's
85 name is returned in *NameGuid. *NameGuid is
86 not modified if no file is found.
87 @param Attributes Attributes is a pointer to a caller
88 allocated EFI_FV_FILE_ATTRIBUTES. If a file
89 is found, the file's attributes are returned
90 in *Attributes. *Attributes is not modified
92 @param Size Size is a pointer to a caller allocated
93 UINTN. If a file is found, the file's size
94 is returned in *Size. *Size is not modified
97 @retval EFI_SUCCESS Successfully find the file.
98 @retval EFI_DEVICE_ERROR Device error.
99 @retval EFI_ACCESS_DENIED Fv could not read.
100 @retval EFI_NOT_FOUND No matching file found.
101 @retval EFI_INVALID_PARAMETER Invalid parameter
107 IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL
*This
,
109 IN OUT EFI_FV_FILETYPE
*FileType
,
110 OUT EFI_GUID
*NameGuid
,
111 OUT EFI_FV_FILE_ATTRIBUTES
*Attributes
,
117 EFI_FV_ATTRIBUTES FvAttributes
;
118 EFI_FFS_FILE_HEADER
*FfsFileHeader
;
121 FFS_FILE_LIST_ENTRY
*FfsFileEntry
;
123 FvDevice
= FV_DEVICE_FROM_THIS (This
);
125 Status
= FvGetVolumeAttributes (This
, &FvAttributes
);
126 if (EFI_ERROR (Status
)){
131 // Check if read operation is enabled
133 if ((FvAttributes
& EFI_FV2_READ_STATUS
) == 0) {
134 return EFI_ACCESS_DENIED
;
137 if (*FileType
> EFI_FV_FILETYPE_SMM_CORE
) {
139 // File type needs to be in 0 - 0x0D
141 return EFI_NOT_FOUND
;
144 KeyValue
= (UINTN
*)Key
;
146 if (*KeyValue
== 0) {
148 // Search for 1st matching file
150 Link
= &FvDevice
->FfsFileListHeader
;
153 // Key is pointer to FFsFileEntry, so get next one
155 Link
= (LIST_ENTRY
*)(*KeyValue
);
158 if (Link
->ForwardLink
== &FvDevice
->FfsFileListHeader
) {
160 // Next is end of list so we did not find data
162 return EFI_NOT_FOUND
;
165 FfsFileEntry
= (FFS_FILE_LIST_ENTRY
*)Link
->ForwardLink
;
166 FfsFileHeader
= (EFI_FFS_FILE_HEADER
*)FfsFileEntry
->FfsHeader
;
171 *KeyValue
= (UINTN
)FfsFileEntry
;
173 if (FfsFileHeader
->Type
== EFI_FV_FILETYPE_FFS_PAD
) {
175 // we ignore pad files
180 if (*FileType
== EFI_FV_FILETYPE_ALL
) {
182 // Process all file types so we have a match
187 if (*FileType
== FfsFileHeader
->Type
) {
189 // Found a matching file type
197 // Return FileType, NameGuid, and Attributes
199 *FileType
= FfsFileHeader
->Type
;
200 CopyGuid (NameGuid
, &FfsFileHeader
->Name
);
201 *Attributes
= FfsAttributes2FvFileAttributes (FfsFileHeader
->Attributes
);
204 // we need to substract the header size
206 if (IS_FFS_FILE2 (FfsFileHeader
)) {
207 *Size
= FFS_FILE2_SIZE (FfsFileHeader
) - sizeof (EFI_FFS_FILE_HEADER2
);
209 *Size
= FFS_FILE_SIZE (FfsFileHeader
) - sizeof (EFI_FFS_FILE_HEADER
);
218 Locates a file in the firmware volume and
219 copies it to the supplied buffer.
221 @param This Indicates the calling context.
222 @param NameGuid Pointer to an EFI_GUID, which is the
224 @param Buffer Buffer is a pointer to pointer to a buffer
225 in which the file or section contents or are
227 @param BufferSize BufferSize is a pointer to caller allocated
228 UINTN. On input *BufferSize indicates the
229 size in bytes of the memory region pointed
230 to by Buffer. On output, *BufferSize
231 contains the number of bytes required to
233 @param FoundType FoundType is a pointer to a caller allocated
234 EFI_FV_FILETYPE that on successful return
235 from Read() contains the type of file read.
236 This output reflects the file type
237 irrespective of the value of the SectionType
239 @param FileAttributes FileAttributes is a pointer to a caller
240 allocated EFI_FV_FILE_ATTRIBUTES. On
241 successful return from Read(),
242 *FileAttributes contains the attributes of
244 @param AuthenticationStatus AuthenticationStatus is a pointer to a
245 caller allocated UINTN in which the
246 authentication status is returned.
248 @retval EFI_SUCCESS Successfully read to memory buffer.
249 @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.
250 @retval EFI_NOT_FOUND Not found.
251 @retval EFI_DEVICE_ERROR Device error.
252 @retval EFI_ACCESS_DENIED Could not read.
253 @retval EFI_INVALID_PARAMETER Invalid parameter.
254 @retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.
260 IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL
*This
,
261 IN CONST EFI_GUID
*NameGuid
,
262 IN OUT VOID
**Buffer
,
263 IN OUT UINTN
*BufferSize
,
264 OUT EFI_FV_FILETYPE
*FoundType
,
265 OUT EFI_FV_FILE_ATTRIBUTES
*FileAttributes
,
266 OUT UINT32
*AuthenticationStatus
271 EFI_GUID SearchNameGuid
;
272 EFI_FV_FILETYPE LocalFoundType
;
273 EFI_FV_FILE_ATTRIBUTES LocalAttributes
;
276 EFI_FFS_FILE_HEADER
*FfsHeader
;
277 UINTN InputBufferSize
;
279 if (NameGuid
== NULL
) {
280 return EFI_INVALID_PARAMETER
;
283 FvDevice
= FV_DEVICE_FROM_THIS (This
);
287 // Keep looking until we find the matching NameGuid.
288 // The Key is really an FfsFileEntry
290 FvDevice
->LastKey
= 0;
293 Status
= FvGetNextFile (
301 if (EFI_ERROR (Status
)) {
302 return EFI_NOT_FOUND
;
304 } while (!CompareGuid (&SearchNameGuid
, NameGuid
));
307 // Get a pointer to the header
309 FfsHeader
= FvDevice
->LastKey
->FfsHeader
;
312 // Remember callers buffer size
314 InputBufferSize
= *BufferSize
;
317 // Calculate return values
319 *FoundType
= FfsHeader
->Type
;
320 *FileAttributes
= FfsAttributes2FvFileAttributes (FfsHeader
->Attributes
);
321 *AuthenticationStatus
= 0;
322 *BufferSize
= FileSize
;
324 if (Buffer
== NULL
) {
326 // If Buffer is NULL, we only want to get the information collected so far
332 // Skip over file header
334 if (IS_FFS_FILE2 (FfsHeader
)) {
335 SrcPtr
= ((UINT8
*) FfsHeader
) + sizeof (EFI_FFS_FILE_HEADER2
);
337 SrcPtr
= ((UINT8
*) FfsHeader
) + sizeof (EFI_FFS_FILE_HEADER
);
340 Status
= EFI_SUCCESS
;
341 if (*Buffer
== NULL
) {
343 // Caller passed in a pointer so allocate buffer for them
345 *Buffer
= AllocatePool (FileSize
);
346 if (*Buffer
== NULL
) {
347 return EFI_OUT_OF_RESOURCES
;
349 } else if (FileSize
> InputBufferSize
) {
351 // Callers buffer was not big enough
353 Status
= EFI_WARN_BUFFER_TOO_SMALL
;
354 FileSize
= InputBufferSize
;
358 // Copy data into callers buffer
360 CopyMem (*Buffer
, SrcPtr
, FileSize
);
368 Locates a section in a given FFS File and
369 copies it to the supplied buffer (not including section header).
371 @param This Indicates the calling context.
372 @param NameGuid Pointer to an EFI_GUID, which is the
374 @param SectionType Indicates the section type to return.
375 @param SectionInstance Indicates which instance of sections with a
376 type of SectionType to return.
377 @param Buffer Buffer is a pointer to pointer to a buffer
378 in which the file or section contents or are
380 @param BufferSize BufferSize is a pointer to caller allocated
382 @param AuthenticationStatus AuthenticationStatus is a pointer to a
383 caller allocated UINT32 in which the
384 authentication status is returned.
386 @retval EFI_SUCCESS Successfully read the file section into
388 @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.
389 @retval EFI_NOT_FOUND Section not found.
390 @retval EFI_DEVICE_ERROR Device error.
391 @retval EFI_ACCESS_DENIED Could not read.
392 @retval EFI_INVALID_PARAMETER Invalid parameter.
398 IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL
*This
,
399 IN CONST EFI_GUID
*NameGuid
,
400 IN EFI_SECTION_TYPE SectionType
,
401 IN UINTN SectionInstance
,
402 IN OUT VOID
**Buffer
,
403 IN OUT UINTN
*BufferSize
,
404 OUT UINT32
*AuthenticationStatus
409 EFI_FV_FILETYPE FileType
;
410 EFI_FV_FILE_ATTRIBUTES FileAttributes
;
413 FFS_FILE_LIST_ENTRY
*FfsEntry
;
415 if (NameGuid
== NULL
|| Buffer
== NULL
) {
416 return EFI_INVALID_PARAMETER
;
419 FvDevice
= FV_DEVICE_FROM_THIS (This
);
422 // Read the whole file into buffer
425 Status
= FvReadFile (
428 (VOID
**)&FileBuffer
,
435 // Get the last key used by our call to FvReadFile as it is the FfsEntry for this file.
437 FfsEntry
= (FFS_FILE_LIST_ENTRY
*) FvDevice
->LastKey
;
439 if (EFI_ERROR (Status
)) {
444 // Check to see that the file actually HAS sections before we go any further.
446 if (FileType
== EFI_FV_FILETYPE_RAW
) {
447 Status
= EFI_NOT_FOUND
;
452 // Use FfsEntry to cache Section Extraction Protocol Information
454 if (FfsEntry
->StreamHandle
== 0) {
455 Status
= OpenSectionStream (
458 &FfsEntry
->StreamHandle
460 if (EFI_ERROR (Status
)) {
466 // If SectionType == 0 We need the whole section stream
468 Status
= GetSection (
469 FfsEntry
->StreamHandle
,
470 (SectionType
== 0) ? NULL
: &SectionType
,
472 (SectionType
== 0) ? 0 : SectionInstance
,
475 AuthenticationStatus
,
480 // Close of stream defered to close of FfsHeader list to allow SEP to cache data
484 CoreFreePool (FileBuffer
);