X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FUniversal%2FDebugSupportDxe%2FDebugSupport.c;h=ed4d86038aa8d75b72f7d8a752e53e4d4139f613;hb=519f076a478a7da9ff4b9d5327a993b1fc2968e8;hp=a0ec6c5934bb5a8b4285e6bbcb40339b55899f68;hpb=c1f23d63363d36947e76df61320bdd2e5e233946;p=mirror_edk2.git

diff --git a/MdeModulePkg/Universal/DebugSupportDxe/DebugSupport.c b/MdeModulePkg/Universal/DebugSupportDxe/DebugSupport.c
index a0ec6c5934..ed4d86038a 100644
--- a/MdeModulePkg/Universal/DebugSupportDxe/DebugSupport.c
+++ b/MdeModulePkg/Universal/DebugSupportDxe/DebugSupport.c
@@ -1,30 +1,21 @@
-/*++
+/** @file
+  Top level C file for debug support driver.  Contains initialization function.
 
-Copyright (c) 2006, Intel Corporation                                                         
-All rights reserved. This program and the accompanying materials                          
-are licensed and made available under the terms and conditions of the BSD License         
-which accompanies this distribution.  The full text of the license may be found at        
-http://opensource.org/licenses/bsd-license.php                                            
-                                                                                          
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+Copyright (c) 2006 - 2008, Intel Corporation. <BR>
+All rights reserved. This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution.  The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
 
-Module Name:
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
-    DebugSupport.c
-
-Abstract:
-
-    Top level C file for debug support driver.  Contains initialization function.
-
-Revision History
-
---*/
+**/
 
 //
 // private header files
 //
-#include "plDebugSupport.h"
+#include "PlDebugSupport.h"
 
 //
 // This is a global that is the actual interface
@@ -37,31 +28,26 @@ EFI_DEBUG_SUPPORT_PROTOCOL  gDebugSupportProtocolInterface = {
   InvalidateInstructionCache
 };
 
-//
-// Driver Entry Point
-//
+
+/**
+  Debug Port Driver entry point. 
+
+  Checks to see there's not already a DebugSupport protocol installed for 
+  the selected processor before installing protocol.
+
+  @param[in] ImageHandle       The firmware allocated handle for the EFI image.  
+  @param[in] SystemTable       A pointer to the EFI System Table.
+  
+  @retval EFI_SUCCESS          The entry point is executed successfully.
+  @retval EFI_ALREADY_STARTED  DebugSupport protocol is installed already.
+  @retval other                Some error occurs when executing this entry point.
+
+**/
 EFI_STATUS
 InitializeDebugSupportDriver (
   IN EFI_HANDLE               ImageHandle,
   IN EFI_SYSTEM_TABLE         *SystemTable
   )
-/*++
-
-Routine Description:
-  Driver entry point.  Checks to see there's not already a DebugSupport protocol
-  installed for the selected processor before installing protocol.
-
-Arguments:
-  IN EFI_HANDLE               ImageHandle,
-  IN EFI_SYSTEM_TABLE         *SystemTable
-
-Returns:
-
-  EFI_STATUS
-
---*/
-// TODO:    ImageHandle - add argument and description to function comment
-// TODO:    SystemTable - add argument and description to function comment
 {
   EFI_LOADED_IMAGE_PROTOCOL   *LoadedImageProtocolPtr;
   EFI_STATUS                  Status;
@@ -120,12 +106,12 @@ Returns:
     goto ErrExit;
   }
 
-  LoadedImageProtocolPtr->Unload = plUnloadDebugSupportDriver;
+  LoadedImageProtocolPtr->Unload = PlUnloadDebugSupportDriver;
 
   //
   // Call hook for platform specific initialization
   //
-  Status = plInitializeDebugSupportDriver ();
+  Status = PlInitializeDebugSupportDriver ();
   ASSERT (!EFI_ERROR (Status));
   if (Status != EFI_SUCCESS) {
     goto ErrExit;