]>
Commit | Line | Data |
---|---|---|
738ec565 | 1 | /** @file\r |
2 | Implementation for PEI Services Library.\r | |
3 | \r | |
4 | Copyright (c) 2006 - 2007, Intel Corporation<BR>\r | |
5 | All rights reserved. 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 | |
738ec565 | 13 | **/\r |
14 | \r | |
c892d846 | 15 | \r |
c7d265a9 | 16 | #include <PiPei.h>\r |
c892d846 | 17 | \r |
18 | \r | |
c7d265a9 | 19 | #include <Library/PeiServicesLib.h>\r |
20 | #include <Library/PeiServicesTablePointerLib.h>\r | |
738ec565 | 21 | \r |
22 | /**\r | |
23 | This service enables a given PEIM to register an interface into the PEI Foundation.\r | |
24 | \r | |
25 | @param PpiList A pointer to the list of interfaces that the caller shall install.\r | |
26 | \r | |
27 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
28 | @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL.\r | |
29 | @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the\r | |
30 | EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
31 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
32 | \r | |
33 | **/\r | |
34 | EFI_STATUS\r | |
35 | EFIAPI\r | |
36 | PeiServicesInstallPpi (\r | |
1c280088 | 37 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r |
738ec565 | 38 | )\r |
39 | {\r | |
1c280088 | 40 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 41 | \r |
1c280088 | 42 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 43 | return (*PeiServices)->InstallPpi (PeiServices, PpiList);\r |
44 | }\r | |
45 | \r | |
46 | /**\r | |
47 | This service enables PEIMs to replace an entry in the PPI database with an alternate entry.\r | |
48 | \r | |
49 | @param OldPpi Pointer to the old PEI PPI Descriptors.\r | |
50 | @param NewPpi Pointer to the new PEI PPI Descriptors.\r | |
51 | \r | |
52 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
53 | @retval EFI_INVALID_PARAMETER The OldPpi or NewPpi is NULL.\r | |
54 | @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the\r | |
55 | EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
56 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
57 | @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been\r | |
58 | installed.\r | |
59 | \r | |
60 | **/\r | |
61 | EFI_STATUS\r | |
62 | EFIAPI\r | |
63 | PeiServicesReInstallPpi (\r | |
1c280088 | 64 | IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi,\r |
65 | IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi\r | |
738ec565 | 66 | )\r |
67 | {\r | |
1c280088 | 68 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 69 | \r |
1c280088 | 70 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 71 | return (*PeiServices)->ReInstallPpi (PeiServices, OldPpi, NewPpi);\r |
72 | }\r | |
73 | \r | |
74 | /**\r | |
75 | This service enables PEIMs to discover a given instance of an interface.\r | |
76 | \r | |
77 | @param Guid A pointer to the GUID whose corresponding interface needs to be\r | |
78 | found.\r | |
79 | @param Instance The N-th instance of the interface that is required.\r | |
80 | @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r | |
81 | @param Ppi A pointer to the instance of the interface.\r | |
82 | \r | |
83 | @retval EFI_SUCCESS The interface was successfully returned.\r | |
84 | @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.\r | |
85 | \r | |
86 | **/\r | |
87 | EFI_STATUS\r | |
88 | EFIAPI\r | |
89 | PeiServicesLocatePpi (\r | |
1c280088 | 90 | IN CONST EFI_GUID *Guid,\r |
738ec565 | 91 | IN UINTN Instance,\r |
92 | IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,\r | |
93 | IN OUT VOID **Ppi\r | |
94 | )\r | |
95 | {\r | |
1c280088 | 96 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 97 | \r |
1c280088 | 98 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 99 | return (*PeiServices)->LocatePpi (PeiServices, Guid, Instance, PpiDescriptor, Ppi);\r |
100 | }\r | |
101 | \r | |
102 | /**\r | |
103 | This service enables PEIMs to register a given service to be invoked when another service is\r | |
104 | installed or reinstalled.\r | |
105 | \r | |
106 | @param NotifyList A pointer to the list of notification interfaces that the caller\r | |
107 | shall install.\r | |
108 | \r | |
109 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
110 | @retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL.\r | |
111 | @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have the\r | |
112 | EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.\r | |
113 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
114 | \r | |
115 | **/\r | |
116 | EFI_STATUS\r | |
117 | EFIAPI\r | |
118 | PeiServicesNotifyPpi (\r | |
1c280088 | 119 | IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList\r |
738ec565 | 120 | )\r |
121 | {\r | |
1c280088 | 122 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 123 | \r |
1c280088 | 124 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 125 | return (*PeiServices)->NotifyPpi (PeiServices, NotifyList);\r |
126 | }\r | |
127 | \r | |
128 | /**\r | |
129 | This service enables PEIMs to ascertain the present value of the boot mode.\r | |
130 | \r | |
131 | @param BootMode A pointer to contain the value of the boot mode.\r | |
132 | \r | |
133 | @retval EFI_SUCCESS The boot mode was returned successfully.\r | |
134 | @retval EFI_INVALID_PARAMETER BootMode is NULL.\r | |
135 | \r | |
136 | **/\r | |
137 | EFI_STATUS\r | |
138 | EFIAPI\r | |
139 | PeiServicesGetBootMode (\r | |
140 | IN OUT EFI_BOOT_MODE *BootMode\r | |
141 | )\r | |
142 | {\r | |
1c280088 | 143 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 144 | \r |
1c280088 | 145 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 146 | return (*PeiServices)->GetBootMode (PeiServices, BootMode);\r |
147 | }\r | |
148 | \r | |
149 | /**\r | |
150 | This service enables PEIMs to update the boot mode variable.\r | |
151 | \r | |
152 | @param BootMode The value of the boot mode to set.\r | |
153 | \r | |
154 | @retval EFI_SUCCESS The value was successfully updated\r | |
155 | \r | |
156 | **/\r | |
157 | EFI_STATUS\r | |
158 | EFIAPI\r | |
159 | PeiServicesSetBootMode (\r | |
160 | IN EFI_BOOT_MODE BootMode\r | |
161 | )\r | |
162 | {\r | |
1c280088 | 163 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 164 | \r |
1c280088 | 165 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 166 | return (*PeiServices)->SetBootMode (PeiServices, BootMode);\r |
167 | }\r | |
168 | \r | |
169 | /**\r | |
170 | This service enables a PEIM to ascertain the address of the list of HOBs in memory.\r | |
171 | \r | |
172 | @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize.\r | |
173 | \r | |
174 | @retval EFI_SUCCESS The list was successfully returned.\r | |
175 | @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r | |
176 | \r | |
177 | **/\r | |
178 | EFI_STATUS\r | |
179 | EFIAPI\r | |
180 | PeiServicesGetHobList (\r | |
181 | IN OUT VOID **HobList\r | |
182 | )\r | |
183 | {\r | |
1c280088 | 184 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 185 | \r |
1c280088 | 186 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 187 | return (*PeiServices)->GetHobList (PeiServices, HobList);\r |
188 | }\r | |
189 | \r | |
190 | /**\r | |
191 | This service enables PEIMs to create various types of HOBs.\r | |
192 | \r | |
193 | @param Type The type of HOB to be installed.\r | |
194 | @param Length The length of the HOB to be added.\r | |
195 | @param Hob The address of a pointer that will contain the HOB header.\r | |
196 | \r | |
197 | @retval EFI_SUCCESS The HOB was successfully created.\r | |
198 | @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r | |
199 | \r | |
200 | **/\r | |
201 | EFI_STATUS\r | |
202 | EFIAPI\r | |
203 | PeiServicesCreateHob (\r | |
204 | IN UINT16 Type,\r | |
205 | IN UINT16 Length,\r | |
206 | IN OUT VOID **Hob\r | |
207 | )\r | |
208 | {\r | |
1c280088 | 209 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 210 | \r |
1c280088 | 211 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 212 | return (*PeiServices)->CreateHob (PeiServices, Type, Length, Hob);\r |
213 | }\r | |
214 | \r | |
215 | /**\r | |
216 | This service enables PEIMs to discover additional firmware volumes.\r | |
217 | \r | |
218 | @param Instance This instance of the firmware volume to find. The value 0 is the\r | |
219 | Boot Firmware Volume (BFV).\r | |
220 | @param FwVolHeader Pointer to the firmware volume header of the volume to return.\r | |
221 | \r | |
222 | @retval EFI_SUCCESS The volume was found.\r | |
223 | @retval EFI_NOT_FOUND The volume was not found.\r | |
224 | @retval EFI_INVALID_PARAMETER FwVolHeader is NULL.\r | |
225 | \r | |
226 | **/\r | |
227 | EFI_STATUS\r | |
228 | EFIAPI\r | |
229 | PeiServicesFfsFindNextVolume (\r | |
230 | IN UINTN Instance,\r | |
1c280088 | 231 | IN OUT EFI_PEI_FV_HANDLE *VolumeHandle\r |
738ec565 | 232 | )\r |
233 | {\r | |
1c280088 | 234 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 235 | \r |
1c280088 | 236 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
237 | return (*PeiServices)->FfsFindNextVolume (PeiServices, Instance, VolumeHandle);\r | |
738ec565 | 238 | }\r |
239 | \r | |
240 | /**\r | |
241 | This service enables PEIMs to discover additional firmware files.\r | |
242 | \r | |
243 | @param SearchType A filter to find files only of this type.\r | |
244 | @param FwVolHeader Pointer to the firmware volume header of the volume to search.\r | |
245 | This parameter must point to a valid FFS volume.\r | |
246 | @param FileHeader Pointer to the current file from which to begin searching.\r | |
247 | \r | |
248 | @retval EFI_SUCCESS The file was found.\r | |
249 | @retval EFI_NOT_FOUND The file was not found.\r | |
250 | @retval EFI_NOT_FOUND The header checksum was not zero.\r | |
251 | \r | |
252 | **/\r | |
253 | EFI_STATUS\r | |
254 | EFIAPI\r | |
255 | PeiServicesFfsFindNextFile (\r | |
256 | IN EFI_FV_FILETYPE SearchType,\r | |
1c280088 | 257 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r |
258 | IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
738ec565 | 259 | )\r |
260 | {\r | |
1c280088 | 261 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 262 | \r |
1c280088 | 263 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
264 | return (*PeiServices)->FfsFindNextFile (PeiServices, SearchType, VolumeHandle, FileHandle);\r | |
738ec565 | 265 | }\r |
266 | \r | |
267 | /**\r | |
268 | This service enables PEIMs to discover sections of a given type within a valid FFS file.\r | |
269 | \r | |
270 | @param SearchType The value of the section type to find.\r | |
271 | @param FfsFileHeader A pointer to the file header that contains the set of sections to\r | |
272 | be searched.\r | |
273 | @param SectionData A pointer to the discovered section, if successful.\r | |
274 | \r | |
275 | @retval EFI_SUCCESS The section was found.\r | |
276 | @retval EFI_NOT_FOUND The section was not found.\r | |
277 | \r | |
278 | **/\r | |
279 | EFI_STATUS\r | |
280 | EFIAPI\r | |
281 | PeiServicesFfsFindSectionData (\r | |
282 | IN EFI_SECTION_TYPE SectionType,\r | |
1c280088 | 283 | IN EFI_PEI_FILE_HANDLE FfsFileHeader,\r |
738ec565 | 284 | IN OUT VOID **SectionData\r |
285 | )\r | |
286 | {\r | |
1c280088 | 287 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 288 | \r |
1c280088 | 289 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 290 | return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FfsFileHeader, SectionData);\r |
291 | }\r | |
292 | \r | |
293 | /**\r | |
294 | This service enables PEIMs to register the permanent memory configuration\r | |
295 | that has been initialized with the PEI Foundation.\r | |
296 | \r | |
297 | @param MemoryBegin The value of a region of installed memory.\r | |
298 | @param MemoryLength The corresponding length of a region of installed memory.\r | |
299 | \r | |
300 | @retval EFI_SUCCESS The region was successfully installed in a HOB.\r | |
301 | @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.\r | |
302 | @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r | |
303 | \r | |
304 | **/\r | |
305 | EFI_STATUS\r | |
306 | EFIAPI\r | |
307 | PeiServicesInstallPeiMemory (\r | |
308 | IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r | |
309 | IN UINT64 MemoryLength\r | |
310 | )\r | |
311 | {\r | |
1c280088 | 312 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 313 | \r |
1c280088 | 314 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 315 | return (*PeiServices)->InstallPeiMemory (PeiServices, MemoryBegin, MemoryLength);\r |
316 | }\r | |
317 | \r | |
318 | /**\r | |
319 | This service enables PEIMs to allocate memory after the permanent memory has been installed by a\r | |
320 | PEIM.\r | |
321 | \r | |
322 | @param MemoryType Type of memory to allocate.\r | |
323 | @param Pages Number of pages to allocate.\r | |
324 | @param Memory Pointer of memory allocated.\r | |
325 | \r | |
326 | @retval EFI_SUCCESS The memory range was successfully allocated.\r | |
327 | @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.\r | |
328 | @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available.\r | |
329 | @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r | |
330 | \r | |
331 | **/\r | |
332 | EFI_STATUS\r | |
333 | EFIAPI\r | |
334 | PeiServicesAllocatePages (\r | |
335 | IN EFI_MEMORY_TYPE MemoryType,\r | |
336 | IN UINTN Pages,\r | |
337 | IN OUT EFI_PHYSICAL_ADDRESS *Memory\r | |
338 | )\r | |
339 | {\r | |
1c280088 | 340 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 341 | \r |
1c280088 | 342 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 343 | return (*PeiServices)->AllocatePages (PeiServices, MemoryType, Pages, Memory);\r |
344 | }\r | |
345 | \r | |
346 | /**\r | |
347 | This service allocates memory from the Hand-Off Block (HOB) heap.\r | |
348 | \r | |
349 | @param Size The number of bytes to allocate from the pool.\r | |
350 | @param Buffer If the call succeeds, a pointer to a pointer to the allocate\r | |
351 | buffer; undefined otherwise.\r | |
352 | \r | |
353 | @retval EFI_SUCCESS The allocation was successful\r | |
354 | @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r | |
355 | \r | |
356 | **/\r | |
357 | EFI_STATUS\r | |
358 | EFIAPI\r | |
359 | PeiServicesAllocatePool (\r | |
360 | IN UINTN Size,\r | |
361 | OUT VOID **Buffer\r | |
362 | )\r | |
363 | {\r | |
1c280088 | 364 | CONST EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 365 | \r |
1c280088 | 366 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r |
738ec565 | 367 | return (*PeiServices)->AllocatePool (PeiServices, Size, Buffer);\r |
368 | }\r | |
369 | \r | |
370 | /**\r | |
371 | This service resets the entire platform, including all processors and devices, and reboots the\r | |
372 | system.\r | |
373 | \r | |
374 | @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r | |
375 | \r | |
376 | **/\r | |
377 | EFI_STATUS\r | |
378 | EFIAPI\r | |
379 | PeiServicesResetSystem (\r | |
380 | VOID\r | |
381 | )\r | |
b0d803fe | 382 | {\r |
383 | CONST EFI_PEI_SERVICES **PeiServices;\r | |
384 | \r | |
385 | PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r | |
386 | return (*PeiServices)->ResetSystem (PeiServices);\r | |
387 | }\r | |
388 | \r | |
389 | EFI_STATUS\r | |
390 | EFIAPI\r | |
391 | PeiServicesRegisterForShadow (\r | |
392 | IN EFI_PEI_FILE_HANDLE FileHandle\r | |
393 | )\r | |
738ec565 | 394 | {\r |
1c280088 | 395 | EFI_PEI_SERVICES **PeiServices;\r |
738ec565 | 396 | \r |
397 | PeiServices = GetPeiServicesTablePointer ();\r | |
b0d803fe | 398 | return (*PeiServices)->RegisterForShadow (FileHandle);\r |
738ec565 | 399 | }\r |
b0d803fe | 400 | \r |
401 | EFI_STATUS\r | |
402 | EFIAPI\r | |
403 | PeiServicesFfsGetFileInfo (\r | |
404 | IN CONST EFI_PEI_FILE_HANDLE FileHandle,\r | |
405 | OUT EFI_FV_FILE_INFO *FileInfo\r | |
406 | )\r | |
407 | {\r | |
408 | EFI_PEI_SERVICES **PeiServices;\r | |
409 | \r | |
410 | PeiServices = GetPeiServicesTablePointer ();\r | |
411 | return (*PeiServices)->FfsGetFileInfo (FileHandle, FileInfo);\r | |
412 | }\r | |
413 | \r | |
414 | \r | |
415 | EFI_STATUS\r | |
416 | EFIAPI\r | |
417 | PeiServicesFfsFindFileByName (\r | |
418 | IN CONST EFI_GUID *FileName,\r | |
419 | IN CONST EFI_PEI_FV_HANDLE VolumeHandle,\r | |
420 | OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
421 | )\r | |
422 | {\r | |
423 | return (*GetPeiServicesTablePointer())->FfsFindFileByName (FileName, VolumeHandle, FileHandle);\r | |
424 | }\r | |
425 | \r | |
426 | \r | |
427 | EFI_STATUS\r | |
428 | EFIAPI\r | |
429 | PeiServicesFfsGetVolumeInfo (\r | |
430 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
431 | OUT EFI_FV_INFO *VolumeInfo\r | |
432 | )\r | |
433 | {\r | |
434 | return (*GetPeiServicesTablePointer())->FfsGetVolumeInfo (VolumeHandle, VolumeInfo);\r | |
435 | }\r | |
436 | \r |