add function header

microsoft · Apr 29, 2024 · 8e9b6db · 8e9b6db
1 parent 98b2859
commit 8e9b6db
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/UefiTestingPkg/Library/FlatPageTableLib/AArch64/FlatPageTableAArch64.c b/UefiTestingPkg/Library/FlatPageTableLib/AArch64/FlatPageTableAArch64.c
@@ -74,6 +74,12 @@ typedef union {
 STATIC BOOLEAN  mHierarchicalControlEnabled = FALSE;
 
 #if !defined (__clang__) && !defined (__GNUC__)
+
+/**
+  Reads the ID_AA64MMFR1_EL1 special register.
+
+  @retval The UINT64 value of the ID_AA64MMFR1_EL1 special register.
+**/
 UINT64
 Asm_Read_ID_AA64MMFR1_EL1 (
   VOID

diff --git a/UefiTestingPkg/Library/FlatPageTableLib/AArch64/ReadIdMmfr1.nasm b/UefiTestingPkg/Library/FlatPageTableLib/AArch64/ReadIdMmfr1.nasm
@@ -4,9 +4,19 @@
 ; SPDX-License-Identifier: BSD-2-Clause-Patent
 ;------------------------------------------------------------------------------
 
-    AREA .text, CODE, READONLY
     EXPORT Asm_Read_ID_AA64MMFR1_EL1
+    AREA |.text|, CODE, READONLY
 
+;------------------------------------------------------------------------------
+; Reads the ID_AA64MMFR1_EL1 special register.
+;
+; @retval The UINT64 value of the ID_AA64MMFR1_EL1 special register.
+;
+; UINT64
+; Asm_Read_ID_AA64MMFR1_EL1 (
+;   VOID
+;   );
+;------------------------------------------------------------------------------
 Asm_Read_ID_AA64MMFR1_EL1
     MRS X0, ID_AA64MMFR1_EL1
     RET