/** @file

  Copyright (c) 2017-2023, Intel Corporation. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#include <PiPei.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/FspSupportLib.h>
#include <Library/BootloaderCoreLib.h>
#include <Guid/FspNonVolatileStorageHob2.h>
#include <Guid/GuidHobFspEas.h>

/**
  This function retrieves FSP Non-volatile Storage HOB buffer and size.

  @param  HobListPtr   A HOB list pointer.
  @param  Length       A pointer to the NVS data buffer length.  If the FSP NVS
                       HOB is located, the length will be updated.
  @retval NULL         Failed to find the NVS HOB.
  @retval others       FSP NVS data buffer pointer.

**/
VOID *
EFIAPI
GetFspNvsDataBuffer (
  CONST VOID       *HobListPtr,
  UINT32           *Length
  )
{
  VOID       *HobData;

  HobData = GetGuidHobData (HobListPtr, Length, &gFspNonVolatileStorageHobGuid);
  if (HobData == NULL){
    return GetFspNvsData2Buffer(HobListPtr, Length);
  }
  return HobData;
}

/**
  This function retrieves FSP Non-volatile Storage HOB 2 buffer and size.

  @param  HobListPtr   A HOB list pointer.
  @param  Length       A pointer to the NVS data buffer length.  If the FSP NVS
                       HOB is located, the length will be updated.
  @retval NULL         Failed to find the NVS HOB.
  @retval others       FSP NVS data buffer pointer.

**/
VOID *
EFIAPI
GetFspNvsData2Buffer (
  CONST VOID       *HobListPtr,
  UINT32           *Length
  )
{
  UINT8                  *GuidHob;

  if (HobListPtr == NULL) {
    return NULL;
  }
  GuidHob = GetNextGuidHob (&gFspNonVolatileStorageHob2Guid, HobListPtr);
  if (GuidHob != NULL) {
    if (Length != NULL) {
      *Length = (UINT32) ((FSP_NON_VOLATILE_STORAGE_HOB2 *) (UINTN) GuidHob)->NvsDataLength;
    }
    return (VOID *) (UINTN) ((FSP_NON_VOLATILE_STORAGE_HOB2 *) (UINTN) GuidHob)->NvsDataPtr;
  }
  return NULL;
}

/**
  This function retrieves a special reserved memory region.

  @param  HobListPtr   A HOB list pointer.
  @param  Length       A pointer to the GUID HOB data buffer length.  If the GUID HOB is
                       located, the length will be updated.
  @param  OwnerGuid    A pointer to the owner guild.
  @retval              Reserved region start address.  0 if this region does not exist.

**/
UINT64
EFIAPI
GetFspReservedMemoryFromGuid (
  CONST VOID     *HobListPtr,
  UINT64         *Length,
  EFI_GUID       *OwnerGuid
  )
{
  EFI_PEI_HOB_POINTERS    Hob;

  /*
   * Get the HOB list for processing
   */
  Hob.Raw = (VOID *)HobListPtr;

  /*
   * Collect memory ranges
   */
  while (!END_OF_HOB_LIST (Hob)) {
    if (Hob.Header->HobType == EFI_HOB_TYPE_RESOURCE_DESCRIPTOR) {
      if (Hob.ResourceDescriptor->ResourceType == EFI_RESOURCE_MEMORY_RESERVED) {
        if (CompareGuid (&Hob.ResourceDescriptor->Owner, OwnerGuid)) {
          if (Length != 0) {
            *Length = (UINT32) (Hob.ResourceDescriptor->ResourceLength);
          }
          return (UINT64) (Hob.ResourceDescriptor->PhysicalStart);
        }
      }
    }
    Hob.Raw = GET_NEXT_HOB (Hob);
  }

  return 0;
}

