[mirror_edk2.git] / MdePkg / Include / Library / ExtractGuidedSectionLib.h

/** @file\r
  Extract Guided Section Library class\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
  ExtractGuidedSectionLib.h\r
**/\r
#ifndef __EXTRACT_GUIDED_SECTION_H__\r
#define __EXTRACT_GUIDED_SECTION_H__\r
\r
/**
  Get information Handler for the input guided section data.\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_INVALID_PARAMETER The input data can't be parsed correctly.\r
\r
**/\r
typedef\r
RETURN_STATUS\r
(EFIAPI *EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER)(\r
  IN CONST  VOID    *InputSection,\r
  OUT       UINT32  *OutputBufferSize,\r
  OUT       UINT32  *ScratchBufferSize,\r
  OUT       UINT16  *SectionAttribute\r
  );\r
\r
/**
  Extract data Handler for one specific guided section.
  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 to the start of the section's contents.\r
                            if guided data is not prcessed. Otherwise,\r
                            OutputBuffer to contain the output data, which is 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 and AuthenticationStatus successfully.\r
  @retval  RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
\r
**/\r
typedef\r
RETURN_STATUS\r
(EFIAPI *EXTRACT_GUIDED_SECTION_DECODE_HANDLER)(\r
  IN CONST  VOID    *InputSection,\r
  OUT       VOID    **OutputBuffer,\r
  IN        VOID    *ScratchBuffer,        OPTIONAL\r
  OUT       UINT32  *AuthenticationStatus\r
  );\r
