2 Header file for helper functions for parsing GuidedSectionTools.txt
4 Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _EFI_PARSE_GUIDED_SECTION_TOOLS_H
16 #define _EFI_PARSE_GUIDED_SECTION_TOOLS_H
18 #include <Common/UefiBaseTypes.h>
21 // Functions declarations
25 ParseGuidedSectionToolsFile (
33 This function parses the tools_def.txt file. It returns a
34 EFI_HANDLE object which can be used for the other library
35 functions and should be passed to FreeParsedToolsDefHandle
36 to free resources when the tools_def.txt information is no
41 InputFile Path name of file to read
46 A non-NULL EFI_HANDLE otherwise
52 ParseGuidedSectionToolsMemoryFile (
53 IN EFI_HANDLE InputFile
60 This function parses the tools_def.txt file. It returns a
61 EFI_HANDLE object which can be used for the other library
62 functions and should be passed to FreeParsedToolsDefHandle
63 to free resources when the tools_def.txt information is no
68 InputFile Memory file image.
73 A non-NULL EFI_HANDLE otherwise
78 LookupGuidedSectionToolPath (
79 IN EFI_HANDLE ParsedGuidedSectionToolsHandle
,
80 IN EFI_GUID
*SectionGuid
87 This function looks up the appropriate tool to use for extracting
88 a GUID defined FV section.
92 ParsedGuidedSectionToolsHandle A parsed GUID section tools handle.
93 SectionGuid The GUID for the section.
97 NULL - if no tool is found or there is another error
98 Non-NULL - The tool to use to access the section contents. (The caller
99 must free the memory associated with this string.)
104 FreeParsedGuidedSectionToolsHandle (
105 IN EFI_HANDLE ParsedGuidedSectionToolsHandle
112 Frees resources that were allocated by ParseGuidedSectionToolsFile.
113 After freeing these resources, the information that was parsed
114 is no longer accessible.
118 ParsedToolDefHandle Handle returned from ParseGuidedSectionToolsFile