Update SMM Core to use SMM Mode as soon as SMM Mode is available

[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / PiSmmCorePrivateData.h

diff --git a/MdeModulePkg/Core/PiSmmCore/PiSmmCorePrivateData.h b/MdeModulePkg/Core/PiSmmCore/PiSmmCorePrivateData.h
index bfacfbb6bd2108d1b24fe1abe894d3c8c9881022..411ebd823f2f5f1897faf287847c2ff479b8a1d6 100644 (file)
--- a/MdeModulePkg/Core/PiSmmCore/PiSmmCorePrivateData.h
+++ b/MdeModulePkg/Core/PiSmmCore/PiSmmCorePrivateData.h
@@ -2,7 +2,7 @@
   The internal header file that declared a data structure that is shared\r
   between the SMM IPL and the SMM Core.\r
 \r
-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials are licensed and made available \r
   under the terms and conditions of the BSD License which accompanies this \r
   distribution.  The full text of the license may be found at        \r
@@ -16,6 +16,22 @@
 #ifndef _PI_SMM_CORE_PRIVATE_DATA_H_\r
 #define _PI_SMM_CORE_PRIVATE_DATA_H_\r
 \r
+///\r
+/// Define values for the communications buffer used when gEfiEventDxeDispatchGuid is\r
+/// event signaled.  This event is signaled by the DXE Core each time the DXE Core \r
+/// dispatcher has completed its work.  When this event is signaled, the SMM Core\r
+/// if notified, so the SMM Core can dispatch SMM drivers.  If COMM_BUFFER_SMM_DISPATCH_ERROR\r
+/// is returned in the communication buffer, then an error occurred dispatching SMM\r
+/// Drivers.  If COMM_BUFFER_SMM_DISPATCH_SUCCESS is returned, then the SMM Core \r
+/// dispatched all the drivers it could.  If COMM_BUFFER_SMM_DISPATCH_RESTART is \r
+/// returned, then the SMM Core just dispatched the SMM Driver that registered\r
+/// the SMM Entry Point enabling the use of SMM Mode.  In this case, the SMM Core\r
+/// should be notified again to dispatch more SMM Drivers using SMM Mode.\r
+///\r
+#define COMM_BUFFER_SMM_DISPATCH_ERROR    0x00\r
+#define COMM_BUFFER_SMM_DISPATCH_SUCCESS  0x01\r
+#define COMM_BUFFER_SMM_DISPATCH_RESTART  0x02\r
+\r
 ///\r
 /// Signature for the private structure shared between the SMM IPL and the SMM Core\r
 ///\r