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