]>
Commit | Line | Data |
---|---|---|
30fdf114 | 1 | /** @file\r |
97fa0ee9 | 2 | Header file for helper functions for parsing GuidedSectionTools.txt\r |
30fdf114 | 3 | \r |
97fa0ee9 | 4 | Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>\r |
40d841f6 | 5 | This program and the accompanying materials \r |
30fdf114 LG |
6 | are licensed and made available under the terms and conditions of the BSD License \r |
7 | which accompanies this distribution. The full text of the license may be found at \r | |
8 | http://opensource.org/licenses/bsd-license.php \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
12 | \r | |
30fdf114 LG |
13 | **/\r |
14 | \r | |
15 | #ifndef _EFI_PARSE_GUIDED_SECTION_TOOLS_H\r | |
16 | #define _EFI_PARSE_GUIDED_SECTION_TOOLS_H\r | |
17 | \r | |
18 | #include <Common/UefiBaseTypes.h>\r | |
19 | \r | |
20 | //\r | |
21 | // Functions declarations\r | |
22 | //\r | |
23 | \r | |
24 | EFI_HANDLE\r | |
25 | ParseGuidedSectionToolsFile (\r | |
26 | IN CHAR8 *InputFile\r | |
27 | )\r | |
28 | ;\r | |
29 | /**\r | |
30 | \r | |
31 | Routine Description:\r | |
32 | \r | |
33 | This function parses the tools_def.txt file. It returns a\r | |
34 | EFI_HANDLE object which can be used for the other library\r | |
35 | functions and should be passed to FreeParsedToolsDefHandle\r | |
36 | to free resources when the tools_def.txt information is no\r | |
37 | longer needed.\r | |
38 | \r | |
39 | Arguments:\r | |
40 | \r | |
41 | InputFile Path name of file to read\r | |
42 | \r | |
43 | Returns:\r | |
44 | \r | |
45 | NULL if error parsing\r | |
46 | A non-NULL EFI_HANDLE otherwise\r | |
47 | \r | |
48 | **/\r | |
49 | \r | |
50 | \r | |
51 | EFI_HANDLE\r | |
52 | ParseGuidedSectionToolsMemoryFile (\r | |
53 | IN EFI_HANDLE InputFile\r | |
54 | )\r | |
55 | ;\r | |
56 | /**\r | |
57 | \r | |
58 | Routine Description:\r | |
59 | \r | |
60 | This function parses the tools_def.txt file. It returns a\r | |
61 | EFI_HANDLE object which can be used for the other library\r | |
62 | functions and should be passed to FreeParsedToolsDefHandle\r | |
63 | to free resources when the tools_def.txt information is no\r | |
64 | longer needed.\r | |
65 | \r | |
66 | Arguments:\r | |
67 | \r | |
68 | InputFile Memory file image.\r | |
69 | \r | |
70 | Returns:\r | |
71 | \r | |
72 | NULL if error parsing\r | |
73 | A non-NULL EFI_HANDLE otherwise\r | |
74 | \r | |
75 | **/\r | |
76 | \r | |
77 | CHAR8*\r | |
78 | LookupGuidedSectionToolPath (\r | |
79 | IN EFI_HANDLE ParsedGuidedSectionToolsHandle,\r | |
80 | IN EFI_GUID *SectionGuid\r | |
81 | )\r | |
82 | ;\r | |
83 | /**\r | |
84 | \r | |
85 | Routine Description:\r | |
86 | \r | |
87 | This function looks up the appropriate tool to use for extracting\r | |
88 | a GUID defined FV section.\r | |
89 | \r | |
90 | Arguments:\r | |
91 | \r | |
92 | ParsedGuidedSectionToolsHandle A parsed GUID section tools handle.\r | |
93 | SectionGuid The GUID for the section.\r | |
94 | \r | |
95 | Returns:\r | |
96 | \r | |
97 | NULL - if no tool is found or there is another error\r | |
98 | Non-NULL - The tool to use to access the section contents. (The caller\r | |
99 | must free the memory associated with this string.)\r | |
100 | \r | |
101 | **/\r | |
102 | \r | |
103 | EFI_STATUS\r | |
104 | FreeParsedGuidedSectionToolsHandle (\r | |
105 | IN EFI_HANDLE ParsedGuidedSectionToolsHandle\r | |
106 | )\r | |
107 | ;\r | |
108 | /**\r | |
109 | \r | |
110 | Routine Description:\r | |
111 | \r | |
112 | Frees resources that were allocated by ParseGuidedSectionToolsFile.\r | |
113 | After freeing these resources, the information that was parsed\r | |
114 | is no longer accessible.\r | |
115 | \r | |
116 | Arguments:\r | |
117 | \r | |
118 | ParsedToolDefHandle Handle returned from ParseGuidedSectionToolsFile\r | |
119 | \r | |
120 | Returns:\r | |
121 | \r | |
122 | EFI_STATUS\r | |
123 | \r | |
124 | **/\r | |
125 | \r | |
126 | #endif\r |