3 Copyright (c) 2007 - 2008, Intel Corporation. All rights reserved.<BR>
4 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
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.
14 ParseGuidedSectionTools.h
18 Header file for helper functions for parsing GuidedSectionTools.txt
22 #ifndef _EFI_PARSE_GUIDED_SECTION_TOOLS_H
23 #define _EFI_PARSE_GUIDED_SECTION_TOOLS_H
25 #include <Common/UefiBaseTypes.h>
28 // Functions declarations
32 ParseGuidedSectionToolsFile (
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
48 InputFile Path name of file to read
53 A non-NULL EFI_HANDLE otherwise
59 ParseGuidedSectionToolsMemoryFile (
60 IN EFI_HANDLE InputFile
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
75 InputFile Memory file image.
80 A non-NULL EFI_HANDLE otherwise
85 LookupGuidedSectionToolPath (
86 IN EFI_HANDLE ParsedGuidedSectionToolsHandle
,
87 IN EFI_GUID
*SectionGuid
94 This function looks up the appropriate tool to use for extracting
95 a GUID defined FV section.
99 ParsedGuidedSectionToolsHandle A parsed GUID section tools handle.
100 SectionGuid The GUID for the section.
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.)
111 FreeParsedGuidedSectionToolsHandle (
112 IN EFI_HANDLE ParsedGuidedSectionToolsHandle
119 Frees resources that were allocated by ParseGuidedSectionToolsFile.
120 After freeing these resources, the information that was parsed
121 is no longer accessible.
125 ParsedToolDefHandle Handle returned from ParseGuidedSectionToolsFile