]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SmmSwDispatch2.h
MdePkg Base.h: Use correct style to check the defined macro
[mirror_edk2.git] / MdePkg / Include / Protocol / SmmSwDispatch2.h
index b49ef96e481ec25006e07ccbbdc7d7124d3d527f..f264bb3e430650c7f340c0f256cad5f948fb8a0c 100644 (file)
@@ -4,14 +4,8 @@
 \r
   This protocol provides the parent dispatch service for a given SMI source generator.\r
 \r
-  Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>\r
-  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
-  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
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -33,9 +27,9 @@ typedef struct {
 } EFI_SMM_SW_REGISTER_CONTEXT;\r
 \r
 ///\r
-/// The DispatchFunction will be called with Context set to the same value as was passed into \r
+/// The DispatchFunction will be called with Context set to the same value as was passed into\r
 /// this function in RegisterContext and with CommBuffer (and CommBufferSize) pointing\r
-/// to an instance of EFI_SMM_SW_CONTEXT indicating the index of the CPU which generated the \r
+/// to an instance of EFI_SMM_SW_CONTEXT indicating the index of the CPU which generated the\r
 /// software SMI.\r
 ///\r
 typedef struct {\r
@@ -58,14 +52,14 @@ typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL  EFI_SMM_SW_DISPATCH2_PROTOCOL;
 /**\r
   Register a child SMI source dispatch function for the specified software SMI.\r
 \r
-  This service registers a function (DispatchFunction) which will be called when the software \r
-  SMI source specified by RegisterContext->SwSmiCpuIndex is detected. On return, \r
-  DispatchHandle contains a unique handle which may be used later to unregister the function \r
+  This service registers a function (DispatchFunction) which will be called when the software\r
+  SMI source specified by RegisterContext->SwSmiCpuIndex is detected. On return,\r
+  DispatchHandle contains a unique handle which may be used later to unregister the function\r
   using UnRegister().\r
 \r
   @param[in]  This                 Pointer to the EFI_SMM_SW_DISPATCH2_PROTOCOL instance.\r
-  @param[in]  DispatchFunction     Function to register for handler when the specified software \r
-                                   SMI is generated. \r
+  @param[in]  DispatchFunction     Function to register for handler when the specified software\r
+                                   SMI is generated.\r
   @param[in, out] RegisterContext  Pointer to the dispatch function's context.\r
                                    The caller fills this context in before calling\r
                                    the register function to indicate to the register\r
@@ -96,7 +90,7 @@ EFI_STATUS
 /**\r
   Unregister a child SMI source dispatch function for the specified software SMI.\r
 \r
-  This service removes the handler associated with DispatchHandle so that it will no longer be \r
+  This service removes the handler associated with DispatchHandle so that it will no longer be\r
   called in response to a software SMI.\r
 \r
   @param[in] This                Pointer to the EFI_SMM_SW_DISPATCH2_PROTOCOL instance.\r
@@ -115,15 +109,15 @@ EFI_STATUS
 ///\r
 /// Interface structure for the SMM Software SMI Dispatch Protocol.\r
 ///\r
-/// The EFI_SMM_SW_DISPATCH2_PROTOCOL provides the ability to install child handlers for the \r
-/// given software.  These handlers will respond to software interrupts, and the maximum software \r
+/// The EFI_SMM_SW_DISPATCH2_PROTOCOL provides the ability to install child handlers for the\r
+/// given software.  These handlers will respond to software interrupts, and the maximum software\r
 /// interrupt in the EFI_SMM_SW_REGISTER_CONTEXT is denoted by MaximumSwiValue.\r
 ///\r
 struct _EFI_SMM_SW_DISPATCH2_PROTOCOL {\r
   EFI_SMM_SW_REGISTER2    Register;\r
   EFI_SMM_SW_UNREGISTER2  UnRegister;\r
   ///\r
-  /// A read-only field that describes the maximum value that can be used in the \r
+  /// A read-only field that describes the maximum value that can be used in the\r
   /// EFI_SMM_SW_DISPATCH2_PROTOCOL.Register() service.\r
   ///\r
   UINTN                  MaximumSwiValue;\r