Fix function comment to follows doxygen format.

[mirror_edk2.git] / MdeModulePkg / Core / Pei / Hob / Hob.c

/** @file\r
  This module provide Hand-Off Block manupulation.\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
                                                                                          \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
#include <PeiMain.h>\r
\r
/**\r
\r
  Gets the pointer to the HOB List.\r
\r
\r
  @param PeiServices                   The PEI core services table.\r
  @param HobList                       Pointer to the HOB List.\r
\r
  @retval EFI_SUCCESS                  Get the pointer of HOB List\r
  @retval EFI_NOT_AVAILABLE_YET        the HOB List is not yet published\r
  @retval EFI_INVALID_PARAMETER        HobList is NULL (in debug mode)\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetHobList (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN OUT VOID          **HobList\r
  )\r
{\r
  PEI_CORE_INSTANCE *PrivateData;\r
\r
  \r
  //\r
  // Only check this parameter in debug mode\r
  //\r
  \r
  DEBUG_CODE_BEGIN ();  \r
    if (HobList == NULL) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  DEBUG_CODE_END ();\r
  \r
  PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS(PeiServices);\r
\r
  *HobList    = PrivateData->HobList.Raw;\r
\r
\r
  return EFI_SUCCESS;   \r
}\r
\r
\r
/**\r
  Add a new HOB to the HOB List.\r
\r
  @param PeiServices     - The PEI core services table.\r
  @param Type            - Type of the new HOB.\r
  @param Length          - Length of the new HOB to allocate.\r
  @param Hob             - Pointer to the new HOB.\r
\r
  @return  EFI_SUCCESS           Success to create hob.\r
  @retval  EFI_INVALID_PARAMETER if Hob is NULL\r
  @retval  EFI_NOT_AVAILABLE_YET if HobList is still not available.\r
  @retval  EFI_OUT_OF_RESOURCES  if there is no more memory to grow the Hoblist.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiCreateHob (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN UINT16            Type,\r
  IN UINT16            Length,\r
  IN OUT VOID          **Hob\r
  )\r
{\r
  EFI_STATUS                           Status;\r
  EFI_HOB_HANDOFF_INFO_TABLE           *HandOffHob;\r
  EFI_HOB_GENERIC_HEADER               *HobEnd;\r
  EFI_PHYSICAL_ADDRESS                 FreeMemory;\r
\r
\r
  Status = PeiGetHobList (PeiServices, Hob);\r
  if (EFI_ERROR(Status)) {\r
    return Status;\r
  }\r
\r
  HandOffHob = *Hob;\r
\r
  Length     = (UINT16)((Length + 0x7) & (~0x7));\r
\r
  FreeMemory = HandOffHob->EfiFreeMemoryTop -\r
               HandOffHob->EfiFreeMemoryBottom;\r
\r
  if (FreeMemory < Length) {\r
    DEBUG ((EFI_D_ERROR, "PeiCreateHob fail: Length - 0x%08x\n", (UINTN)Length));\r
    DEBUG ((EFI_D_ERROR, "  FreeMemoryTop    - 0x%08x\n", (UINTN)HandOffHob->EfiFreeMemoryTop));\r
    DEBUG ((EFI_D_ERROR, "  FreeMemoryBottom - 0x%08x\n", (UINTN)HandOffHob->EfiFreeMemoryBottom));\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  \r
  *Hob = (VOID*) (UINTN) HandOffHob->EfiEndOfHobList;\r
  ((EFI_HOB_GENERIC_HEADER*) *Hob)->HobType   = Type;\r
  ((EFI_HOB_GENERIC_HEADER*) *Hob)->HobLength = Length;\r
  ((EFI_HOB_GENERIC_HEADER*) *Hob)->Reserved  = 0;\r
\r
  HobEnd = (EFI_HOB_GENERIC_HEADER*) ((UINTN) *Hob + Length);\r
  HandOffHob->EfiEndOfHobList = (EFI_PHYSICAL_ADDRESS) (UINTN) HobEnd;\r
 \r
  HobEnd->HobType   = EFI_HOB_TYPE_END_OF_HOB_LIST;\r
  HobEnd->HobLength = sizeof(EFI_HOB_GENERIC_HEADER);\r
  HobEnd->Reserved  = 0;\r
  HobEnd++;\r
  HandOffHob->EfiFreeMemoryBottom = (EFI_PHYSICAL_ADDRESS) (UINTN) HobEnd;\r
\r
\r
  return EFI_SUCCESS;   \r
}\r
\r
\r
/**\r
\r
  Builds a Handoff Information Table HOB\r
\r
  @param BootMode        - Current Bootmode\r
  @param MemoryBegin     - Start Memory Address.\r
  @param MemoryLength    - Length of Memory.\r
\r
  @return EFI_SUCCESS Always success to initialize HOB.\r
\r
**/\r
EFI_STATUS\r
PeiCoreBuildHobHandoffInfoTable (\r
  IN EFI_BOOT_MODE         BootMode,\r
  IN EFI_PHYSICAL_ADDRESS  MemoryBegin,\r
  IN UINT64                MemoryLength\r
  )\r
{\r
  EFI_HOB_HANDOFF_INFO_TABLE   *Hob;\r
  EFI_HOB_GENERIC_HEADER       *HobEnd;\r
\r
  Hob    = (VOID *)(UINTN)MemoryBegin;\r
  HobEnd = (EFI_HOB_GENERIC_HEADER*) (Hob+1);\r
  Hob->Header.HobType   = EFI_HOB_TYPE_HANDOFF;\r
  Hob->Header.HobLength = sizeof(EFI_HOB_HANDOFF_INFO_TABLE);\r
  Hob->Header.Reserved  = 0;\r
  \r
  HobEnd->HobType     = EFI_HOB_TYPE_END_OF_HOB_LIST;\r
  HobEnd->HobLength   = sizeof(EFI_HOB_GENERIC_HEADER);\r
  HobEnd->Reserved    = 0;\r
\r
  Hob->Version             = EFI_HOB_HANDOFF_TABLE_VERSION;\r
  Hob->BootMode            = BootMode;\r
  \r
  Hob->EfiMemoryTop        = MemoryBegin + MemoryLength;\r
  Hob->EfiMemoryBottom     = MemoryBegin;\r
  Hob->EfiFreeMemoryTop    = MemoryBegin + MemoryLength;\r
  Hob->EfiFreeMemoryBottom = (EFI_PHYSICAL_ADDRESS) (UINTN) (HobEnd+1);\r
  Hob->EfiEndOfHobList     = (EFI_PHYSICAL_ADDRESS) (UINTN) HobEnd;\r
\r
  return EFI_SUCCESS;\r
}\r