ArmPlatformPkg/ArmPlatformLib.h: Added documentation for ArmPlatformPeiBootAction()

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

diff --git a/ArmPlatformPkg/Include/Library/ArmPlatformLib.h b/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
index 94ad5c176f3e42d64e4776782bf1ce96737ca6e7..ed631f3c42c3c48c639580adfcb14f9856a0ad40 100644 (file)
--- a/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
+++ b/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
@@ -96,6 +96,22 @@ ArmPlatformGetBootMode (
   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