--- /dev/null
+/*++\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
+Module Name:\r
+\r
+ PeiDxeExtractGuidedSectionLib.c\r
+\r
+Abstract:\r
+\r
+ Provide generic extract guided section functions. \r
+\r
+--*/\r
+\r
+#include <PiPei.h>\r
+\r
+#include <Library/DebugLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/ExtractGuidedSectionLib.h>\r
+\r
+STATIC GUID *mExtractHandlerGuidTable;\r
+STATIC UINT32 mNumberOfExtractHandler;\r
+\r
+STATIC EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable;\r
+STATIC EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable;\r
+\r
+/**
+ Construtor allocates the global memory to store the registered guid and Handler list.\r
+
+ @retval RETURN_SUCCESS Allocate the global memory space to store guid and funciton tables.\r
+ @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PeiDxeExtractGuidedSectionLibConstructor (\r
+ )\r
+{\r
+ //\r
+ // Allocate global pool space to store the registered handler and its guid value.\r
+ //\r
+ mExtractHandlerGuidTable = (GUID *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID));\r
+ if (mExtractHandlerGuidTable == NULL) {\r
+ return RETURN_OUT_OF_RESOURCES;\r
+ }\r
+ \r
+ mExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER));\r
+ if (mExtractDecodeHandlerTable == NULL) {\r
+ return RETURN_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ mExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER));\r
+ if (mExtractGetInfoHandlerTable == NULL) {\r
+ return RETURN_OUT_OF_RESOURCES;\r
+ }\r
+ \r
+ //\r
+ // the initialized number is Zero.\r
+ //\r
+ mNumberOfExtractHandler = 0;\r
+ \r
+ return RETURN_SUCCESS;\r
+}\r
+\r
+/**
+ Get the supported exract guided section Handler guid list.\r
+ If ExtractHandlerGuidTable = NULL, then ASSERT.\r
+\r
+ @param[in, out] ExtractHandlerGuidTable The extract Handler guid pointer list.
+\r
+ @retval return the number of the supported extract guided Handler.
+**/\r
+UINTN\r
+EFIAPI\r
+ExtractGuidedSectionGetGuidList (\r
+ IN OUT GUID **ExtractHandlerGuidTable\r
+ )\r
+{\r
+ ASSERT (ExtractHandlerGuidTable != NULL);\r
+\r
+ *ExtractHandlerGuidTable = mExtractHandlerGuidTable;\r
+ return mNumberOfExtractHandler;\r
+}\r
+\r
+/**
+ Register Guided Section Extract and GetInfo handler.\r
+\r
+ @param[in] SectionGuid The guid matches this Extraction function.
+ @param[in] GetInfoHandler Function to get info from guided section.\r
+ @param[in] DecodeHandler Function to extract guided section.
+
+ @retval RETURN_SUCCESS Register Guided Section Extract function successfully.
+ @retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function. \r
+ @retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+ExtractGuidedSectionRegisterHandlers (\r
+ IN CONST GUID *SectionGuid,\r
+ IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler,\r
+ IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler\r
+ )\r
+{\r
+ //\r
+ // Check input paramter.\r
+ //\r
+ if (SectionGuid == NULL) {\r
+ return RETURN_INVALID_PARAMETER;\r
+ }\r
+ //\r
+ // Check the global table is enough to contain new Handler.\r
+ //\r
+ if (mNumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) {\r
+ return RETURN_OUT_OF_RESOURCES;\r
+ }\r
+ \r
+ //\r
+ // Register new Handler and guid value.\r
+ //\r
+ CopyGuid (&mExtractHandlerGuidTable [mNumberOfExtractHandler], SectionGuid);\r
+ mExtractDecodeHandlerTable [mNumberOfExtractHandler] = DecodeHandler;\r
+ mExtractGetInfoHandlerTable [mNumberOfExtractHandler++] = GetInfoHandler;\r
+ \r
+ return RETURN_SUCCESS;\r
+}\r
+\r
+/**
+ Get information from the guided section. This function first gets the guid value\r
+ from guided section header, then match this guid in the registered extract Handler list\r
+ to its corresponding getinfo Handler. \r
+ If not found, RETURN_UNSUPPORTED will be return. \r
+ If found, it will call the getinfo Handler to get the required size and attribute.\r
+\r
+ It will ASSERT () if the pointer to OutputBufferSize is NULL.\r
+ It will ASSERT () if the pointer to ScratchBufferSize is NULL.
+ It will ASSERT () if the pointer to SectionAttribute is NULL.\r
+\r
+ @param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
+ @param[out] OutputBufferSize The size of OutputBuffer.\r
+ @param[out] ScratchBufferSize The size of ScratchBuffer. \r
+ @param[out] SectionAttribute The attribute of the input guided section.\r
+
+ @retval RETURN_SUCCESS Get the required information successfully.\r
+ @retval RETURN_UNSUPPORTED Guided section data is not supported.\r
+ @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+ExtractGuidedSectionGetInfo (\r
+ IN CONST VOID *InputSection,\r
+ OUT UINT32 *OutputBufferSize,\r
+ OUT UINT32 *ScratchBufferSize,\r
+ OUT UINT16 *SectionAttribute \r
+ )\r
+{\r
+ UINT32 Index;\r
+ \r
+ if (InputSection == NULL) {\r
+ return RETURN_INVALID_PARAMETER;\r
+ }\r
+ \r
+ ASSERT (OutputBufferSize != NULL);\r
+ ASSERT (ScratchBufferSize != NULL);\r
+ ASSERT (SectionAttribute != NULL);\r
+ \r
+ //\r
+ // Search the match registered GetInfo handler for the input guided section.\r
+ //\r
+ for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
+ if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
+ break;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Not found, the input guided section is not supported. \r
+ //\r
+ if (Index == mNumberOfExtractHandler) {\r
+ return RETURN_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // Call the match handler to getinfo for the input section data.\r
+ //\r
+ return mExtractGetInfoHandlerTable [Index] (\r
+ InputSection,\r
+ OutputBufferSize,\r
+ ScratchBufferSize,\r
+ SectionAttribute\r
+ );\r
+}\r
+\r
+/**
+ Extract data from the guided section. This function first gets the guid value\r
+ from guided section header, then match this guid in the registered extract Handler list\r
+ to its corresponding extract Handler. \r
+ If not found, RETURN_UNSUPPORTED will be return. \r
+ If found, it will call this extract Handler to get output data and AuthenticationStatus.
+\r
+ It will ASSERT () if the pointer to OutputBuffer is NULL.\r
+ It will ASSERT () if the pointer to AuthenticationStatus is NULL.\r
+\r
+ @param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
+ @param[out] OutputBuffer OutputBuffer to point the start of the section's contents \r
+ if guided data is not required prcessing. Otherwise,\r
+ OutputBuffer to contain the output data, which is \r
+ allocated by the caller.\r
+ @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. \r
+ @param[out] AuthenticationStatus \r
+ A pointer to a caller-allocated UINT32 that indicates the\r
+ authentication status of the output buffer.
+
+ @retval RETURN_SUCCESS Get the output data, size and AuthenticationStatus successfully.\r
+ @retval RETURN_UNSUPPORTED Guided section data is not supported to be decoded.\r
+ @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
+
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+ExtractGuidedSectionDecode (\r
+ IN CONST VOID *InputSection,\r
+ OUT VOID **OutputBuffer,\r
+ OUT VOID *ScratchBuffer, OPTIONAL\r
+ OUT UINT32 *AuthenticationStatus \r
+ )\r
+{\r
+ UINT32 Index;\r
+ \r
+ if (InputSection == NULL) {\r
+ return RETURN_INVALID_PARAMETER;\r
+ }\r
+ \r
+ ASSERT (OutputBuffer != NULL);\r
+ ASSERT (AuthenticationStatus != NULL);\r
+\r
+ //\r
+ // Search the match registered GetInfo handler for the input guided section.\r
+ //\r
+ for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
+ if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
+ break;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Not found, the input guided section is not supported. \r
+ //\r
+ if (Index == mNumberOfExtractHandler) {\r
+ return RETURN_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // Call the match handler to getinfo for the input section data.\r
+ //\r
+ return mExtractDecodeHandlerTable [Index] (\r
+ InputSection,\r
+ OutputBuffer,\r
+ ScratchBuffer,\r
+ AuthenticationStatus\r
+ );\r
+}\r
projects / mirror_edk2.git / blobdiff