ArmPlatformPkg/ArmPlatformLib: Added support for ArmPlatformIsPrimaryCore()

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

diff --git a/ArmPlatformPkg/Include/Library/ArmPlatformLib.h b/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
index 4ea1445e18f99ca785d86278ef4c2f5767731d4b..b58ddd5d3fa59307ecd8b6b5134d257cfc5d744d 100644 (file)
--- a/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
+++ b/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
@@ -40,11 +40,35 @@ typedef struct {
   UINT64                       NumberOfBytes;\r
 } ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR;\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 current Boot Mode\r
 \r