[MdePkg] Code clean-up: Remove trailing spaces
Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Lee Leahy <leroy.p.leahy@intel.com> Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16223 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Lee Leahy
lgao4
@@ -3,9 +3,9 @@
|
||||
and DXE module types.
|
||||
|
||||
The HOB Library supports the efficient creation and searching of HOBs
|
||||
defined in the PI Specification.
|
||||
A HOB is a Hand-Off Block, defined in the Framework architecture, that
|
||||
allows the PEI phase to pass information to the DXE phase. HOBs are position
|
||||
defined in the PI Specification.
|
||||
A HOB is a Hand-Off Block, defined in the Framework architecture, that
|
||||
allows the PEI phase to pass information to the DXE phase. HOBs are position
|
||||
independent and can be relocated easily to different memory memory locations.
|
||||
|
||||
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
|
||||
@@ -26,15 +26,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
Returns the pointer to the HOB list.
|
||||
|
||||
This function returns the pointer to first HOB in the list.
|
||||
For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer
|
||||
For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer
|
||||
to the HOB list. For the DXE phase, the HOB list pointer can be retrieved through
|
||||
the EFI System Table by looking up theHOB list GUID in the System Configuration Table.
|
||||
Since the System Configuration Table does not exist that the time the DXE Core is
|
||||
launched, the DXE Core uses a global variable from the DXE Core Entry Point Library
|
||||
Since the System Configuration Table does not exist that the time the DXE Core is
|
||||
launched, the DXE Core uses a global variable from the DXE Core Entry Point Library
|
||||
to manage the pointer to the HOB list.
|
||||
|
||||
|
||||
If the pointer to the HOB list is NULL, then ASSERT().
|
||||
|
||||
|
||||
@return The pointer to the HOB list.
|
||||
|
||||
**/
|
||||
@@ -47,12 +47,12 @@ GetHobList (
|
||||
/**
|
||||
Returns the next instance of a HOB type from the starting HOB.
|
||||
|
||||
This function searches the first instance of a HOB type from the starting HOB pointer.
|
||||
This function searches the first instance of a HOB type from the starting HOB pointer.
|
||||
If there does not exist such HOB type from the starting HOB pointer, it will return NULL.
|
||||
In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
|
||||
unconditionally: it returns HobStart back if HobStart itself meets the requirement;
|
||||
caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
|
||||
|
||||
|
||||
If HobStart is NULL, then ASSERT().
|
||||
|
||||
@param Type The HOB type to return.
|
||||
@@ -71,9 +71,9 @@ GetNextHob (
|
||||
/**
|
||||
Returns the first instance of a HOB type among the whole HOB list.
|
||||
|
||||
This function searches the first instance of a HOB type among the whole HOB list.
|
||||
If there does not exist such HOB type in the HOB list, it will return NULL.
|
||||
|
||||
This function searches the first instance of a HOB type among the whole HOB list.
|
||||
If there does not exist such HOB type in the HOB list, it will return NULL.
|
||||
|
||||
If the pointer to the HOB list is NULL, then ASSERT().
|
||||
|
||||
@param Type The HOB type to return.
|
||||
@@ -89,17 +89,17 @@ GetFirstHob (
|
||||
|
||||
/**
|
||||
Returns the next instance of the matched GUID HOB from the starting HOB.
|
||||
|
||||
This function searches the first instance of a HOB from the starting HOB pointer.
|
||||
Such HOB should satisfy two conditions:
|
||||
its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
|
||||
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
|
||||
|
||||
This function searches the first instance of a HOB from the starting HOB pointer.
|
||||
Such HOB should satisfy two conditions:
|
||||
its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
|
||||
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
|
||||
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
|
||||
to extract the data section and its size info respectively.
|
||||
In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
|
||||
unconditionally: it returns HobStart back if HobStart itself meets the requirement;
|
||||
caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
|
||||
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
If HobStart is NULL, then ASSERT().
|
||||
|
||||
@@ -118,14 +118,14 @@ GetNextGuidHob (
|
||||
|
||||
/**
|
||||
Returns the first instance of the matched GUID HOB among the whole HOB list.
|
||||
|
||||
This function searches the first instance of a HOB among the whole HOB list.
|
||||
|
||||
This function searches the first instance of a HOB among the whole HOB list.
|
||||
Such HOB should satisfy two conditions:
|
||||
its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
|
||||
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
|
||||
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
|
||||
to extract the data section and its size info respectively.
|
||||
|
||||
|
||||
If the pointer to the HOB list is NULL, then ASSERT().
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@@ -143,11 +143,11 @@ GetFirstGuidHob (
|
||||
/**
|
||||
Get the system boot mode from the HOB list.
|
||||
|
||||
This function returns the system boot mode information from the
|
||||
This function returns the system boot mode information from the
|
||||
PHIT HOB in HOB list.
|
||||
|
||||
If the pointer to the HOB list is NULL, then ASSERT().
|
||||
|
||||
|
||||
@param VOID
|
||||
|
||||
@return The Boot Mode.
|
||||
@@ -165,7 +165,7 @@ GetBootModeHob (
|
||||
This function builds a HOB for a loaded PE32 module.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If ModuleName is NULL, then ASSERT().
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@@ -190,7 +190,7 @@ BuildModuleHob (
|
||||
This function builds a HOB that describes a chunk of system memory.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@param ResourceType The type of resource described by this HOB.
|
||||
@@ -209,15 +209,15 @@ BuildResourceDescriptorHob (
|
||||
);
|
||||
|
||||
/**
|
||||
Builds a customized HOB tagged with a GUID for identification and returns
|
||||
Builds a customized HOB tagged with a GUID for identification and returns
|
||||
the start address of GUID HOB data.
|
||||
|
||||
This function builds a customized HOB tagged with a GUID for identification
|
||||
and returns the start address of GUID HOB data so that caller can fill the customized data.
|
||||
This function builds a customized HOB tagged with a GUID for identification
|
||||
and returns the start address of GUID HOB data so that caller can fill the customized data.
|
||||
The HOB Header and Name field is already stripped.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
|
||||
@@ -238,16 +238,16 @@ BuildGuidHob (
|
||||
);
|
||||
|
||||
/**
|
||||
Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB
|
||||
Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB
|
||||
data field, and returns the start address of the GUID HOB data.
|
||||
|
||||
This function builds a customized HOB tagged with a GUID for identification and copies the input
|
||||
data to the HOB data field and returns the start address of the GUID HOB data. It can only be
|
||||
invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
data to the HOB data field and returns the start address of the GUID HOB data. It can only be
|
||||
invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
The HOB Header and Name field is already stripped.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
If Data is NULL and DataLength > 0, then ASSERT().
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
@@ -276,7 +276,7 @@ BuildGuidDataHob (
|
||||
This function builds a Firmware Volume HOB.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@param BaseAddress The base address of the Firmware Volume.
|
||||
@@ -296,14 +296,14 @@ BuildFvHob (
|
||||
This function builds a EFI_HOB_TYPE_FV2 HOB.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@param BaseAddress The base address of the Firmware Volume.
|
||||
@param Length The size of the Firmware Volume in bytes.
|
||||
@param FvName The name of the Firmware Volume.
|
||||
@param FileName The name of the file.
|
||||
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
@@ -320,7 +320,7 @@ BuildFv2Hob (
|
||||
This function builds a Capsule Volume HOB.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If the platform does not support Capsule Volume HOBs, then ASSERT().
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@@ -341,7 +341,7 @@ BuildCvHob (
|
||||
This function builds a HOB for the CPU.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@param SizeOfMemorySpace The maximum physical memory addressability of the processor.
|
||||
@@ -361,7 +361,7 @@ BuildCpuHob (
|
||||
This function builds a HOB for the stack.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@param BaseAddress The 64 bit physical address of the Stack.
|
||||
@@ -381,7 +381,7 @@ BuildStackHob (
|
||||
This function builds a HOB for BSP store.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@param BaseAddress The 64 bit physical address of the BSP.
|
||||
@@ -403,7 +403,7 @@ BuildBspStoreHob (
|
||||
This function builds a HOB for the memory allocation.
|
||||
It can only be invoked during PEI phase;
|
||||
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||
|
||||
|
||||
If there is no additional space for HOB creation, then ASSERT().
|
||||
|
||||
@param BaseAddress The 64 bit physical address of the memory.
|
||||
@@ -422,13 +422,13 @@ BuildMemoryAllocationHob (
|
||||
/**
|
||||
Returns the type of a HOB.
|
||||
|
||||
This macro returns the HobType field from the HOB header for the
|
||||
This macro returns the HobType field from the HOB header for the
|
||||
HOB specified by HobStart.
|
||||
|
||||
@param HobStart A pointer to a HOB.
|
||||
|
||||
|
||||
@return HobType.
|
||||
|
||||
|
||||
**/
|
||||
#define GET_HOB_TYPE(HobStart) \
|
||||
((*(EFI_HOB_GENERIC_HEADER **)&(HobStart))->HobType)
|
||||
@@ -436,7 +436,7 @@ BuildMemoryAllocationHob (
|
||||
/**
|
||||
Returns the length, in bytes, of a HOB.
|
||||
|
||||
This macro returns the HobLength field from the HOB header for the
|
||||
This macro returns the HobLength field from the HOB header for the
|
||||
HOB specified by HobStart.
|
||||
|
||||
@param HobStart A pointer to a HOB.
|
||||
@@ -450,7 +450,7 @@ BuildMemoryAllocationHob (
|
||||
/**
|
||||
Returns a pointer to the next HOB in the HOB list.
|
||||
|
||||
This macro returns a pointer to HOB that follows the
|
||||
This macro returns a pointer to HOB that follows the
|
||||
HOB specified by HobStart in the HOB List.
|
||||
|
||||
@param HobStart A pointer to a HOB.
|
||||
@@ -463,9 +463,9 @@ BuildMemoryAllocationHob (
|
||||
|
||||
/**
|
||||
Determines if a HOB is the last HOB in the HOB list.
|
||||
|
||||
This macro determine if the HOB specified by HobStart is the
|
||||
last HOB in the HOB list. If HobStart is last HOB in the HOB list,
|
||||
|
||||
This macro determine if the HOB specified by HobStart is the
|
||||
last HOB in the HOB list. If HobStart is last HOB in the HOB list,
|
||||
then TRUE is returned. Otherwise, FALSE is returned.
|
||||
|
||||
@param HobStart A pointer to a HOB.
|
||||
@@ -480,12 +480,12 @@ BuildMemoryAllocationHob (
|
||||
Returns a pointer to data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
|
||||
|
||||
This macro returns a pointer to the data buffer in a HOB specified by HobStart.
|
||||
HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
|
||||
HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
|
||||
|
||||
@param GuidHob A pointer to a HOB.
|
||||
|
||||
@return A pointer to the data buffer in a HOB.
|
||||
|
||||
|
||||
**/
|
||||
#define GET_GUID_HOB_DATA(HobStart) \
|
||||
(VOID *)(*(UINT8 **)&(HobStart) + sizeof (EFI_HOB_GUID_TYPE))
|
||||
|
||||
Reference in New Issue
Block a user