79964ac8 |
1 | /** @file\r |
2 | This file declares Section Extraction protocols.\r |
3 | \r |
4 | This interface provides a means of decoding a set of sections into a linked list of\r |
5 | leaf sections. This provides for an extensible and flexible file format.\r |
6 | \r |
7 | Copyright (c) 2007, Intel Corporation\r |
8 | All rights reserved. This program and the materials\r |
9 | are licensed and made available under the terms and conditions of the BSD License\r |
10 | which accompanies this distribution. The full text of the license may be found at\r |
11 | http://opensource.org/licenses/bsd-license.php\r |
12 | \r |
13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
15 | \r |
16 | Module Name: SectionExtraction.h\r |
17 | \r |
18 | @par Revision Reference:\r |
19 | This protocol is defined in Firmware Volume Specification.\r |
20 | Version 0.9\r |
21 | \r |
22 | **/\r |
23 | \r |
24 | #ifndef _SECTION_EXTRACTION_PROTOCOL_H_\r |
25 | #define _SECTION_EXTRACTION_PROTOCOL_H_\r |
26 | \r |
b80fbe85 |
27 | #include <PiDxe.h>\r |
79964ac8 |
28 | \r |
29 | //\r |
30 | // Protocol GUID definition\r |
31 | //\r |
32 | #define EFI_SECTION_EXTRACTION_PROTOCOL_GUID \\r |
33 | { \\r |
34 | 0x448F5DA4, 0x6DD7, 0x4FE1, {0x93, 0x07, 0x69, 0x22, 0x41, 0x92, 0x21, 0x5D } \\r |
35 | }\r |
36 | \r |
37 | typedef struct _EFI_SECTION_EXTRACTION_PROTOCOL EFI_SECTION_EXTRACTION_PROTOCOL;\r |
38 | \r |
39 | //\r |
40 | // Protocol member functions\r |
41 | //\r |
42 | /**\r |
43 | Creates and returns a new section stream handle to represent the new section stream.\r |
44 | \r |
45 | @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r |
46 | @param SectionStreamLength Size in bytes of the section stream.\r |
47 | @param SectionStream Buffer containing the new section stream.\r |
48 | @param SectionStreamHandle A pointer to a caller-allocated UINTN that,\r |
49 | on output, contains the new section stream handle.\r |
50 | \r |
51 | @retval EFI_SUCCESS The SectionStream was successfully processed and\r |
52 | the section stream handle was returned.\r |
53 | @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to\r |
54 | process the request.\r |
55 | @retval EFI_INVALID_PARAMETER The section stream may be corrupt or the value\r |
56 | of SectionStreamLength may be incorrect.\r |
57 | \r |
58 | **/\r |
59 | typedef\r |
60 | EFI_STATUS\r |
61 | (EFIAPI *EFI_OPEN_SECTION_STREAM) (\r |
62 | IN EFI_SECTION_EXTRACTION_PROTOCOL *This,\r |
63 | IN UINTN SectionStreamLength,\r |
64 | IN VOID *SectionStream,\r |
65 | OUT UINTN *SectionStreamHandle\r |
66 | );\r |
67 | \r |
68 | /**\r |
69 | Reads and returns a single section from a section stream.\r |
70 | \r |
71 | @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r |
72 | @param SectionStreamHandle Indicates from which section stream to read.\r |
73 | @param SectionType Pointer to an EFI_SECTION_TYPE.\r |
74 | @param SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==\r |
75 | EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID\r |
76 | to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then\r |
77 | SectionDefinitionGuid is unused and is ignored.\r |
78 | @param SectionInstance Indicates which instance of the requested section\r |
79 | type to return when SectionType is not NULL.\r |
80 | @param SectionStreamHandle A pointer to a caller-allocated UINTN that, on output,\r |
81 | contains the new section stream handle.\r |
82 | @param Buffer Pointer to a pointer to a buffer in which the section\r |
83 | contents are returned.\r |
84 | @param BufferSize Pointer to a caller-allocated UINTN.\r |
85 | @param AuthenticationStatus Pointer to a caller-allocated UINT32 in\r |
86 | which any meta-data from encapsulation GUID-defined sections is returned.\r |
87 | \r |
88 | @retval EFI_SUCCESS The SectionStream was successfully processed and\r |
89 | the section contents were returned in Buffer.\r |
90 | @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in\r |
91 | the section stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,\r |
92 | but there was no corresponding GUIDed Section Extraction Protocol in\r |
93 | the handle database.\r |
94 | @retval EFI_NOT_FOUND An error was encountered when parsing the SectionStream,\r |
95 | which indicates that the SectionStream is not correctly formatted.\r |
96 | Or The requested section does not exist.\r |
97 | @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process\r |
98 | the request.\r |
99 | @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r |
100 | @retval EFI_BUFFER_TOO_SMALL The size of the input buffer is insufficient to\r |
101 | contain the requested section.\r |
102 | \r |
103 | **/\r |
104 | typedef\r |
105 | EFI_STATUS\r |
106 | (EFIAPI *EFI_GET_SECTION) (\r |
107 | IN EFI_SECTION_EXTRACTION_PROTOCOL *This,\r |
108 | IN UINTN SectionStreamHandle,\r |
109 | IN EFI_SECTION_TYPE *SectionType,\r |
110 | IN EFI_GUID *SectionDefinitionGuid,\r |
111 | IN UINTN SectionInstance,\r |
112 | IN VOID **Buffer,\r |
113 | IN OUT UINTN *BufferSize,\r |
114 | OUT UINT32 *AuthenticationStatus\r |
115 | );\r |
116 | \r |
117 | /**\r |
118 | Deletes a section stream handle and returns all associated resources to the system.\r |
119 | \r |
120 | @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r |
121 | @param SectionStreamHandle Indicates the section stream to close.\r |
122 | @retval EFI_SUCCESS The SectionStream was successfully processed and\r |
123 | the section stream handle was returned.\r |
124 | @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r |
125 | \r |
126 | **/\r |
127 | typedef\r |
128 | EFI_STATUS\r |
129 | (EFIAPI *EFI_CLOSE_SECTION_STREAM) (\r |
130 | IN EFI_SECTION_EXTRACTION_PROTOCOL *This,\r |
131 | IN UINTN SectionStreamHandle\r |
132 | );\r |
133 | \r |
134 | //\r |
135 | // Protocol definition\r |
136 | //\r |
137 | /**\r |
138 | @par Protocol Description:\r |
139 | The Section Extraction Protocol provides a simple method of extracting\r |
140 | sections from arbitrarily complex files.\r |
141 | \r |
142 | @param OpenSectionStream\r |
143 | Takes a bounded stream of sections and returns a section stream handle.\r |
144 | \r |
145 | @param GetSection\r |
146 | Given a section stream handle, retrieves the requested section and\r |
147 | meta-data from the section stream.\r |
148 | \r |
149 | @param CloseSectionStream\r |
150 | Given a section stream handle, closes the section stream.\r |
151 | \r |
152 | **/\r |
153 | struct _EFI_SECTION_EXTRACTION_PROTOCOL {\r |
154 | EFI_OPEN_SECTION_STREAM OpenSectionStream;\r |
155 | EFI_GET_SECTION GetSection;\r |
156 | EFI_CLOSE_SECTION_STREAM CloseSectionStream;\r |
157 | };\r |
158 | \r |
159 | extern EFI_GUID gEfiSectionExtractionProtocolGuid;\r |
160 | \r |
161 | #endif\r |