1) Fix build issues

2) Change ARCHITECTURAL_PROTOCOL_ENTRY name to EFI_CORE_PROTOCOL_NOTIFY_ENTRY so it can be used for both Architectural Protocols and optional protocols that the DXE Core may use.  Also remove BOOLEAN ArchitecturalProtocol field, so it is back to its original form.
3) Put mArchProtocols[] back to its original form, but add a NULL entry at the end so the end of the table can be easily detected in loops
4) Add mOptionalProtocols[] that at this time only has the SMM Base 2 Protocol in it.
5) Add NULL entry to mMissingProtocols[] so the end of the table can be easily detected.
6) Update all loops on mArchProtocols[], mOptionalProtocols, and mMissingProtocols[] to remove Index(s) and simply looks for a NULL ProtocolGuid to find the end of the table.
7) Update protocol notify events to pass the associated EFI_CORE_PROTOCOL_NOTIFY_ENTRY * as the Context parameter.   This simplifies GenericProtocolNotify() by completely eliminating the search loop.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10016 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 128 insertions, 111 deletions

diff --git a/MdeModulePkg/Core/Dxe/DxeMain.h b/MdeModulePkg/Core/Dxe/DxeMain.h
index 6a005be8d1..da56c88fd7 100644
--- a/MdeModulePkg/Core/Dxe/DxeMain.h
+++ b/MdeModulePkg/Core/Dxe/DxeMain.h
@@ -117,8 +117,7 @@ typedef struct {
   EFI_EVENT                   Event;

   VOID                        *Registration;

   BOOLEAN                     Present;

-  BOOLEAN                     ArchitecturalProtocol;

-} ARCHITECTURAL_PROTOCOL_ENTRY;

+} EFI_CORE_PROTOCOL_NOTIFY_ENTRY;

 

 //

 // DXE Dispatcher Data structures

