ArmPlatformPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ArmPlatformPkg / Include / Library / ArmPlatformLib.h

/** @file\r
*\r
*  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#ifndef _ARMPLATFORMLIB_H_\r
#define _ARMPLATFORMLIB_H_\r
\r
//\r
// The package level header files this module uses\r
//\r
#include <PiPei.h>\r
//\r
// The protocols, PPI and GUID defintions for this module\r
//\r
#include <Ppi/MasterBootMode.h>\r
#include <Ppi/BootInRecoveryMode.h>\r
\r
#include <Library/ArmLib.h>\r
\r
/**\r
  Return the core position from the value of its MpId register\r
\r
  This function returns the core position from the position 0 in the processor.\r
  This function might be called from assembler before any stack is set.\r
\r
  @return   Return the core position\r
\r
**/\r
UINTN\r
ArmPlatformGetCorePosition (\r
  IN UINTN MpId\r
  );\r
\r
/**\r
  Return a non-zero value if the callee is the primary core\r
\r
  This function returns a non-zero value if the callee is the primary core.\r
  The primary core is the core responsible to initialize the hardware and run UEFI.\r
  This function might be called from assembler before any stack is set.\r
\r
  @return   Return a non-zero value if the callee is the primary core.\r
\r
**/\r
UINTN\r
ArmPlatformIsPrimaryCore (\r
  IN UINTN MpId\r
  );\r
\r
/**\r
  Return the MpId of the primary core\r
\r
  This function returns the MpId of the primary core.\r
  This function might be called from assembler before any stack is set.\r
\r
  @return   Return the MpId of the primary core\r
\r
**/\r
UINTN\r
ArmPlatformGetPrimaryCoreMpId (\r
  VOID\r
  );\r
\r
/**\r
  Return the current Boot Mode\r
\r
  This function returns the boot reason on the platform\r
\r
  @return   Return the current Boot Mode of the platform\r
\r
**/\r
EFI_BOOT_MODE\r
ArmPlatformGetBootMode (\r
  VOID\r
  );\r
\r
/**\r
  First platform specific function to be called in the PEI phase\r
\r
  This function is actually the first function called by the PrePi\r
  or PrePeiCore modules. It allows to retrieve arguments passed to\r
  the UEFI firmware through the CPU registers.\r
\r
  This function might be written into assembler as no stack are set\r
  when the function is invoked.\r
\r
**/\r
VOID\r
ArmPlatformPeiBootAction (\r
  VOID\r
  );\r
\r
/**\r
  Initialize controllers that must setup in the normal world\r
\r
  This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei\r
  in the PEI phase.\r
\r
**/\r
RETURN_STATUS\r
ArmPlatformInitialize (\r
  IN  UINTN                     MpId\r
  );\r
\r
/**\r
  Return the Virtual Memory Map of your platform\r
\r
  This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.\r
\r
  @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-\r
                                    Virtual Memory mapping. This array must be ended by a zero-filled\r
                                    entry\r
\r
**/\r
VOID\r
ArmPlatformGetVirtualMemoryMap (\r
  OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap\r
  );\r
\r
/**\r
  Return the Platform specific PPIs\r
\r
  This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed\r
  to the PeiCore by PrePeiCore.\r
\r
  @param[out]   PpiListSize         Size in Bytes of the Platform PPI List\r
  @param[out]   PpiList             Platform PPI List\r
\r
**/\r
VOID\r
ArmPlatformGetPlatformPpiList (\r
  OUT UINTN                   *PpiListSize,\r
  OUT EFI_PEI_PPI_DESCRIPTOR  **PpiList\r
  );\r
\r
#endif\r