-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
+/** @file\r
+ This module provide Hand-Off Block manupulation.\r
+ \r
+Copyright (c) 2006, 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
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
\r
- Hob.c\r
+#include "PeiMain.h"\r
\r
-Abstract:\r
+/**\r
\r
- EFI PEI Core HOB services\r
+ Gets the pointer to the HOB List.\r
\r
---*/\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param HobList Pointer to the HOB List.\r
\r
-#include <PeiMain.h>\r
+ @retval EFI_SUCCESS Get the pointer of HOB List\r
+ @retval EFI_NOT_AVAILABLE_YET the HOB List is not yet published\r
+ @retval EFI_INVALID_PARAMETER HobList is NULL (in debug mode)\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetHobList (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN OUT VOID **HobList\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Gets the pointer to the HOB List.\r
-\r
-Arguments:\r
-\r
- PeiServices - The PEI core services table.\r
- HobList - Pointer to the HOB List.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Get the pointer of HOB List\r
- EFI_NOT_AVAILABLE_YET - the HOB List is not yet published\r
- EFI_INVALID_PARAMETER - HobList is NULL (in debug mode)\r
- \r
---*/\r
{\r
PEI_CORE_INSTANCE *PrivateData;\r
-\r
\r
//\r
// Only check this parameter in debug mode\r
\r
*HobList = PrivateData->HobList.Raw;\r
\r
-\r
return EFI_SUCCESS; \r
}\r
\r
\r
+/**\r
+ Add a new HOB to the HOB List.\r
+\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param Type Type of the new HOB.\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
+ @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
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiCreateHob (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN UINT16 Type,\r
IN UINT16 Length,\r
IN OUT VOID **Hob\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Add a new HOB to the HOB List.\r
-\r
-Arguments:\r
-\r
- PeiServices - The PEI core services table.\r
- Type - Type of the new HOB.\r
- Length - Length of the new HOB to allocate.\r
- Hob - Pointer to the new HOB.\r
-\r
-Returns:\r
-\r
- Status - EFI_SUCCESS\r
- - EFI_INVALID_PARAMETER if Hob is NULL\r
- - EFI_NOT_AVAILABLE_YET if HobList is still not available.\r
- - EFI_OUT_OF_RESOURCES if there is no more memory to grow the Hoblist.\r
- \r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_HOB_HANDOFF_INFO_TABLE *HandOffHob;\r
HobEnd++;\r
HandOffHob->EfiFreeMemoryBottom = (EFI_PHYSICAL_ADDRESS) (UINTN) HobEnd;\r
\r
-\r
return EFI_SUCCESS; \r
}\r
\r
+/**\r
+\r
+ Builds a Handoff Information Table HOB\r
+\r
+ @param BootMode - Current Bootmode\r
+ @param MemoryBegin - Start Memory Address.\r
+ @param MemoryLength - Length of Memory.\r
\r
+ @return EFI_SUCCESS Always success to initialize HOB.\r
+\r
+**/\r
EFI_STATUS\r
PeiCoreBuildHobHandoffInfoTable (\r
IN EFI_BOOT_MODE BootMode,\r
IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r
IN UINT64 MemoryLength\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Builds a Handoff Information Table HOB\r
-\r
-Arguments:\r
-\r
- BootMode - Current Bootmode\r
- MemoryBegin - Start Memory Address.\r
- MemoryLength - Length of Memory.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS\r
-\r
---*/\r
{\r
EFI_HOB_HANDOFF_INFO_TABLE *Hob;\r
EFI_HOB_GENERIC_HEADER *HobEnd;\r
\r
- Hob = (VOID *)(UINTN)MemoryBegin;\r
- HobEnd = (EFI_HOB_GENERIC_HEADER*) (Hob+1);\r
- Hob->Header.HobType = EFI_HOB_TYPE_HANDOFF;\r
- Hob->Header.HobLength = sizeof(EFI_HOB_HANDOFF_INFO_TABLE);\r
- Hob->Header.Reserved = 0;\r
+ Hob = (VOID *)(UINTN)MemoryBegin;\r
+ HobEnd = (EFI_HOB_GENERIC_HEADER*) (Hob+1);\r
+ Hob->Header.HobType = EFI_HOB_TYPE_HANDOFF;\r
+ Hob->Header.HobLength = sizeof(EFI_HOB_HANDOFF_INFO_TABLE);\r
+ Hob->Header.Reserved = 0;\r
\r
- HobEnd->HobType = EFI_HOB_TYPE_END_OF_HOB_LIST;\r
- HobEnd->HobLength = sizeof(EFI_HOB_GENERIC_HEADER);\r
- HobEnd->Reserved = 0;\r
+ HobEnd->HobType = EFI_HOB_TYPE_END_OF_HOB_LIST;\r
+ HobEnd->HobLength = sizeof(EFI_HOB_GENERIC_HEADER);\r
+ HobEnd->Reserved = 0;\r
\r
Hob->Version = EFI_HOB_HANDOFF_TABLE_VERSION;\r
Hob->BootMode = BootMode;\r
Hob->EfiMemoryTop = MemoryBegin + MemoryLength;\r
Hob->EfiMemoryBottom = MemoryBegin;\r
Hob->EfiFreeMemoryTop = MemoryBegin + MemoryLength;\r
- Hob->EfiFreeMemoryBottom = (EFI_PHYSICAL_ADDRESS) (UINTN) (HobEnd+1);\r
+ Hob->EfiFreeMemoryBottom = (EFI_PHYSICAL_ADDRESS) (UINTN) (HobEnd + 1);\r
Hob->EfiEndOfHobList = (EFI_PHYSICAL_ADDRESS) (UINTN) HobEnd;\r
\r
return EFI_SUCCESS;\r
projects / mirror_edk2.git / blobdiff