]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/GuidedSectionExtraction.h
MdePkg/ProcessorBind: add defines for page allocation granularity
[mirror_edk2.git] / MdePkg / Include / Protocol / GuidedSectionExtraction.h
index 55692e8080a76f154b3af4f02f7d3b2577fac54e..020b20369afc77d2b0acd04c8e4a1e746054c9ec 100644 (file)
@@ -4,8 +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
+  Copyright (c) 2006 - 2008, 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
@@ -62,8 +62,7 @@ typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRAC
   defined in RaiseTPL() in the UEFI 2.0 specification.\r
 \r
   \r
-  @param This   Indicates the\r
-                EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.\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
@@ -102,10 +101,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 +126,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