]>
Commit | Line | Data |
---|---|---|
acd32208 CZ |
1 | /** @file\r |
2 | Esrt management implementation head file.\r | |
3 | \r | |
4 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials\r | |
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 | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _DXE_ESRT_IMPL_H_\r | |
16 | #define _DXE_ESRT_IMPL_H_\r | |
17 | \r | |
18 | #include <Guid/EventGroup.h>\r | |
19 | #include <Guid/SystemResourceTable.h>\r | |
20 | \r | |
21 | #include <Library/UefiLib.h>\r | |
22 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
23 | #include <Library/UefiLib.h>\r | |
24 | #include <Library/PcdLib.h>\r | |
25 | #include <Library/BaseLib.h>\r | |
26 | #include <Library/BaseMemoryLib.h>\r | |
27 | #include <Library/MemoryAllocationLib.h>\r | |
28 | #include <Library/UefiBootServicesTableLib.h>\r | |
29 | #include <Library/DebugLib.h>\r | |
30 | #include <Library/CapsuleLib.h>\r | |
31 | #include <Library/PrintLib.h>\r | |
32 | \r | |
33 | #include <Protocol/FirmwareManagement.h>\r | |
34 | #include <Protocol/EsrtManagement.h>\r | |
35 | #include <Protocol/VariableLock.h>\r | |
36 | \r | |
37 | //\r | |
38 | // Name of Variable for Non-FMP ESRT Repository\r | |
39 | // \r | |
40 | #define EFI_ESRT_NONFMP_VARIABLE_NAME L"EsrtNonFmp"\r | |
41 | \r | |
42 | //\r | |
43 | // Name of Variable for FMP\r | |
44 | // \r | |
45 | #define EFI_ESRT_FMP_VARIABLE_NAME L"EsrtFmp"\r | |
46 | \r | |
47 | //\r | |
48 | // Attribute of Cached ESRT entry\r | |
49 | //\r | |
50 | #define ESRT_FROM_FMP 0x00000001\r | |
51 | #define ESRT_FROM_NONFMP 0x00000002\r | |
52 | \r | |
53 | typedef struct {\r | |
54 | EFI_HANDLE Handle;\r | |
55 | //\r | |
56 | // Ready to boot event\r | |
57 | //\r | |
58 | EFI_EVENT Event;\r | |
59 | \r | |
60 | //\r | |
61 | // Updates to Fmp storage must be locked.\r | |
62 | //\r | |
63 | EFI_LOCK FmpLock;\r | |
64 | \r | |
65 | //\r | |
66 | // Update to Non-Fmp storage must be locked\r | |
67 | //\r | |
68 | EFI_LOCK NonFmpLock;\r | |
69 | } ESRT_PRIVATE_DATA;\r | |
70 | \r | |
71 | \r | |
72 | /**\r | |
73 | Find Esrt Entry stored in ESRT repository. \r | |
74 | \r | |
75 | @param[in] FwClass Firmware class guid in Esrt entry\r | |
76 | @param[in] Attribute Esrt from Non FMP or FMP instance\r | |
77 | @param[out] Entry Esrt entry returned\r | |
78 | \r | |
79 | @retval EFI_SUCCESS Successfully find an Esrt entry\r | |
80 | @retval EF_NOT_FOUND No Esrt entry found\r | |
81 | \r | |
82 | **/\r | |
83 | EFI_STATUS\r | |
84 | GetEsrtEntry (\r | |
85 | IN EFI_GUID *FwClass,\r | |
86 | IN UINTN Attribute,\r | |
87 | OUT EFI_SYSTEM_RESOURCE_ENTRY *Entry\r | |
88 | );\r | |
89 | \r | |
90 | /**\r | |
91 | Insert a new ESRT entry into ESRT Cache repository.\r | |
92 | \r | |
93 | @param[in] Entry Esrt entry to be set\r | |
94 | @param[in] Attribute Esrt from Esrt private protocol or FMP instance\r | |
95 | \r | |
96 | @retval EFI_SUCCESS Successfully set a variable.\r | |
97 | \r | |
98 | **/\r | |
99 | EFI_STATUS\r | |
100 | InsertEsrtEntry(\r | |
101 | IN EFI_SYSTEM_RESOURCE_ENTRY *Entry,\r | |
102 | UINTN Attribute\r | |
103 | );\r | |
104 | \r | |
105 | /**\r | |
106 | Delete ESRT Entry from ESRT repository. \r | |
107 | \r | |
108 | @param[in] FwClass FwClass of Esrt entry to delete \r | |
109 | @param[in] Attribute Esrt from Esrt private protocol or FMP instance\r | |
110 | \r | |
111 | @retval EFI_SUCCESS Insert all entries Successfully \r | |
112 | @retval EFI_NOT_FOUND ESRT entry with FwClass doesn't exsit\r | |
113 | \r | |
114 | **/\r | |
115 | EFI_STATUS\r | |
116 | DeleteEsrtEntry(\r | |
117 | IN EFI_GUID *FwClass,\r | |
118 | IN UINTN Attribute\r | |
119 | );\r | |
120 | \r | |
121 | /**\r | |
122 | Update one ESRT entry in ESRT repository\r | |
123 | \r | |
124 | @param[in] Entry Esrt entry to be set\r | |
125 | @param[in] Attribute Esrt from Non Esrt or FMP instance\r | |
126 | \r | |
127 | @retval EFI_SUCCESS Successfully Update a variable.\r | |
128 | @retval EFI_NOT_FOUND The Esrt enry doesn't exist\r | |
129 | \r | |
130 | **/\r | |
131 | EFI_STATUS\r | |
132 | UpdateEsrtEntry(\r | |
133 | IN EFI_SYSTEM_RESOURCE_ENTRY *Entry,\r | |
134 | UINTN Attribute\r | |
135 | );\r | |
136 | \r | |
137 | /**\r | |
138 | Init one ESRT entry according to input FmpImageInfo (V1, V2, V3) .\r | |
139 | \r | |
a3ac2587 CZ |
140 | @param[in, out] EsrtEntry Esrt entry to be Init\r |
141 | @param[in] FmpImageInfo FMP image info descriptor\r | |
142 | @param[in] DescriptorVersion FMP Image info descriptor version\r | |
acd32208 CZ |
143 | \r |
144 | **/\r | |
145 | VOID \r | |
146 | SetEsrtEntryFromFmpInfo (\r | |
147 | IN OUT EFI_SYSTEM_RESOURCE_ENTRY *EsrtEntry,\r | |
148 | IN EFI_FIRMWARE_IMAGE_DESCRIPTOR *FmpImageInfo,\r | |
149 | IN UINT32 DescriptorVersion\r | |
150 | );\r | |
151 | \r | |
152 | /**\r | |
153 | Get ESRT entry from ESRT Cache by FwClass Guid \r | |
154 | \r | |
155 | @param[in] FwClass FwClass of Esrt entry to get \r | |
a3ac2587 | 156 | @param[in, out] Entry Esrt entry returned \r |
acd32208 CZ |
157 | \r |
158 | @retval EFI_SUCCESS The variable saving this Esrt Entry exists.\r | |
159 | @retval EF_NOT_FOUND No correct variable found.\r | |
160 | @retval EFI_WRITE_PROTECTED ESRT Cache repository is locked\r | |
161 | \r | |
162 | **/\r | |
163 | EFI_STATUS\r | |
164 | EFIAPI\r | |
165 | EsrtDxeGetEsrtEntry(\r | |
166 | IN EFI_GUID *FwClass,\r | |
167 | IN OUT EFI_SYSTEM_RESOURCE_ENTRY *Entry\r | |
168 | );\r | |
169 | \r | |
170 | /**\r | |
171 | Update one ESRT entry in ESRT Cache.\r | |
172 | \r | |
173 | @param[in] Entry Esrt entry to be updated\r | |
174 | \r | |
175 | @retval EFI_SUCCESS Successfully update an ESRT entry in cache.\r | |
176 | @retval EFI_INVALID_PARAMETER Entry does't exist in ESRT Cache\r | |
177 | @retval EFI_WRITE_PROTECTED ESRT Cache is locked\r | |
178 | \r | |
179 | **/\r | |
180 | EFI_STATUS\r | |
181 | EFIAPI\r | |
182 | EsrtDxeUpdateEsrtEntry(\r | |
183 | IN EFI_SYSTEM_RESOURCE_ENTRY *Entry\r | |
184 | );\r | |
185 | \r | |
186 | /**\r | |
187 | Non-FMP instance to unregister Esrt Entry from ESRT Cache. \r | |
188 | \r | |
189 | @param[in] FwClass FwClass of Esrt entry to Unregister \r | |
190 | \r | |
191 | @retval EFI_SUCCESS Insert all entries Successfully \r | |
192 | @retval EFI_NOT_FOUND Entry of FwClass does not exsit\r | |
193 | \r | |
194 | **/\r | |
195 | EFI_STATUS\r | |
196 | EFIAPI\r | |
197 | EsrtDxeUnRegisterEsrtEntry(\r | |
198 | IN EFI_GUID *FwClass\r | |
199 | );\r | |
200 | \r | |
201 | /**\r | |
202 | Non-FMP instance to register one ESRT entry into ESRT Cache.\r | |
203 | \r | |
204 | @param[in] Entry Esrt entry to be set\r | |
205 | \r | |
206 | @retval EFI_SUCCESS Successfully set a variable.\r | |
207 | @retval EFI_INVALID_PARAMETER ESRT Entry is already exist\r | |
208 | **/\r | |
209 | EFI_STATUS\r | |
210 | EFIAPI\r | |
211 | EsrtDxeRegisterEsrtEntry(\r | |
212 | IN EFI_SYSTEM_RESOURCE_ENTRY *Entry\r | |
213 | );\r | |
214 | \r | |
215 | /**\r | |
216 | This function syn up Cached ESRT with data from FMP instances\r | |
217 | Function should be called after Connect All in order to locate all FMP protocols\r | |
a3ac2587 | 218 | installed.\r |
acd32208 CZ |
219 | \r |
220 | @retval EFI_SUCCESS Successfully sync cache repository from FMP instances\r | |
221 | @retval EFI_NOT_FOUND No FMP Instance are found\r | |
222 | @retval EFI_OUT_OF_RESOURCES Resource allocaton fail\r | |
223 | \r | |
224 | **/\r | |
225 | EFI_STATUS\r | |
226 | EFIAPI\r | |
227 | EsrtDxeSyncFmp(\r | |
228 | VOID\r | |
229 | );\r | |
230 | \r | |
231 | /**\r | |
232 | This function locks up Esrt repository to be readonly. It should be called \r | |
233 | before gEfiEndOfDxeEventGroupGuid event signaled\r | |
234 | \r | |
235 | @retval EFI_SUCCESS Locks up FMP Non-FMP repository successfully \r | |
236 | \r | |
237 | **/\r | |
238 | EFI_STATUS\r | |
239 | EFIAPI\r | |
240 | EsrtDxeLockEsrtRepository(\r | |
241 | VOID\r | |
242 | );\r | |
243 | \r | |
244 | #endif // #ifndef _EFI_ESRT_IMPL_H_\r | |
245 | \r |