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

   1 /*++
   2
   3 Copyright (c) 2006, 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 Tiano File Image Format specification
  20   FV spec 0.3.6
  21
  22 --*/
  23
  24 #ifndef _CRC32_GUIDED_SECTION_EXTRACTION_H
  25 #define _CRC32_GUIDED_SECTION_EXTRACTION_H
  26
  27 typedef struct {
  28   EFI_GUID_DEFINED_SECTION  GuidedSectionHeader;
  29   UINT32                    CRC32Checksum;
  30 } CRC32_SECTION_HEADER;
  31
  32 //
  33 // Function prototype declarations
  34 //
  35 STATIC
  36 EFI_STATUS
  37 EFIAPI
  38 Crc32ExtractSection (
  39   IN  EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL  *This,
  40   IN  VOID                                    *InputSection,
  41   OUT VOID                                    **OutputBuffer,
  42   OUT UINTN                                   *OutputSize,
  43   OUT UINT32                                  *AuthenticationStatus
  44   )
  45 /*++
  46
  47 Routine Description:
  48
  49   TODO: Add function description
  50
  51 Arguments:
  52
  53   This                  - TODO: add argument description
  54   InputSection          - TODO: add argument description
  55   OutputBuffer          - TODO: add argument description
  56   OutputSize            - TODO: add argument description
  57   AuthenticationStatus  - TODO: add argument description
  58
  59 Returns:
  60
  61   TODO: add return values
  62
  63 --*/
  64 ;
  65
  66 EFI_STATUS
  67 EFIAPI
  68 InitializeCrc32GuidedSectionExtractionProtocol (
  69   IN EFI_HANDLE                   ImageHandle,
  70   IN EFI_SYSTEM_TABLE             *SystemTable
  71   )
  72 /*++
  73
  74 Routine Description:
  75
  76   Entry point of the CRC32 GUIDed section extraction protocol.
  77   Creates and initializes an instance of the GUIDed section
  78   extraction protocol with CRC32 GUID.
  79
  80 Arguments:
  81
  82   ImageHandle   EFI_HANDLE: A handle for the image that is initializing
  83                 this driver
  84   SystemTable   EFI_SYSTEM_TABLE: A pointer to the EFI system table
  85
  86 Returns:
  87
  88   EFI_SUCCESS:          Driver initialized successfully
  89   EFI_LOAD_ERROR:       Failed to Initialize or has been loaded
  90   EFI_OUT_OF_RESOURCES: Could not allocate needed resources
  91
  92 --*/
  93 ;
  94
  95 #endif