clean up the un-suitable ';' location when declaring the functions.

[mirror_edk2.git] / MdePkg / Include / Library / HobLib.h

diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h
index 0d9dc83ad99b6f1570d3fd6509982207a698864b..a02246f6b0139863ba833f26d026a2e5df77fcc7 100644 (file)
--- a/MdePkg/Include/Library/HobLib.h
+++ b/MdePkg/Include/Library/HobLib.h
@@ -1,16 +1,14 @@
 /** @file\r
-       Public include file for the HOB Library\r
+  Public include file for the HOB Library\r
 \r
-       Copyright (c) 2006, Intel Corporation                                                         \r
-       All rights reserved. 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
+  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  All rights reserved. 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
 \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:    HobLib.h\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
 **/\r
 \r
@@ -29,8 +27,7 @@ VOID *
 EFIAPI\r
 GetHobList (\r
   VOID\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Returns the next instance of a HOB type from the starting HOB.\r
@@ -53,8 +50,7 @@ EFIAPI
 GetNextHob (\r
   IN UINT16                 Type,\r
   IN CONST VOID             *HobStart\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Returns the first instance of a HOB type among the whole HOB list.\r
@@ -71,8 +67,7 @@ VOID *
 EFIAPI\r
 GetFirstHob (\r
   IN UINT16                 Type\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   This function searches the first instance of a HOB from the starting HOB pointer. \r
@@ -98,8 +93,7 @@ EFIAPI
 GetNextGuidHob (\r
   IN CONST EFI_GUID         *Guid,\r
   IN CONST VOID             *HobStart\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   This function searches the first instance of a HOB among the whole HOB list. \r
@@ -119,8 +113,24 @@ VOID *
 EFIAPI\r
 GetFirstGuidHob (\r
   IN CONST EFI_GUID         *Guid\r
-  )\r
-;\r
+  );\r
+\r
+/**\r
+  Get the Boot Mode from the HOB list.\r
+\r
+  This function returns the system boot mode information from the \r
+  PHIT HOB in HOB list.\r
+\r
+  @param  VOID\r
+\r
+  @return The Boot Mode.\r
+\r
+**/\r
+EFI_BOOT_MODE\r
+EFIAPI\r
+GetBootModeHob (\r
+  VOID\r
+  );\r
 \r
 /**\r
   Builds a HOB for a loaded PE32 module.\r
@@ -134,7 +144,7 @@ GetFirstGuidHob (
   @param  ModuleName              The GUID File Name of the module.\r
   @param  MemoryAllocationModule  The 64 bit physical address of the module.\r
   @param  ModuleLength            The length of the module in bytes.\r
-  @param  EntryPoint              The 64 bit physical address of the module\92s entry point.\r
+  @param  EntryPoint              The 64 bit physical address of the module entry point.\r
 \r
 **/\r
 VOID\r
@@ -144,8 +154,7 @@ BuildModuleHob (
   IN EFI_PHYSICAL_ADDRESS   MemoryAllocationModule,\r
   IN UINT64                 ModuleLength,\r
   IN EFI_PHYSICAL_ADDRESS   EntryPoint\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Builds a HOB that describes a chunk of system memory.\r
@@ -168,8 +177,7 @@ BuildResourceDescriptorHob (
   IN EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute,\r
   IN EFI_PHYSICAL_ADDRESS         PhysicalStart,\r
   IN UINT64                       NumberOfBytes\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Builds a GUID HOB with a certain data length.\r
@@ -194,8 +202,7 @@ EFIAPI
 BuildGuidHob (\r
   IN CONST EFI_GUID              *Guid,\r
   IN UINTN                       DataLength\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Copies a data buffer to a newly-built HOB.\r
@@ -223,8 +230,7 @@ BuildGuidDataHob (
   IN CONST EFI_GUID              *Guid,\r
   IN VOID                        *Data,\r
   IN UINTN                       DataLength\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Builds a Firmware Volume HOB.\r
@@ -243,8 +249,30 @@ EFIAPI
 BuildFvHob (\r
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length\r
-  )\r
-;\r
+  );\r
+\r
+/**\r
+  Builds a EFI_HOB_TYPE_FV2 HOB.\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
+  If there is no additional space for HOB creation, then ASSERT().\r
+\r
+  @param  BaseAddress   The base address of the Firmware Volume.\r
+  @param  Length        The size of the Firmware Volume in bytes.\r
+  @param  FvName       The name of the Firmware Volume.\r
+  @param  FileName      The name of the file.\r
+  \r
+**/\r
+VOID\r
+EFIAPI\r
+BuildFv2Hob (\r
+  IN          EFI_PHYSICAL_ADDRESS        BaseAddress,\r
+  IN          UINT64                      Length,\r
+  IN CONST    EFI_GUID                    *FvName,\r
+  IN CONST    EFI_GUID                    *FileName\r
+  );\r
 \r
 /**\r
   Builds a Capsule Volume HOB.\r
@@ -263,8 +291,7 @@ EFIAPI
 BuildCvHob (\r
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Builds a HOB for the CPU.\r
@@ -283,8 +310,7 @@ EFIAPI
 BuildCpuHob (\r
   IN UINT8                       SizeOfMemorySpace,\r
   IN UINT8                       SizeOfIoSpace\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Builds a HOB for the Stack.\r
@@ -303,8 +329,7 @@ EFIAPI
 BuildStackHob (\r
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Builds a HOB for the BSP store.\r
@@ -325,8 +350,7 @@ BuildBspStoreHob (
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length,\r
   IN EFI_MEMORY_TYPE             MemoryType\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Builds a HOB for the memory allocation.\r
@@ -347,7 +371,17 @@ BuildMemoryAllocationHob (
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length,\r
   IN EFI_MEMORY_TYPE             MemoryType\r
-  )\r
-;\r
+  );\r
+\r
+#define GET_HOB_TYPE(Hob)     ((Hob).Header->HobType)\r
+#define GET_HOB_LENGTH(Hob)   ((Hob).Header->HobLength)\r
+#define GET_NEXT_HOB(Hob)     ((Hob).Raw + GET_HOB_LENGTH (Hob))\r
+#define END_OF_HOB_LIST(Hob)  (GET_HOB_TYPE (Hob) == (UINT16)EFI_HOB_TYPE_END_OF_HOB_LIST)\r
+\r
+//\r
+// Get the data and data size field of GUID \r
+//\r
+#define GET_GUID_HOB_DATA(GuidHob)      ((VOID *) (((UINT8 *) &((GuidHob)->Name)) + sizeof (EFI_GUID)))\r
+#define GET_GUID_HOB_DATA_SIZE(GuidHob) (((GuidHob)->Header).HobLength - sizeof (EFI_HOB_GUID_TYPE))\r
 \r
 #endif\r