/** @file\r
Provide Hob Library functions for Pei phase.\r
\r
-Copyright (c) 2007 - 2009, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007 - 2014, 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
+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
its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid. \r
If there does not exist such HOB from the starting HOB pointer, it will return NULL. \r
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()\r
- to extract the data section and its size info respectively.\r
+ to extract the data section and its size information, respectively.\r
In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer\r
unconditionally: it returns HobStart back if HobStart itself meets the requirement;\r
caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.\r
its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.\r
If there does not exist such HOB from the starting HOB pointer, it will return NULL.\r
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()\r
- to extract the data section and its size info respectively.\r
+ to extract the data section and its size information, respectively.\r
\r
If the pointer to the HOB list is NULL, then ASSERT().\r
If Guid is NULL, then ASSERT().\r
\r
If the pointer to the HOB list is NULL, then ASSERT().\r
\r
- @param VOID\r
+ @param VOID.\r
\r
@return The Boot Mode.\r
\r
@param Type Type of the new HOB.\r
@param Length Length of the new HOB to allocate.\r
\r
- @return The address of new HOB.\r
+ @retval NULL The HOB could not be allocated.\r
+ @retval others The address of new HOB.\r
\r
**/\r
VOID *\r
VOID *Hob;\r
\r
Status = PeiServicesCreateHob (Type, Length, &Hob);\r
+ if (EFI_ERROR (Status)) {\r
+ Hob = NULL;\r
+ }\r
//\r
// Assume the process of HOB building is always successful.\r
//\r
- ASSERT_EFI_ERROR (Status);\r
+ ASSERT (Hob != NULL);\r
return Hob;\r
}\r
\r
ASSERT (((MemoryAllocationModule & (EFI_PAGE_SIZE - 1)) == 0) &&\r
((ModuleLength & (EFI_PAGE_SIZE - 1)) == 0));\r
\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, sizeof (EFI_HOB_MEMORY_ALLOCATION_MODULE));\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_MODULE));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
\r
CopyGuid (&(Hob->MemoryAllocationHeader.Name), &gEfiHobMemoryAllocModuleGuid);\r
Hob->MemoryAllocationHeader.MemoryBaseAddress = MemoryAllocationModule;\r
Hob->EntryPoint = EntryPoint;\r
}\r
\r
+/**\r
+ Builds a HOB that describes a chunk of system memory with Owner GUID.\r
+\r
+ This function builds a HOB that describes a chunk of system memory.\r
+ It can only be invoked during PEI phase;\r
+ for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
+ \r
+ If there is no additional space for HOB creation, then ASSERT().\r
+\r
+ @param ResourceType The type of resource described by this HOB.\r
+ @param ResourceAttribute The resource attributes of the memory described by this HOB.\r
+ @param PhysicalStart The 64 bit physical address of memory described by this HOB.\r
+ @param NumberOfBytes The length of the memory described by this HOB in bytes.\r
+ @param OwnerGUID GUID for the owner of this resource.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+BuildResourceDescriptorWithOwnerHob (\r
+ IN EFI_RESOURCE_TYPE ResourceType,\r
+ IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute,\r
+ IN EFI_PHYSICAL_ADDRESS PhysicalStart,\r
+ IN UINT64 NumberOfBytes,\r
+ IN EFI_GUID *OwnerGUID\r
+ )\r
+{\r
+ EFI_HOB_RESOURCE_DESCRIPTOR *Hob;\r
+\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, (UINT16) sizeof (EFI_HOB_RESOURCE_DESCRIPTOR));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
+\r
+ Hob->ResourceType = ResourceType;\r
+ Hob->ResourceAttribute = ResourceAttribute;\r
+ Hob->PhysicalStart = PhysicalStart;\r
+ Hob->ResourceLength = NumberOfBytes;\r
+\r
+ CopyGuid (&Hob->Owner, OwnerGUID);\r
+}\r
+\r
/**\r
Builds a HOB that describes a chunk of system memory.\r
\r
{\r
EFI_HOB_RESOURCE_DESCRIPTOR *Hob;\r
\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, sizeof (EFI_HOB_RESOURCE_DESCRIPTOR));\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, (UINT16) sizeof (EFI_HOB_RESOURCE_DESCRIPTOR));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
\r
Hob->ResourceType = ResourceType;\r
Hob->ResourceAttribute = ResourceAttribute;\r
Hob->PhysicalStart = PhysicalStart;\r
Hob->ResourceLength = NumberOfBytes;\r
+ ZeroMem (&(Hob->Owner), sizeof (EFI_GUID));\r
}\r
\r
/**\r
\r
If Guid is NULL, then ASSERT().\r
If there is no additional space for HOB creation, then ASSERT().\r
- If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+ If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+ HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.\r
\r
@param Guid The GUID to tag the customized HOB.\r
@param DataLength The size of the data payload for the GUID HOB.\r
\r
- @return The start address of GUID HOB data.\r
+ @retval NULL The GUID HOB could not be allocated.\r
+ @retval others The start address of GUID HOB data.\r
\r
**/\r
VOID *\r
{\r
EFI_HOB_GUID_TYPE *Hob;\r
\r
+ //\r
+ // Make sure Guid is valid\r
+ //\r
+ ASSERT (Guid != NULL);\r
+ \r
//\r
// Make sure that data length is not too long.\r
//\r
- ASSERT (DataLength <= (0xffff - sizeof (EFI_HOB_GUID_TYPE)));\r
+ ASSERT (DataLength <= (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)));\r
\r
Hob = InternalPeiCreateHob (EFI_HOB_TYPE_GUID_EXTENSION, (UINT16) (sizeof (EFI_HOB_GUID_TYPE) + DataLength));\r
+ if (Hob == NULL) {\r
+ return Hob;\r
+ }\r
CopyGuid (&Hob->Name, Guid);\r
return Hob + 1;\r
}\r
If Guid is NULL, then ASSERT().\r
If Data is NULL and DataLength > 0, then ASSERT().\r
If there is no additional space for HOB creation, then ASSERT().\r
- If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+ If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+ HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.\r
\r
@param Guid The GUID to tag the customized HOB.\r
@param Data The data to be copied into the data field of the GUID HOB.\r
@param DataLength The size of the data payload for the GUID HOB.\r
\r
- @return The start address of GUID HOB data.\r
+ @retval NULL The GUID HOB could not be allocated.\r
+ @retval others The start address of GUID HOB data.\r
\r
**/\r
VOID *\r
ASSERT (Data != NULL || DataLength == 0);\r
\r
HobData = BuildGuidHob (Guid, DataLength);\r
+ if (HobData == NULL) {\r
+ return HobData;\r
+ }\r
\r
return CopyMem (HobData, Data, DataLength);\r
}\r
{\r
EFI_HOB_FIRMWARE_VOLUME *Hob;\r
\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV, sizeof (EFI_HOB_FIRMWARE_VOLUME));\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV, (UINT16) sizeof (EFI_HOB_FIRMWARE_VOLUME));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
\r
Hob->BaseAddress = BaseAddress;\r
Hob->Length = Length;\r
{\r
EFI_HOB_FIRMWARE_VOLUME2 *Hob;\r
\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV2, sizeof (EFI_HOB_FIRMWARE_VOLUME2));\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV2, (UINT16) sizeof (EFI_HOB_FIRMWARE_VOLUME2));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
\r
Hob->BaseAddress = BaseAddress;\r
Hob->Length = Length;\r
IN UINT64 Length\r
)\r
{\r
- ASSERT (FALSE);\r
+ EFI_HOB_UEFI_CAPSULE *Hob;\r
+\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_UEFI_CAPSULE, (UINT16) sizeof (EFI_HOB_UEFI_CAPSULE));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
+\r
+ Hob->BaseAddress = BaseAddress;\r
+ Hob->Length = Length;\r
}\r
\r
/**\r
{\r
EFI_HOB_CPU *Hob;\r
\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_CPU, sizeof (EFI_HOB_CPU));\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_CPU, (UINT16) sizeof (EFI_HOB_CPU));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
\r
Hob->SizeOfMemorySpace = SizeOfMemorySpace;\r
Hob->SizeOfIoSpace = SizeOfIoSpace;\r
ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, sizeof (EFI_HOB_MEMORY_ALLOCATION_STACK));\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_STACK));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
\r
CopyGuid (&(Hob->AllocDescriptor.Name), &gEfiHobMemoryAllocStackGuid);\r
Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
\r
@param BaseAddress The 64 bit physical address of the BSP.\r
@param Length The length of the BSP store in bytes.\r
- @param MemoryType Type of memory allocated by this HOB.\r
+ @param MemoryType The type of memory allocated by this HOB.\r
\r
**/\r
VOID\r
ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, sizeof (EFI_HOB_MEMORY_ALLOCATION_BSP_STORE));\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_BSP_STORE));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
\r
CopyGuid (&(Hob->AllocDescriptor.Name), &gEfiHobMemoryAllocBspStoreGuid);\r
Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
\r
@param BaseAddress The 64 bit physical address of the memory.\r
@param Length The length of the memory allocation in bytes.\r
- @param MemoryType Type of memory allocated by this HOB.\r
+ @param MemoryType The type of memory allocated by this HOB.\r
\r
**/\r
VOID\r
ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, sizeof (EFI_HOB_MEMORY_ALLOCATION));\r
+ Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION));\r
+ if (Hob == NULL) {\r
+ return;\r
+ }\r
\r
ZeroMem (&(Hob->AllocDescriptor.Name), sizeof (EFI_GUID));\r
Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
//\r
ZeroMem (Hob->AllocDescriptor.Reserved, sizeof (Hob->AllocDescriptor.Reserved));\r
}\r
-\r
-/**\r
- Builds an UEFI Capsule HOB.\r
-\r
- This function builds an UEFI Capsule HOB.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param BaseAddress The physical memory-mapped base address of an UEFI capsule.\r
- @param Length The length of the contiguous memory in bytes.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildCapsuleHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length\r
- )\r
-{\r
- EFI_HOB_UEFI_CAPSULE *Hob;\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_UEFI_CAPSULE, sizeof (EFI_HOB_UEFI_CAPSULE));\r
-\r
- Hob->BaseAddress = BaseAddress;\r
- Hob->Length = Length;\r
-}\r
projects / mirror_edk2.git / blobdiff