/**
  This function retrieves a top of low and high memory address.

  @param  HobListPtr    A HOB list pointer.
  @param  TopOfHighMem  A pointer to receive the top of high memory.

  @retval              Top of low memory.

**/
UINT32
EFIAPI
GetSystemTopOfMemeory (
  CONST VOID     *HobListPtr,
  UINT64         *TopOfHighMem  OPTIONAL
  )
{
  EFI_PEI_HOB_POINTERS    Hob;
  UINT32                  Tolm;
  UINT64                  Tohm;
  EFI_PHYSICAL_ADDRESS    EndAddr;

  // Get the HOB list for processing
  Hob.Raw = (VOID *)HobListPtr;

  // Collect memory ranges
  Tolm = 0;
  Tohm = SIZE_4GB;
  while (!END_OF_HOB_LIST (Hob)) {
    if (Hob.Header->HobType == EFI_HOB_TYPE_RESOURCE_DESCRIPTOR) {
      if (Hob.ResourceDescriptor->ResourceType == EFI_RESOURCE_SYSTEM_MEMORY) {
        EndAddr = Hob.ResourceDescriptor->PhysicalStart + Hob.ResourceDescriptor->ResourceLength;
        if (EndAddr < SIZE_4GB) {
          if (EndAddr > Tolm) {
            Tolm = (UINT32) EndAddr;
          }
        } else {
          if (EndAddr > Tohm) {
            Tohm = EndAddr;
          }
        }
      }
    }
    Hob.Raw = GET_NEXT_HOB (Hob);
  }

  if (TopOfHighMem != NULL) {
    *TopOfHighMem = Tohm;
  }

  return Tolm;
}

/**
  This function traverses each memory resource hob type and calls the handler.

  @param  HobListPtr         A HOB list pointer.
  @param  MemResHobCallback  A function pointer to the callback handler
  @param  Param              A pointer to the parameter which will be passed into handler.

**/
VOID
EFIAPI
TraverseMemoryResourceHob (
  IN  CONST VOID            *HobListPtr,
  IN  MEM_RES_HOB_CALLBACK   MemResHobCallback,
  IN  VOID                  *Param
  )
{
  EFI_PEI_HOB_POINTERS    Hob;

  /*
   * Get the HOB list for processing
   */
  Hob.Raw = (VOID *)HobListPtr;

  /*
   * Collect memory ranges
   */
  while (!END_OF_HOB_LIST (Hob)) {
    if (Hob.Header->HobType == EFI_HOB_TYPE_RESOURCE_DESCRIPTOR) {
      if ((Hob.ResourceDescriptor->ResourceType == EFI_RESOURCE_MEMORY_RESERVED) ||
          (Hob.ResourceDescriptor->ResourceType == EFI_RESOURCE_SYSTEM_MEMORY)) {
        MemResHobCallback (Hob.ResourceDescriptor, Param);
      }
    }
    Hob.Raw = GET_NEXT_HOB (Hob);
  }
}

/**
  Dump FSP memory resource

  @param  HobListPtr         A HOB list pointer.

**/
VOID
EFIAPI
DumpFspResourceHob (
  IN  CONST VOID            *HobListPtr
  )
{
  EFI_PEI_HOB_POINTERS    Hob;

  // Get the HOB list for processing
  Hob.Raw = (VOID *)HobListPtr;

  DEBUG ((DEBUG_INFO, "    FSP Resource HOB Range        Type       Owner\n"));
  DEBUG ((DEBUG_INFO, "================================= ==== ====================================\n"));

  // Collect memory ranges
  while (!END_OF_HOB_LIST (Hob)) {
    if (Hob.Header->HobType == EFI_HOB_TYPE_RESOURCE_DESCRIPTOR) {
      DEBUG ((DEBUG_INFO, "%016lx-%016lx  %02x  %g\n",
              Hob.ResourceDescriptor->PhysicalStart,
              Hob.ResourceDescriptor->PhysicalStart + Hob.ResourceDescriptor->ResourceLength,
              Hob.ResourceDescriptor->ResourceType,
              &(Hob.ResourceDescriptor->Owner)
              ));
    }
    Hob.Raw = GET_NEXT_HOB (Hob);
  }
  DEBUG ((DEBUG_INFO, "\n"));
}