UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

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

diff --git a/ArmPlatformPkg/Include/Library/ArmPlatformLib.h b/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
index 4ea1445e18f99ca785d86278ef4c2f5767731d4b..cd87743eba521fd097c04fd0ac49ce1691b9203b 100644 (file)
--- a/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
+++ b/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
@@ -1,15 +1,9 @@
 /** @file\r
-*\r
-*  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
-*  \r
-*  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
+  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
@@ -20,7 +14,7 @@
 //\r
 #include <PiPei.h>\r
 //\r
-// The protocols, PPI and GUID defintions for this module\r
+// The protocols, PPI and GUID definitions for this module\r
 //\r
 #include <Ppi/MasterBootMode.h>\r
 #include <Ppi/BootInRecoveryMode.h>\r
@@ -28,21 +22,46 @@
 #include <Library/ArmLib.h>\r
 \r
 /**\r
-  This structure is used to describe a region of the EFI memory map\r
+  Return the core position from the value of its MpId register\r
 \r
-  Every EFI regions of the system memory described by their physical start address and their size\r
-  can have different attributes. Some regions can be tested and other untested.\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
-**/\r
-typedef struct {\r
-  EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute;\r
-  EFI_PHYSICAL_ADDRESS         PhysicalStart;\r
-  UINT64                       NumberOfBytes;\r
-} ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR;\r
+  @return   Return the core position\r
 \r
+**/\r
 UINTN\r
 ArmPlatformGetCorePosition (\r
-  IN UINTN MpId\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
@@ -59,26 +78,31 @@ ArmPlatformGetBootMode (
   );\r
 \r
 /**\r
-  Initialize controllers that must setup in the normal world\r
+  First platform specific function to be called in the PEI phase\r
 \r
-  This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei\r
-  in the PEI phase.\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
-RETURN_STATUS\r
-ArmPlatformInitialize (\r
-  IN  UINTN                     MpId\r
+VOID\r
+ArmPlatformPeiBootAction (\r
+  VOID\r
   );\r
 \r
 /**\r
-  Initialize the system (or sometimes called permanent) memory\r
+  Initialize controllers that must setup in the normal world\r
 \r
-  This memory is generally represented by the DRAM.\r
+  This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei\r
+  in the PEI phase.\r
 \r
 **/\r
-VOID\r
-ArmPlatformInitializeSystemMemory (\r
-  VOID\r
+RETURN_STATUS\r
+ArmPlatformInitialize (\r
+  IN  UINTN  MpId\r
   );\r
 \r
 /**\r
@@ -93,7 +117,7 @@ ArmPlatformInitializeSystemMemory (
 **/\r
 VOID\r
 ArmPlatformGetVirtualMemoryMap (\r
-  OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap\r
+  OUT ARM_MEMORY_REGION_DESCRIPTOR  **VirtualMemoryMap\r
   );\r
 \r
 /**\r