X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FLegacyInterrupt.h;h=8c952ebf9ef081e66cac0d4ff8d76d1d349de693;hp=5bc093f13e62b566f3074d272a888993ce39582a;hb=3a0d56608f54c88f55986fbd1c729028f6aa7e16;hpb=0f899407a356d80ee211b181878b0b432e7c3fff

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h b/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
index 5bc093f13e..8c952ebf9e 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;
 };