ArmPlatformPkg/Include/Ppi/ArmGlobalVariable.h

   1 /** @file
   2 *
   3 *  Copyright (c) 2011, ARM Limited. All rights reserved.
   4 *
   5 *  This program and the accompanying materials
   6 *  are licensed and made available under the terms and conditions of the BSD License
   7 *  which accompanies this distribution.  The full text of the license may be found at
   8 *  http://opensource.org/licenses/bsd-license.php
   9 *
  10 *  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 *  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 *
  13 **/
  14
  15 #ifndef __ARM_GLOBAL_VARIABLE_H__
  16 #define __ARM_GLOBAL_VARIABLE_H__
  17
  18 #define ARM_GLOBAL_VARIABLE_PPI_GUID  \
  19   { 0xab1c1816, 0xd542, 0x4e6f, {0x9b, 0x1e, 0x8e, 0xcd, 0x92, 0x53, 0xe2, 0xe7} }
  20
  21
  22 /**
  23   This service of the EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into
  24   permanent memory.
  25
  26   @param PeiServices            Pointer to the PEI Services Table.
  27   @param TemporaryMemoryBase    Source Address in temporary memory from which the SEC or PEIM will copy the
  28                                 Temporary RAM contents.
  29   @param PermanentMemoryBase    Destination Address in permanent memory into which the SEC or PEIM will copy the
  30                                 Temporary RAM contents.
  31   @param CopySize               Amount of memory to migrate from temporary to permanent memory.
  32
  33   @retval EFI_SUCCESS           The data was successfully returned.
  34   @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize > TemporaryMemoryBase when
  35                                 TemporaryMemoryBase > PermanentMemoryBase.
  36
  37 **/
  38 typedef
  39 EFI_STATUS
  40 (EFIAPI * ARM_GLOBAL_VARIABLE_GET_MEMORY) (
  41   OUT EFI_PHYSICAL_ADDRESS    *GlobalVariableBase
  42 );
  43
  44 ///
  45 /// This service abstracts the ability to migrate contents of the platform early memory store.
  46 /// Note: The name EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI is different from the current PI 1.2 spec.
  47 ///       This PPI was optional.
  48 ///
  49 typedef struct {
  50   ARM_GLOBAL_VARIABLE_GET_MEMORY   GetGlobalVariableMemory;
  51 } ARM_GLOBAL_VARIABLE_PPI;
  52
  53 extern EFI_GUID gArmGlobalVariablePpiGuid;
  54
  55 #endif