Remove BugBug in comments and adjust function header according to code style doc.

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

diff --git a/MdePkg/Include/Protocol/Legacy8259.h b/MdePkg/Include/Protocol/Legacy8259.h
index c30a5e519c75e240d3489d0bf9a5151e0548eeec..6be8f89d5b4031f3af2d2af589b02c3121e28e2a 100644 (file)
--- a/MdePkg/Include/Protocol/Legacy8259.h
+++ b/MdePkg/Include/Protocol/Legacy8259.h
@@ -60,12 +60,12 @@ typedef enum {
   the legacy mode mask and the protected mode mask. The base address for the 8259\r
   is different for legacy and protected mode, so two masks are required.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  MasterBase The base vector for the Master PIC in the 8259 controller\r
-  @param  Slavebase The base vector for the Master PIC in the 8259 controller\r
+  @param  This                  Protocol instance pointer.\r
+  @param  MasterBase            The base vector for the Master PIC in the 8259 controller\r
+  @param  Slavebase             The base vector for the Master PIC in the 8259 controller\r
 \r
-  @retval  EFI_SUCCESS The new bases were programmed\r
-  @retval  EFI_DEVICE_ERROR A device erro occured programming the vector bases\r
+  @retval EFI_SUCCESS           The new bases were programmed\r
+  @retval EFI_DEVICE_ERROR      A device erro occured programming the vector bases\r
 \r
 **/\r
 typedef\r
@@ -82,14 +82,14 @@ EFI_STATUS
   the legacy mode mask and the protected mode mask. The base address for the 8259\r
   is different for legacy and protected mode, so two masks are required.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  This                  Protocol instance pointer.\r
+  @param  LegacyMask            Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  LegacyEdgeLevel       Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  ProtectedMask         Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  ProtectedEdgeLevel    Bit 0 is Irq0 - Bit 15 is Irq15\r
 \r
-  @retval  EFI_SUCCESS 8259 status returned\r
-  @retval  EFI_DEVICE_ERROR Error reading 8259\r
+  @retval EFI_SUCCESS           8259 status returned\r
+  @retval EFI_DEVICE_ERROR      Error reading 8259\r
 \r
 **/\r
 typedef\r
@@ -109,14 +109,14 @@ EFI_STATUS
   is different for legacy and protected mode, so two masks are required.\r
   Also set the edge/level masks.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  This                  Protocol instance pointer.\r
+  @param  LegacyMask            Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  LegacyEdgeLevel       Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  ProtectedMask         Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  ProtectedEdgeLevel    Bit 0 is Irq0 - Bit 15 is Irq15\r
 \r
-  @retval  EFI_SUCCESS 8259 status returned\r
-  @retval  EFI_DEVICE_ERROR Error reading 8259\r
+  @retval EFI_SUCCESS           8259 status returned\r
+  @retval EFI_DEVICE_ERROR      Error reading 8259\r
 \r
 **/\r
 typedef\r
@@ -139,13 +139,13 @@ EFI_STATUS
   mask for the new mode is Mask, or if Mask does not exist the previously saved\r
   mask is used.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Mode Mode of operation. i.e. real mode or protected mode\r
-  @param  Mask Optional interupt mask for the new mode.\r
-  @param  EdgeLevel Optional trigger mask for the new mode.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Mode                  Mode of operation. i.e. real mode or protected mode\r
+  @param  Mask                  Optional interupt mask for the new mode.\r
+  @param  EdgeLevel             Optional trigger mask for the new mode.\r
 \r
-  @retval  EFI_SUCCESS 8259 programmed\r
-  @retval  EFI_DEVICE_ERROR Error writting to 8259\r
+  @retval EFI_SUCCESS           8259 programmed\r
+  @retval EFI_DEVICE_ERROR      Error writting to 8259\r
 \r
 **/\r
 typedef\r
@@ -161,12 +161,12 @@ EFI_STATUS
 /**\r
   Convert from IRQ to processor interrupt vector number.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Irq 8259 IRQ0 - IRQ15\r
-  @param  Vector Processor vector number that matches Irq\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Irq                   8259 IRQ0 - IRQ15\r
+  @param  Vector                Processor vector number that matches Irq\r
 \r
-  @retval  EFI_SUCCESS The Vector matching Irq is returned\r
-  @retval  EFI_INVALID_PARAMETER Irq not valid\r
+  @retval EFI_SUCCESS           The Vector matching Irq is returned\r
+  @retval EFI_INVALID_PARAMETER Irq not valid\r
 \r
 **/\r
 typedef\r
@@ -181,12 +181,12 @@ EFI_STATUS
 /**\r
   Enable Irq by unmasking interrupt in 8259\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Irq 8259 IRQ0 - IRQ15\r
-  @param  LevelTriggered TRUE if level triggered.  FALSE if edge triggered.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Irq                   8259 IRQ0 - IRQ15\r
+  @param  LevelTriggered        TRUE if level triggered. FALSE if edge triggered.\r
 \r
-  @retval  EFI_SUCCESS Irq enabled on 8259\r
-  @retval  EFI_INVALID_PARAMETER Irq not valid\r
+  @retval EFI_SUCCESS           Irq enabled on 8259\r
+  @retval EFI_INVALID_PARAMETER Irq not valid\r
 \r
 **/\r
 typedef\r
@@ -201,11 +201,11 @@ EFI_STATUS
 /**\r
   Disable Irq by masking interrupt in 8259\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Irq 8259 IRQ0 - IRQ15\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Irq                   8259 IRQ0 - IRQ15\r
 \r
-  @retval  EFI_SUCCESS Irq disabled on 8259\r
-  @retval  EFI_INVALID_PARAMETER Irq not valid\r
+  @retval EFI_SUCCESS           Irq disabled on 8259\r
+  @retval EFI_INVALID_PARAMETER Irq not valid\r
 \r
 **/\r
 typedef\r
@@ -222,12 +222,12 @@ EFI_STATUS
   that is programmed into the Interrupt Line (from the PCI config space)\r
   register.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  PciHandle PCI function to return vector for\r
-  @param  Vector Vector for fucntion that matches\r
+  @param  This                  Protocol instance pointer.\r
+  @param  PciHandle             PCI function to return vector for\r
+  @param  Vector                Vector for fucntion that matches\r
 \r
-  @retval  EFI_SUCCESS A valid Vector is returned\r
-  @retval  EFI_INVALID_PARAMETER PciHandle not valid\r
+  @retval EFI_SUCCESS           A valid Vector is returned\r
+  @retval EFI_INVALID_PARAMETER PciHandle not valid\r
 \r
 **/\r
 typedef\r
@@ -242,11 +242,11 @@ EFI_STATUS
 /**\r
   Send an EOI to 8259\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Irq 8259 IRQ0 - IRQ15\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Irq                   8259 IRQ0 - IRQ15\r
 \r
-  @retval  EFI_SUCCESS EOI successfully sent to 8259\r
-  @retval  EFI_INVALID_PARAMETER Irq not valid\r
+  @retval EFI_SUCCESS           EOI successfully sent to 8259\r
+  @retval EFI_INVALID_PARAMETER Irq not valid\r
 \r
 **/\r
 typedef\r