[mirror_edk2.git] / MdeModulePkg / Library / LzmaCustomDecompressLib / F86GuidedSectionExtraction.c

/** @file\r
  LZMA Decompress GUIDed Section Extraction Library, which produces LZMA custom\r
  decompression algorithm with the converter for the different arch code.\r
  It wraps Lzma decompress interfaces to GUIDed Section Extraction interfaces\r
  and registers them into GUIDed handler table.\r
\r
  Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "LzmaDecompressLibInternal.h"\r
#include "Sdk/C/Bra.h"\r
\r
/**\r
  Examines a GUIDed section and returns the size of the decoded buffer and the\r
  size of an scratch buffer required to actually decode the data in a GUIDed section.\r
\r
  Examines a GUIDed section specified by InputSection.\r
  If GUID for InputSection does not match the GUID that this handler supports,\r
  then RETURN_UNSUPPORTED is returned.\r
  If the required information can not be retrieved from InputSection,\r
  then RETURN_INVALID_PARAMETER is returned.\r
  If the GUID of InputSection does match the GUID that this handler supports,\r
  then the size required to hold the decoded buffer is returned in OututBufferSize,\r
  the size of an optional scratch buffer is returned in ScratchSize, and the Attributes field\r
  from EFI_GUID_DEFINED_SECTION header of InputSection is returned in SectionAttribute.\r
\r
  If InputSection is NULL, then ASSERT().\r
  If OutputBufferSize is NULL, then ASSERT().\r
  If ScratchBufferSize is NULL, then ASSERT().\r
  If SectionAttribute is NULL, then ASSERT().\r
\r
\r
  @param[in]  InputSection       A pointer to a GUIDed section of an FFS formatted file.\r
  @param[out] OutputBufferSize   A pointer to the size, in bytes, of an output buffer required\r
                                 if the buffer specified by InputSection were decoded.\r
  @param[out] ScratchBufferSize  A pointer to the size, in bytes, required as scratch space\r
                                 if the buffer specified by InputSection were decoded.\r
  @param[out] SectionAttribute   A pointer to the attributes of the GUIDed section. See the Attributes\r
                                 field of EFI_GUID_DEFINED_SECTION in the PI Specification.\r
\r
  @retval  RETURN_SUCCESS            The information about InputSection was returned.\r
  @retval  RETURN_UNSUPPORTED        The section specified by InputSection does not match the GUID this handler supports.\r
  @retval  RETURN_INVALID_PARAMETER  The information can not be retrieved from the section specified by InputSection.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
LzmaArchGuidedSectionGetInfo (\r
  IN  CONST VOID  *InputSection,\r
  OUT UINT32      *OutputBufferSize,\r
  OUT UINT32      *ScratchBufferSize,\r
  OUT UINT16      *SectionAttribute\r
  )\r
{\r
  ASSERT (InputSection != NULL);\r
  ASSERT (OutputBufferSize != NULL);\r
  ASSERT (ScratchBufferSize != NULL);\r
  ASSERT (SectionAttribute != NULL);\r
\r
  if (IS_SECTION2 (InputSection)) {\r
    if (!CompareGuid (\r
           &gLzmaF86CustomDecompressGuid,\r
           &(((EFI_GUID_DEFINED_SECTION2 *)InputSection)->SectionDefinitionGuid)\r
           ))\r
    {\r
      return RETURN_INVALID_PARAMETER;\r
    }\r
\r
    *SectionAttribute = ((EFI_GUID_DEFINED_SECTION2 *)InputSection)->Attributes;\r
\r
    return LzmaUefiDecompressGetInfo (\r
             (UINT8 *)InputSection + ((EFI_GUID_DEFINED_SECTION2 *)InputSection)->DataOffset,\r
             SECTION2_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION2 *)InputSection)->DataOffset,\r
             OutputBufferSize,\r
             ScratchBufferSize\r
             );\r
  } else {\r
    if (!CompareGuid (\r
           &gLzmaF86CustomDecompressGuid,\r
           &(((EFI_GUID_DEFINED_SECTION *)InputSection)->SectionDefinitionGuid)\r
           ))\r
    {\r
      return RETURN_INVALID_PARAMETER;\r
    }\r
\r
    *SectionAttribute = ((EFI_GUID_DEFINED_SECTION *)InputSection)->Attributes;\r
\r
    return LzmaUefiDecompressGetInfo (\r
             (UINT8 *)InputSection + ((EFI_GUID_DEFINED_SECTION *)InputSection)->DataOffset,\r
             SECTION_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION *)InputSection)->DataOffset,\r
             OutputBufferSize,\r
             ScratchBufferSize\r
             );\r
  }\r
}\r
\r
/**\r
  Decompress a LZAM compressed GUIDed section into a caller allocated output buffer.\r
\r
  Decodes the GUIDed section specified by InputSection.\r
  If GUID for InputSection does not match the GUID that this handler supports, then RETURN_UNSUPPORTED is returned.\r
  If the data in InputSection can not be decoded, then RETURN_INVALID_PARAMETER is returned.\r
  If the GUID of InputSection does match the GUID that this handler supports, then InputSection\r
  is decoded into the buffer specified by OutputBuffer and the authentication status of this\r
  decode operation is returned in AuthenticationStatus.  If the decoded buffer is identical to the\r
  data in InputSection, then OutputBuffer is set to point at the data in InputSection.  Otherwise,\r
  the decoded data will be placed in caller allocated buffer specified by OutputBuffer.\r
\r
  If InputSection is NULL, then ASSERT().\r
  If OutputBuffer is NULL, then ASSERT().\r
  If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().\r
  If AuthenticationStatus is NULL, then ASSERT().\r
\r
\r
  @param[in]  InputSection  A pointer to a GUIDed section of an FFS formatted file.\r
  @param[out] OutputBuffer  A pointer to a buffer that contains the result of a decode operation.\r
  @param[out] ScratchBuffer A caller allocated buffer that may be required by this function\r
                            as a scratch buffer to perform the decode operation.\r
  @param[out] AuthenticationStatus\r
                            A pointer to the authentication status of the decoded output buffer.\r
                            See the definition of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI\r
                            section of the PI Specification. EFI_AUTH_STATUS_PLATFORM_OVERRIDE must\r
                            never be set by this handler.\r
\r
  @retval  RETURN_SUCCESS            The buffer specified by InputSection was decoded.\r
  @retval  RETURN_UNSUPPORTED        The section specified by InputSection does not match the GUID this handler supports.\r
  @retval  RETURN_INVALID_PARAMETER  The section specified by InputSection can not be decoded.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
LzmaArchGuidedSectionExtraction (\r
  IN CONST  VOID    *InputSection,\r
  OUT       VOID    **OutputBuffer,\r
  OUT       VOID    *ScratchBuffer         OPTIONAL,\r
  OUT       UINT32  *AuthenticationStatus\r
  )\r
{\r
  EFI_GUID    *InputGuid;\r
  VOID        *Source;\r
  UINTN       SourceSize;\r
  EFI_STATUS  Status;\r
  UINT32      X86State;\r
  UINT32      OutputBufferSize;\r
  UINT32      ScratchBufferSize;\r
\r
  ASSERT (OutputBuffer != NULL);\r
  ASSERT (InputSection != NULL);\r
\r
  if (IS_SECTION2 (InputSection)) {\r
    InputGuid  = &(((EFI_GUID_DEFINED_SECTION2 *)InputSection)->SectionDefinitionGuid);\r
    Source     = (UINT8 *)InputSection + ((EFI_GUID_DEFINED_SECTION2 *)InputSection)->DataOffset;\r
    SourceSize = SECTION2_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION2 *)InputSection)->DataOffset;\r
  } else {\r
    InputGuid  = &(((EFI_GUID_DEFINED_SECTION *)InputSection)->SectionDefinitionGuid);\r
    Source     = (UINT8 *)InputSection + ((EFI_GUID_DEFINED_SECTION *)InputSection)->DataOffset;\r
    SourceSize = SECTION_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION *)InputSection)->DataOffset;\r
  }\r
\r
  if (!CompareGuid (&gLzmaF86CustomDecompressGuid, InputGuid)) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Authentication is set to Zero, which may be ignored.\r
  //\r
  *AuthenticationStatus = 0;\r
\r
  Status = LzmaUefiDecompress (\r
             Source,\r
             SourceSize,\r
             *OutputBuffer,\r
             ScratchBuffer\r
             );\r
\r
  //\r
  // After decompress, the data need to be converted to the raw data.\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    Status = LzmaUefiDecompressGetInfo (\r
               Source,\r
               (UINT32)SourceSize,\r
               &OutputBufferSize,\r
               &ScratchBufferSize\r
               );\r
\r
    if (!EFI_ERROR (Status)) {\r
      x86_Convert_Init (X86State);\r
      x86_Convert (*OutputBuffer, OutputBufferSize, 0, &X86State, 0);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Register LzmaArchDecompress and LzmaArchDecompressGetInfo handlers with LzmaF86CustomDecompressGuid.\r
\r
  @retval  RETURN_SUCCESS            Register successfully.\r
  @retval  RETURN_OUT_OF_RESOURCES   No enough memory to store this handler.\r
**/\r
EFI_STATUS\r
EFIAPI\r
LzmaArchDecompressLibConstructor (\r
  VOID\r
  )\r
{\r
  return ExtractGuidedSectionRegisterHandlers (\r
           &gLzmaF86CustomDecompressGuid,\r
           LzmaArchGuidedSectionGetInfo,\r
           LzmaArchGuidedSectionExtraction\r
           );\r
}\r
Commit	Line	Data
11ff2c71	1	/** @file\r
d1102dba	2	LZMA Decompress GUIDed Section Extraction Library, which produces LZMA custom\r
11ff2c71 LG	3	decompression algorithm with the converter for the different arch code.\r
	4	It wraps Lzma decompress interfaces to GUIDed Section Extraction interfaces\r
	5	and registers them into GUIDed handler table.\r
	6	\r
d1102dba	7	Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>\r
9d510e61	8	SPDX-License-Identifier: BSD-2-Clause-Patent\r
11ff2c71 LG	9	\r
	10	**/\r
	11	\r
	12	#include "LzmaDecompressLibInternal.h"\r
	13	#include "Sdk/C/Bra.h"\r
	14	\r
	15	/**\r
	16	Examines a GUIDed section and returns the size of the decoded buffer and the\r
	17	size of an scratch buffer required to actually decode the data in a GUIDed section.\r
	18	\r
d1102dba	19	Examines a GUIDed section specified by InputSection.\r
11ff2c71	20	If GUID for InputSection does not match the GUID that this handler supports,\r
d1102dba	21	then RETURN_UNSUPPORTED is returned.\r
11ff2c71 LG	22	If the required information can not be retrieved from InputSection,\r
	23	then RETURN_INVALID_PARAMETER is returned.\r
	24	If the GUID of InputSection does match the GUID that this handler supports,\r
	25	then the size required to hold the decoded buffer is returned in OututBufferSize,\r
	26	the size of an optional scratch buffer is returned in ScratchSize, and the Attributes field\r
	27	from EFI_GUID_DEFINED_SECTION header of InputSection is returned in SectionAttribute.\r
d1102dba	28	\r
11ff2c71 LG	29	If InputSection is NULL, then ASSERT().\r
	30	If OutputBufferSize is NULL, then ASSERT().\r
	31	If ScratchBufferSize is NULL, then ASSERT().\r
	32	If SectionAttribute is NULL, then ASSERT().\r
	33	\r
	34	\r
	35	@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
	36	@param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required\r
	37	if the buffer specified by InputSection were decoded.\r
	38	@param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space\r
	39	if the buffer specified by InputSection were decoded.\r
	40	@param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes\r
	41	field of EFI_GUID_DEFINED_SECTION in the PI Specification.\r
	42	\r
	43	@retval RETURN_SUCCESS The information about InputSection was returned.\r
	44	@retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.\r
	45	@retval RETURN_INVALID_PARAMETER The information can not be retrieved from the section specified by InputSection.\r
	46	\r
	47	**/\r
	48	RETURN_STATUS\r
	49	EFIAPI\r
	50	LzmaArchGuidedSectionGetInfo (\r
	51	IN CONST VOID *InputSection,\r
	52	OUT UINT32 *OutputBufferSize,\r
	53	OUT UINT32 *ScratchBufferSize,\r
	54	OUT UINT16 *SectionAttribute\r
	55	)\r
	56	{\r
	57	ASSERT (InputSection != NULL);\r
	58	ASSERT (OutputBufferSize != NULL);\r
	59	ASSERT (ScratchBufferSize != NULL);\r
	60	ASSERT (SectionAttribute != NULL);\r
	61	\r
	62	if (IS_SECTION2 (InputSection)) {\r
	63	if (!CompareGuid (\r
1436aea4 MK	64	&gLzmaF86CustomDecompressGuid,\r
	65	&(((EFI_GUID_DEFINED_SECTION2 *)InputSection)->SectionDefinitionGuid)\r
	66	))\r
	67	{\r
11ff2c71 LG	68	return RETURN_INVALID_PARAMETER;\r
	69	}\r
	70	\r
1436aea4	71	SectionAttribute = ((EFI_GUID_DEFINED_SECTION2 )InputSection)->Attributes;\r
11ff2c71 LG	72	\r
11ff2c71 LG	73	return LzmaUefiDecompressGetInfo (\r
1436aea4 MK	74	(UINT8 )InputSection + ((EFI_GUID_DEFINED_SECTION2 )InputSection)->DataOffset,\r
1436aea4 MK	75	SECTION2_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION2 *)InputSection)->DataOffset,\r
11ff2c71 LG	76	OutputBufferSize,\r
	77	ScratchBufferSize\r
	78	);\r
	79	} else {\r
	80	if (!CompareGuid (\r
1436aea4 MK	81	&gLzmaF86CustomDecompressGuid,\r
	82	&(((EFI_GUID_DEFINED_SECTION *)InputSection)->SectionDefinitionGuid)\r
	83	))\r
	84	{\r
11ff2c71 LG	85	return RETURN_INVALID_PARAMETER;\r
	86	}\r
	87	\r
1436aea4	88	SectionAttribute = ((EFI_GUID_DEFINED_SECTION )InputSection)->Attributes;\r
11ff2c71 LG	89	\r
11ff2c71 LG	90	return LzmaUefiDecompressGetInfo (\r
1436aea4 MK	91	(UINT8 )InputSection + ((EFI_GUID_DEFINED_SECTION )InputSection)->DataOffset,\r
1436aea4 MK	92	SECTION_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION *)InputSection)->DataOffset,\r
11ff2c71 LG	93	OutputBufferSize,\r
	94	ScratchBufferSize\r
	95	);\r
	96	}\r
	97	}\r
	98	\r
	99	/**\r
	100	Decompress a LZAM compressed GUIDed section into a caller allocated output buffer.\r
d1102dba LG	101	\r
	102	Decodes the GUIDed section specified by InputSection.\r
	103	If GUID for InputSection does not match the GUID that this handler supports, then RETURN_UNSUPPORTED is returned.\r
11ff2c71 LG	104	If the data in InputSection can not be decoded, then RETURN_INVALID_PARAMETER is returned.\r
	105	If the GUID of InputSection does match the GUID that this handler supports, then InputSection\r
	106	is decoded into the buffer specified by OutputBuffer and the authentication status of this\r
	107	decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the\r
	108	data in InputSection, then OutputBuffer is set to point at the data in InputSection. Otherwise,\r
	109	the decoded data will be placed in caller allocated buffer specified by OutputBuffer.\r
d1102dba	110	\r
11ff2c71 LG	111	If InputSection is NULL, then ASSERT().\r
	112	If OutputBuffer is NULL, then ASSERT().\r
	113	If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().\r
	114	If AuthenticationStatus is NULL, then ASSERT().\r
	115	\r
	116	\r
	117	@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
d1102dba	118	@param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation.\r
11ff2c71	119	@param[out] ScratchBuffer A caller allocated buffer that may be required by this function\r
d1102dba LG	120	as a scratch buffer to perform the decode operation.\r
d1102dba LG	121	@param[out] AuthenticationStatus\r
11ff2c71 LG	122	A pointer to the authentication status of the decoded output buffer.\r
	123	See the definition of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI\r
	124	section of the PI Specification. EFI_AUTH_STATUS_PLATFORM_OVERRIDE must\r
	125	never be set by this handler.\r
	126	\r
	127	@retval RETURN_SUCCESS The buffer specified by InputSection was decoded.\r
	128	@retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.\r
	129	@retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.\r
	130	\r
	131	**/\r
	132	RETURN_STATUS\r
	133	EFIAPI\r
	134	LzmaArchGuidedSectionExtraction (\r
	135	IN CONST VOID *InputSection,\r
	136	OUT VOID **OutputBuffer,\r
e3917e22	137	OUT VOID *ScratchBuffer OPTIONAL,\r
11ff2c71 LG	138	OUT UINT32 *AuthenticationStatus\r
	139	)\r
	140	{\r
1436aea4 MK	141	EFI_GUID *InputGuid;\r
	142	VOID *Source;\r
	143	UINTN SourceSize;\r
	144	EFI_STATUS Status;\r
	145	UINT32 X86State;\r
	146	UINT32 OutputBufferSize;\r
	147	UINT32 ScratchBufferSize;\r
d1102dba	148	\r
11ff2c71 LG	149	ASSERT (OutputBuffer != NULL);\r
	150	ASSERT (InputSection != NULL);\r
	151	\r
	152	if (IS_SECTION2 (InputSection)) {\r
1436aea4 MK	153	InputGuid = &(((EFI_GUID_DEFINED_SECTION2 *)InputSection)->SectionDefinitionGuid);\r
	154	Source = (UINT8 )InputSection + ((EFI_GUID_DEFINED_SECTION2 )InputSection)->DataOffset;\r
	155	SourceSize = SECTION2_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION2 *)InputSection)->DataOffset;\r
