Definition of Pei Core Structures and Services\r
\r
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
///\r
/// It is an FFS type extension used for PeiFindFileEx. It indicates current\r
-/// Ffs searching is for all PEIMs can be dispatched by PeiCore.\r
+/// FFS searching is for all PEIMs can be dispatched by PeiCore.\r
///\r
#define PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE 0xff\r
\r
} PEI_PPI_DATABASE;\r
\r
//\r
-// PEI_CORE_FV_HANDE.PeimState\r
+// PEI_CORE_FV_HANDLE.PeimState\r
// Do not change these values as there is code doing math to change states.\r
// Look for Private->Fv[FvCount].PeimState[PeimCount]++;\r
//\r
EFI_PEI_FV_HANDLE FvHandle;\r
UINTN PeimCount;\r
//\r
- // Ponter to the buffer with the PeimCount number of Entries.\r
+ // Pointer to the buffer with the PeimCount number of Entries.\r
//\r
UINT8 *PeimState;\r
//\r
- // Ponter to the buffer with the PeimCount number of Entries.\r
+ // Pointer to the buffer with the PeimCount number of Entries.\r
//\r
EFI_PEI_FILE_HANDLE *FvFileHandles;\r
BOOLEAN ScanFv;\r
//\r
// For Loading modules at fixed address feature to cache the top address below which the\r
// Runtime code, boot time code and PEI memory will be placed. Please note that the offset between this field\r
- // and Ps should not be changed since maybe user could get this top address by using the offet to Ps.\r
+ // and Ps should not be changed since maybe user could get this top address by using the offset to Ps.\r
//\r
EFI_PHYSICAL_ADDRESS LoadModuleAtFixAddressTopAddress;\r
//\r
\r
This is the POSTFIX version of the dependency evaluator. When a\r
PUSH [PPI GUID] is encountered, a pointer to the GUID is stored on\r
- the evaluation stack. When that entry is poped from the evaluation\r
+ the evaluation stack. When that entry is popped from the evaluation\r
stack, the PPI is checked if it is installed. This method allows\r
some time savings as not all PPIs must be checked for certain\r
operation types (AND, OR).\r
\r
@param PrivateData PeiCore's private data structure\r
@param OldCoreData Old data from SecCore\r
- NULL if being run in non-permament memory mode.\r
+ NULL if being run in non-permanent memory mode.\r
@param SecCoreData Points to a data structure containing SEC to PEI handoff data, such as the size\r
and location of temporary RAM, the stack location and the BFV location.\r
\r
\r
@param PrivateData Pointer to the PEI Core data.\r
@param OldCoreData Pointer to old PEI Core data.\r
- NULL if being run in non-permament memory mode.\r
+ NULL if being run in non-permanent memory mode.\r
\r
**/\r
VOID\r
Install PPI services. It is implementation of EFI_PEI_SERVICE.InstallPpi.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- @param PpiList Pointer to ppi array that want to be installed.\r
+ @param PpiList Pointer to PPI array that want to be installed.\r
\r
@retval EFI_SUCCESS if all PPIs in PpiList are successfully installed.\r
@retval EFI_INVALID_PARAMETER if PpiList is NULL pointer\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param OldCoreData Pointer to the old core data.\r
- NULL if being run in non-permament memory mode.\r
+ NULL if being run in non-permanent memory mode.\r
\r
**/\r
VOID\r
\r
@param PrivateData PeiCore's private data structure\r
@param VolumeHandle Handle of FV\r
- @param FileHandle Handle of PEIM's ffs\r
+ @param FileHandle Handle of PEIM's FFS\r
@param AuthenticationStatus Authentication status\r
\r
@retval EFI_SUCCESS Image is OK\r
@param Length Length of the new HOB to allocate.\r
@param Hob Pointer to the new HOB.\r
\r
- @return EFI_SUCCESS Success to create hob.\r
+ @return EFI_SUCCESS Success to create HOB.\r
@retval EFI_INVALID_PARAMETER if Hob is NULL\r
@retval EFI_NOT_AVAILABLE_YET if HobList is still not available.\r
@retval EFI_OUT_OF_RESOURCES if there is no more memory to grow the Hoblist.\r
@param SecCoreData Points to a data structure containing SEC to PEI handoff data, such as the size\r
and location of temporary RAM, the stack location and the BFV location.\r
@param OldCoreData Pointer to the PEI Core data.\r
- NULL if being run in non-permament memory mode.\r
+ NULL if being run in non-permanent memory mode.\r
\r
**/\r
VOID\r
the data buffer starts with a Null-terminated string, optionally\r
followed by additional binary data. The string is a description\r
that the caller may use to further indicate the reason for the\r
- system reset. ResetData is only valid if ResetStatus is something\r
- other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific\r
- where a minimum amount of ResetData is always required.\r
+ system reset.\r
\r
**/\r
VOID\r
\r
/**\r
\r
- Initialize PeiCore Fv List.\r
+ Initialize PeiCore FV List.\r
\r
\r
@param PrivateData - Pointer to PEI_CORE_INSTANCE.\r
);\r
\r
/**\r
- Process Firmware Volum Information once FvInfoPPI install.\r
+ Process Firmware Volume Information once FvInfoPPI install.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param NotifyDescriptor Address of the notification descriptor data structure.\r
**/\r
EFI_STATUS\r
EFIAPI\r
-FirmwareVolmeInfoPpiNotifyCallback (\r
+FirmwareVolumeInfoPpiNotifyCallback (\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
IN VOID *Ppi\r
);\r
\r
/**\r
- This routine enable a PEIM to register itself to shadow when PEI Foundation\r
- discovery permanent memory.\r
+ This routine enables a PEIM to register itself for shadow when the PEI Foundation\r
+ discovers permanent memory.\r
\r
@param FileHandle File handle of a PEIM.\r
\r
);\r
\r
/**\r
- Get Fv image(s) from the FV type file, then install FV INFO(2) ppi, Build FV(2, 3) hob.\r
+ Get FV image(s) from the FV type file, then install FV INFO(2) PPI, Build FV(2, 3) HOB.\r
\r
@param PrivateData PeiCore's private data structure\r
- @param ParentFvCoreHandle Pointer of EFI_CORE_FV_HANDLE to parent Fv image that contain this Fv image.\r
- @param ParentFvFileHandle File handle of a Fv type file that contain this Fv image.\r
+ @param ParentFvCoreHandle Pointer of EFI_CORE_FV_HANDLE to parent FV image that contain this FV image.\r
+ @param ParentFvFileHandle File handle of a FV type file that contain this FV image.\r
\r
@retval EFI_NOT_FOUND FV image can't be found.\r
@retval EFI_SUCCESS Successfully to process it.\r
);\r
\r
/**\r
- Get instance of PEI_CORE_FV_HANDLE for next volume according to given index.\r
+ Gets a PEI_CORE_FV_HANDLE instance for the next volume according to the given index.\r
\r
- This routine also will install FvInfo ppi for FV hob in PI ways.\r
+ This routine also will install an instance of the FvInfo PPI for the FV HOB\r
+ as defined in the PI specification.\r
\r
@param Private Pointer of PEI_CORE_INSTANCE\r
- @param Instance The index of FV want to be searched.\r
+ @param Instance Index of the FV to search\r
\r
@return Instance of PEI_CORE_FV_HANDLE.\r
**/\r
projects / mirror_edk2.git / blobdiff