tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-31 01:24:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

1) Update comments for API in DxePiLib.h

Browse Source 
2) Fix a bug that SectionInstance is not referenced in the function GetSectionFromFv
3) Some minor cleanup.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5711 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qwang12 2008-08-22 09:09:24 +00:00
parent 6812ef9fea
commit ff197efbbc
2 changed files with 264 additions and 256 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

219
MdePkg/Include/Library/DxePiLib.h
View File

@ -19,90 +19,100 @@
/** /**
Allocate and fill a buffer from the Firmware Section identified by a Firmware File GUID name and a Firmware Locates a requested firmware section within a file and returns it to a buffer allocated by this function.
Section type and instance number from any Firmware Volumes in the system.
The function will read the first Firmware Section sepcifed by NameGuid, SectionType and Instance by searching
for all Firmware Volumes in the system.
The search order for Firmware Volumes in the system is determistic but abitrary if no new Firmware Volume is installed PiLibGetSectionFromAnyFv () is used to read a specific section from a file within a firmware volume. The function
into the system. The search order for the section specified by SectionType within a Firmware File is defined by will search the first file with the specified name in all firmware volumes in the system. The search order for firmware
EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization volumes in the system is determistic but abitrary if no new firmware volume is added into the system between
Shared Architectural Elements for detailes. each calls of this function.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section After the specific file is located, the function searches the specifc firmware section with type SectionType in this file.
data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection ()
read Firmware Section data from the Firmware File. If no such section specified is found to match , found in PI Specification.
EFI_NOT_FOUND is returned.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section
is not found, EFI_SECTION_PE32 will be used to try the search again. If no EFI_SECTION_PE32 section is found, EFI_NOT_FOUND
is returned.
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can only be called at TPL_NOTIFY and below.
If NameGuid is NULL, then ASSERT();
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param NameGuid Pointer to an EFI_GUID, which indicates the file name from which the requested
section will be read. Type EFI_GUID is defined in
InstallProtocolInterface() in the UEFI 2.0 specification.
@param SectionType Indicates the section type to return. SectionType in conjunction with
SectionInstance indicates which section to return. Type
EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.
@param SectionInstance Indicates which instance of sections with a type of SectionType to return.
SectionType in conjunction with SectionInstance indicates which section to
return. SectionInstance is zero based.
@param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not
including the section header. Caller is responsible to free this memory.
@param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by
*Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can only be called at TPL_NOTIFY and below.
If NameGuid is NULL, then ASSERT();
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param NameGuid The GUID name of a Firmware File.
@param SectionType The Firmware Section type.
@param Instance The instance number of Firmware Section to read from starting from 0.
@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found.
@param Size On output, the size of Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PiLibGetSectionFromAnyFv ( PiLibGetSectionFromAnyFv (
IN CONST EFI_GUID *NameGuid, IN CONST EFI_GUID *NameGuid,
IN EFI_SECTION_TYPE SectionType, IN EFI_SECTION_TYPE SectionType,
IN UINTN Instance, IN UINTN SectionInstance,
OUT VOID **Buffer, OUT VOID **Buffer,
OUT UINTN *Size OUT UINTN *Size
) )
; ;
/** /**
Allocate and fill a buffer from a Firmware Section identified by a Firmware File GUID name, a Firmware Locates a requested firmware section within a file and returns it to a buffer allocated by this function.
Section type and instance number from the same Firmware Volume with the caller's FFS.
This functions first locates the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance for same Firmrware Volume
which also contains the FFS of the caller in order to carry out the Firmware Volume read operation.
The function then reads the Firmware Section found sepcifed by NameGuid, SectionType and Instance.
The search order for the section specified by SectionType within a Firmware File is defined by
EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization
Shared Architectural Elements for detailes.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section
data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to
read Firmware Section data from the Firmware File. If no such section specified is found to match ,
EFI_NOT_FOUND is returned.
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can be only called at TPL_NOTIFY and below.
If FvHandle is NULL, then ASSERT ();
If NameGuid is NULL, then ASSERT();
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param NameGuid The GUID name of a Firmware File. PiLibGetSectionFromCurrentFv () is used to read a specific section from a file within the same firmware volume from which
@param SectionType The Firmware Section type. the running image is loaded. If the specific file is found, the function searches the specifc firmware section with type SectionType.
@param Instance The instance number of Firmware Section to read from starting from 0. The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection ()
@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found. found in PI Specification.
@param Size On output, the size of Buffer.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section
@retval EFI_SUCCESS The image is found and data and size is returned. is not found, EFI_SECTION_PE32 will be used to try the search again. If no EFI_SECTION_PE32 section is found, EFI_NOT_FOUND
@retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL. is returned.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations. The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume. by this function. This function can be only called at TPL_NOTIFY and below.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
If NameGuid is NULL, then ASSERT();
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param NameGuid Pointer to an EFI_GUID, which indicates the file name from which the requested
section will be read. Type EFI_GUID is defined in
InstallProtocolInterface() in the UEFI 2.0 specification.
@param SectionType Indicates the section type to return. SectionType in conjunction with
SectionInstance indicates which section to return. Type
EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.
@param SectionInstance Indicates which instance of sections with a type of SectionType to return.
SectionType in conjunction with SectionInstance indicates which section to
return. SectionInstance is zero based.
@param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not
including the section header. Caller is responsible to free this memory.
@param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by
*Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/ **/
EFI_STATUS EFI_STATUS
@ -110,7 +120,7 @@ EFIAPI
PiLibGetSectionFromCurrentFv ( PiLibGetSectionFromCurrentFv (
IN CONST EFI_GUID *NameGuid, IN CONST EFI_GUID *NameGuid,
IN EFI_SECTION_TYPE SectionType, IN EFI_SECTION_TYPE SectionType,
IN UINTN Instance, IN UINTN SectionInstance,
OUT VOID **Buffer, OUT VOID **Buffer,
OUT UINTN *Size OUT UINTN *Size
) )
@ -118,47 +128,46 @@ PiLibGetSectionFromCurrentFv (
/** /**
Allocate and fill a buffer from the first Firmware Section in the same Firmware File as the caller of this function. Locates a requested firmware section within a file and returns it to a buffer allocated by this function.
The function will read the first Firmware Section found sepcifed by NameGuid and SectionType from the PiLibGetSectionFromCurrentFfs () searches the specifc firmware section with type SectionType in the same firmware file from
Firmware Volume specified by FvHandle. On this FvHandle, an EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance which the running image is loaded. The details of this search order is defined in description of
should be located succesfully in order to carry out the Firmware Volume operations. EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection () found in PI Specification.
The search order for the section type specified by SectionType in the Firmware File is using a depth-first If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section
and left-to-right algorithm through all sections. The first section found to match SectionType will be returned. is not found, EFI_SECTION_PE32 will be used to try the search again. If no EFI_SECTION_PE32 section is found, EFI_NOT_FOUND
is returned.
If SectionType is EFI_SECTION_PE32, EFI_SECTION_PE32 will be used as Firmware Section type
to read Firmware Section data from the Firmware File. If no such section exists, the function will try
to read a Firmware File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned. The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can only be called at TPL_NOTIFY and below.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section
data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to If Buffer is NULL, then ASSERT();
read Firmware Section data from the Firmware File. If no such section exists, the function will try to read a Firmware If Size is NULL, then ASSERT().
File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned.
@param SectionType Indicates the section type to return. SectionType in conjunction with
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated SectionInstance indicates which section to return. Type
by this function. This function can only be called at TPL_NOTIFY and below. EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.
@param SectionInstance Indicates which instance of sections with a type of SectionType to return.
If Buffer is NULL, then ASSERT(); SectionType in conjunction with SectionInstance indicates which section to
If Size is NULL, then ASSERT(). return. SectionInstance is zero based.
@param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not
@param SectionType The Firmware Section type. including the section header. Caller is responsible to free this memory.
@param Instance Instance number of a section. @param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by
@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found. *Buffer.
@param Size On output, the size of Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_SUCCESS The image is found and data and size is returned. @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found. @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations. @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume. @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PiLibGetSectionFromCurrentFfs ( PiLibGetSectionFromCurrentFfs (
IN EFI_SECTION_TYPE SectionType, IN EFI_SECTION_TYPE SectionType,
IN UINTN Instance, IN UINTN SectionInstance,
OUT VOID **Buffer, OUT VOID **Buffer,
OUT UINTN *Size OUT UINTN *Size
) )

301
MdePkg/Library/DxePiLib/DxePiLib.c
View File

@ -65,16 +65,14 @@ InternalImageHandleToFvHandle (
This functions first locate the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance on FvHandle in order to This functions first locate the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance on FvHandle in order to
carry out the Firmware Volume read operation. The function then reads the Firmware Section found sepcifed carry out the Firmware Volume read operation. The function then reads the Firmware Section found sepcifed
by NameGuid, SectionType and Instance. by NameGuid, SectionType and SectionInstance.
The search order for the section specified by SectionType within a Firmware File is defined by The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection ()
EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization found in PI Specification.
Shared Architectural Elements for detailes.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section
data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to is not found, EFI_SECTION_PE32 will be used to try the search again. If no EFI_SECTION_PE32 section is found, EFI_NOT_FOUND
read Firmware Section data from the Firmware File. If no such section specified is found to match , is returned.
EFI_NOT_FOUND is returned.
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can be only called at TPL_NOTIFY and below. by this function. This function can be only called at TPL_NOTIFY and below.
@ -84,19 +82,19 @@ InternalImageHandleToFvHandle (
If Buffer is NULL, then ASSERT(); If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT(). If Size is NULL, then ASSERT().
@param FvHandle The device handle that contains a instance of EFI_FIRMWARE_VOLUME2_PROTOCOL instance. @param FvHandle The device handle that contains a instance of EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
@param NameGuid The GUID name of a Firmware File. @param NameGuid The GUID name of a Firmware File.
@param SectionType The Firmware Section type. @param SectionType The Firmware Section type.
@param Instance The instance number of Firmware Section to read from starting from 0. @param SectionInstance The instance number of Firmware Section to read from starting from 0.
@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found. @param Buffer On output, Buffer contains the the data read from the section in the Firmware File found.
@param Size On output, the size of Buffer. @param Size On output, the size of Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned. @retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL. @retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found. @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations. @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume. @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads. @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/ **/
EFI_STATUS EFI_STATUS
@ -104,7 +102,7 @@ GetSectionFromFv (
IN EFI_HANDLE FvHandle, IN EFI_HANDLE FvHandle,
IN CONST EFI_GUID *NameGuid, IN CONST EFI_GUID *NameGuid,
IN EFI_SECTION_TYPE SectionType, IN EFI_SECTION_TYPE SectionType,
IN UINTN Instance, IN UINTN SectionInstance,
OUT VOID **Buffer, OUT VOID **Buffer,
OUT UINTN *Size OUT UINTN *Size
) )
@ -133,7 +131,7 @@ GetSectionFromFv (
Fv, Fv,
NameGuid, NameGuid,
SectionType, SectionType,
0, SectionInstance,
Buffer, Buffer,
Size, Size,
&AuthenticationStatus &AuthenticationStatus
@ -149,7 +147,7 @@ GetSectionFromFv (
Fv, Fv,
NameGuid, NameGuid,
EFI_SECTION_PE32, EFI_SECTION_PE32,
0, SectionInstance,
Buffer, Buffer,
Size, Size,
&AuthenticationStatus &AuthenticationStatus
@ -162,48 +160,55 @@ GetSectionFromFv (
/** /**
Allocate and fill a buffer from the Firmware Section identified by a Firmware File GUID name and a Firmware Locates a requested firmware section within a file and returns it to a buffer allocated by this function.
Section type and instance number from any Firmware Volumes in the system.
The function will read the first Firmware Section sepcifed by NameGuid, SectionType and Instance by searching
for all Firmware Volumes in the system.
The search order for Firmware Volumes in the system is determistic but abitrary if no new Firmware Volume is installed PiLibGetSectionFromAnyFv () is used to read a specific section from a file within a firmware volume. The function
into the system. The search order for the section specified by SectionType within a Firmware File is defined by will search the first file with the specified name in all firmware volumes in the system. The search order for firmware
EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization volumes in the system is determistic but abitrary if no new firmware volume is added into the system between
Shared Architectural Elements for detailes. each calls of this function.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section After the specific file is located, the function searches the specifc firmware section with type SectionType in this file.
data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection ()
read Firmware Section data from the Firmware File. If no such section specified is found to match , found in PI Specification.
EFI_NOT_FOUND is returned.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section
is not found, EFI_SECTION_PE32 will be used to try the search again. If no EFI_SECTION_PE32 section is found, EFI_NOT_FOUND
is returned.
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can only be called at TPL_NOTIFY and below.
If NameGuid is NULL, then ASSERT();
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param NameGuid Pointer to an EFI_GUID, which indicates the file name from which the requested
section will be read. Type EFI_GUID is defined in
InstallProtocolInterface() in the UEFI 2.0 specification.
@param SectionType Indicates the section type to return. SectionType in conjunction with
SectionInstance indicates which section to return. Type
EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.
@param SectionInstance Indicates which instance of sections with a type of SectionType to return.
SectionType in conjunction with SectionInstance indicates which section to
return. SectionInstance is zero based.
@param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not
including the section header. Caller is responsible to free this memory.
@param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by
*Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can only be called at TPL_NOTIFY and below.
If NameGuid is NULL, then ASSERT();
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param NameGuid The GUID name of a Firmware File.
@param SectionType The Firmware Section type.
@param Instance The instance number of Firmware Section to read from starting from 0.
@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found.
@param Size On output, the size of Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PiLibGetSectionFromAnyFv ( PiLibGetSectionFromAnyFv (
IN CONST EFI_GUID *NameGuid, IN CONST EFI_GUID *NameGuid,
IN EFI_SECTION_TYPE SectionType, IN EFI_SECTION_TYPE SectionType,
IN UINTN Instance, IN UINTN SectionInstance,
OUT VOID **Buffer, OUT VOID **Buffer,
OUT UINTN *Size OUT UINTN *Size
) )
@ -213,7 +218,6 @@ PiLibGetSectionFromAnyFv (
UINTN HandleCount; UINTN HandleCount;
UINTN Index; UINTN Index;
EFI_HANDLE FvHandle; EFI_HANDLE FvHandle;
EFI_TPL OldTpl;
// //
// Search the FV that contain the caller's FFS first. // Search the FV that contain the caller's FFS first.
@ -226,7 +230,7 @@ PiLibGetSectionFromAnyFv (
FvHandle, FvHandle,
NameGuid, NameGuid,
SectionType, SectionType,
Instance, SectionInstance,
Buffer, Buffer,
Size Size
); );
@ -234,8 +238,6 @@ PiLibGetSectionFromAnyFv (
return EFI_SUCCESS; return EFI_SUCCESS;
} }
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
HandleBuffer = NULL; HandleBuffer = NULL;
Status = gBS->LocateHandleBuffer ( Status = gBS->LocateHandleBuffer (
ByProtocol, ByProtocol,
@ -248,26 +250,25 @@ PiLibGetSectionFromAnyFv (
goto Done; goto Done;
} }
for (Index = 0; Index < HandleCount; ++Index) { for (Index = 0; Index < HandleCount; Index++) {
// //
// Skip the FV that contain the caller's FFS // Skip the FV that contain the caller's FFS
// //
if (HandleBuffer[Index] == FvHandle) { if (HandleBuffer[Index] != FvHandle) {
continue; Status = GetSectionFromFv (
HandleBuffer[Index],
NameGuid,
SectionType,
SectionInstance,
Buffer,
Size
);
if (!EFI_ERROR (Status)) {
goto Done;
}
} }
Status = GetSectionFromFv (
HandleBuffer[Index],
NameGuid,
SectionType,
Instance,
Buffer,
Size
);
if (!EFI_ERROR (Status)) {
goto Done;
}
} }
if (Index == HandleCount) { if (Index == HandleCount) {
@ -276,8 +277,6 @@ PiLibGetSectionFromAnyFv (
Done: Done:
gBS->RestoreTPL (OldTpl);
if (HandleBuffer != NULL) { if (HandleBuffer != NULL) {
FreePool(HandleBuffer); FreePool(HandleBuffer);
} }
@ -286,42 +285,45 @@ Done:
} }
/** /**
Allocate and fill a buffer from a Firmware Section identified by a Firmware File GUID name, a Firmware Locates a requested firmware section within a file and returns it to a buffer allocated by this function.
Section type and instance number from the same Firmware Volume with the caller's FFS.
This functions first locates the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance for same Firmrware Volume
which also contains the FFS of the caller in order to carry out the Firmware Volume read operation.
The function then reads the Firmware Section found sepcifed by NameGuid, SectionType and Instance.
The search order for the section specified by SectionType within a Firmware File is defined by
EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization
Shared Architectural Elements for detailes.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section
data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to
read Firmware Section data from the Firmware File. If no such section specified is found to match ,
EFI_NOT_FOUND is returned.
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can be only called at TPL_NOTIFY and below.
If FvHandle is NULL, then ASSERT ();
If NameGuid is NULL, then ASSERT();
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param NameGuid The GUID name of a Firmware File. PiLibGetSectionFromCurrentFv () is used to read a specific section from a file within the same firmware volume from which
@param SectionType The Firmware Section type. the running image is loaded. If the specific file is found, the function searches the specifc firmware section with type SectionType.
@param Instance The instance number of Firmware Section to read from starting from 0. The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection ()
@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found. found in PI Specification.
@param Size On output, the size of Buffer.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section
@retval EFI_SUCCESS The image is found and data and size is returned. is not found, EFI_SECTION_PE32 will be used to try the search again. If no EFI_SECTION_PE32 section is found, EFI_NOT_FOUND
@retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL. is returned.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations. The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume. by this function. This function can be only called at TPL_NOTIFY and below.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
If NameGuid is NULL, then ASSERT();
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param NameGuid Pointer to an EFI_GUID, which indicates the file name from which the requested
section will be read. Type EFI_GUID is defined in
InstallProtocolInterface() in the UEFI 2.0 specification.
@param SectionType Indicates the section type to return. SectionType in conjunction with
SectionInstance indicates which section to return. Type
EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.
@param SectionInstance Indicates which instance of sections with a type of SectionType to return.
SectionType in conjunction with SectionInstance indicates which section to
return. SectionInstance is zero based.
@param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not
including the section header. Caller is responsible to free this memory.
@param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by
*Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/ **/
EFI_STATUS EFI_STATUS
@ -329,7 +331,7 @@ EFIAPI
PiLibGetSectionFromCurrentFv ( PiLibGetSectionFromCurrentFv (
IN CONST EFI_GUID *NameGuid, IN CONST EFI_GUID *NameGuid,
IN EFI_SECTION_TYPE SectionType, IN EFI_SECTION_TYPE SectionType,
IN UINTN Instance, IN UINTN SectionInstance,
OUT VOID **Buffer, OUT VOID **Buffer,
OUT UINTN *Size OUT UINTN *Size
) )
@ -338,7 +340,7 @@ PiLibGetSectionFromCurrentFv (
InternalImageHandleToFvHandle(gImageHandle), InternalImageHandleToFvHandle(gImageHandle),
NameGuid, NameGuid,
SectionType, SectionType,
Instance, SectionInstance,
Buffer, Buffer,
Size Size
); );
@ -346,49 +348,46 @@ PiLibGetSectionFromCurrentFv (
/** /**
Allocate and fill a buffer from the first Firmware Section in the same Firmware File as the caller of this function. Locates a requested firmware section within a file and returns it to a buffer allocated by this function.
The function will read the first Firmware Section found sepcifed by NameGuid and SectionType from the PiLibGetSectionFromCurrentFfs () searches the specifc firmware section with type SectionType in the same firmware file from
Firmware Volume specified by FvHandle. On this FvHandle, an EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance which the running image is loaded. The details of this search order is defined in description of
should be located succesfully in order to carry out the Firmware Volume operations. EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection () found in PI Specification.
The search order for the section type specified by SectionType in the Firmware File is using a depth-first If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section
and left-to-right algorithm through all sections. The first section found to match SectionType will be returned. is not found, EFI_SECTION_PE32 will be used to try the search again. If no EFI_SECTION_PE32 section is found, EFI_NOT_FOUND
is returned.
If SectionType is EFI_SECTION_PE32, EFI_SECTION_PE32 will be used as Firmware Section type
to read Firmware Section data from the Firmware File. If no such section exists, the function will try
to read a Firmware File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned. The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
by this function. This function can only be called at TPL_NOTIFY and below.
If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section
data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to If Buffer is NULL, then ASSERT();
read Firmware Section data from the Firmware File. If no such section exists, the function will try to read a Firmware If Size is NULL, then ASSERT().
File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned.
@param SectionType Indicates the section type to return. SectionType in conjunction with
The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated SectionInstance indicates which section to return. Type
by this function. This function can only be called at TPL_NOTIFY and below. EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.
@param SectionInstance Indicates which instance of sections with a type of SectionType to return.
If FvHandle is NULL and WithinImage is TRUE, then ASSERT (); SectionType in conjunction with SectionInstance indicates which section to
If NameGuid is NULL, then ASSERT(); return. SectionInstance is zero based.
If Buffer is NULL, then ASSERT(); @param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not
If Size is NULL, then ASSERT(). including the section header. Caller is responsible to free this memory.
@param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by
@param NameGuid The GUID name of a Firmware File. *Buffer.
@param SectionType The Firmware Section type.
@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found. @retval EFI_SUCCESS The image is found and data and size is returned.
@param Size On output, the size of Buffer. @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_SUCCESS The image is found and data and size is returned. @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found. @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PiLibGetSectionFromCurrentFfs ( PiLibGetSectionFromCurrentFfs (
IN EFI_SECTION_TYPE SectionType, IN EFI_SECTION_TYPE SectionType,
IN UINTN Instance, IN UINTN SectionInstance,
OUT VOID **Buffer, OUT VOID **Buffer,
OUT UINTN *Size OUT UINTN *Size
) )
@ -397,7 +396,7 @@ PiLibGetSectionFromCurrentFfs (
InternalImageHandleToFvHandle(gImageHandle), InternalImageHandleToFvHandle(gImageHandle),
&gEfiCallerIdGuid, &gEfiCallerIdGuid,
SectionType, SectionType,
Instance, SectionInstance,
Buffer, Buffer,
Size Size
); );