git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8509 6f19259b...
authorjcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Jun 2009 17:07:59 +0000 (17:07 +0000)
committerjcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Jun 2009 17:07:59 +0000 (17:07 +0000)
IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
IntelFrameworkPkg/Include/Protocol/SectionExtraction.h

index 5bc093f13e62b566f3074d272a888993ce39582a..8c952ebf9ef081e66cac0d4ff8d76d1d349de693 100644 (file)
@@ -32,9 +32,9 @@ typedef struct _EFI_LEGACY_INTERRUPT_PROTOCOL EFI_LEGACY_INTERRUPT_PROTOCOL;
   Get the number of PIRQs this hardware supports.\r
 \r
   @param  This                  Protocol instance pointer.\r
-  @param  NumberPirsq           Number of PIRQs.\r
+  @param  NumberPirsq           Number of PIRQs that are supported.\r
 \r
-  @retval EFI_SUCCESS           Number of PIRQs returned.\r
+  @retval EFI_SUCCESS           The number of PIRQs was returned successfully.\r
 \r
 **/\r
 typedef\r
@@ -52,7 +52,7 @@ EFI_STATUS
   @param  Device                PCI Device\r
   @param  Function              PCI Function\r
 \r
-  @retval EFI_SUCCESS           Bus/Device/Function returned\r
+  @retval EFI_SUCCESS           The Bus, Device, and Function were returned successfully\r
 \r
 **/\r
 typedef\r
@@ -88,9 +88,9 @@ EFI_STATUS
 \r
   @param  This                  Protocol instance pointer.\r
   @param  PirqNumber            PIRQ register to read.\r
-  @param  PirqData              Data written.\r
+  @param  PirqData              Data to write.\r
 \r
-  @retval EFI_SUCCESS           Table pointer returned\r
+  @retval EFI_SUCCESS           The PIRQ was programmed\r
   @retval EFI_INVALID_PARAMETER Invalid PIRQ number\r
 \r
 **/\r
@@ -102,27 +102,22 @@ EFI_STATUS
   IN UINT8                                   PirqData\r
   );\r
 \r
-/**\r
-  @par Protocol Description:\r
-  Abstracts the PIRQ programming from the generic EFI Compatibility Support Modules\r
-\r
-  @param GetNumberPirqs\r
-  Gets the number of PIRQs supported.\r
-\r
-  @param GetLocation\r
-  Gets the PCI bus, device, and function that associated with this protocol.\r
-\r
-  @param ReadPirq\r
-  Reads the indicated PIRQ register.\r
-\r
-  @param WritePirq\r
-  Writes to the indicated PIRQ register.\r
-\r
-**/\r
 struct _EFI_LEGACY_INTERRUPT_PROTOCOL {\r
+///\r
+///   Gets the number of PIRQs supported.\r
+///\r
   EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS GetNumberPirqs;\r
+///\r
+/// Gets the PCI bus, device, and function that associated with this protocol.\r
+///\r
   EFI_LEGACY_INTERRUPT_GET_LOCATION     GetLocation;\r
+///\r
+/// Reads the indicated PIRQ register.\r
+///\r
   EFI_LEGACY_INTERRUPT_READ_PIRQ        ReadPirq;\r
+///\r
+/// Writes to the indicated PIRQ register.\r
+///\r
   EFI_LEGACY_INTERRUPT_WRITE_PIRQ       WritePirq;\r
 };\r
 \r
index bb2a8680d51537f6d14cd5f64fbb879aef73a965..18074ec588d86e2a4149983e8683dc5a5b9302c7 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  This file declares Section Extraction protocols.\r
+  This file declares Section Extraction Protocol.\r
 \r
   This interface provides a means of decoding a set of sections into a linked list of\r
   leaf sections.  This provides for an extensible and flexible file format.\r
@@ -71,7 +71,10 @@ EFI_STATUS
 \r
   @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r
   @param  SectionStreamHandle   Indicates from which section stream to read.\r
-  @param  SectionType           Pointer to an EFI_SECTION_TYPE.\r
+  @param  SectionType           Pointer to an EFI_SECTION_TYPE.  SectionType == NULL, the contents of the \r
+                                entire section stream are returned in Buffer.If SectionType is not NULL, \r
+                                only the  requested section is returned. EFI_SECTION_ALL matches all section \r
+                                types and can be used as a wild card to extract all sections in order.\r
   @param  SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==\r
                                 EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID\r
                                 to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then\r
@@ -135,25 +138,19 @@ EFI_STATUS
 //\r
 // Protocol definition\r
 //\r
-/**\r
-  @par Protocol Description:\r
-  The Section Extraction Protocol provides a simple method of extracting\r
-  sections from arbitrarily complex files.\r
-\r
-  @param OpenSectionStream\r
-  Takes a bounded stream of sections and returns a section stream handle.\r
-\r
-  @param GetSection\r
-  Given a section stream handle, retrieves the requested section and\r
-  meta-data from the section stream.\r
-\r
-  @param CloseSectionStream\r
-  Given a section stream handle, closes the section stream.\r
-\r
-**/\r
 struct _EFI_SECTION_EXTRACTION_PROTOCOL {\r
+///\r
+///  Takes a bounded stream of sections and returns a section stream handle.\r
+///\r
   EFI_OPEN_SECTION_STREAM   OpenSectionStream;\r
+///\r
+///  Given a section stream handle, retrieves the requested section and\r
+///  meta-data from the section stream.\r
+///\r
   EFI_GET_SECTION           GetSection;\r
+///\r
+///  Given a section stream handle, closes the section stream.\r
+///\r
   EFI_CLOSE_SECTION_STREAM  CloseSectionStream;\r
 };\r
 \r