11ff2c71	156	} else {\r
1436aea4 MK	157	InputGuid = &(((EFI_GUID_DEFINED_SECTION *)InputSection)->SectionDefinitionGuid);\r
	158	Source = (UINT8 )InputSection + ((EFI_GUID_DEFINED_SECTION )InputSection)->DataOffset;\r
	159	SourceSize = SECTION_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION *)InputSection)->DataOffset;\r
11ff2c71 LG	160	}\r
	161	\r
	162	if (!CompareGuid (&gLzmaF86CustomDecompressGuid, InputGuid)) {\r
	163	return RETURN_INVALID_PARAMETER;\r
	164	}\r
	165	\r
	166	//\r
	167	// Authentication is set to Zero, which may be ignored.\r
	168	//\r
	169	*AuthenticationStatus = 0;\r
	170	\r
	171	Status = LzmaUefiDecompress (\r
1436aea4 MK	172	Source,\r
	173	SourceSize,\r
	174	*OutputBuffer,\r
	175	ScratchBuffer\r
	176	);\r
11ff2c71 LG	177	\r
11ff2c71 LG	178	//\r
d1102dba	179	// After decompress, the data need to be converted to the raw data.\r
11ff2c71 LG	180	//\r
	181	if (!EFI_ERROR (Status)) {\r
	182	Status = LzmaUefiDecompressGetInfo (\r
1436aea4 MK	183	Source,\r
	184	(UINT32)SourceSize,\r
	185	&OutputBufferSize,\r
	186	&ScratchBufferSize\r
	187	);\r
d1102dba	188	\r
11ff2c71	189	if (!EFI_ERROR (Status)) {\r
1436aea4 MK	190	x86_Convert_Init (X86State);\r
1436aea4 MK	191	x86_Convert (*OutputBuffer, OutputBufferSize, 0, &X86State, 0);\r
11ff2c71 LG	192	}\r
11ff2c71 LG	193	}\r
d1102dba	194	\r
11ff2c71 LG	195	return Status;\r
	196	}\r
	197	\r
11ff2c71 LG	198	/**\r
	199	Register LzmaArchDecompress and LzmaArchDecompressGetInfo handlers with LzmaF86CustomDecompressGuid.\r
	200	\r
	201	@retval RETURN_SUCCESS Register successfully.\r
	202	@retval RETURN_OUT_OF_RESOURCES No enough memory to store this handler.\r
	203	**/\r
	204	EFI_STATUS\r
	205	EFIAPI\r
	206	LzmaArchDecompressLibConstructor (\r
f826516d	207	VOID\r
11ff2c71 LG	208	)\r
	209	{\r
	210	return ExtractGuidedSectionRegisterHandlers (\r
1436aea4 MK	211	&gLzmaF86CustomDecompressGuid,\r
	212	LzmaArchGuidedSectionGetInfo,\r
	213	LzmaArchGuidedSectionExtraction\r
	214	);\r
11ff2c71	215	}\r