@@ -348,7 +347,7 @@ CoreInitializeImageServices (
 

 **/

 VOID

-CoreNotifyOnArchProtocolInstallation (

+CoreNotifyOnProtocolInstallation (

   VOID

   );

 

diff --git a/MdeModulePkg/Core/Dxe/DxeMain/DxeMain.c b/MdeModulePkg/Core/Dxe/DxeMain/DxeMain.c
index 0b49e7f6d0..bb94654690 100644
--- a/MdeModulePkg/Core/Dxe/DxeMain/DxeMain.c
+++ b/MdeModulePkg/Core/Dxe/DxeMain/DxeMain.c
@@ -378,8 +378,9 @@ DxeMain (
   //

   // Register for the GUIDs of the Architectural Protocols, so the rest of the

   // EFI Boot Services and EFI Runtime Services tables can be filled in.

+  // Also register for the GUIDs of optional protocols.

   //

-  CoreNotifyOnArchProtocolInstallation ();

+  CoreNotifyOnProtocolInstallation ();

 

   //

   // Produce Firmware Volume Protocols, one for each FV in the HOB list.

diff --git a/MdeModulePkg/Core/Dxe/DxeMain/DxeProtocolNotify.c b/MdeModulePkg/Core/Dxe/DxeMain/DxeProtocolNotify.c
index 96338adec8..c140d9fc30 100644
--- a/MdeModulePkg/Core/Dxe/DxeMain/DxeProtocolNotify.c
+++ b/MdeModulePkg/Core/Dxe/DxeMain/DxeProtocolNotify.c
@@ -16,7 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 #include "DxeMain.h"

 

-

 //

 // DXE Core Global Variables for all of the Architectural Protocols.

 // If a protocol is installed mArchProtocols[].Present will be TRUE.

@@ -25,30 +24,37 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 // and mArchProtocols[].Registration as it creates events for every array

 // entry.

 //

+EFI_CORE_PROTOCOL_NOTIFY_ENTRY  mArchProtocols[] = {

+  { &gEfiSecurityArchProtocolGuid,         (VOID **)&gSecurity,      NULL, NULL, FALSE },

+  { &gEfiCpuArchProtocolGuid,              (VOID **)&gCpu,           NULL, NULL, FALSE },

+  { &gEfiMetronomeArchProtocolGuid,        (VOID **)&gMetronome,     NULL, NULL, FALSE },

+  { &gEfiTimerArchProtocolGuid,            (VOID **)&gTimer,         NULL, NULL, FALSE },

+  { &gEfiBdsArchProtocolGuid,              (VOID **)&gBds,           NULL, NULL, FALSE },

+  { &gEfiWatchdogTimerArchProtocolGuid,    (VOID **)&gWatchdogTimer, NULL, NULL, FALSE },

+  { &gEfiRuntimeArchProtocolGuid,          (VOID **)&gRuntime,       NULL, NULL, FALSE },

+  { &gEfiVariableArchProtocolGuid,         (VOID **)NULL,            NULL, NULL, FALSE },

+  { &gEfiVariableWriteArchProtocolGuid,    (VOID **)NULL,            NULL, NULL, FALSE },

+  { &gEfiCapsuleArchProtocolGuid,          (VOID **)NULL,            NULL, NULL, FALSE },

+  { &gEfiMonotonicCounterArchProtocolGuid, (VOID **)NULL,            NULL, NULL, FALSE },

+  { &gEfiResetArchProtocolGuid,            (VOID **)NULL,            NULL, NULL, FALSE },

+  { &gEfiRealTimeClockArchProtocolGuid,    (VOID **)NULL,            NULL, NULL, FALSE },

+  { NULL,                                  (VOID **)NULL,            NULL, NULL, FALSE }

+};

 

-ARCHITECTURAL_PROTOCOL_ENTRY  mArchProtocols[] = {

-  { &gEfiSecurityArchProtocolGuid,         (VOID **)&gSecurity,      NULL, NULL, FALSE, TRUE  },

-  { &gEfiCpuArchProtocolGuid,              (VOID **)&gCpu,           NULL, NULL, FALSE, TRUE  },

-  { &gEfiMetronomeArchProtocolGuid,        (VOID **)&gMetronome,     NULL, NULL, FALSE, TRUE  },

-  { &gEfiTimerArchProtocolGuid,            (VOID **)&gTimer,         NULL, NULL, FALSE, TRUE  },

-  { &gEfiBdsArchProtocolGuid,              (VOID **)&gBds,           NULL, NULL, FALSE, TRUE  },

-  { &gEfiWatchdogTimerArchProtocolGuid,    (VOID **)&gWatchdogTimer, NULL, NULL, FALSE, TRUE  },

-  { &gEfiRuntimeArchProtocolGuid,          (VOID **)&gRuntime,       NULL, NULL, FALSE, TRUE  },

-  { &gEfiVariableArchProtocolGuid,         (VOID **)NULL,            NULL, NULL, FALSE, TRUE  },

-  { &gEfiVariableWriteArchProtocolGuid,    (VOID **)NULL,            NULL, NULL, FALSE, TRUE  },

-  { &gEfiCapsuleArchProtocolGuid,          (VOID **)NULL,            NULL, NULL, FALSE, TRUE  },

-  { &gEfiMonotonicCounterArchProtocolGuid, (VOID **)NULL,            NULL, NULL, FALSE, TRUE  },

-  { &gEfiResetArchProtocolGuid,            (VOID **)NULL,            NULL, NULL, FALSE, TRUE  },

-  { &gEfiRealTimeClockArchProtocolGuid,    (VOID **)NULL,            NULL, NULL, FALSE, TRUE  },

-  { &gEfiSmmBase2ProtocolGuid,             (VOID **)&gSmmBase2,      NULL, NULL, FALSE, FALSE }

+//

+// Optional protocols that the DXE Core will use if they are present

+//

+EFI_CORE_PROTOCOL_NOTIFY_ENTRY  mOptionalProtocols[] = {

+  { &gEfiSmmBase2ProtocolGuid,             (VOID **)&gSmmBase2,      NULL, NULL, FALSE },

+  { NULL,                                  (VOID **)NULL,            NULL, NULL, FALSE }

 };

 

 //

 // Following is needed to display missing architectural protocols in debug builds

 //

 typedef struct {

-  EFI_GUID                     *ProtocolGuid;

-  CHAR8                        *GuidString;

+  EFI_GUID  *ProtocolGuid;

+  CHAR8     *GuidString;

 } GUID_TO_STRING_PROTOCOL_ENTRY;

 

 GLOBAL_REMOVE_IF_UNREFERENCED CONST GUID_TO_STRING_PROTOCOL_ENTRY mMissingProtocols[] = {

@@ -64,7 +70,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST GUID_TO_STRING_PROTOCOL_ENTRY mMissingProtoc
   { &gEfiCapsuleArchProtocolGuid,          "Capsule"            },

   { &gEfiMonotonicCounterArchProtocolGuid, "Monotonic Counter"  },

   { &gEfiResetArchProtocolGuid,            "Reset"              },

-  { &gEfiRealTimeClockArchProtocolGuid,    "Real Time Clock"    }

+  { &gEfiRealTimeClockArchProtocolGuid,    "Real Time Clock"    },

+  { NULL,                                  ""                   }

 };

 

 /**

@@ -79,14 +86,13 @@ CoreAllEfiServicesAvailable (
   VOID

   )

 {

-  UINTN        Index;

+  EFI_CORE_PROTOCOL_NOTIFY_ENTRY  *Entry;

 

-  for (Index = 0; Index < sizeof (mArchProtocols) / sizeof (mArchProtocols[0]); Index++) {

-    if (mArchProtocols[Index].ArchitecturalProtocol && !mArchProtocols[Index].Present) {

+  for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {

+    if (!Entry->Present) {

       return EFI_NOT_FOUND;

     }

   }

-

   return EFI_SUCCESS;

 }

 

@@ -104,119 +110,119 @@ CoreAllEfiServicesAvailable (
 **/

 VOID

 EFIAPI

-GenericArchProtocolNotify (

-  IN  EFI_EVENT       Event,

-  IN  VOID            *Context

+GenericProtocolNotify (

+  IN  EFI_EVENT  Event,

+  IN  VOID       *Context

   )

 {

   EFI_STATUS                      Status;

-  ARCHITECTURAL_PROTOCOL_ENTRY    *Entry;

+  EFI_CORE_PROTOCOL_NOTIFY_ENTRY  *Entry;

   VOID                            *Protocol;

-  BOOLEAN                         Found;

   LIST_ENTRY                      *Link;

   LIST_ENTRY                      TempLinkNode;

-  UINTN                           Index;

 

-  Found = FALSE;

-  for (Index = 0; Index < sizeof (mArchProtocols) / sizeof (mArchProtocols[0]); Index++) {

-    Entry = &mArchProtocols[Index];

+  //

+  // Get Entry from Context

+  //

+  Entry = (EFI_CORE_PROTOCOL_NOTIFY_ENTRY *)Context;

 

-    Status = CoreLocateProtocol (Entry->ProtocolGuid, Entry->Registration, &Protocol);

-    if (EFI_ERROR (Status)) {

-      continue;

-    }

+  //

+  // See if the expected protocol is present in the handle database

+  //

+  Status = CoreLocateProtocol (Entry->ProtocolGuid, Entry->Registration, &Protocol);

+  if (EFI_ERROR (Status)) {

+    return;

+  }

 

-    Found = TRUE;

-    Entry->Present = TRUE;

+  //

+  // Mark the protocol as present

+  //

+  Entry->Present = TRUE;

 

+  //

+  // Update protocol global variable if one exists. Entry->Protocol points to a global variable

+  // if one exists in the DXE core for this Architectural Protocol

+  //

+  if (Entry->Protocol != NULL) {

+    *(Entry->Protocol) = Protocol;

+  }

+

+  //

+  // Do special operations for Architectural Protocols

+  //

+

+  if (CompareGuid (Entry->ProtocolGuid, &gEfiTimerArchProtocolGuid)) {

     //

-    // Update protocol global variable if one exists. Entry->Protocol points to a global variable

-    // if one exists in the DXE core for this Architectural Protocol

+    // Register the Core timer tick handler with the Timer AP

     //

-    if (Entry->Protocol != NULL) {

-      *(Entry->Protocol) = Protocol;

-    }

+    gTimer->RegisterHandler (gTimer, CoreTimerTick);

+  }

 

-    if (CompareGuid (Entry->ProtocolGuid, &gEfiTimerArchProtocolGuid)) {

-      //

-      // Register the Core timer tick handler with the Timer AP

-      //

-      gTimer->RegisterHandler (gTimer, CoreTimerTick);

-    }

+  if (CompareGuid (Entry->ProtocolGuid, &gEfiRuntimeArchProtocolGuid)) {

+    //

+    // When runtime architectural protocol is available, updates CRC32 in the Debug Table

+    //

+    CoreUpdateDebugTableCrc32 ();

 

-    if (CompareGuid (Entry->ProtocolGuid, &gEfiRuntimeArchProtocolGuid)) {

-      //

-      // When runtime architectural protocol is available, updates CRC32 in the Debug Table

-      //

-      CoreUpdateDebugTableCrc32 ();

-

-      //

-      // Update the Runtime Architectural protocol with the template that the core was

-      // using so there would not need to be a dependency on the Runtime AP

-      //

-

-      //

-      // Copy all the registered Image to new gRuntime protocol

-      //

-      for (Link = gRuntimeTemplate.ImageHead.ForwardLink; Link != &gRuntimeTemplate.ImageHead; Link = TempLinkNode.ForwardLink) {

-        CopyMem (&TempLinkNode, Link, sizeof(LIST_ENTRY));

-        InsertTailList (&gRuntime->ImageHead, Link);

-      }

-      //

-      // Copy all the registered Event to new gRuntime protocol

-      //

-      for (Link = gRuntimeTemplate.EventHead.ForwardLink; Link != &gRuntimeTemplate.EventHead; Link = TempLinkNode.ForwardLink) {

-        CopyMem (&TempLinkNode, Link, sizeof(LIST_ENTRY));

-        InsertTailList (&gRuntime->EventHead, Link);

-      }

+    //

+    // Update the Runtime Architectural protocol with the template that the core was

+    // using so there would not need to be a dependency on the Runtime AP

+    //

 

-      //

-      // Clean up gRuntimeTemplate

-      //

-      gRuntimeTemplate.ImageHead.ForwardLink = &gRuntimeTemplate.ImageHead;

-      gRuntimeTemplate.ImageHead.BackLink    = &gRuntimeTemplate.ImageHead;

-      gRuntimeTemplate.EventHead.ForwardLink = &gRuntimeTemplate.EventHead;

-      gRuntimeTemplate.EventHead.BackLink    = &gRuntimeTemplate.EventHead;

+    //

+    // Copy all the registered Image to new gRuntime protocol

+    //

+    for (Link = gRuntimeTemplate.ImageHead.ForwardLink; Link != &gRuntimeTemplate.ImageHead; Link = TempLinkNode.ForwardLink) {

+      CopyMem (&TempLinkNode, Link, sizeof(LIST_ENTRY));

+      InsertTailList (&gRuntime->ImageHead, Link);

+    }

+    //

+    // Copy all the registered Event to new gRuntime protocol

+    //

+    for (Link = gRuntimeTemplate.EventHead.ForwardLink; Link != &gRuntimeTemplate.EventHead; Link = TempLinkNode.ForwardLink) {

+      CopyMem (&TempLinkNode, Link, sizeof(LIST_ENTRY));

+      InsertTailList (&gRuntime->EventHead, Link);

     }

+

+    //

+    // Clean up gRuntimeTemplate

+    //

+    gRuntimeTemplate.ImageHead.ForwardLink = &gRuntimeTemplate.ImageHead;

+    gRuntimeTemplate.ImageHead.BackLink    = &gRuntimeTemplate.ImageHead;

+    gRuntimeTemplate.EventHead.ForwardLink = &gRuntimeTemplate.EventHead;

+    gRuntimeTemplate.EventHead.BackLink    = &gRuntimeTemplate.EventHead;

   }

 

   //

   // It's over kill to do them all every time, but it saves a lot of code.

   //

-  if (Found) {

-    CalculateEfiHdrCrc (&gDxeCoreRT->Hdr);

-    CalculateEfiHdrCrc (&gBS->Hdr);

-    CalculateEfiHdrCrc (&gDxeCoreST->Hdr);

-    CalculateEfiHdrCrc (&gDxeCoreDS->Hdr);

-  }

+  CalculateEfiHdrCrc (&gDxeCoreRT->Hdr);

+  CalculateEfiHdrCrc (&gBS->Hdr);

+  CalculateEfiHdrCrc (&gDxeCoreST->Hdr);

+  CalculateEfiHdrCrc (&gDxeCoreDS->Hdr);

 }

 

-

-

 /**

-  Creates an event that is fired everytime a Protocol of a specific type is installed.

+  Creates an event for each entry in a table that is fired everytime a Protocol 

+  of a specific type is installed.

 

 **/

 VOID

-CoreNotifyOnArchProtocolInstallation (

-  VOID

+CoreNotifyOnProtocolEntryTable (

+  EFI_CORE_PROTOCOL_NOTIFY_ENTRY  *Entry

   )

 {

-  EFI_STATUS                      Status;

-  ARCHITECTURAL_PROTOCOL_ENTRY    *Entry;

-  UINTN                           Index;

-

-  for (Index = 0; Index < sizeof (mArchProtocols) / sizeof (mArchProtocols[0]); Index++) {

-    Entry = &mArchProtocols[Index];

+  EFI_STATUS  Status;

 

+  for (; Entry->ProtocolGuid != NULL; Entry++) {

     //

     // Create the event

     //

     Status = CoreCreateEvent (

               EVT_NOTIFY_SIGNAL,

               TPL_CALLBACK,

-              GenericArchProtocolNotify,

-              NULL,

+              GenericProtocolNotify,

+              Entry,

               &Entry->Event

               );

     ASSERT_EFI_ERROR(Status);

@@ -230,10 +236,23 @@ CoreNotifyOnArchProtocolInstallation (
               &Entry->Registration

               );

     ASSERT_EFI_ERROR(Status);

-

   }

 }

 

+/**

+  Creates an events for the Architectural Protocols and the optional protocols 

+  that are fired everytime a Protocol of a specific type is installed.

+

+**/

+VOID

+CoreNotifyOnProtocolInstallation (

+  VOID

+  )

+{

+  CoreNotifyOnProtocolEntryTable (mArchProtocols);

+  CoreNotifyOnProtocolEntryTable (mOptionalProtocols);

+}

+

 

 /**

   Displays Architectural protocols that were not loaded and are required for DXE

@@ -245,14 +264,12 @@ CoreDisplayMissingArchProtocols (
   VOID

   )

 {

+  EFI_CORE_PROTOCOL_NOTIFY_ENTRY       *Entry;

   CONST GUID_TO_STRING_PROTOCOL_ENTRY  *MissingEntry;

-  ARCHITECTURAL_PROTOCOL_ENTRY         *Entry;

-  UINTN                                Index;

 

-  for (Index = 0; Index < sizeof (mArchProtocols) / sizeof (mArchProtocols[0]); Index++) {

-    Entry = &mArchProtocols[Index];

-    if (!Entry->Present && Entry->ArchitecturalProtocol) {

-      for (MissingEntry = mMissingProtocols; MissingEntry < sizeof (mMissingProtocols)/sizeof (mMissingProtocols[0]) ; MissingEntry++) {

+  for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {

+    if (!Entry->Present) {

+      for (MissingEntry = mMissingProtocols; MissingEntry->ProtocolGuid != NULL; MissingEntry++) {

         if (CompareGuid (Entry->ProtocolGuid, MissingEntry->ProtocolGuid)) {

           DEBUG ((DEBUG_ERROR, "\n%a Arch Protocol not present!!\n", MissingEntry->GuidString));

           break;