Correct description for return status code of PEI service AllocatePages(), according...

[mirror_edk2.git] / MdeModulePkg / Core / Pei / Memory / MemoryServices.c

/** @file\r
  EFI PEI Core memory services\r
  \r
Copyright (c) 2006 - 2010, 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
  Initialize the memory services.\r
\r
  @param PrivateData     Points to PeiCore's private instance data.\r
  @param SecCoreData     Points to a data structure containing information about the PEI core's operating\r
                         environment, such as the size and location of temporary RAM, the stack location and\r
                         the BFV location.\r
  @param OldCoreData     Pointer to the PEI Core data.\r
                         NULL if being run in non-permament memory mode.\r
\r
**/\r
VOID\r
InitializeMemoryServices (\r
  IN PEI_CORE_INSTANCE           *PrivateData,\r
  IN CONST EFI_SEC_PEI_HAND_OFF  *SecCoreData,\r
  IN PEI_CORE_INSTANCE           *OldCoreData\r
  )\r
{\r
  \r
  PrivateData->SwitchStackSignal    = FALSE;\r
\r
  //\r
  // First entering PeiCore, following code will initialized some field\r
  // in PeiCore's private data according to hand off data from sec core.\r
  //\r
  if (OldCoreData == NULL) {\r
\r
    PrivateData->PeiMemoryInstalled = FALSE;\r
    PrivateData->HobList.Raw        = SecCoreData->PeiTemporaryRamBase;\r
    \r
    PeiCoreBuildHobHandoffInfoTable (\r
      BOOT_WITH_FULL_CONFIGURATION,\r
      (EFI_PHYSICAL_ADDRESS) (UINTN) SecCoreData->PeiTemporaryRamBase,\r
      (UINTN) SecCoreData->PeiTemporaryRamSize\r
      );\r
\r
    //\r
    // Set Ps to point to ServiceTableShadow in Cache\r
    //\r
    PrivateData->Ps = &(PrivateData->ServiceTableShadow);\r
  }\r
  \r
  return;\r
}\r
\r
/**\r
\r
  This function registers the found memory configuration with the PEI Foundation.\r
\r
  The usage model is that the PEIM that discovers the permanent memory shall invoke this service.\r
  This routine will hold discoveried memory information into PeiCore's private data,\r
  and set SwitchStackSignal flag. After PEIM who discovery memory is dispatched,\r
  PeiDispatcher will migrate temporary memory to permenement memory.\r
  \r
  @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param MemoryBegin        Start of memory address.\r
  @param MemoryLength       Length of memory.\r
\r
  @return EFI_SUCCESS Always success.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiInstallPeiMemory (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN EFI_PHYSICAL_ADDRESS    MemoryBegin,\r
  IN UINT64                  MemoryLength\r
  )\r
{\r
  PEI_CORE_INSTANCE                     *PrivateData;\r
\r
  DEBUG ((EFI_D_INFO, "PeiInstallPeiMemory MemoryBegin 0x%LX, MemoryLength 0x%LX\n", MemoryBegin, MemoryLength));\r
  PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
\r
  //\r
  // PEI_SERVICE.InstallPeiMemory should only be called one time during whole PEI phase.\r
  // If it is invoked more than one time, ASSERT information is given for developer debugging in debug tip and\r
  // simply return EFI_SUCESS in release tip to ignore it.\r
  // \r
  if (PrivateData->PeiMemoryInstalled) {\r
    DEBUG ((EFI_D_ERROR, "ERROR: PeiInstallPeiMemory is called more than once!\n"));\r
    ASSERT (PrivateData->PeiMemoryInstalled);\r
    return EFI_SUCCESS;\r
  }\r
  \r
  PrivateData->PhysicalMemoryBegin   = MemoryBegin;\r
  PrivateData->PhysicalMemoryLength  = MemoryLength;\r
  PrivateData->FreePhysicalMemoryTop = MemoryBegin + MemoryLength;\r
   \r
  PrivateData->SwitchStackSignal      = TRUE;\r
\r
  return EFI_SUCCESS;   \r
}\r
\r
/**\r
\r
  Memory allocation service on permanent memory,\r
  not usable prior to the memory installation.\r
\r
\r
  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param MemoryType      Type of memory to allocate.\r
  @param Pages           Number of pages to allocate.\r
  @param Memory          Pointer of memory allocated.\r
\r
  @retval EFI_SUCCESS              The allocation was successful\r
  @retval EFI_NOT_AVAILABLE_YET    Called with permanent memory not available\r
  @retval EFI_OUT_OF_RESOURCES     There is not enough HOB heap to satisfy the requirement\r
                                   to allocate the number of pages.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiAllocatePages (\r
  IN CONST EFI_PEI_SERVICES     **PeiServices,\r
  IN       EFI_MEMORY_TYPE      MemoryType,\r
  IN       UINTN                Pages,\r
  OUT      EFI_PHYSICAL_ADDRESS *Memory\r
  )\r
{\r
  PEI_CORE_INSTANCE                       *PrivateData;\r
  EFI_PEI_HOB_POINTERS                    Hob;\r
  EFI_PHYSICAL_ADDRESS                    *FreeMemoryTop;\r
  EFI_PHYSICAL_ADDRESS                    *FreeMemoryBottom;\r
  UINTN                                   RemainingPages;\r
\r
  PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
  Hob.Raw     = PrivateData->HobList.Raw;\r
  \r
  //\r
  // Check if Hob already available\r
  //\r
  if (!PrivateData->PeiMemoryInstalled) {\r
    //\r
    // When PeiInstallMemory is called but temporary memory has *not* been moved to temporary memory,\r
    // the AllocatePage will depend on the field of PEI_CORE_INSTANCE structure.\r
    //\r
    if (!PrivateData->SwitchStackSignal) {\r
      return EFI_NOT_AVAILABLE_YET;\r
    } else {\r
      FreeMemoryTop     = &(PrivateData->FreePhysicalMemoryTop);\r
      FreeMemoryBottom  = &(PrivateData->PhysicalMemoryBegin);\r
    }\r
  } else {\r
    FreeMemoryTop     = &(Hob.HandoffInformationTable->EfiFreeMemoryTop);\r
    FreeMemoryBottom  = &(Hob.HandoffInformationTable->EfiFreeMemoryBottom);\r
  }\r
\r
  //\r
  // Check to see if on 4k boundary, If not aligned, make the allocation aligned.\r
  //\r
  *(FreeMemoryTop) -= *(FreeMemoryTop) & 0xFFF;\r
  \r
  //\r
  // Verify that there is sufficient memory to satisfy the allocation\r
  //\r
  RemainingPages = EFI_SIZE_TO_PAGES ((UINTN) (*FreeMemoryTop - *FreeMemoryBottom));\r
  //\r
  // For page allocation, the overhead sizeof (EFI_HOB_MEMORY_ALLOCATION) needs one extra page.\r
  // So the number of remaining pages needs to be greater than that of the request pages.\r
  //\r
  if (RemainingPages <= Pages) {\r
    DEBUG ((EFI_D_ERROR, "AllocatePages failed: No 0x%lx Pages is available.\n", (UINT64) Pages));\r
    DEBUG ((EFI_D_ERROR, "There is only left 0x%lx pages memory resource to be allocated.\n", (UINT64) RemainingPages));\r
    return  EFI_OUT_OF_RESOURCES;\r
  } else {\r
    //\r
    // Update the PHIT to reflect the memory usage\r
    //\r
    *(FreeMemoryTop) -= Pages * EFI_PAGE_SIZE;\r
\r
    //\r
    // Update the value for the caller\r
    //\r
    *Memory = *(FreeMemoryTop);\r
\r
    //\r
    // Create a memory allocation HOB.\r
    //\r
    BuildMemoryAllocationHob (\r
      *(FreeMemoryTop),\r
      Pages * EFI_PAGE_SIZE,\r
      MemoryType\r
      );\r
\r
    return EFI_SUCCESS;\r
  }\r
}\r
\r
/**\r
\r
  Pool allocation service. Before permenent memory is discoveried, the pool will \r
  be allocated the heap in the temporary memory. Genenrally, the size of heap in temporary \r
  memory does not exceed to 64K, so the biggest pool size could be allocated is \r
  64K.\r
\r
  @param PeiServices               An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param Size                      Amount of memory required\r
  @param Buffer                    Address of pointer to the buffer\r
\r
  @retval EFI_SUCCESS              The allocation was successful\r
  @retval EFI_OUT_OF_RESOURCES     There is not enough heap to satisfy the requirement\r
                                   to allocate the requested size.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiAllocatePool (\r
  IN CONST EFI_PEI_SERVICES     **PeiServices,\r
  IN       UINTN                Size,\r
  OUT      VOID                 **Buffer\r
  )\r
{\r
  EFI_STATUS               Status;\r
  EFI_HOB_MEMORY_POOL      *Hob;\r
\r
  //\r
  // If some "post-memory" PEIM wishes to allocate larger pool,\r
  // it should use AllocatePages service instead.\r
  //\r
  \r
  //\r
  // Generally, the size of heap in temporary memory does not exceed to 64K,\r
  // so the maxmium size of pool is 0x10000 - sizeof (EFI_HOB_MEMORY_POOL)\r
  //\r
  if (Size >= (0x10000 - sizeof (EFI_HOB_MEMORY_POOL))) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  \r
  Status = PeiServicesCreateHob (\r
             EFI_HOB_TYPE_MEMORY_POOL,\r
             (UINT16)(sizeof (EFI_HOB_MEMORY_POOL) + Size),\r
             (VOID **)&Hob\r
             );\r
  *Buffer = Hob+1;  \r
\r
  return Status;\r
}\r