#include "DxeMain.h"
#include "FwVolDriver.h"

Functions
EFI_FV_FILE_ATTRIBUTES	FfsAttributes2FvFileAttributes (IN EFI_FFS_FILE_ATTRIBUTES FfsAttributes)

EFI_STATUS EFIAPI	FvGetNextFile (IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL This, IN OUT VOID Key, IN OUT EFI_FV_FILETYPE FileType, OUT EFI_GUID NameGuid, OUT EFI_FV_FILE_ATTRIBUTES Attributes, OUT UINTN Size)

EFI_STATUS EFIAPI	FvReadFile (IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL This, IN CONST EFI_GUID NameGuid, IN OUT VOID *Buffer, IN OUT UINTN BufferSize, OUT EFI_FV_FILETYPE FoundType, OUT EFI_FV_FILE_ATTRIBUTES FileAttributes, OUT UINT32 *AuthenticationStatus)

EFI_STATUS EFIAPI	FvReadFileSection (IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL This, IN CONST EFI_GUID NameGuid, IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, IN OUT VOID *Buffer, IN OUT UINTN BufferSize, OUT UINT32 *AuthenticationStatus)

Variables
UINT8	mFvAttributes [] = { 0, 4, 7, 9, 10, 12, 15, 16 }

UINT8	mFvAttributes2 [] = { 17, 18, 19, 20, 21, 22, 23, 24 }

Detailed Description

Implements functions to read firmware file

Copyright (c) 2006 - 2020, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file FwVolRead.c.

Function Documentation

◆ FfsAttributes2FvFileAttributes()

EFI_FV_FILE_ATTRIBUTES FfsAttributes2FvFileAttributes ( IN EFI_FFS_FILE_ATTRIBUTES FfsAttributes )

Convert the FFS File Attributes to FV File Attributes

Parameters

FfsAttributes The attributes of UINT8 type.

Returns: The attributes of EFI_FV_FILE_ATTRIBUTES

Definition at line 44 of file FwVolRead.c.

◆ FvGetNextFile()

EFI_STATUS EFIAPI FvGetNextFile	(	IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *	This,
		IN OUT VOID *	Key,
		IN OUT EFI_FV_FILETYPE *	FileType,
		OUT EFI_GUID *	NameGuid,
		OUT EFI_FV_FILE_ATTRIBUTES *	Attributes,
		OUT UINTN *	Size
	)

Given the input key, search for the next matching file in the volume.

Parameters

This	Indicates the calling context.
Key	Key is a pointer to a caller allocated buffer that contains implementation specific data that is used to track where to begin the search for the next file. The size of the buffer must be at least This->KeySize bytes long. To reinitialize the search and begin from the beginning of the firmware volume, the entire buffer must be cleared to zero. Other than clearing the buffer to initiate a new search, the caller must not modify the data in the buffer between calls to GetNextFile().
FileType	FileType is a pointer to a caller allocated EFI_FV_FILETYPE. The GetNextFile() API can filter it's search for files based on the value of FileType input. A FileType input of 0 causes GetNextFile() to search for files of all types. If a file is found, the file's type is returned in *FileType. FileType is not modified if no file is found.
NameGuid	NameGuid is a pointer to a caller allocated EFI_GUID. If a file is found, the file's name is returned in NameGuid. NameGuid is not modified if no file is found.
Attributes	Attributes is a pointer to a caller allocated EFI_FV_FILE_ATTRIBUTES. If a file is found, the file's attributes are returned in Attributes. Attributes is not modified if no file is found.
Size	Size is a pointer to a caller allocated UINTN. If a file is found, the file's size is returned in Size. Size is not modified if no file is found.

Return values

EFI_SUCCESS	Successfully find the file.
EFI_DEVICE_ERROR	Device error.
EFI_ACCESS_DENIED	Fv could not read.
EFI_NOT_FOUND	No matching file found.
EFI_INVALID_PARAMETER	Invalid parameter

Definition at line 115 of file FwVolRead.c.

◆ FvReadFile()

EFI_STATUS EFIAPI FvReadFile	(	IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *	This,
		IN CONST EFI_GUID *	NameGuid,
		IN OUT VOID **	Buffer,
		IN OUT UINTN *	BufferSize,
		OUT EFI_FV_FILETYPE *	FoundType,
		OUT EFI_FV_FILE_ATTRIBUTES *	FileAttributes,
		OUT UINT32 *	AuthenticationStatus
	)

