UefiPayloadPkg: Enhance UEFI payload for coreboot and Slim Bootloader

[mirror_edk2.git] / UefiPayloadPkg / Include / Library / BlParseLib.h

/** @file\r
  This library will parse the coreboot table in memory and extract those required\r
  information.\r
\r
  Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#include <PiPei.h>\r
#include <Guid/GraphicsInfoHob.h>\r
#include <Guid/MemoryMapInfoGuid.h>\r
#include <Guid/SerialPortInfoGuid.h>\r
#include <Guid/SystemTableInfoGuid.h>\r
#include <Guid/AcpiBoardInfoGuid.h>\r
\r
#ifndef __BOOTLOADER_PARSE_LIB__\r
#define __BOOTLOADER_PARSE_LIB__\r
\r
#define GET_BOOTLOADER_PARAMETER()      (*(UINT32 *)(UINTN)(PcdGet32(PcdPayloadStackTop) - sizeof(UINT32)))\r
#define SET_BOOTLOADER_PARAMETER(Value) GET_BOOTLOADER_PARAMETER()=Value\r
\r
typedef RETURN_STATUS \\r
        (*BL_MEM_INFO_CALLBACK) (MEMROY_MAP_ENTRY *MemoryMapEntry, VOID *Param);\r
\r
/**\r
  This function retrieves the parameter base address from boot loader.\r
\r
  This function will get bootloader specific parameter address for UEFI payload.\r
  e.g. HobList pointer for Slim Bootloader, and coreboot table header for Coreboot.\r
\r
  @retval NULL            Failed to find the GUID HOB.\r
  @retval others          GUIDed HOB data pointer.\r
\r
**/\r
VOID *\r
EFIAPI\r
GetParameterBase (\r
  VOID\r
  );\r
\r
/**\r
  Acquire the memory map information.\r
\r
  @param  MemInfoCallback     The callback routine\r
  @param  Params              Pointer to the callback routine parameter\r
\r
  @retval RETURN_SUCCESS     Successfully find out the memory information.\r
  @retval RETURN_NOT_FOUND   Failed to find the memory information.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ParseMemoryInfo (\r
  IN  BL_MEM_INFO_CALLBACK       MemInfoCallback,\r
  IN  VOID                       *Params\r
  );\r
\r
/**\r
  Acquire acpi table and smbios table from slim bootloader\r
\r
  @param  SystemTableInfo           Pointer to the system table info\r
\r
  @retval RETURN_SUCCESS            Successfully find out the tables.\r
  @retval RETURN_NOT_FOUND          Failed to find the tables.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ParseSystemTable (\r
  OUT SYSTEM_TABLE_INFO     *SystemTableInfo\r
  );\r
\r
\r
/**\r
  Find the serial port information\r
\r
  @param  SERIAL_PORT_INFO   Pointer to serial port info structure\r
\r
  @retval RETURN_SUCCESS     Successfully find the serial port information.\r
  @retval RETURN_NOT_FOUND   Failed to find the serial port information .\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ParseSerialInfo (\r
  OUT SERIAL_PORT_INFO     *SerialPortInfo\r
  );\r
\r
\r
/**\r
  Find the video frame buffer information\r
\r
  @param  GfxInfo             Pointer to the EFI_PEI_GRAPHICS_INFO_HOB structure\r
\r
  @retval RETURN_SUCCESS     Successfully find the video frame buffer information.\r
  @retval RETURN_NOT_FOUND   Failed to find the video frame buffer information .\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ParseGfxInfo (\r
  OUT EFI_PEI_GRAPHICS_INFO_HOB       *GfxInfo\r
  );\r
\r
/**\r
  Find the video frame buffer device information\r
\r
  @param  GfxDeviceInfo      Pointer to the EFI_PEI_GRAPHICS_DEVICE_INFO_HOB structure\r
\r
  @retval RETURN_SUCCESS     Successfully find the video frame buffer information.\r
  @retval RETURN_NOT_FOUND   Failed to find the video frame buffer information .\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ParseGfxDeviceInfo (\r
  OUT EFI_PEI_GRAPHICS_DEVICE_INFO_HOB       *GfxDeviceInfo\r
  );\r
\r
#endif\r