Use doxygen comment style for document entity such as struct, enum, variable that...

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

/** @file\r
  Extract Guided Section Library class defintions, \r
  which can provide many handlers for the different guided section data.\r
\r
  Copyright (c) 2007 - 2008, 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
#ifndef __EXTRACT_GUIDED_SECTION_H__\r
#define __EXTRACT_GUIDED_SECTION_H__\r
\r
/**
  Get information 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 is not the valid guided section.\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 and Auth from the 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 directly points to the start of the section's contents,\r
                            if guided data is not prcessed. Otherwise,\r
                            OutputBuffer contains 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 is not the valid guided section.\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 information 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 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 table, which is maintained\r
  by library. The caller can directly get the guid table \r
  without responsibility to allocate or free this table buffer.  \r
  It will ASSERT () if ExtractHandlerGuidTable = NULL.\r
\r
  @param[out]  ExtractHandlerGuidTable   The extract Handler guid pointer list.
\r
  @return the number of the supported extract guided Handler.
**/\r
UINTN\r
EFIAPI\r
ExtractGuidedSectionGetGuidList (\r
  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 is not the valid guided section.\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 and AuthenticationStatus successfully.\r
  @retval  RETURN_UNSUPPORTED       Guided section data is not supported to be decoded.\r
  @retval  RETURN_INVALID_PARAMETER The input data is not the valid guided section.
**/\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