MdePkg: introduce MM communicate 2 protocol

[mirror_edk2.git] / MdePkg / Include / Protocol / GuidedSectionExtraction.h

diff --git a/MdePkg/Include/Protocol/GuidedSectionExtraction.h b/MdePkg/Include/Protocol/GuidedSectionExtraction.h
index 55692e8080a76f154b3af4f02f7d3b2577fac54e..5f55b0bccb23c37c1ab62bc719613453d73584a9 100644 (file)
--- a/MdePkg/Include/Protocol/GuidedSectionExtraction.h
+++ b/MdePkg/Include/Protocol/GuidedSectionExtraction.h
@@ -4,14 +4,8 @@
   instance of the GUIDed Section Extraction Protocol to extract\r
   the section stream contained therein.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
-  All rights reserved. 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) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference: PI\r
   Version 1.00.\r
@@ -22,14 +16,14 @@
 #define __GUID_SECTION_EXTRACTION_PROTOCOL_H__\r
 \r
 //\r
-// The protocol interface structures are identified by associating \r
-// them with a GUID. Each instance of a protocol with a given \r
-// GUID must have the same interface structure. While all instances \r
-// of the GUIDed Section Extraction Protocol must have the same \r
-// interface structure, they do not all have the same GUID. The \r
-// GUID that is associated with an instance of the GUIDed Section \r
-// Extraction Protocol is used to correlate it with the GUIDed \r
-// section type that it is intended to process. \r
+// The protocol interface structures are identified by associating\r
+// them with a GUID. Each instance of a protocol with a given\r
+// GUID must have the same interface structure. While all instances\r
+// of the GUIDed Section Extraction Protocol must have the same\r
+// interface structure, they do not all have the same GUID. The\r
+// GUID that is associated with an instance of the GUIDed Section\r
+// Extraction Protocol is used to correlate it with the GUIDed\r
+// section type that it is intended to process.\r
 //\r
 \r
 typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL;\r
@@ -61,10 +55,9 @@ typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRAC
   EFI_TPL above TPL_NOTIFY is undefined. Type EFI_TPL is\r
   defined in RaiseTPL() in the UEFI 2.0 specification.\r
 \r
-  \r
-  @param This   Indicates the\r
-                EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.\r
-  \r
+\r
+  @param This         Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.\r
+\r
   @param InputSection Buffer containing the input GUIDed section\r
                       to be processed. OutputBuffer OutputBuffer\r
                       is allocated from boot services pool\r
@@ -102,10 +95,9 @@ typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRAC
                               the value of AuthenticationStatus\r
                               is undefined.\r
 \r
-\r
-  @retval EFI_SUCCESS The InputSection was successfully\r
-                      processed and the section contents were\r
-                      returned.\r
+  @retval EFI_SUCCESS           The InputSection was successfully\r
+                                processed and the section contents were\r
+                                returned.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
                                 resources to process the\r
@@ -128,12 +120,13 @@ EFI_STATUS
 );\r
 \r
 \r
-/**\r
-  \r
-  Takes the GUIDed section as input and produces the section\r
-  stream data. See the ExtractSection() function description.\r
-\r
-**/\r
+///\r
+/// Typically, protocol interface structures are identified by associating them with a GUID. Each\r
+/// instance of a protocol with a given GUID must have the same interface structure. While all instances\r
+/// of the GUIDed Section Extraction Protocol must have the same interface structure, they do not all\r
+/// have the same GUID. The GUID that is associated with an instance of the GUIDed Section\r
+/// Extraction Protocol is used to correlate it with the GUIDed section type that it is intended to process.\r
+///\r
 struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL {\r
   EFI_EXTRACT_GUIDED_SECTION  ExtractSection;\r
 };\r