Minor coding style adjustment for DxeCore.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Misc / DebugImageInfo.c

diff --git a/MdeModulePkg/Core/Dxe/Misc/DebugImageInfo.c b/MdeModulePkg/Core/Dxe/Misc/DebugImageInfo.c
index 3512477c8f83eb88e53724e060d3d8bf071651b4..afe668fe45a0b5739bbf4dfff7cf1458c95efe16 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Misc/DebugImageInfo.c
+++ b/MdeModulePkg/Core/Dxe/Misc/DebugImageInfo.c
@@ -1,6 +1,9 @@
-/*++\r
+/** @file \r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Support functions for managing debug image info table when loading and unloading\r
+  images.\r
+\r
+Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
 All rights reserved. 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
@@ -9,53 +12,36 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-Module Name:\r
-\r
-  DebugImageInfo.c\r
-    \r
-Abstract:\r
-\r
-  Support functions for managing debug image info table when loading and unloading\r
-  images.\r
-\r
---*/\r
+**/\r
 \r
 #include <DxeMain.h>\r
 \r
 \r
-static EFI_DEBUG_IMAGE_INFO_TABLE_HEADER  mDebugInfoTableHeader = {\r
+STATIC EFI_DEBUG_IMAGE_INFO_TABLE_HEADER  mDebugInfoTableHeader = {\r
   0,          // volatile UINT32                 UpdateStatus;\r
   0,          // UINT32                          TableSize;\r
   NULL        // EFI_DEBUG_IMAGE_INFO            *EfiDebugImageInfoTable;\r
 };\r
 \r
-static EFI_SYSTEM_TABLE_POINTER *mDebugTable = NULL;\r
+STATIC EFI_SYSTEM_TABLE_POINTER *mDebugTable = NULL;\r
 \r
     \r
-VOID\r
-CoreInitializeDebugImageInfoTable (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Creates and initializes the DebugImageInfo Table.  Also creates the configuration\r
   table and registers it into the system table.\r
 \r
-Arguments:\r
-  None\r
-\r
-Returns:\r
-  NA\r
+  Note:\r
+    This function allocates memory, frees it, and then allocates memory at an\r
+    address within the initial allocation. Since this function is called early\r
+    in DXE core initialization (before drivers are dispatched), this should not\r
+    be a problem.\r
 \r
-Notes:\r
-  This function allocates memory, frees it, and then allocates memory at an\r
-  address within the initial allocation. Since this function is called early\r
-  in DXE core initialization (before drivers are dispatched), this should not\r
-  be a problem.\r
-\r
---*/\r
+**/\r
+VOID\r
+CoreInitializeDebugImageInfoTable (\r
+  VOID\r
+  )\r
 { \r
   EFI_STATUS                          Status;\r
   EFI_PHYSICAL_ADDRESS                Mem;\r
@@ -103,56 +89,42 @@ Notes:
   ASSERT_EFI_ERROR (Status);\r
 }\r
 \r
-VOID\r
-CoreUpdateDebugTableCrc32 (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Update the CRC32 in the Debug Table.\r
   Since the CRC32 service is made available by the Runtime driver, we have to\r
   wait for the Runtime Driver to be installed before the CRC32 can be computed.\r
   This function is called elsewhere by the core when the runtime architectural\r
   protocol is produced.\r
 \r
-Arguments:\r
-  None\r
-\r
-Returns:\r
-  NA\r
-\r
---*/\r
+**/\r
+VOID\r
+CoreUpdateDebugTableCrc32 (\r
+  VOID\r
+  )\r
 {\r
   ASSERT(mDebugTable != NULL);\r
   mDebugTable->Crc32 = 0;\r
   gDxeCoreBS->CalculateCrc32 ((VOID *)mDebugTable, sizeof (EFI_SYSTEM_TABLE_POINTER), &mDebugTable->Crc32);\r
 }\r
 \r
+\r
+/**\r
+  Adds a new DebugImageInfo structure to the DebugImageInfo Table.  Re-Allocates\r
+  the table if it's not large enough to accomidate another entry.\r
+\r
+  @param  ImageInfoType  type of debug image information \r
+  @param  LoadedImage    pointer to the loaded image protocol for the image being \r
+                         loaded \r
+  @param  ImageHandle    image handle for the image being loaded\r
+\r
+**/\r
 VOID\r
 CoreNewDebugImageInfoEntry (\r
   IN  UINT32                      ImageInfoType,\r
   IN  EFI_LOADED_IMAGE_PROTOCOL   *LoadedImage,\r
   IN  EFI_HANDLE                  ImageHandle\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Adds a new DebugImageInfo structure to the DebugImageInfo Table.  Re-Allocates\r
-  the table if it's not large enough to accomidate another entry.\r
-\r
-Arguments:\r
-\r
-  ImageInfoType     - type of debug image information\r
-  LoadedImage       - pointer to the loaded image protocol for the image being loaded\r
-  ImageHandle       - image handle for the image being loaded\r
-\r
-Returns:\r
-  NA\r
-\r
---*/\r
 {    \r
   EFI_DEBUG_IMAGE_INFO      *Table;\r
   EFI_DEBUG_IMAGE_INFO      *NewTable;\r
@@ -217,25 +189,17 @@ Returns:
 }\r
 \r
 \r
-VOID\r
-CoreRemoveDebugImageInfoEntry (\r
-  EFI_HANDLE ImageHandle\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Removes and frees an entry from the DebugImageInfo Table.\r
 \r
-Arguments:\r
-\r
-  ImageHandle       - image handle for the image being unloaded\r
+  @param  ImageHandle    image handle for the image being unloaded\r
 \r
-Returns:\r
-\r
-  NA\r
-\r
---*/\r
+**/\r
+VOID\r
+CoreRemoveDebugImageInfoEntry (\r
+  EFI_HANDLE ImageHandle\r
+  )\r
 {    \r
   EFI_DEBUG_IMAGE_INFO  *Table;\r
   UINTN                 Index;\r
@@ -258,3 +222,4 @@ Returns:
   mDebugInfoTableHeader.UpdateStatus &= ~EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS;\r
 }\r
 \r
+\r