BaseTools/Source/C/Common/ParseGuidedSectionTools.h

   1 /** @file
   2
   3 Copyright (c) 2007 - 2008, 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   ParseGuidedSectionTools.h
  15
  16 Abstract:
  17
  18   Header file for helper functions for parsing GuidedSectionTools.txt
  19
  20 **/
  21
  22 #ifndef _EFI_PARSE_GUIDED_SECTION_TOOLS_H
  23 #define _EFI_PARSE_GUIDED_SECTION_TOOLS_H
  24
  25 #include <Common/UefiBaseTypes.h>
  26
  27 //
  28 // Functions declarations
  29 //
  30
  31 EFI_HANDLE
  32 ParseGuidedSectionToolsFile (
  33   IN CHAR8    *InputFile
  34   )
  35 ;
  36 /**
  37
  38 Routine Description:
  39
  40   This function parses the tools_def.txt file.  It returns a
  41   EFI_HANDLE object which can be used for the other library
  42   functions and should be passed to FreeParsedToolsDefHandle
  43   to free resources when the tools_def.txt information is no
  44   longer needed.
  45
  46 Arguments:
  47
  48   InputFile     Path name of file to read
  49
  50 Returns:
  51
  52   NULL if error parsing
  53   A non-NULL EFI_HANDLE otherwise
  54
  55 **/
  56
  57
  58 EFI_HANDLE
  59 ParseGuidedSectionToolsMemoryFile (
  60   IN EFI_HANDLE    InputFile
  61   )
  62 ;
  63 /**
  64
  65 Routine Description:
  66
  67   This function parses the tools_def.txt file.  It returns a
  68   EFI_HANDLE object which can be used for the other library
  69   functions and should be passed to FreeParsedToolsDefHandle
  70   to free resources when the tools_def.txt information is no
  71   longer needed.
  72
  73 Arguments:
  74
  75   InputFile     Memory file image.
  76
  77 Returns:
  78
  79   NULL if error parsing
  80   A non-NULL EFI_HANDLE otherwise
  81
  82 **/
  83
  84 CHAR8*
  85 LookupGuidedSectionToolPath (
  86   IN EFI_HANDLE ParsedGuidedSectionToolsHandle,
  87   IN EFI_GUID   *SectionGuid
  88   )
  89 ;
  90 /**
  91
  92 Routine Description:
  93
  94   This function looks up the appropriate tool to use for extracting
  95   a GUID defined FV section.
  96
  97 Arguments:
  98
  99   ParsedGuidedSectionToolsHandle    A parsed GUID section tools handle.
 100   SectionGuid                       The GUID for the section.
 101
 102 Returns:
 103
 104   NULL     - if no tool is found or there is another error
 105   Non-NULL - The tool to use to access the section contents.  (The caller
 106              must free the memory associated with this string.)
 107
 108 **/
 109
 110 EFI_STATUS
 111 FreeParsedGuidedSectionToolsHandle (
 112   IN EFI_HANDLE ParsedGuidedSectionToolsHandle
 113   )
 114 ;
 115 /**
 116
 117 Routine Description:
 118
 119   Frees resources that were allocated by ParseGuidedSectionToolsFile.
 120   After freeing these resources, the information that was parsed
 121   is no longer accessible.
 122
 123 Arguments:
 124
 125   ParsedToolDefHandle   Handle returned from ParseGuidedSectionToolsFile
 126
 127 Returns:
 128
 129   EFI_STATUS
 130
 131 **/
 132
 133 #endif