Cleanup style and convention issues

This commit cleans up several style and convention issues in DebuggerFeaturePkg.

Author: cfernald

DebuggerFeaturePkg/Library/DebugAgent/AARCH64/DebugAarch64.c

@@ -6,8 +6,6 @@
 
 **/
 
-#include <Library/UefiBootServicesTableLib.h>
-#include <Library/UefiLib.h>
 #include <Library/DebugLib.h>
 #include <Library/BaseMemoryLib.h>
 #include <Library/WatchdogTimerLib.h>
@@ -54,10 +52,10 @@ typedef union _DBG_WCR {
 // Structures used by the arch-agnostic code.
 //
 
-UINT8  ArchBreakpointInstruction[]   = { 0x00, 0x00, 0x3E, 0xD4 };
-UINTN  ArchBreakpointInstructionSize = sizeof (ArchBreakpointInstruction);
+UINT8  mArchBreakpointInstruction[]   = { 0x00, 0x00, 0x3E, 0xD4 };
+UINTN  mArchBreakpointInstructionSize = sizeof (mArchBreakpointInstruction);
 
-UINT32  ArchExceptionTypes[] = {
+UINT32  mArchExceptionTypes[] = {
   EXCEPT_AARCH64_SYNCHRONOUS_EXCEPTIONS,
   MAX_UINT32 // End of list
 };
@@ -106,8 +104,8 @@ DEBUG_WATCHPOINT_REGISTERS  DebugWatchpointRegisters[] = {
 VOID
 EFIAPI
 DebuggerExceptionHandler (
-  EFI_EXCEPTION_TYPE  InterruptType,
-  EFI_SYSTEM_CONTEXT  SystemContext
+  IN EFI_EXCEPTION_TYPE  InterruptType,
+  IN EFI_SYSTEM_CONTEXT  SystemContext
   )
 {
   EFI_SYSTEM_CONTEXT_AARCH64  *Context;
@@ -194,9 +192,9 @@ DebuggerExceptionHandler (
   //
 
   if ((ExceptionType == 0x3c) &&
-      (CompareMem ((UINT8 *)Context->ELR, &ArchBreakpointInstruction[0], ArchBreakpointInstructionSize) == 0))
+      (CompareMem ((UINT8 *)Context->ELR, &mArchBreakpointInstruction[0], mArchBreakpointInstructionSize) == 0))
   {
-    Context->ELR += ArchBreakpointInstructionSize;
+    Context->ELR += mArchBreakpointInstructionSize;
   }
 
   //

DebuggerFeaturePkg/Library/DebugAgent/Breakpoint.c

@@ -37,14 +37,14 @@ BREAKPOINT_REASON  DebuggerBreakpointReason = BreakpointReasonNone;
 **/
 BOOLEAN
 AddSoftwareBreakpoint (
-  UINTN  Address
+  IN UINTN  Address
   )
 {
   UINTN            i;
   BREAKPOINT_INFO  *Entry;
 
   // Make sure we don't overflow OriginalValue.
-  ASSERT (ArchBreakpointInstructionSize <= MAX_BREAKPOINT_SIZE);
+  ASSERT (mArchBreakpointInstructionSize <= MAX_BREAKPOINT_SIZE);
 
   Entry = NULL;
   for (i = 0; i < MAX_BREAKPOINTS; i++) {
@@ -65,9 +65,9 @@ AddSoftwareBreakpoint (
 
   Entry->Active  = TRUE;
   Entry->Address = Address;
-  DbgReadMemory (Address, &(Entry->OriginalValue[0]), ArchBreakpointInstructionSize);
-  DbgWriteMemory (Address, ArchBreakpointInstruction, ArchBreakpointInstructionSize);
-  InvalidateInstructionCacheRange ((VOID *)Address, ArchBreakpointInstructionSize);
+  DbgReadMemory (Address, &(Entry->OriginalValue[0]), mArchBreakpointInstructionSize);
+  DbgWriteMemory (Address, mArchBreakpointInstruction, mArchBreakpointInstructionSize);
+  InvalidateInstructionCacheRange ((VOID *)Address, mArchBreakpointInstructionSize);
   return TRUE;
 }
 
@@ -81,16 +81,16 @@ AddSoftwareBreakpoint (
 **/
 BOOLEAN
 RemoveSoftwareBreakpoint (
-  UINTN  Address
+  IN UINTN  Address
   )
 {
   UINTN  i;
 
   for (i = 0; i < MAX_BREAKPOINTS; i++) {
     if (mBreakpoints[i].Active && (mBreakpoints[i].Address == Address)) {
-      DbgWriteMemory (Address, &(mBreakpoints[i].OriginalValue[0]), ArchBreakpointInstructionSize);
+      DbgWriteMemory (Address, &(mBreakpoints[i].OriginalValue[0]), mArchBreakpointInstructionSize);
       mBreakpoints[i].Active = FALSE;
-      InvalidateInstructionCacheRange ((VOID *)Address, ArchBreakpointInstructionSize);
+      InvalidateInstructionCacheRange ((VOID *)Address, mArchBreakpointInstructionSize);
       return TRUE;
     }
   }
@@ -107,7 +107,7 @@ RemoveSoftwareBreakpoint (
 **/
 VOID
 DebuggerBreak (
-  BREAKPOINT_REASON  Reason
+  IN BREAKPOINT_REASON  Reason
   )
 {
   DebuggerBreakpointReason = Reason;

DebuggerFeaturePkg/Library/DebugAgent/DebugAgent.h

@@ -67,9 +67,9 @@ typedef struct _EXCEPTION_INFO {
 // Architecture specific definitions used by general debugger code.
 //
 
-extern UINT8   ArchBreakpointInstruction[];
-extern UINTN   ArchBreakpointInstructionSize;
-extern UINT32  ArchExceptionTypes[];
+extern UINT8   mArchBreakpointInstruction[];
+extern UINTN   mArchBreakpointInstructionSize;
+extern UINT32  mArchExceptionTypes[];
 
 //
 // Global used to track debugger invoked breakpoint.
@@ -93,8 +93,8 @@ extern CONST CHAR8  *gDebuggerInfo;
 VOID
 EFIAPI
 DebuggerExceptionHandler (
-  EFI_EXCEPTION_TYPE  InterruptType,
-  EFI_SYSTEM_CONTEXT  SystemContext
+  IN EFI_EXCEPTION_TYPE  InterruptType,
+  IN EFI_SYSTEM_CONTEXT  SystemContext
   );
 
 EFI_STATUS
@@ -134,16 +134,16 @@ IsPageWritable (
 
 BOOLEAN
 DbgReadMemory (
-  UINTN  Address,
-  VOID   *Data,
-  UINTN  Length
+  IN  UINTN  Address,
+  OUT VOID   *Data,
+  IN  UINTN  Length
   );
 
 BOOLEAN
 DbgWriteMemory (
-  UINTN  Address,
-  VOID   *Data,
-  UINTN  Length
+  IN UINTN  Address,
+  IN VOID   *Data,
+  IN UINTN  Length
   );
 
 //
@@ -163,7 +163,7 @@ DebuggerPollInput (
 
 VOID
 DebuggerInitialBreakpoint (
-  UINT64  Timeout
+  IN UINT64  Timeout
   );
 
 //
@@ -172,17 +172,17 @@ DebuggerInitialBreakpoint (
 
 BOOLEAN
 AddSoftwareBreakpoint (
-  UINTN  Address
+  IN UINTN  Address
   );
 
 BOOLEAN
 RemoveSoftwareBreakpoint (
-  UINTN  Address
+  IN UINTN  Address
   );
 
 VOID
 DebuggerBreak (
-  BREAKPOINT_REASON  Reason
+  IN BREAKPOINT_REASON  Reason
   );
 
 //

DebuggerFeaturePkg/Library/DebugAgent/DebugAgentDxe.c

@@ -275,7 +275,7 @@ OnLoadedImageNotification (
   CHAR8                      *PdbPointer;
   CHAR8                      Name[64];
   CHAR8                      *NameEnd;
-  UINTN                      i;
+  UINTN                      Index;
 
   BufferSize = sizeof (EFI_HANDLE);
 
@@ -314,9 +314,9 @@ OnLoadedImageNotification (
     }
 
     // Strip of the directories.
-    for (i = AsciiStrLen (PdbPointer); i > 0; i--) {
-      if ((PdbPointer[i - 1] == '\\') || (PdbPointer[i - 1] == '/')) {
-        PdbPointer = &PdbPointer[i];
+    for (Index = AsciiStrLen (PdbPointer); Index > 0; Index--) {
+      if ((PdbPointer[Index - 1] == '\\') || (PdbPointer[Index - 1] == '/')) {
+        PdbPointer = &PdbPointer[Index];
         break;
       }
     }
@@ -347,18 +347,18 @@ VOID
 DebugAgentExceptionDestroy (
   )
 {
-  UINT8  i;
+  UINT8  Index;
 
   if (gCpu != NULL) {
-    for (i = 0; ArchExceptionTypes[i] != MAX_UINT32; i += 1) {
+    for (Index = 0; mArchExceptionTypes[Index] != MAX_UINT32; Index += 1) {
       if (gCpu != NULL) {
         gCpu->RegisterInterruptHandler (
                 gCpu,
-                ArchExceptionTypes[i],
+                mArchExceptionTypes[Index],
                 NULL
                 );
       } else {
-        RegisterCpuInterruptHandler (ArchExceptionTypes[i], NULL);
+        RegisterCpuInterruptHandler (mArchExceptionTypes[Index], NULL);
       }
     }
   }
@@ -375,21 +375,21 @@ EFI_STATUS
 DebugAgentExceptionInitialize (
   )
 {
-  UINT8       i;
+  UINT8       Index;
   EFI_STATUS  Status;
 
   // First uninstall any handler that needs to be replaced.
   DebugAgentExceptionDestroy ();
 
-  for (i = 0; ArchExceptionTypes[i] != MAX_UINT32; i += 1) {
+  for (Index = 0; mArchExceptionTypes[Index] != MAX_UINT32; Index += 1) {
     if (gCpu != NULL) {
       Status = gCpu->RegisterInterruptHandler (
                        gCpu,
-                       ArchExceptionTypes[i],
+                       mArchExceptionTypes[Index],
                        DebuggerExceptionHandler
                        );
     } else {
-      Status = RegisterCpuInterruptHandler (ArchExceptionTypes[i], DebuggerExceptionHandler);
+      Status = RegisterCpuInterruptHandler (mArchExceptionTypes[Index], DebuggerExceptionHandler);
     }
 
     if (EFI_ERROR (Status)) {
@@ -428,10 +428,10 @@ DebugReboot (
 **/
 BOOLEAN
 AccessMemory (
-  UINTN    Address,
-  UINT8    *Data,
-  UINTN    Length,
-  BOOLEAN  Write
+  IN     UINTN    Address,
+  IN OUT UINT8    *Data,
+  IN     UINTN    Length,
+  IN     BOOLEAN  Write
   )
 {
   UINTN       LengthInPage;
@@ -517,17 +517,17 @@ AccessMemory (
   Read system memory.
 
   @param[in]      Address   The virtual address of the memory access.
-  @param[in,out]  Data      The buffer to read memory into.
+  @param[out]     Data      The buffer to read memory into.
   @param[in]      Length    The length of the memory range.
 
   @retval         TRUE      Memory access was complete successfully.
   @retval         FALSE     Memory access failed, either completely or partially.
 **/
 BOOLEAN
 DbgReadMemory (
-  UINTN  Address,
-  VOID   *Data,
-  UINTN  Length
+  IN  UINTN  Address,
+  OUT VOID   *Data,
+  IN  UINTN  Length
   )
 {
   return AccessMemory (Address, Data, Length, FALSE);
@@ -537,17 +537,17 @@ DbgReadMemory (
   Write to system memory.
 
   @param[in]      Address   The virtual address of the memory access.
-  @param[in,out]  Data      The buffer of data to write.
+  @param[in]      Data      The buffer of data to write.
   @param[in]      Length    The length of the memory range.
 
   @retval         TRUE      Memory access was complete successfully.
   @retval         FALSE     Memory access failed, either completely or partially.
 **/
 BOOLEAN
 DbgWriteMemory (
-  UINTN  Address,
-  VOID   *Data,
-  UINTN  Length
+  IN UINTN  Address,
+  IN VOID   *Data,
+  IN UINTN  Length
   )
 {
   return AccessMemory (Address, Data, Length, TRUE);