/** @file\r
HOB Library implementation for DxeCore driver.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 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
\r
This function searches the first instance of a HOB from the starting HOB pointer. \r
Such HOB should satisfy two conditions: \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
+ its HOB type is EFI_HOB_TYPE_GUID_EXTENSION, and its GUID Name equals to the input Guid. \r
+ If such a HOB from the starting HOB pointer does not exist, 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
This function searches the first instance of a HOB among the whole HOB list. \r
Such HOB should satisfy two conditions:\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
+ If such a HOB from the starting HOB pointer does not exist, 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
This function builds a HOB for a loaded PE32 module.\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
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
\r
If ModuleName is NULL, then ASSERT().\r
If there is no additional space for HOB creation, then ASSERT().\r
}\r
\r
/**\r
- Builds a HOB that describes a chunk of system memory.\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
@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
+ //\r
+ // PEI HOB is read only for DXE phase\r
+ //\r
+ ASSERT (FALSE);\r
+}\r
+\r
+/**\r
+ Builds a HOB that describes a chunk of system memory.\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() because 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
\r
**/\r
VOID\r
This function builds a customized HOB tagged with a GUID for identification \r
and returns the start address of GUID HOB data so that caller can fill the customized data. \r
The HOB Header and Name field is already stripped.\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
+ It can only be invoked during PEI phase.\r
+ For DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\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
This function builds a customized HOB tagged with a GUID for identification and copies the input\r
data to the HOB data field and returns the start address of the GUID HOB data. It can only be \r
- invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. \r
+ invoked during PEI phase; for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase. \r
The HOB Header and Name field is already stripped.\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
+ It can only be invoked during PEI phase.\r
+ For DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\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
\r
This function builds a Firmware Volume 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
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
\r
If there is no additional space for HOB creation, then ASSERT().\r
\r
\r
This function builds a EFI_HOB_TYPE_FV2 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
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
\r
If there is no additional space for HOB creation, then ASSERT().\r
\r
\r
This function builds a Capsule Volume 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
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
\r
If the platform does not support Capsule Volume HOBs, then ASSERT().\r
If there is no additional space for HOB creation, then ASSERT().\r
\r
This function builds a HOB for the CPU.\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
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
\r
If there is no additional space for HOB creation, then ASSERT().\r
\r
\r
This function builds a HOB for the stack.\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
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
\r
If there is no additional space for HOB creation, then ASSERT().\r
\r
\r
This function builds a HOB for BSP store.\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
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
\r
If there is no additional space for HOB creation, then ASSERT().\r
\r
\r
This function builds a HOB for the memory allocation.\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
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
\r
If there is no additional space for HOB creation, then ASSERT().\r
\r
projects / mirror_edk2.git / blobdiff