Update to fix minor coding style issues.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / DxeMain / DxeProtocolNotify.c

diff --git a/MdeModulePkg/Core/Dxe/DxeMain/DxeProtocolNotify.c b/MdeModulePkg/Core/Dxe/DxeMain/DxeProtocolNotify.c
index a3d4bbaaacee862c678076bb6426aa962186418b..e815df718d1748e6230c2d092c0626b6d87365c3 100644 (file)
--- a/MdeModulePkg/Core/Dxe/DxeMain/DxeProtocolNotify.c
+++ b/MdeModulePkg/Core/Dxe/DxeMain/DxeProtocolNotify.c
@@ -1,10 +1,9 @@
-/** @file \r
-\r
+/** @file\r
   This file deals with Architecture Protocol (AP) registration in\r
   the Dxe Core. The mArchProtocols[] array represents a list of\r
   events that represent the Architectural Protocols.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation. <BR>\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
@@ -45,23 +44,19 @@ ARCHITECTURAL_PROTOCOL_ENTRY  mArchProtocols[] = {
 };\r
 \r
 \r
-EFI_STATUS\r
-CoreAllEfiServicesAvailable (\r
-  VOID\r
-  )\r
-/*++\r
 \r
-Routine Description:\r
+/**\r
   Return TRUE if all AP services are availible.\r
 \r
-Arguments:\r
-  NONE\r
 \r
-Returns:\r
-  EFI_SUCCESS   - All AP services are available\r
-  EFI_NOT_FOUND - At least one AP service is not available\r
+  @retval EFI_SUCCESS    All AP services are available \r
+  @retval EFI_NOT_FOUND  At least one AP service is not available\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+CoreAllEfiServicesAvailable (\r
+  VOID\r
+  )\r
 {\r
   ARCHITECTURAL_PROTOCOL_ENTRY  *Entry;\r
 \r
@@ -74,33 +69,24 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-STATIC\r
-VOID\r
-EFIAPI\r
-GenericArchProtocolNotify (\r
-  IN   EFI_EVENT       Event,\r
-  IN   VOID            *Context\r
-  )\r
-/*++\r
 \r
-Routine Description:\r
+/**\r
   Notification event handler registered by CoreNotifyOnArchProtocolInstallation ().\r
   This notify function is registered for every architectural protocol. This handler\r
   updates mArchProtocol[] array entry with protocol instance data and sets it's\r
   present flag to TRUE. If any constructor is required it is executed. The EFI\r
   System Table headers are updated.\r
 \r
-Arguments:\r
-\r
-  Event   - The Event that is being processed, not used.\r
+  @param  Event          The Event that is being processed, not used. \r
+  @param  Context        Event Context, not used.\r
 \r
-  Context - Event Context, not used.\r
-\r
-Returns:\r
-\r
-  None\r
-\r
---*/\r
+**/\r
+VOID\r
+EFIAPI\r
+GenericArchProtocolNotify (\r
+  IN  EFI_EVENT       Event,\r
+  IN  VOID            *Context\r
+  )\r
 {\r
   EFI_STATUS                      Status;\r
   ARCHITECTURAL_PROTOCOL_ENTRY    *Entry;\r
@@ -184,22 +170,15 @@ Returns:
 \r
 \r
 \r
+\r
+/**\r
+  Creates an event that is fired everytime a Protocol of a specific type is installed.\r
+\r
+**/\r
 VOID\r
 CoreNotifyOnArchProtocolInstallation (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Creates an event that is fired everytime a Protocol of a specific type is installed\r
-\r
-Arguments:\r
-  NONE\r
-\r
-Returns:\r
-  NONE\r
-\r
---*/\r
 {\r
   EFI_STATUS                      Status;\r
   ARCHITECTURAL_PROTOCOL_ENTRY    *Entry;\r
@@ -239,7 +218,7 @@ typedef struct {
   CHAR16                       *GuidString;\r
 } GUID_TO_STRING_PROTOCOL_ENTRY;\r
 \r
-static const GUID_TO_STRING_PROTOCOL_ENTRY MissingProtocols[] = {\r
+STATIC CONST GUID_TO_STRING_PROTOCOL_ENTRY MissingProtocols[] = {\r
   { &gEfiSecurityArchProtocolGuid,         (CHAR16 *)L"Security"           },\r
   { &gEfiCpuArchProtocolGuid,              (CHAR16 *)L"CPU"                },\r
   { &gEfiMetronomeArchProtocolGuid,        (CHAR16 *)L"Metronome"          },\r
@@ -256,23 +235,16 @@ static const GUID_TO_STRING_PROTOCOL_ENTRY MissingProtocols[] = {
   { &gEfiRealTimeClockArchProtocolGuid,    (CHAR16 *)L"Real Time Clock"    }\r
 };\r
 \r
+\r
+/**\r
+  Displays Architectural protocols that were not loaded and are required for DXE\r
+  core to function.  Only used in Debug Builds.\r
+\r
+**/\r
 VOID\r
 CoreDisplayMissingArchProtocols (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Displays Architectural protocols that were not loaded and are required for DXE core to function\r
-  Only used in Debug Builds\r
-\r
-Arguments:\r
-  NONE\r
-\r
-Returns:\r
-  NONE\r
-\r
---*/\r
 {\r
   const GUID_TO_STRING_PROTOCOL_ENTRY  *MissingEntry;\r
   ARCHITECTURAL_PROTOCOL_ENTRY         *Entry;\r
@@ -282,7 +254,7 @@ Returns:
       MissingEntry = MissingProtocols;\r
       for (MissingEntry = MissingProtocols; TRUE ; MissingEntry++) {\r
         if (CompareGuid (Entry->ProtocolGuid, MissingEntry->ProtocolGuid)) {\r
-          DEBUG ((EFI_D_ERROR, "\n%s Arch Protocol not present!!\n", MissingEntry->GuidString));\r
+          DEBUG ((DEBUG_ERROR, "\n%s Arch Protocol not present!!\n", MissingEntry->GuidString));\r
           break;\r
         }\r
       }\r