git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8509 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 32 insertions, 40 deletions

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h b/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
index 5bc093f..8c952eb 100644
--- a/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
+++ b/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
@@ -32,9 +32,9 @@ typedef struct _EFI_LEGACY_INTERRUPT_PROTOCOL EFI_LEGACY_INTERRUPT_PROTOCOL;
   Get the number of PIRQs this hardware supports.

 

   @param  This                  Protocol instance pointer.

-  @param  NumberPirsq           Number of PIRQs.

+  @param  NumberPirsq           Number of PIRQs that are supported.

 

-  @retval EFI_SUCCESS           Number of PIRQs returned.

+  @retval EFI_SUCCESS           The number of PIRQs was returned successfully.

 

 **/

 typedef

@@ -52,7 +52,7 @@ EFI_STATUS
   @param  Device                PCI Device

   @param  Function              PCI Function

 

-  @retval EFI_SUCCESS           Bus/Device/Function returned

+  @retval EFI_SUCCESS           The Bus, Device, and Function were returned successfully

 

 **/

 typedef

@@ -88,9 +88,9 @@ EFI_STATUS
 

   @param  This                  Protocol instance pointer.

   @param  PirqNumber            PIRQ register to read.

-  @param  PirqData              Data written.

+  @param  PirqData              Data to write.

 

-  @retval EFI_SUCCESS           Table pointer returned

+  @retval EFI_SUCCESS           The PIRQ was programmed

   @retval EFI_INVALID_PARAMETER Invalid PIRQ number

 

 **/

@@ -102,27 +102,22 @@ EFI_STATUS
   IN UINT8                                   PirqData

   );

 

-/**

-  @par Protocol Description:

-  Abstracts the PIRQ programming from the generic EFI Compatibility Support Modules

-

-  @param GetNumberPirqs

-  Gets the number of PIRQs supported.

-

-  @param GetLocation

-  Gets the PCI bus, device, and function that associated with this protocol.

-

-  @param ReadPirq

-  Reads the indicated PIRQ register.

-

-  @param WritePirq

-  Writes to the indicated PIRQ register.

-

-**/

 struct _EFI_LEGACY_INTERRUPT_PROTOCOL {

+///

+///   Gets the number of PIRQs supported.

+///

   EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS GetNumberPirqs;

+///

+/// Gets the PCI bus, device, and function that associated with this protocol.

+///

   EFI_LEGACY_INTERRUPT_GET_LOCATION     GetLocation;

+///

+/// Reads the indicated PIRQ register.

+///

   EFI_LEGACY_INTERRUPT_READ_PIRQ        ReadPirq;

+///

+/// Writes to the indicated PIRQ register.

+///

   EFI_LEGACY_INTERRUPT_WRITE_PIRQ       WritePirq;

 };

 

diff --git a/IntelFrameworkPkg/Include/Protocol/SectionExtraction.h b/IntelFrameworkPkg/Include/Protocol/SectionExtraction.h
index bb2a868..18074ec 100644
--- a/IntelFrameworkPkg/Include/Protocol/SectionExtraction.h
+++ b/IntelFrameworkPkg/Include/Protocol/SectionExtraction.h
@@ -1,5 +1,5 @@
 /** @file

-  This file declares Section Extraction protocols.

+  This file declares Section Extraction Protocol.

 

   This interface provides a means of decoding a set of sections into a linked list of

   leaf sections.  This provides for an extensible and flexible file format.

@@ -71,7 +71,10 @@ EFI_STATUS
 

   @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.

   @param  SectionStreamHandle   Indicates from which section stream to read.

-  @param  SectionType           Pointer to an EFI_SECTION_TYPE.

+  @param  SectionType           Pointer to an EFI_SECTION_TYPE.  SectionType == NULL, the contents of the 

+                                entire section stream are returned in Buffer.If SectionType is not NULL, 

+                                only the  requested section is returned. EFI_SECTION_ALL matches all section 

+                                types and can be used as a wild card to extract all sections in order.

   @param  SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==

                                 EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID

                                 to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then

@@ -135,25 +138,19 @@ EFI_STATUS
 //

 // Protocol definition

 //

-/**

-  @par Protocol Description:

-  The Section Extraction Protocol provides a simple method of extracting

-  sections from arbitrarily complex files.

-

-  @param OpenSectionStream

-  Takes a bounded stream of sections and returns a section stream handle.

-

-  @param GetSection

-  Given a section stream handle, retrieves the requested section and

-  meta-data from the section stream.

-

-  @param CloseSectionStream

-  Given a section stream handle, closes the section stream.

-

-**/

 struct _EFI_SECTION_EXTRACTION_PROTOCOL {

+///

+///  Takes a bounded stream of sections and returns a section stream handle.

+///

   EFI_OPEN_SECTION_STREAM   OpenSectionStream;

+///

+///  Given a section stream handle, retrieves the requested section and

+///  meta-data from the section stream.

+///

   EFI_GET_SECTION           GetSection;

+///

+///  Given a section stream handle, closes the section stream.

+///

   EFI_CLOSE_SECTION_STREAM  CloseSectionStream;

 };