Locates a file in the firmware volume and copies it to the supplied buffer.

Parameters

This	Indicates the calling context.
NameGuid	Pointer to an EFI_GUID, which is the filename.
Buffer	Buffer is a pointer to pointer to a buffer in which the file or section contents or are returned.
BufferSize	BufferSize is a pointer to caller allocated UINTN. On input BufferSize indicates the size in bytes of the memory region pointed to by Buffer. On output, BufferSize contains the number of bytes required to read the file.
FoundType	FoundType is a pointer to a caller allocated EFI_FV_FILETYPE that on successful return from Read() contains the type of file read. This output reflects the file type irrespective of the value of the SectionType input.
FileAttributes	FileAttributes is a pointer to a caller allocated EFI_FV_FILE_ATTRIBUTES. On successful return from Read(), FileAttributes contains the attributes of the file read.
AuthenticationStatus	AuthenticationStatus is a pointer to a caller allocated UINTN in which the authentication status is returned.

Return values

EFI_SUCCESS	Successfully read to memory buffer.
EFI_WARN_BUFFER_TOO_SMALL	Buffer too small.
EFI_NOT_FOUND	Not found.
EFI_DEVICE_ERROR	Device error.
EFI_ACCESS_DENIED	Could not read.
EFI_INVALID_PARAMETER	Invalid parameter.
EFI_OUT_OF_RESOURCES	Not enough buffer to be allocated.

Definition at line 268 of file FwVolRead.c.

◆ FvReadFileSection()

EFI_STATUS EFIAPI FvReadFileSection	(	IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *	This,
		IN CONST EFI_GUID *	NameGuid,
		IN EFI_SECTION_TYPE	SectionType,
		IN UINTN	SectionInstance,
		IN OUT VOID **	Buffer,
		IN OUT UINTN *	BufferSize,
		OUT UINT32 *	AuthenticationStatus
	)

Locates a section in a given FFS File and copies it to the supplied buffer (not including section header).

Parameters

This	Indicates the calling context.
NameGuid	Pointer to an EFI_GUID, which is the filename.
SectionType	Indicates the section type to return.
SectionInstance	Indicates which instance of sections with a type of SectionType to return.
Buffer	Buffer is a pointer to pointer to a buffer in which the file or section contents or are returned.
BufferSize	BufferSize is a pointer to caller allocated UINTN.
AuthenticationStatus	AuthenticationStatus is a pointer to a caller allocated UINT32 in which the authentication status is returned.

Return values

EFI_SUCCESS	Successfully read the file section into buffer.
EFI_WARN_BUFFER_TOO_SMALL	Buffer too small.
EFI_NOT_FOUND	Section not found.
EFI_DEVICE_ERROR	Device error.
EFI_ACCESS_DENIED	Could not read.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 432 of file FwVolRead.c.

Variable Documentation

◆ mFvAttributes

UINT8 mFvAttributes[] = { 0, 4, 7, 9, 10, 12, 15, 16 }

Required Alignment Alignment Value in FFS FFS_ATTRIB_DATA_ALIGNMENT2 Alignment Value in (bytes) Attributes Field in FFS Attributes Field Firmware Volume Interfaces 1 0 0 0 16 1 0 4 128 2 0 7 512 3 0 9 1 KB 4 0 10 4 KB 5 0 12 32 KB 6 0 15 64 KB 7 0 16 128 KB 0 1 17 256 KB 1 1 18 512 KB 2 1 19 1 MB 3 1 20 2 MB 4 1 21 4 MB 5 1 22 8 MB 6 1 23 16 MB 7 1 24

Definition at line 32 of file FwVolRead.c.

◆ mFvAttributes2

UINT8 mFvAttributes2[] = { 17, 18, 19, 20, 21, 22, 23, 24 }

Definition at line 33 of file FwVolRead.c.

Functions

Variables

Detailed Description

Function Documentation

◆ FfsAttributes2FvFileAttributes()

◆ FvGetNextFile()

◆ FvReadFile()

◆ FvReadFileSection()

Variable Documentation

◆ mFvAttributes

◆ mFvAttributes2