From 8e9b6db7cc4075234754d9ad64a069f8c095eb38 Mon Sep 17 00:00:00 2001
From: Taylor Beebe <taylor.d.beebe@gmail.com>
Date: Mon, 29 Apr 2024 14:42:01 -0700
Subject: [PATCH] add function header

---
 .../FlatPageTableLib/AArch64/FlatPageTableAArch64.c  |  6 ++++++
 .../FlatPageTableLib/AArch64/ReadIdMmfr1.nasm        | 12 +++++++++++-
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/UefiTestingPkg/Library/FlatPageTableLib/AArch64/FlatPageTableAArch64.c b/UefiTestingPkg/Library/FlatPageTableLib/AArch64/FlatPageTableAArch64.c
index 7aa9b2050f..b3a13046bf 100644
--- 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
index 612b478fcf..aa3bb0fca4 100644
--- 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