]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/PiSmmCore/PiSmmCorePrivateData.h
MdeModulePkg: Clean up source files
[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / PiSmmCorePrivateData.h
index 8aec7a6568facc26f12ad7b99867a4b1835df66e..2bf9abe4cc916694109b609cc440614b3fd4107a 100644 (file)
@@ -2,14 +2,14 @@
   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 - 2015, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2009 - 2018, 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
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  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
+  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
 **/\r
 \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
+/// 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
+/// 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
 #define SMM_CORE_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('s', 'm', 'm', 'c')\r
 \r
 ///\r
-/// Private structure that is used to share information between the SMM IPL and \r
+/// Private structure that is used to share information between the SMM IPL and\r
 /// the SMM Core.  This structure is allocated from memory of type EfiRuntimeServicesData.\r
-/// Since runtime memory types are converted to available memory when a legacy boot \r
-/// is performed, the SMM Core must not access any fields of this structure if a legacy \r
-/// boot is performed.  As a result, the SMM IPL must create an event notification \r
-/// for the Legacy Boot event and notify the SMM Core that a legacy boot is being \r
-/// performed.  The SMM Core can then use this information to filter accesses to \r
+/// Since runtime memory types are converted to available memory when a legacy boot\r
+/// is performed, the SMM Core must not access any fields of this structure if a legacy\r
+/// boot is performed.  As a result, the SMM IPL must create an event notification\r
+/// for the Legacy Boot event and notify the SMM Core that a legacy boot is being\r
+/// performed.  The SMM Core can then use this information to filter accesses to\r
 /// thos structure.\r
 ///\r
 typedef struct {\r
@@ -70,43 +70,43 @@ typedef struct {
   EFI_SMRAM_DESCRIPTOR            *SmramRanges;\r
 \r
   ///\r
-  /// The SMM Foundation Entry Point.  The SMM Core fills in this field when the \r
-  /// SMM Core is initialized.  The SMM IPL is responsbile for registering this entry \r
-  /// point with the SMM Configuration Protocol.  The SMM Configuration Protocol may \r
+  /// The SMM Foundation Entry Point.  The SMM Core fills in this field when the\r
+  /// SMM Core is initialized.  The SMM IPL is responsbile for registering this entry\r
+  /// point with the SMM Configuration Protocol.  The SMM Configuration Protocol may\r
   /// not be available at the time the SMM IPL and SMM Core are started, so the SMM IPL\r
-  /// sets up a protocol notification on the SMM Configuration Protocol and registers \r
-  /// the SMM Foundation Entry Point as soon as the SMM Configuration Protocol is \r
+  /// sets up a protocol notification on the SMM Configuration Protocol and registers\r
+  /// the SMM Foundation Entry Point as soon as the SMM Configuration Protocol is\r
   /// available.\r
   ///\r
   EFI_SMM_ENTRY_POINT             SmmEntryPoint;\r
-  \r
+\r
   ///\r
   /// Boolean flag set to TRUE while an SMI is being processed by the SMM Core.\r
-  /// \r
+  ///\r
   BOOLEAN                         SmmEntryPointRegistered;\r
 \r
   ///\r
   /// Boolean flag set to TRUE while an SMI is being processed by the SMM Core.\r
-  /// \r
+  ///\r
   BOOLEAN                         InSmm;\r
 \r
   ///\r
   /// This field is set by the SMM Core then the SMM Core is initialized.  This field is\r
   /// used by the SMM Base 2 Protocol and SMM Communication Protocol implementations in\r
-  /// the SMM IPL.  \r
+  /// the SMM IPL.\r
   ///\r
   EFI_SMM_SYSTEM_TABLE2           *Smst;\r
 \r
   ///\r
-  /// This field is used by the SMM Communicatioon Protocol to pass a buffer into \r
+  /// This field is used by the SMM Communicatioon Protocol to pass a buffer into\r
   /// a software SMI handler and for the software SMI handler to pass a buffer back to\r
-  /// the caller of the SMM Communication Protocol.  \r
+  /// the caller of the SMM Communication Protocol.\r
   ///\r
   VOID                            *CommunicationBuffer;\r
 \r
   ///\r
   /// This field is used by the SMM Communicatioon Protocol to pass the size of a buffer,\r
-  /// in bytes, into a software SMI handler and for the software SMI handler to pass the \r
+  /// in bytes, into a software SMI handler and for the software SMI handler to pass the\r
   /// size, in bytes, of a buffer back to the caller of the SMM Communication Protocol.\r
   ///\r
   UINTN                           BufferSize;\r