Changeset 58466 in vbox for trunk/src/VBox/Devices/EFI/Firmware/MdePkg/Include/Library/HobLib.h

Timestamp:

Oct 29, 2015 4:30:44 AM (9 years ago)

Author:

vboxsync

Message:

EFI/Firmware: Merged in the svn:eol-style, svn:mime-type and trailing whitespace cleanup that was done after the initial UDK2014.SP1 import: svn merge ^{/vendor/edk2/UDK2014.SP1} /vendor/edk2/current .

Location:

trunk/src/VBox/Devices/EFI/Firmware

Files:

• . (modified) (1 prop)
• MdePkg/Include/Library/HobLib.h (modified) (27 diffs)

trunk/src/VBox/Devices/EFI/Firmware/MdePkg/Include/Library/HobLib.h

@@ -4 +4 @@
 
   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.
 
@@ -27 +27 @@
 
   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.
 
@@ -48 +48 @@
   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().
 
@@ -72 +72 @@
   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().
 
@@ -90 +90 @@
 /**
   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.
@@ -100 +100 @@
   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().
@@ -119 +119 @@
 /**
   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.
@@ -126 +126 @@
   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().
@@ -144 +144 @@
   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
 
@@ -166 +166 @@
   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().
@@ -191 +191 @@
   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().
 
@@ -217 +217 @@
   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().
 
@@ -236 +236 @@
 
 /**
-  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().
@@ -265 +265 @@
 
 /**
-  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().
@@ -303 +303 @@
   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().
 
@@ -323 +323 @@
   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().
 
@@ -330 +330 @@
   @param  FvName        The name of the Firmware Volume.
   @param  FileName      The name of the file.
-  
+
 **/
 VOID
@@ -347 +347 @@
   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().
@@ -368 +368 @@
   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().
 
@@ -388 +388 @@
   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().
 
@@ -408 +408 @@
   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().
 
@@ -430 +430 @@
   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().
 
@@ -449 +449 @@
   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) \
@@ -463 +463 @@
   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.
 
@@ -477 +477 @@
   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.
 
@@ -490 +490 @@
 /**
   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.
 
@@ -507 +507 @@
 
   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) \