--- /dev/null
+/** @file\r
+ MDE PI library functions and macros\r
+\r
+ Copyright (c) 2007, Intel Corporation \r
+ All rights reserved. This program and the accompanying materials \r
+ are licensed and made available under the terms and conditions of the BSD License \r
+ which accompanies this distribution. The full text of the license may be found at \r
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+**/\r
+\r
+#ifndef __PI_LIB_H__\r
+#define __PI_LIB_H__\r
+\r
+#include <Pi/PiFirmwareFile.h>\r
+\r
+\r
+/**\r
+ Locates a requested firmware section within a file and returns it to a buffer allocated by this function. \r
+\r
+ GetSectionFromAnyFv () is used to read a specific section from a file within a firmware volume. The function\r
+ will search the first file with the specified name in all firmware volumes in the system. The search order for firmware \r
+ volumes in the system is determistic but abitrary if no new firmware volume is added into the system between \r
+ each calls of this function. \r
+\r
+ After the specific file is located, the function searches the specifc firmware section with type SectionType in this file. \r
+ The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection () \r
+ found in PI Specification.\r
+\r
+ If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section \r
+ 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 \r
+ is returned.\r
+\r
+ The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
+ by this function. This function can only be called at TPL_NOTIFY and below.\r
+\r
+ If NameGuid is NULL, then ASSERT();\r
+ If Buffer is NULL, then ASSERT();\r
+ If Size is NULL, then ASSERT().\r
+\r
+ @param NameGuid Pointer to an EFI_GUID, which indicates the file name from which the requested \r
+ section will be read. Type EFI_GUID is defined in \r
+ InstallProtocolInterface() in the UEFI 2.0 specification. \r
+ @param SectionType Indicates the section type to return. SectionType in conjunction with \r
+ SectionInstance indicates which section to return. Type \r
+ EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.\r
+ @param SectionInstance Indicates which instance of sections with a type of SectionType to return. \r
+ SectionType in conjunction with SectionInstance indicates which section to \r
+ return. SectionInstance is zero based.\r
+ @param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not \r
+ including the section header. Caller is responsible to free this memory.\r
+ @param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by \r
+ *Buffer.\r
+\r
+ @retval EFI_SUCCESS The image is found and data and size is returned.\r
+ @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
+ @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
+ @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
+ @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GetSectionFromAnyFv (\r
+ IN CONST EFI_GUID *NameGuid,\r
+ IN EFI_SECTION_TYPE SectionType,\r
+ IN UINTN SectionInstance,\r
+ OUT VOID **Buffer,\r
+ OUT UINTN *Size\r
+ );\r
+\r
+/**\r
+ Locates a requested firmware section within a file and returns it to a buffer allocated by this function. \r
+\r
+ GetSectionFromFv () is used to read a specific section from a file within the same firmware volume from which\r
+ the running image is loaded. If the specific file is found, the function searches the specifc firmware section with type SectionType. \r
+ The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection () \r
+ found in PI Specification.\r
+\r
+ If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section \r
+ 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 \r
+ is returned.\r
+\r
+ The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
+ by this function. This function can be only called at TPL_NOTIFY and below.\r
+\r
+ If NameGuid is NULL, then ASSERT();\r
+ If Buffer is NULL, then ASSERT();\r
+ If Size is NULL, then ASSERT().\r
+\r
+ @param NameGuid Pointer to an EFI_GUID, which indicates the file name from which the requested \r
+ section will be read. Type EFI_GUID is defined in \r
+ InstallProtocolInterface() in the UEFI 2.0 specification. \r
+ @param SectionType Indicates the section type to return. SectionType in conjunction with \r
+ SectionInstance indicates which section to return. Type \r
+ EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.\r
+ @param SectionInstance Indicates which instance of sections with a type of SectionType to return. \r
+ SectionType in conjunction with SectionInstance indicates which section to \r
+ return. SectionInstance is zero based.\r
+ @param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not \r
+ including the section header. Caller is responsible to free this memory.\r
+ @param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by \r
+ *Buffer.\r
+\r
+\r
+ @retval EFI_SUCCESS The image is found and data and size is returned.\r
+ @retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
+ @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
+ @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
+ @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
+ @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
+ \r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GetSectionFromFv (\r
+ IN CONST EFI_GUID *NameGuid,\r
+ IN EFI_SECTION_TYPE SectionType,\r
+ IN UINTN SectionInstance,\r
+ OUT VOID **Buffer,\r
+ OUT UINTN *Size\r
+ );\r
+\r
+\r
+/**\r
+ Locates a requested firmware section within a file and returns it to a buffer allocated by this function. \r
+\r
+ GetSectionFromFfs () searches the specifc firmware section with type SectionType in the same firmware file from\r
+ which the running image is loaded. The details of this search order is defined in description of \r
+ EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection () found in PI Specification.\r
+\r
+ If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section \r
+ 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 \r
+ is returned.\r
+\r
+\r
+ The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
+ by this function. This function can only be called at TPL_NOTIFY and below.\r
+\r
+ If Buffer is NULL, then ASSERT();\r
+ If Size is NULL, then ASSERT().\r
+\r
+ @param SectionType Indicates the section type to return. SectionType in conjunction with \r
+ SectionInstance indicates which section to return. Type \r
+ EFI_SECTION_TYPE is defined in EFI_COMMON_SECTION_HEADER.\r
+ @param SectionInstance Indicates which instance of sections with a type of SectionType to return. \r
+ SectionType in conjunction with SectionInstance indicates which section to \r
+ return. SectionInstance is zero based.\r
+ @param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not \r
+ including the section header. Caller is responsible to free this memory.\r
+ @param Size Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by \r
+ *Buffer.\r
+\r
+ @retval EFI_SUCCESS The image is found and data and size is returned.\r
+ @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
+ @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
+ @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
+ @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
+ \r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GetSectionFromFfs (\r
+ IN EFI_SECTION_TYPE SectionType,\r
+ IN UINTN SectionInstance,\r
+ OUT VOID **Buffer,\r
+ OUT UINTN *Size\r
+ );\r
+\r
+#endif\r
+\r
projects / mirror_edk2.git / blobdiff