MdeModulePkg: Clean up source files

[mirror_edk2.git] / MdeModulePkg / Universal / DebugSupportDxe / DebugSupport.c

diff --git a/MdeModulePkg/Universal/DebugSupportDxe/DebugSupport.c b/MdeModulePkg/Universal/DebugSupportDxe/DebugSupport.c
index ed4d86038aa8d75b72f7d8a752e53e4d4139f613..b7c1c5c4dd9eb96b4b5eef7d3f9991bfa266d17b 100644 (file)
--- a/MdeModulePkg/Universal/DebugSupportDxe/DebugSupport.c
+++ b/MdeModulePkg/Universal/DebugSupportDxe/DebugSupport.c
@@ -1,8 +1,8 @@
 /** @file\r
   Top level C file for debug support driver.  Contains initialization function.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -12,15 +12,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-//\r
-// private header files\r
-//\r
 #include "PlDebugSupport.h"\r
 \r
-//\r
-// This is a global that is the actual interface\r
-//\r
-EFI_DEBUG_SUPPORT_PROTOCOL  gDebugSupportProtocolInterface = {\r
+EFI_DEBUG_SUPPORT_PROTOCOL  mDebugSupportProtocolInterface = {\r
   EFI_ISA,\r
   GetMaximumProcessorIndex,\r
   RegisterPeriodicCallback,\r
@@ -30,20 +24,21 @@ EFI_DEBUG_SUPPORT_PROTOCOL  gDebugSupportProtocolInterface = {
 \r
 \r
 /**\r
-  Debug Port Driver entry point. \r
+  Debug Support Driver entry point.\r
 \r
-  Checks to see there's not already a DebugSupport protocol installed for \r
-  the selected processor before installing protocol.\r
+  Checks to see if there's not already a Debug Support protocol installed for\r
+  the selected processor before installing it.\r
 \r
-  @param[in] ImageHandle       The firmware allocated handle for the EFI image.  \r
+  @param[in] ImageHandle       The firmware allocated handle for the EFI image.\r
   @param[in] SystemTable       A pointer to the EFI System Table.\r
-  \r
+\r
   @retval EFI_SUCCESS          The entry point is executed successfully.\r
-  @retval EFI_ALREADY_STARTED  DebugSupport protocol is installed already.\r
+  @retval EFI_ALREADY_STARTED  Debug Support protocol is installed already.\r
   @retval other                Some error occurs when executing this entry point.\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 InitializeDebugSupportDriver (\r
   IN EFI_HANDLE               ImageHandle,\r
   IN EFI_SYSTEM_TABLE         *SystemTable\r
@@ -56,8 +51,6 @@ InitializeDebugSupportDriver (
   UINTN                       NumHandles;\r
   EFI_DEBUG_SUPPORT_PROTOCOL  *DebugSupportProtocolPtr;\r
 \r
-  //\r
-  //  Install Protocol Interface...\r
   //\r
   // First check to see that the debug support protocol for this processor\r
   // type is not already installed\r
@@ -81,7 +74,10 @@ InitializeDebugSupportDriver (
                       NULL,\r
                       EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                       );\r
-      if (Status == EFI_SUCCESS && DebugSupportProtocolPtr->Isa == EFI_ISA) {\r
+      if ((Status == EFI_SUCCESS) && (DebugSupportProtocolPtr->Isa == EFI_ISA)) {\r
+        //\r
+        // a Debug Support protocol has been installed for this processor\r
+        //\r
         FreePool (HandlePtr);\r
         Status = EFI_ALREADY_STARTED;\r
         goto ErrExit;\r
@@ -109,7 +105,7 @@ InitializeDebugSupportDriver (
   LoadedImageProtocolPtr->Unload = PlUnloadDebugSupportDriver;\r
 \r
   //\r
-  // Call hook for platform specific initialization\r
+  // Call hook for processor specific initialization\r
   //\r
   Status = PlInitializeDebugSupportDriver ();\r
   ASSERT (!EFI_ERROR (Status));\r
@@ -118,14 +114,14 @@ InitializeDebugSupportDriver (
   }\r
 \r
   //\r
-  // Install DebugSupport protocol to new handle\r
+  // Install Debug Support protocol to new handle\r
   //\r
   Handle = NULL;\r
   Status = gBS->InstallProtocolInterface (\r
                   &Handle,\r
                   &gEfiDebugSupportProtocolGuid,\r
                   EFI_NATIVE_INTERFACE,\r
-                  &gDebugSupportProtocolInterface\r
+                  &mDebugSupportProtocolInterface\r
                   );\r
   ASSERT (!EFI_ERROR (Status));\r
   if (Status != EFI_SUCCESS) {\r