/** @file\r
-\r
+ EFI PEI Core PPI services\r
+ \r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\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
\r
-Module Name:\r
-\r
- Ppi.c\r
+**/\r
\r
-Abstract:\r
+#include <PeiMain.h>\r
\r
- EFI PEI Core PPI services\r
+/**\r
\r
-Revision History\r
+ Initialize PPI services.\r
\r
-**/\r
\r
-#include <PeiMain.h>\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
\r
+**/\r
VOID\r
InitializePpiServices (\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN PEI_CORE_INSTANCE *OldCoreData\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Initialize PPI services.\r
-\r
-Arguments:\r
-\r
- PeiServices - The PEI core services table.\r
- OldCoreData - Pointer to the PEI Core data.\r
- NULL if being run in non-permament memory mode.\r
-\r
-Returns:\r
- Nothing\r
-\r
---*/\r
{\r
if (OldCoreData == NULL) {\r
PrivateData->PpiData.NotifyListEnd = FixedPcdGet32 (PcdPeiCoreMaxPpiSupported)-1;\r
PrivateData->PpiData.DispatchListEnd = FixedPcdGet32 (PcdPeiCoreMaxPpiSupported)-1;\r
PrivateData->PpiData.LastDispatchedNotify = FixedPcdGet32 (PcdPeiCoreMaxPpiSupported)-1;\r
}\r
-\r
- return;\r
}\r
\r
+/**\r
+\r
+ Migrate the Hob list from the CAR stack to PEI installed memory.\r
+\r
+ @param PeiServices The PEI core services table.\r
+ @param OldCheckingBottom The old checking bottom.\r
+ @param OldCheckingTop The old checking top.\r
+ @param NewHandOffHob The new handoff HOB list.\r
+\r
+**/\r
VOID\r
ConvertPpiPointers (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN UINTN OldCheckingTop,\r
IN EFI_HOB_HANDOFF_INFO_TABLE *NewHandOffHob\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Migrate the Hob list from the CAR stack to PEI installed memory.\r
-\r
-Arguments:\r
-\r
- PeiServices - The PEI core services table.\r
- OldCheckingBottom - The old checking bottom.\r
- OldCheckingTop - The old checking top.\r
- NewHandOffHob - The new handoff HOB list.\r
-\r
-Returns:\r
-\r
---*/\r
{\r
PEI_CORE_INSTANCE *PrivateData;\r
UINT8 Index;\r
}\r
}\r
\r
+/**\r
\r
+ Install PPI services.\r
\r
+ @param PeiServices - Pointer to the PEI Service Table\r
+ @param PpiList - Pointer to a list of PEI PPI Descriptors.\r
+\r
+ @retval EFI_SUCCESS - if all PPIs in PpiList are successfully installed.\r
+ @retval EFI_INVALID_PARAMETER - if PpiList is NULL pointer\r
+ @retval EFI_INVALID_PARAMETER - if any PPI in PpiList is not valid\r
+ @retval EFI_OUT_OF_RESOURCES - if there is no more memory resource to install PPI\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiInstallPpi (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Install PPI services.\r
-\r
-Arguments:\r
-\r
- PeiServices - Pointer to the PEI Service Table\r
- PpiList - Pointer to a list of PEI PPI Descriptors.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - if all PPIs in PpiList are successfully installed.\r
- EFI_INVALID_PARAMETER - if PpiList is NULL pointer\r
- EFI_INVALID_PARAMETER - if any PPI in PpiList is not valid\r
- EFI_OUT_OF_RESOURCES - if there is no more memory resource to install PPI\r
-\r
---*/\r
{\r
PEI_CORE_INSTANCE *PrivateData;\r
INTN Index;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Re-Install PPI services.\r
+\r
+ @param PeiServices - Pointer to the PEI Service Table\r
+ @param OldPpi - Pointer to the old PEI PPI Descriptors.\r
+ @param NewPpi - Pointer to the new PEI PPI Descriptors.\r
\r
+ @retval EFI_SUCCESS - if the operation was successful\r
+ @retval EFI_INVALID_PARAMETER - if OldPpi or NewPpi is NULL\r
+ @retval EFI_INVALID_PARAMETER - if NewPpi is not valid\r
+ @retval EFI_NOT_FOUND - if the PPI was not in the database\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiReInstallPpi (\r
IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi,\r
IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Re-Install PPI services.\r
-\r
-Arguments:\r
-\r
- PeiServices - Pointer to the PEI Service Table\r
- OldPpi - Pointer to the old PEI PPI Descriptors.\r
- NewPpi - Pointer to the new PEI PPI Descriptors.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - if the operation was successful\r
- EFI_INVALID_PARAMETER - if OldPpi or NewPpi is NULL\r
- EFI_INVALID_PARAMETER - if NewPpi is not valid\r
- EFI_NOT_FOUND - if the PPI was not in the database\r
-\r
---*/\r
{\r
PEI_CORE_INSTANCE *PrivateData;\r
INTN Index;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Locate a given named PPI.\r
+\r
\r
+ @param PeiServices - Pointer to the PEI Service Table\r
+ @param Guid - Pointer to GUID of the PPI.\r
+ @param Instance - Instance Number to discover.\r
+ @param PpiDescriptor - Pointer to reference the found descriptor. If not NULL,\r
+ returns a pointer to the descriptor (includes flags, etc)\r
+ @param Ppi - Pointer to reference the found PPI\r
+\r
+ @retval EFI_SUCCESS if the PPI is in the database\r
+ @retval EFI_NOT_FOUND if the PPI is not in the database\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiLocatePpi (\r
IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,\r
IN OUT VOID **Ppi\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Locate a given named PPI.\r
-\r
-Arguments:\r
-\r
- PeiServices - Pointer to the PEI Service Table\r
- Guid - Pointer to GUID of the PPI.\r
- Instance - Instance Number to discover.\r
- PpiDescriptor - Pointer to reference the found descriptor. If not NULL,\r
- returns a pointer to the descriptor (includes flags, etc)\r
- Ppi - Pointer to reference the found PPI\r
-\r
-Returns:\r
-\r
- Status - EFI_SUCCESS if the PPI is in the database\r
- EFI_NOT_FOUND if the PPI is not in the database\r
---*/\r
{\r
PEI_CORE_INSTANCE *PrivateData;\r
INTN Index;\r
return EFI_NOT_FOUND;\r
}\r
\r
+/**\r
\r
+ Install a notification for a given PPI.\r
+\r
+\r
+ @param PeiServices - Pointer to the PEI Service Table\r
+ @param NotifyList - Pointer to list of Descriptors to notify upon.\r
+\r
+ @retval EFI_SUCCESS if successful\r
+ @retval EFI_OUT_OF_RESOURCES if no space in the database\r
+ @retval EFI_INVALID_PARAMETER if not a good decriptor\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiNotifyPpi (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Install a notification for a given PPI.\r
-\r
-Arguments:\r
-\r
- PeiServices - Pointer to the PEI Service Table\r
- NotifyList - Pointer to list of Descriptors to notify upon.\r
-\r
-Returns:\r
-\r
- Status - EFI_SUCCESS if successful\r
- EFI_OUT_OF_RESOURCES if no space in the database\r
- EFI_INVALID_PARAMETER if not a good decriptor\r
-\r
---*/\r
{\r
PEI_CORE_INSTANCE *PrivateData;\r
INTN Index;\r
}\r
\r
\r
-VOID\r
-ProcessNotifyList (\r
- IN PEI_CORE_INSTANCE *PrivateData\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Process the Notify List at dispatch level.\r
\r
-Arguments:\r
-\r
- PeiServices - Pointer to the PEI Service Table\r
-\r
-Returns:\r
-\r
---*/\r
+ @param PrivateData PeiCore's private data structure.\r
\r
+**/\r
+VOID\r
+ProcessNotifyList (\r
+ IN PEI_CORE_INSTANCE *PrivateData\r
+ )\r
{\r
INTN TempValue;\r
\r
return;\r
}\r
\r
+/**\r
+\r
+ Dispatch notifications.\r
+\r
+ @param PrivateData PeiCore's private data structure\r
+ @param NotifyType Type of notify to fire.\r
+ @param InstallStartIndex Install Beginning index.\r
+ @param InstallStopIndex Install Ending index.\r
+ @param NotifyStartIndex Notify Beginning index.\r
+ @param NotifyStopIndex Notify Ending index.\r
+\r
+**/\r
VOID\r
DispatchNotify (\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN INTN NotifyStartIndex,\r
IN INTN NotifyStopIndex\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Dispatch notifications.\r
-\r
-Arguments:\r
-\r
- PeiServices - Pointer to the PEI Service Table\r
- NotifyType - Type of notify to fire.\r
- InstallStartIndex - Install Beginning index.\r
- InstallStopIndex - Install Ending index.\r
- NotifyStartIndex - Notify Beginning index.\r
- NotifyStopIndex - Notify Ending index.\r
-\r
-Returns: None\r
-\r
---*/\r
-\r
{\r
INTN Index1;\r
INTN Index2;\r
projects / mirror_edk2.git / blobdiff