4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provide generic extract guided section functions for PEI phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync http://opensource.org/licenses/bsd-license.php.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <PiPei.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/DebugLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/PcdLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/BaseMemoryLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/HobLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/ExtractGuidedSectionLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PEI_EXTRACT_HANDLER_INFO_SIGNATURE SIGNATURE_32 ('P', 'E', 'H', 'I')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Signature;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 NumberOfExtractHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GUID *ExtractHandlerGuidTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EXTRACT_GUIDED_SECTION_DECODE_HANDLER *ExtractDecodeHandlerTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *ExtractGetInfoHandlerTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Build guid hob for the global memory to store the registered guid and Handler list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If GuidHob exists, HandlerInfo will be directly got from Guid hob data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] InfoPointer The pointer to pei handler information structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and function tables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPeiGetExtractGuidedSectionHandlerInfo (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO **InfoPointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PEI_HOB_POINTERS Hob;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // First try to get handler information from guid hob specified by CallerId.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GetHobList ());
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while (Hob.Raw != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CompareGuid (&(Hob.Guid->Name), &gEfiCallerIdGuid)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo = (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *) GET_GUID_HOB_DATA (Hob.Guid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (HandlerInfo->Signature == PEI_EXTRACT_HANDLER_INFO_SIGNATURE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Update Table Pointer when hob start address is changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (HandlerInfo->ExtractHandlerGuidTable != (GUID *) (HandlerInfo + 1)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractHandlerGuidTable = (GUID *) (HandlerInfo + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (UINT8 *)HandlerInfo->ExtractHandlerGuidTable +
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (UINT8 *)HandlerInfo->ExtractDecodeHandlerTable +
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdGet32 (PcdMaximumGuidedExtractHandler) *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return HandlerInfo pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *InfoPointer = HandlerInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Hob.Raw = GET_NEXT_HOB (Hob);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, Hob.Raw);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If Guid Hob is not found, Build CallerId Guid hob to store Handler Info
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo = BuildGuidHob (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &gEfiCallerIdGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sizeof (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO) +
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdGet32 (PcdMaximumGuidedExtractHandler) *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (sizeof (GUID) + sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER) + sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (HandlerInfo == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // No enough resource to build guid hob.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *InfoPointer = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_OUT_OF_RESOURCES;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Init HandlerInfo structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->Signature = PEI_EXTRACT_HANDLER_INFO_SIGNATURE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->NumberOfExtractHandler = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractHandlerGuidTable = (GUID *) (HandlerInfo + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (UINT8 *)HandlerInfo->ExtractHandlerGuidTable +
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (UINT8 *)HandlerInfo->ExtractDecodeHandlerTable +
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdGet32 (PcdMaximumGuidedExtractHandler) *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // return the created HandlerInfo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *InfoPointer = HandlerInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieve the list GUIDs that have been registered through ExtractGuidedSectionRegisterHandlers().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and caller must treat this array of GUIDs as read-only data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ExtractHandlerGuidTable is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ExtractGuidedSectionRegisterHandlers().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return the number of the supported extract guided Handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUINTN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncExtractGuidedSectionGetGuidList (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT GUID **ExtractHandlerGuidTable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (ExtractHandlerGuidTable != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get all registered handler information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *ExtractHandlerGuidTable = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get GuidTable and Table Number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (HandlerInfo != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *ExtractHandlerGuidTable = HandlerInfo->ExtractHandlerGuidTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return HandlerInfo->NumberOfExtractHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for a specific GUID section type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SectionGuid is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If GetInfoHandler is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DecodeHandler is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SectionGuid A pointer to the GUID associated with the the handlers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the GUIDed section type being registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] GetInfoHandler The pointer to a function that examines a GUIDed section and returns the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the decoded buffer and the size of an optional scratch buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync required to actually decode the data in a GUIDed section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DecodeHandler The pointer to a function that decodes a GUIDed section into a caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated output buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The handlers were registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncExtractGuidedSectionRegisterHandlers (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST GUID *SectionGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Index;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check input paramter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (SectionGuid != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (GetInfoHandler != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (DecodeHandler != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get the registered handler information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search the match registered GetInfo handler for the input guided section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (HandlerInfo != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionGuid)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the guided handler has been registered before, only update its handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractDecodeHandlerTable [Index] = DecodeHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractGetInfoHandlerTable [Index] = GetInfoHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return RETURN_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check the global table is enough to contain new Handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (HandlerInfo->NumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return RETURN_OUT_OF_RESOURCES;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Register new Handler and guid value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyGuid (HandlerInfo->ExtractHandlerGuidTable + HandlerInfo->NumberOfExtractHandler, SectionGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractDecodeHandlerTable [HandlerInfo->NumberOfExtractHandler] = DecodeHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerInfo->ExtractGetInfoHandlerTable [HandlerInfo->NumberOfExtractHandler++] = GetInfoHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return RETURN_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The selected handler is used to retrieve and return the size of the decoded buffer and the size of an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync optional scratch buffer required to actually decode the data in a GUIDed section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Examines a GUIDed section specified by InputSection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then RETURN_UNSUPPORTED is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If InputSection is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If OutputBufferSize is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScratchBufferSize is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SectionAttribute is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required if the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by InputSection were decoded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space if the buffer specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InputSection were decoded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GUID_DEFINED_SECTION in the PI Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Get the required information successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the GUIDs registered with ExtractGuidedSectionRegisterHandlers().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others The return status from the handler associated with the GUID retrieved from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the section specified by InputSection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncExtractGuidedSectionGetInfo (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST VOID *InputSection,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT32 *OutputBufferSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT32 *ScratchBufferSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT16 *SectionAttribute
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Index;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GUID *SectionDefinitionGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check input paramter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (InputSection != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (OutputBufferSize != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (ScratchBufferSize != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (SectionAttribute != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get all registered handler information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (IS_SECTION2 (InputSection)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SectionDefinitionGuid = &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)->SectionDefinitionGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SectionDefinitionGuid = &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search the match registered GetInfo handler for the input guided section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (HandlerInfo != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionDefinitionGuid)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Call the match handler to get information for the input section data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return HandlerInfo->ExtractGetInfoHandlerTable [Index] (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InputSection,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OutputBufferSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScratchBufferSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SectionAttribute
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Not found, the input guided section is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return RETURN_UNSUPPORTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The selected handler is used to decode the data in a GUIDed section and return the result in a caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated output buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Decodes the GUIDed section specified by InputSection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then RETURN_UNSUPPORTED is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If InputSection is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If OutputBuffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If AuthenticationStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AuthenticationStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A pointer to the authentication status of the decoded output buffer. See the definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The buffer specified by InputSection was decoded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncExtractGuidedSectionDecode (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST VOID *InputSection,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT VOID **OutputBuffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *ScratchBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT32 *AuthenticationStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Index;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GUID *SectionDefinitionGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check input parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (InputSection != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (OutputBuffer != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (AuthenticationStatus != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get all registered handler information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (IS_SECTION2 (InputSection)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SectionDefinitionGuid = &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)->SectionDefinitionGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SectionDefinitionGuid = &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search the match registered Extract handler for the input guided section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (HandlerInfo != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionDefinitionGuid)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Call the match handler to extract raw data for the input guided section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return HandlerInfo->ExtractDecodeHandlerTable [Index] (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InputSection,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OutputBuffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScratchBuffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AuthenticationStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Not found, the input guided section is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return RETURN_UNSUPPORTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EXTRACT_GUIDED_SECTION_DECODE_HANDLER for a specific GUID section type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the handlers associated with SectionGuid and returns them in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetInfoHandler and DecodeHandler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the GUID value specified by SectionGuid has not been registered, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return RETURN_NOT_FOUND.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SectionGuid is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section type being retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the size of the decoded buffer and the size of an optional scratch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer required to actually decode the data in a GUIDed section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter that may be NULL. If it is NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the previously registered handler is not returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated output buffer. This is an optional parameter that may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is NULL, then the previously registered handler is not returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The handlers were retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_NOT_FOUND No handlers have been registered with the specified GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncExtractGuidedSectionGetHandlers (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST GUID *SectionGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *GetInfoHandler, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EXTRACT_GUIDED_SECTION_DECODE_HANDLER *DecodeHandler OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Index;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check input parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (SectionGuid != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get the registered handler information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search the match registered GetInfo handler for the input guided section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (HandlerInfo != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionGuid)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the guided handler has been registered before, then return the registered handlers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (GetInfoHandler != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *GetInfoHandler = HandlerInfo->ExtractGetInfoHandlerTable[Index];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (DecodeHandler != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *DecodeHandler = HandlerInfo->ExtractDecodeHandlerTable[Index];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return RETURN_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return RETURN_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}