]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Protocol/SmmBase.h
IntelFrameworkPkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmBase.h
index 0429c574d19f740f65eb057e6057a82e4193a055..d98d527dd24bf69000da75d60dca6bb482c8270f 100644 (file)
@@ -2,7 +2,7 @@
   This file declares SMM Base abstraction protocol.\r
   This protocol is used to install SMM handlers for support of subsequent SMI/PMI activations. This\r
   protocol is available on both IA-32 and Itanium-based systems.\r
\r
+\r
   The EFI_SMM_BASE_PROTOCOL is a set of services that is exported by a processor device. It is\r
   a required protocol for the platform processor. This protocol can be used in both boot services and\r
   runtime mode. However, only the following member functions need to exist during runtime:\r
   workarounds for the century rollover in CMOS should provide commensurate services throughout\r
   preboot and OS runtime.\r
 \r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
 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
+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
 \r
   @par Revision Reference:\r
@@ -72,9 +72,9 @@ typedef struct _EFI_SMM_BASE_PROTOCOL  EFI_SMM_BASE_PROTOCOL;
   @param[in]  SmmImageHandle        A handle allocated by the SMM infrastructure code\r
                                     to uniquely designate a specific DXE SMM driver.\r
   @param[in]  CommunicationBuffer   A pointer to a collection of data in memory\r
-                                    that will be conveyed from a non-SMM environment \r
-                                    into an SMM environment. The buffer must be \r
-                                    contiguous and physically mapped, and must be \r
+                                    that will be conveyed from a non-SMM environment\r
+                                    into an SMM environment. The buffer must be\r
+                                    contiguous and physically mapped, and must be\r
                                     a physical address.\r
   @param[in]  SourceSize            The size of the CommunicationBuffer.\r
 \r
@@ -101,10 +101,10 @@ EFI_STATUS
   @param[in]   SourceBuffer          An optional source buffer in case the image file\r
                                      is in memory.\r
   @param[in]   SourceSize            The size of the source image file, if in memory.\r
-  @param[out]  ImageHandle           The handle that the base driver uses to decode \r
-                                     the handler. Unique among SMM handlers only; \r
+  @param[out]  ImageHandle           The handle that the base driver uses to decode\r
+                                     the handler. Unique among SMM handlers only;\r
                                      not unique across DXE/EFI.\r
-  @param[in]   LegacyIA32Binary      An optional parameter specifying that the associated \r
+  @param[in]   LegacyIA32Binary      An optional parameter specifying that the associated\r
                                      file is a real-mode IA-32 binary.\r
 \r
   @retval      EFI_SUCCESS           The operation was successful.\r
@@ -177,7 +177,7 @@ EFI_STATUS
   @param[in]  This                  Protocol instance pointer.\r
   @param[in]  SmmImageHandle        Handle of the callback service.\r
   @param[in]  CallbackAddress       Address of the callback service.\r
-  @param[in]  MakeLast              If present, will stipulate that the handler is posted to \r
+  @param[in]  MakeLast              If present, will stipulate that the handler is posted to\r
                                     be executed last in the dispatch table.\r
   @param[in]  FloatingPointSave     An optional parameter that informs the\r
                                     EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save\r
@@ -209,8 +209,8 @@ EFI_STATUS
   @param[in]   This                  Protocol instance pointer.\r
   @param[in]   PoolType              The type of pool to allocate.\r
                                      The only supported type is EfiRuntimeServicesData;\r
-                                     the interface will internally map this runtime request to \r
-                                     SMRAM for IA-32 and leave as this type for the Itanium \r
+                                     the interface will internally map this runtime request to\r
+                                     SMRAM for IA-32 and leave as this type for the Itanium\r
                                      processor family. Other types can be ignored.\r
   @param[in]   Size                  The number of bytes to allocate from the pool.\r
   @param[out]  Buffer                A pointer to a pointer to the allocated buffer if the call\r