EdkModulePkg/Universal/FirmwareVolume/GuidedSectionExtraction/Crc32SectionExtract/Dxe/Crc32SectionExtract.h

   1 /*++
   2
   3 Copyright (c) 2006 - 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   Crc32SectionExtract.h
  15
  16 Abstract:
  17
  18   Header file for Crc32SectionExtract.c
  19   Please refer to the Framewokr Firmware Volume Specification 0.9.
  20
  21 --*/
  22
  23 #ifndef _CRC32_GUIDED_SECTION_EXTRACTION_H
  24 #define _CRC32_GUIDED_SECTION_EXTRACTION_H
  25
  26 typedef struct {
  27   EFI_GUID_DEFINED_SECTION  GuidedSectionHeader;
  28   UINT32                    CRC32Checksum;
  29 } CRC32_SECTION_HEADER;
  30
  31 //
  32 // Function prototype declarations
  33 //
  34 STATIC
  35 EFI_STATUS
  36 EFIAPI
  37 Crc32ExtractSection (
  38   IN  EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL  *This,
  39   IN  VOID                                    *InputSection,
  40   OUT VOID                                    **OutputBuffer,
  41   OUT UINTN                                   *OutputSize,
  42   OUT UINT32                                  *AuthenticationStatus
  43   )
  44 /*++
  45
  46 Routine Description:
  47
  48   TODO: Add function description
  49
  50 Arguments:
  51
  52   This                  - TODO: add argument description
  53   InputSection          - TODO: add argument description
  54   OutputBuffer          - TODO: add argument description
  55   OutputSize            - TODO: add argument description
  56   AuthenticationStatus  - TODO: add argument description
  57
  58 Returns:
  59
  60   TODO: add return values
  61
  62 --*/
  63 ;
  64
  65 EFI_STATUS
  66 EFIAPI
  67 InitializeCrc32GuidedSectionExtractionProtocol (
  68   IN EFI_HANDLE                   ImageHandle,
  69   IN EFI_SYSTEM_TABLE             *SystemTable
  70   )
  71 /*++
  72
  73 Routine Description:
  74
  75   Entry point of the CRC32 GUIDed section extraction protocol.
  76   Creates and initializes an instance of the GUIDed section
  77   extraction protocol with CRC32 GUID.
  78
  79 Arguments:
  80
  81   ImageHandle   EFI_HANDLE: A handle for the image that is initializing
  82                 this driver
  83   SystemTable   EFI_SYSTEM_TABLE: A pointer to the EFI system table
  84
  85 Returns:
  86
  87   EFI_SUCCESS:          Driver initialized successfully
  88   EFI_LOAD_ERROR:       Failed to Initialize or has been loaded
  89   EFI_OUT_OF_RESOURCES: Could not allocate needed resources
  90
  91 --*/
  92 ;
  93
  94 #endif