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