\r
/**
  Register Guided Section Extract and GetInfo Handler.\r
\r
  @param[in]     SectionGuid    The guid matches this Extraction Handler.
  @param[in]     GetInfoHandler Handler to get info from guided section.\r
  @param[in]     DecodeHandler  Handler to extract guided section.

  @retval  RETURN_SUCCESS           Register Guided Section Extract Handler successfully.
  @retval  RETURN_OUT_OF_RESOURCES  Resource is not enough to register new Handler. \r
  @retval  RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.\r
\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
/**
  Get the supported exract guided section Handler guid list.\r
  It will ASSERT () if ExtractHandlerGuidTable = NULL.\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
/**
  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
/**
  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
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
#endif\r
Commit	Line	Data
18fd8d65 LG	1	/** @file\r
	2	Extract Guided Section Library class\r
	3	\r
	4	Copyright (c) 2007, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	ExtractGuidedSectionLib.h\r
	14	**/\r
	15	#ifndef __EXTRACT_GUIDED_SECTION_H__\r
	16	#define __EXTRACT_GUIDED_SECTION_H__\r
	17	\r
	18	/**
	19	Get information Handler for the input guided section data.\r
	20	It will ASSERT () if the pointer to OutputBufferSize is NULL.\r
	21	It will ASSERT () if the pointer to ScratchBufferSize is NULL.
	22	It will ASSERT () if the pointer to SectionAttribute is NULL.\r
	23	\r
	24	@param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
	25	@param[out] OutputBufferSize The size of OutputBuffer.\r
	26	@param[out] ScratchBufferSize The size of ScratchBuffer.\r
	27	@param[out] SectionAttribute The attribute of the input guided section.\r
	28
	29	@retval RETURN_SUCCESS Get the required information successfully.\r
	30	@retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
	31	\r
	32	**/\r
	33	typedef\r
	34	RETURN_STATUS\r
	35	(EFIAPI *EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER)(\r
	36	IN CONST VOID *InputSection,\r
	37	OUT UINT32 *OutputBufferSize,\r
	38	OUT UINT32 *ScratchBufferSize,\r
	39	OUT UINT16 *SectionAttribute\r
	40	);\r
	41	\r
	42	/**
	43	Extract data Handler for one specific guided section.
	44	It will ASSERT () if the pointer to OutputBuffer is NULL.\r
	45	It will ASSERT () if the pointer to AuthenticationStatus is NULL.\r
	46	\r
	47	@param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
	48	@param[out] OutputBuffer OutputBuffer to point to the start of the section's contents.\r
	49	if guided data is not prcessed. Otherwise,\r
	50	OutputBuffer to contain the output data, which is allocated by the caller.\r
	51	@param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. \r
	52	@param[out] AuthenticationStatus \r
	53	A pointer to a caller-allocated UINT32 that indicates the\r
	54	authentication status of the output buffer.
	55
	56	@retval RETURN_SUCCESS Get the output data and AuthenticationStatus successfully.\r
	57	@retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
	58	\r
	59	**/\r
	60	typedef\r
	61	RETURN_STATUS\r
	62	(EFIAPI *EXTRACT_GUIDED_SECTION_DECODE_HANDLER)(\r
	63	IN CONST VOID *InputSection,\r
	64	OUT VOID **OutputBuffer,\r
65	IN VOID *ScratchBuffer, OPTIONAL\r
66	OUT UINT32 *AuthenticationStatus\r
67	);\r
68	\r
69	/**
70	Register Guided Section Extract and GetInfo Handler.\r
71	\r
72	@param[in] SectionGuid The guid matches this Extraction Handler.
73	@param[in] GetInfoHandler Handler to get info from guided section.\r
74	@param[in] DecodeHandler Handler to extract guided section.
75
76	@retval RETURN_SUCCESS Register Guided Section Extract Handler successfully.
77	@retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new Handler. \r
78	@retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.\r
79	\r
80	**/\r
81	RETURN_STATUS\r
82	EFIAPI\r
83	ExtractGuidedSectionRegisterHandlers (\r
84	IN CONST GUID *SectionGuid,\r
85	IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler,\r
86	IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler\r
87	);\r
88	\r
89	/**
90	Get the supported exract guided section Handler guid list.\r
91	It will ASSERT () if ExtractHandlerGuidTable = NULL.\r
92	\r
93	@param[in, out] ExtractHandlerGuidTable The extract Handler guid pointer list.
94	\r
95	@retval return the number of the supported extract guided Handler.
96	**/\r
97	UINTN\r
98	EFIAPI\r
99	ExtractGuidedSectionGetGuidList (\r
100	IN OUT GUID **ExtractHandlerGuidTable\r
101	);\r
102	\r
103	/**
104	Get information from the guided section. This function first gets the guid value\r
105	from guided section header, then match this guid in the registered extract Handler list\r
106	to its corresponding getinfo Handler. \r
107	If not found, RETURN_UNSUPPORTED will be return. \r
108	If found, it will call the getinfo Handler to get the required size and attribute.\r
109	\r
110	It will ASSERT () if the pointer to OutputBufferSize is NULL.\r
111	It will ASSERT () if the pointer to ScratchBufferSize is NULL.
112	It will ASSERT () if the pointer to SectionAttribute is NULL.\r
113	\r
114	@param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
115	@param[out] OutputBufferSize The size of OutputBuffer.\r
116	@param[out] ScratchBufferSize The size of ScratchBuffer. \r
117	@param[out] SectionAttribute The attribute of the input guided section.\r
118
119	@retval RETURN_SUCCESS Get the required information successfully.\r
120	@retval RETURN_UNSUPPORTED Guided section data is not supported.\r
121	@retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
122	\r
123	**/\r
124	RETURN_STATUS\r
125	EFIAPI\r
126	ExtractGuidedSectionGetInfo (\r
127	IN CONST VOID *InputSection,\r
128	OUT UINT32 *OutputBufferSize,\r
129	OUT UINT32 *ScratchBufferSize,\r
130	OUT UINT16 *SectionAttribute \r
131	);\r
132	\r
133	/**
134	Extract data from the guided section. This function first gets the guid value\r
135	from guided section header, then match this guid in the registered extract Handler list\r
136	to its corresponding extract Handler. \r
137	If not found, RETURN_UNSUPPORTED will be return. \r
138	If found, it will call this extract Handler to get output data and AuthenticationStatus.
139	\r
140	It will ASSERT () if the pointer to OutputBuffer is NULL.\r
141	It will ASSERT () if the pointer to AuthenticationStatus is NULL.\r
142	\r
143	@param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
144	@param[out] OutputBuffer OutputBuffer to point the start of the section's contents \r
145	if guided data is not required prcessing. Otherwise,\r
146	OutputBuffer to contain the output data, which is \r
147	allocated by the caller.\r
148	@param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. \r
149	@param[out] AuthenticationStatus \r
150	A pointer to a caller-allocated UINT32 that indicates the\r
151	authentication status of the output buffer.
152
153	@retval RETURN_SUCCESS Get the output data, size and AuthenticationStatus successfully.\r
154	@retval RETURN_UNSUPPORTED Guided section data is not supported to be decoded.\r
155	@retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.
156	**/\r
157	RETURN_STATUS\r
158	EFIAPI\r
159	ExtractGuidedSectionDecode (\r
160	IN CONST VOID *InputSection,\r
161	OUT VOID **OutputBuffer,\r
162	OUT VOID *ScratchBuffer, OPTIONAL\r
163	OUT UINT32 *AuthenticationStatus \r
164	);\r
165	\r
166	#endif\r