Adding top-level Conf directory for next generation of EDK II build infrastructure...
[mirror_edk2.git] / OldMdePkg / Include / Peim / PeiCis.h
CommitLineData
72df7b0f 1/** @file\r
2 Framework PEI master include file. This file should match the PEI CIS spec.\r
3\r
4 Copyright (c) 2006, Intel Corporation \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
13 Module Name: PeiCis.h\r
14\r
15 @par Revision Reference:\r
16 Version 0.91.\r
17\r
18**/\r
19\r
20#ifndef __PEIM_CIS_H__\r
21#define __PEIM_CIS_H__\r
22\r
23#include <Common/MultiPhase.h>\r
24#include <Common/BootMode.h>\r
25#include <Common/Hob.h>\r
26#include <Common/FirmwareVolumeImageFormat.h>\r
27#include <Common/FirmwareVolumeHeader.h>\r
28#include <Common/FirmwareFileSystem.h>\r
29#include <Common/Dependency.h>\r
30\r
31#define TIANO_ERROR(a) (MAX_2_BITS | (a))\r
32\r
33#if (EFI_SPECIFICATION_VERSION < 0x00020000)\r
34//\r
35// Tiano added a couple of return types. These are owned by UEFI specification\r
36// and Tiano can not use them. Thus for UEFI 2.0/R9 support we moved the values\r
37// to a UEFI OEM extension range to conform to UEFI specification.\r
38//\r
39#define EFI_NOT_AVAILABLE_YET EFIERR (28)\r
40#define EFI_UNLOAD_IMAGE EFIERR (29)\r
41#else\r
42#define EFI_NOT_AVAILABLE_YET TIANO_ERROR (0)\r
43#define EFI_UNLOAD_IMAGE TIANO_ERROR (1)\r
44#endif\r
45\r
46//\r
47// Declare forward referenced data structures\r
48//\r
49typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;\r
50typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;\r
51\r
52\r
53#include <Ppi/CpuIo.h>\r
d3058489 54#include <Ppi/PciCfg2.h>\r
72df7b0f 55#include <Ppi/PciCfg.h>\r
56\r
57//\r
58// PEI Specification Revision information\r
59//\r
60#define PEI_SPECIFICATION_MAJOR_REVISION 0\r
61#define PEI_SPECIFICATION_MINOR_REVISION 91\r
62\r
63/**\r
64 The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI \r
65 Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r
66\r
0647c9ad
LG
67 @param FfsHeader Pointer to the FFS file header.\r
68 @param PeiServices Describes the list of possible PEI Services.\r
72df7b0f 69\r
70 @return Status code\r
71\r
72**/\r
73typedef\r
74EFI_STATUS\r
75(EFIAPI *EFI_PEIM_ENTRY_POINT)(\r
76 IN EFI_FFS_FILE_HEADER *FfsHeader,\r
77 IN EFI_PEI_SERVICES **PeiServices\r
78 );\r
79\r
80/**\r
81 Entry point of the notification callback function itself within the PEIM.\r
82\r
0647c9ad 83 @param PeiServices Indirect reference to the PEI Services Table.\r
72df7b0f 84 @param NotifyDescriptor Address of the notification descriptor data structure.\r
0647c9ad 85 @param Ppi Address of the PPI that was installed.\r
72df7b0f 86\r
87 @return Status code\r
88 \r
89**/\r
90typedef\r
91EFI_STATUS\r
92(EFIAPI *EFI_PEIM_NOTIFY_ENTRY_POINT) (\r
93 IN EFI_PEI_SERVICES **PeiServices,\r
94 IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
95 IN VOID *Ppi\r
96 );\r
97\r
98//\r
99// PEI Ppi Services List Descriptors\r
100//\r
101#define EFI_PEI_PPI_DESCRIPTOR_PIC 0x00000001\r
102#define EFI_PEI_PPI_DESCRIPTOR_PPI 0x00000010\r
103#define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK 0x00000020\r
104#define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH 0x00000040\r
105#define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES 0x00000060\r
106#define EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST 0x80000000\r
107\r
108typedef struct {\r
109 UINTN Flags;\r
110 EFI_GUID *Guid;\r
111 VOID *Ppi;\r
112} EFI_PEI_PPI_DESCRIPTOR;\r
113\r
114struct _EFI_PEI_NOTIFY_DESCRIPTOR {\r
115 UINTN Flags;\r
116 EFI_GUID *Guid;\r
117 EFI_PEIM_NOTIFY_ENTRY_POINT Notify;\r
118};\r
119\r
120/**\r
121 This service is the first one provided by the PEI Foundation. This function \r
122 installs an interface in the PEI PPI database by GUID. The purpose of the \r
123 service is to publish an interface that other parties can use to call \r
124 additional PEIMs.\r
125\r
0647c9ad
LG
126 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r
127 published by the PEI Foundation.\r
128 @param PpiList A pointer to the list of interfaces that the caller shall install.\r
72df7b0f 129\r
0647c9ad
LG
130 @retval EFI_SUCCESS The interface was successfully installed.\r
131 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
132 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
72df7b0f 133\r
134**/\r
135typedef\r
136EFI_STATUS\r
137(EFIAPI *EFI_PEI_INSTALL_PPI) (\r
138 IN EFI_PEI_SERVICES **PeiServices,\r
139 IN EFI_PEI_PPI_DESCRIPTOR *PpiList\r
140 );\r
141\r
142/**\r
143 This function reinstalls an interface in the PEI PPI database by GUID. \r
144 The purpose of the service is to publish an interface that other parties \r
145 can use to replace a same-named interface in the protocol database \r
146 with a different interface. \r
147\r
0647c9ad
LG
148 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r
149 published by the PEI Foundation.\r
150 @param OldPpi A pointer to the former PPI in the database.\r
151 @param NewPpi A pointer to the new interfaces that the caller shall install.\r
72df7b0f 152\r
0647c9ad
LG
153 @retval EFI_SUCCESS The interface was successfully installed.\r
154 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
155 list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
156 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
157 @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r
72df7b0f 158\r
159**/\r
160typedef\r
161EFI_STATUS\r
162(EFIAPI *EFI_PEI_REINSTALL_PPI) (\r
163 IN EFI_PEI_SERVICES **PeiServices,\r
164 IN EFI_PEI_PPI_DESCRIPTOR *OldPpi,\r
165 IN EFI_PEI_PPI_DESCRIPTOR *NewPpi\r
166 );\r
167\r
168/**\r
169 This function locates an interface in the PEI PPI database by GUID. \r
170\r
0647c9ad
LG
171 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
172 @param Guid A pointer to the GUID whose corresponding interface needs to be found.\r
173 @param Instance The N-th instance of the interface that is required.\r
174 @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r
175 @param Ppi A pointer to the instance of the interface.\r
72df7b0f 176\r
0647c9ad
LG
177 @retval EFI_SUCCESS The interface was successfully returned.\r
178 @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.\r
72df7b0f 179\r
180**/\r
181typedef\r
182EFI_STATUS\r
183(EFIAPI *EFI_PEI_LOCATE_PPI) (\r
184 IN EFI_PEI_SERVICES **PeiServices,\r
185 IN EFI_GUID *Guid,\r
186 IN UINTN Instance,\r
187 IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,\r
188 IN OUT VOID **Ppi\r
189 );\r
190\r
191/**\r
192 This function installs a notification service to be called back when a \r
193 given interface is installed or reinstalled. The purpose of the service \r
194 is to publish an interface that other parties can use to call additional PPIs \r
195 that may materialize later.\r
196\r
0647c9ad
LG
197 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
198 @param NotifyList A pointer to the list of notification interfaces that the caller shall install.\r
72df7b0f 199\r
0647c9ad
LG
200 @retval EFI_SUCCESS The interface was successfully installed.\r
201 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
202 list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
203 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
72df7b0f 204\r
205**/\r
206typedef\r
207EFI_STATUS\r
208(EFIAPI *EFI_PEI_NOTIFY_PPI) (\r
209 IN EFI_PEI_SERVICES **PeiServices,\r
210 IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList\r
211 );\r
212\r
213/**\r
214 This function returns the present value of the boot mode.\r
215\r
0647c9ad
LG
216 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
217 @param BootMode A pointer to contain the value of the boot mode.\r
72df7b0f 218\r
0647c9ad 219 @retval EFI_SUCCESS The boot mode was returned successfully.\r
72df7b0f 220\r
221**/\r
222typedef\r
223EFI_STATUS\r
224(EFIAPI *EFI_PEI_GET_BOOT_MODE) (\r
225 IN EFI_PEI_SERVICES **PeiServices,\r
226 OUT EFI_BOOT_MODE *BootMode\r
227 );\r
228\r
229/**\r
230 This function sets the value of the boot mode.\r
231\r
0647c9ad
LG
232 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
233 @param BootMode The value of the boot mode to set.\r
72df7b0f 234\r
0647c9ad 235 @retval EFI_SUCCESS The boot mode was returned successfully.\r
72df7b0f 236\r
237**/\r
238typedef\r
239EFI_STATUS\r
240(EFIAPI *EFI_PEI_SET_BOOT_MODE) (\r
241 IN EFI_PEI_SERVICES **PeiServices,\r
242 IN EFI_BOOT_MODE BootMode\r
243 );\r
244\r
245/**\r
246 This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. \r
247\r
0647c9ad
LG
248 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
249 @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize\r
72df7b0f 250\r
0647c9ad 251 @retval EFI_SUCCESS The list was successfully returned.\r
72df7b0f 252 @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r
253\r
254**/\r
255typedef\r
256EFI_STATUS\r
257(EFIAPI *EFI_PEI_GET_HOB_LIST) (\r
258 IN EFI_PEI_SERVICES **PeiServices,\r
259 IN OUT VOID **HobList\r
260 );\r
261\r
262/**\r
511710d6 263 This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB's) headers.\r
72df7b0f 264\r
0647c9ad
LG
265 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
266 @param Type The type of HOB to be installed.\r
267 @param Length The length of the HOB to be added.\r
268 @param Hob The address of a pointer that will contain the HOB header.\r
72df7b0f 269\r
0647c9ad
LG
270 @retval EFI_SUCCESS The HOB was successfully created.\r
271 @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
72df7b0f 272\r
273**/\r
274typedef\r
275EFI_STATUS\r
276(EFIAPI *EFI_PEI_CREATE_HOB) (\r
277 IN EFI_PEI_SERVICES **PeiServices,\r
278 IN UINT16 Type,\r
279 IN UINT16 Length,\r
280 IN OUT VOID **Hob\r
281 );\r
282\r
283/**\r
284 The purpose of the service is to abstract the capability of the PEI \r
285 Foundation to discover instances of firmware volumes in the system. \r
286 Given the input file pointer, this service searches for the next \r
287 matching file in the Firmware File System (FFS) volume.\r
288\r
0647c9ad
LG
289 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
290 @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).\r
291 @param FwVolHeader Pointer to the firmware volume header of the volume to return.\r
72df7b0f 292\r
0647c9ad
LG
293 @retval EFI_SUCCESS The volume was found.\r
294 @retval EFI_NOT_FOUND The volume was not found.\r
72df7b0f 295 @retval EFI_INVALID_PARAMETER FwVolHeader is NULL\r
296\r
297**/\r
298typedef\r
299EFI_STATUS\r
300(EFIAPI *EFI_PEI_FFS_FIND_NEXT_VOLUME) (\r
301 IN EFI_PEI_SERVICES **PeiServices,\r
302 IN UINTN Instance,\r
303 IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader\r
304 );\r
305\r
306/**\r
307 The purpose of the service is to abstract the capability of the PEI \r
308 Foundation to discover instances of firmware files in the system. \r
309 Given the input file pointer, this service searches for the next matching \r
310 file in the Firmware File System (FFS) volume.\r
311\r
0647c9ad
LG
312 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
313 @param SearchType A filter to find files only of this type.\r
314 @param FwVolHeader Pointer to the firmware volume header of the volume to search.This parameter \r
315 must point to a valid FFS volume.\r
316 @param FileHeader Pointer to the current file from which to begin searching.This pointer will be \r
317 updated upon return to reflect the file found.\r
72df7b0f 318\r
0647c9ad
LG
319 @retval EFI_SUCCESS The file was found.\r
320 @retval EFI_NOT_FOUND The file was not found.\r
321 @retval EFI_NOT_FOUND The header checksum was not zero.\r
72df7b0f 322\r
323**/\r
324typedef\r
325EFI_STATUS\r
326(EFIAPI *EFI_PEI_FFS_FIND_NEXT_FILE) (\r
327 IN EFI_PEI_SERVICES **PeiServices,\r
328 IN EFI_FV_FILETYPE SearchType,\r
329 IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader,\r
330 IN OUT EFI_FFS_FILE_HEADER **FileHeader\r
331 );\r
332\r
333/**\r
334 Given the input file pointer, this service searches for the next \r
335 matching file in the Firmware File System (FFS) volume. \r
336\r
0647c9ad
LG
337 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
338 @param SectionType The value of the section type to find.\r
339 @param FfsFileHeader A pointer to the file header that contains the set of sections to be searched.\r
340 @param SectionData A pointer to the discovered section, if successful.\r
72df7b0f 341\r
0647c9ad
LG
342 @retval EFI_SUCCESS The section was found.\r
343 @retval EFI_NOT_FOUND The section was not found.\r
72df7b0f 344\r
345**/\r
346typedef\r
347EFI_STATUS\r
348(EFIAPI *EFI_PEI_FFS_FIND_SECTION_DATA) (\r
349 IN EFI_PEI_SERVICES **PeiServices,\r
350 IN EFI_SECTION_TYPE SectionType,\r
351 IN EFI_FFS_FILE_HEADER *FfsFileHeader,\r
352 IN OUT VOID **SectionData\r
353 );\r
354\r
355/**\r
356 This function registers the found memory configuration with the PEI Foundation.\r
357\r
0647c9ad
LG
358 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
359 @param MemoryBegin The value of a region of installed memory\r
360 @param MemoryLength The corresponding length of a region of installed memory.\r
72df7b0f 361\r
0647c9ad 362 @retval EFI_SUCCESS The region was successfully installed in a HOB.\r
72df7b0f 363 @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.\r
0647c9ad 364 @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
72df7b0f 365\r
366**/\r
367typedef\r
368EFI_STATUS\r
369(EFIAPI *EFI_PEI_INSTALL_PEI_MEMORY) (\r
370 IN EFI_PEI_SERVICES **PeiServices,\r
371 IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r
372 IN UINT64 MemoryLength\r
373 );\r
374\r
375/**\r
376 The purpose of the service is to publish an interface that allows \r
377 PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
378\r
0647c9ad
LG
379 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
380 @param MemoryType The type of memory to allocate.\r
381 @param Pages The number of contiguous 4 KB pages to allocate.\r
382 @param Memory Pointer to a physical address. On output, the address is set to the base \r
383 of the page range that was allocated.\r
72df7b0f 384\r
0647c9ad 385 @retval EFI_SUCCESS The memory range was successfully allocated.\r
72df7b0f 386 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r
72df7b0f 387 @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.\r
388\r
389**/\r
390typedef\r
391EFI_STATUS\r
392(EFIAPI *EFI_PEI_ALLOCATE_PAGES) (\r
393 IN EFI_PEI_SERVICES **PeiServices,\r
394 IN EFI_MEMORY_TYPE MemoryType,\r
395 IN UINTN Pages,\r
396 IN OUT EFI_PHYSICAL_ADDRESS *Memory\r
397 );\r
398\r
399/**\r
400 The purpose of this service is to publish an interface that \r
401 allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
402\r
0647c9ad
LG
403 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
404 @param Size The number of bytes to allocate from the pool.\r
405 @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.\r
72df7b0f 406\r
0647c9ad
LG
407 @retval EFI_SUCCESS The allocation was successful.\r
408 @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r
72df7b0f 409\r
410**/\r
411typedef\r
412EFI_STATUS\r
413(EFIAPI *EFI_PEI_ALLOCATE_POOL) (\r
414 IN EFI_PEI_SERVICES **PeiServices,\r
415 IN UINTN Size,\r
416 OUT VOID **Buffer\r
417 );\r
418\r
419/**\r
420 This service copies the contents of one buffer to another buffer.\r
421\r
0647c9ad
LG
422 @param Destination Pointer to the destination buffer of the memory copy.\r
423 @param Source Pointer to the source buffer of the memory copy\r
424 @param Length Number of bytes to copy from Source to Destination.\r
72df7b0f 425\r
426 @return None\r
427\r
428**/\r
429typedef\r
430VOID\r
431(EFIAPI *EFI_PEI_COPY_MEM) (\r
432 IN VOID *Destination,\r
433 IN VOID *Source,\r
434 IN UINTN Length\r
435 );\r
436\r
437/**\r
438 The service fills a buffer with a specified value.\r
439\r
0647c9ad
LG
440 @param Buffer Pointer to the buffer to fill.\r
441 @param Size Number of bytes in Buffer to fill.\r
442 @param Value Value to fill Buffer with\r
72df7b0f 443\r
444 @return None\r
445\r
446**/\r
447typedef\r
448VOID\r
449(EFIAPI *EFI_PEI_SET_MEM) (\r
450 IN VOID *Buffer,\r
451 IN UINTN Size,\r
452 IN UINT8 Value\r
453 );\r
454\r
455/**\r
456 This service publishes an interface that allows PEIMs to report status codes.\r
457\r
0647c9ad
LG
458 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
459 @param Type Indicates the type of status code being reported.\r
460 @param Value Describes the current status of a hardware or\r
461 software entity. This includes information about the class and\r
462 subclass that is used to classify the entity as well as an operation.\r
463 For progress codes, the operation is the current activity.\r
464 For error codes, it is the exception.For debug codes,it is not defined at this time.\r
465 @param Instance The enumeration of a hardware or software entity within\r
466 the system. A system may contain multiple entities that match a class/subclass\r
467 pairing. The instance differentiates between them. An instance of 0 indicates\r
468 that instance information is unavailable, not meaningful, or not relevant.\r
469 Valid instance numbers start with 1.\r
470 @param CallerId This optional parameter may be used to identify the caller.\r
471 This parameter allows the status code driver to apply different rules to\r
472 different callers.\r
473 @param Data This optional parameter may be used to pass additional data.\r
474\r
475 @retval EFI_SUCCESS The function completed successfully.\r
72df7b0f 476 @retval EFI_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.\r
477\r
478**/\r
479typedef\r
480EFI_STATUS\r
481(EFIAPI *EFI_PEI_REPORT_STATUS_CODE) (\r
482 IN EFI_PEI_SERVICES **PeiServices,\r
483 IN EFI_STATUS_CODE_TYPE Type,\r
484 IN EFI_STATUS_CODE_VALUE Value,\r
485 IN UINT32 Instance,\r
486 IN EFI_GUID *CallerId OPTIONAL,\r
487 IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
488 );\r
489\r
490/**\r
491 Resets the entire platform.\r
492\r
0647c9ad
LG
493 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES\r
494 table published by the PEI Foundation.\r
72df7b0f 495\r
0647c9ad 496 @retval EFI_SUCCESS The function completed successfully.\r
72df7b0f 497 @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
498\r
499**/\r
500typedef\r
501EFI_STATUS\r
502(EFIAPI *EFI_PEI_RESET_SYSTEM) (\r
503 IN EFI_PEI_SERVICES **PeiServices\r
504 );\r
505\r
506//\r
507// EFI PEI Services Table\r
508//\r
509#define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL\r
510#define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION << 16) | (PEI_SPECIFICATION_MINOR_REVISION))\r
511\r
512struct _EFI_PEI_SERVICES {\r
513 EFI_TABLE_HEADER Hdr;\r
514\r
515 //\r
516 // PPI Functions\r
517 //\r
518 EFI_PEI_INSTALL_PPI InstallPpi;\r
519 EFI_PEI_REINSTALL_PPI ReInstallPpi;\r
520 EFI_PEI_LOCATE_PPI LocatePpi;\r
521 EFI_PEI_NOTIFY_PPI NotifyPpi;\r
522\r
523 //\r
524 // Boot Mode Functions\r
525 //\r
526 EFI_PEI_GET_BOOT_MODE GetBootMode;\r
527 EFI_PEI_SET_BOOT_MODE SetBootMode;\r
528\r
529 //\r
530 // HOB Functions\r
531 //\r
532 EFI_PEI_GET_HOB_LIST GetHobList;\r
533 EFI_PEI_CREATE_HOB CreateHob;\r
534\r
535 //\r
536 // Filesystem Functions\r
537 //\r
538 EFI_PEI_FFS_FIND_NEXT_VOLUME FfsFindNextVolume;\r
539 EFI_PEI_FFS_FIND_NEXT_FILE FfsFindNextFile;\r
540 EFI_PEI_FFS_FIND_SECTION_DATA FfsFindSectionData;\r
541\r
542 //\r
543 // Memory Functions\r
544 //\r
545 EFI_PEI_INSTALL_PEI_MEMORY InstallPeiMemory;\r
546 EFI_PEI_ALLOCATE_PAGES AllocatePages;\r
547 EFI_PEI_ALLOCATE_POOL AllocatePool;\r
548 EFI_PEI_COPY_MEM CopyMem;\r
549 EFI_PEI_SET_MEM SetMem;\r
550\r
551 //\r
552 // Status Code\r
553 //\r
554 EFI_PEI_REPORT_STATUS_CODE PeiReportStatusCode;\r
555\r
556 //\r
557 // Reset\r
558 //\r
559 EFI_PEI_RESET_SYSTEM PeiResetSystem;\r
560\r
561 //\r
562 // Pointer to PPI interface\r
563 //\r
564 EFI_PEI_CPU_IO_PPI *CpuIo;\r
565 EFI_PEI_PCI_CFG_PPI *PciCfg;\r
566\r
567};\r
568\r
569typedef struct {\r
570 UINTN BootFirmwareVolume;\r
571 UINTN SizeOfCacheAsRam;\r
572 EFI_PEI_PPI_DESCRIPTOR *DispatchTable;\r
573} EFI_PEI_STARTUP_DESCRIPTOR;\r
574\r
575#include <Common/EfiImage.h>\r
576#include <Common/StatusCode.h>\r
577#include <Common/BootScript.h>\r
578#include <Common/Capsule.h>\r
579\r
580#include <Guid/Apriori.h>\r
581#include <Guid/Capsule.h>\r
582#include <Guid/DxeServices.h>\r
583#include <Guid/HobList.h>\r
584#include <Guid/MemoryAllocationHob.h>\r
585#include <Guid/FirmwareFileSystem.h>\r
586#include <Guid/SmramMemoryReserve.h>\r
587#include <Guid/GlobalVariable.h>\r
588\r
589#include <Ppi/BlockIo.h>\r
590#include <Ppi/BootInRecoveryMode.h>\r
591#include <Ppi/BootScriptExecuter.h>\r
592#include <Ppi/DeviceRecoveryModule.h>\r
593#include <Ppi/DxeIpl.h>\r
594#include <Ppi/EndOfPeiPhase.h>\r
595#include <Ppi/FindFv.h>\r
596#include <Ppi/LoadFile.h>\r
597#include <Ppi/MasterBootMode.h>\r
598#include <Ppi/MemoryDiscovered.h>\r
599#include <Ppi/Pcd.h>\r
600#include <Ppi/ReadOnlyVariable.h>\r
601#include <Ppi/RecoveryModule.h>\r
602#include <Ppi/Reset.h>\r
603#include <Ppi/S3Resume.h>\r
604#include <Ppi/SecPlatformInformation.h>\r
605#include <Ppi/SectionExtraction.h>\r
606#include <Ppi/Security.h>\r
607#include <Ppi/Smbus.h>\r
608#include <Ppi/Stall.h>\r
609#include <Ppi/StatusCode.h>\r
610\r
611#include <Protocol/FirmwareVolumeBlock.h>\r
72df7b0f 612#endif\r