Initial import.

[mirror_edk2.git] / EdkModulePkg / Universal / FirmwareVolume / GuidedSectionExtraction / Crc32SectionExtract / Dxe / GuidedSection.c

/*++\r
\r
Copyright (c) 2006, 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
  GuidedSection.c\r
  \r
Abstract:\r
\r
  GUIDed section extraction protocol implementation.  \r
  This contains the common constructor of GUIDed section\r
  extraction protocol. GUID specific implementation of each\r
  GUIDed section extraction protocol can be found in other\r
  files under the same directory.\r
  \r
  Please refer to the Tiano File Image Format Specification, \r
  FV spec 0.3.6\r
  \r
  Acronyms used       Meaning\r
\r
    \r
--*/\r
\r
\r
#include "Common/FirmwareFileSystem.h"\r
\r
EFI_STATUS\r
GuidedSectionExtractionProtocolConstructor (\r
  OUT EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL      **GuidedSep,\r
  IN  EFI_EXTRACT_GUIDED_SECTION                  ExtractSection\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Constructor for the GUIDed section extraction protocol.  Initializes\r
  instance data.\r
\r
Arguments:\r
\r
  This      Instance to construct\r
\r
Returns:\r
\r
  EFI_SUCCESS:  Instance initialized.\r
\r
--*/\r
// TODO:    GuidedSep - add argument and description to function comment\r
// TODO:    ExtractSection - add argument and description to function comment\r
// TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment\r
{\r
  EFI_STATUS  Status;\r
\r
  *GuidedSep = NULL;\r
  Status = gBS->AllocatePool (\r
                  EfiBootServicesData,\r
                  sizeof (EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL),\r
                  (VOID **) GuidedSep\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  (*GuidedSep)->ExtractSection = ExtractSection;\r
\r
  return EFI_SUCCESS;\r
}\r