code scrub on Ps2MouseDxe module

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2MouseDxe / CommPs2.h

diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h b/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h
index c92a1c57ed520ac065498e1b5947cb7a5229e421..5eb55de13cc3570436ce251e29d88eb742a2b42b 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h
+++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h
@@ -1,7 +1,6 @@
-/**@file\r
+/** @file\r
   PS2 Mouse Communication Interface \r
 \r
-  \r
 Copyright (c) 2006 - 2007, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
@@ -76,32 +75,50 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 // Keyboard Controller Status\r
 //\r
-#define KBC_PARE  0x80  // Parity Error\r
-#define KBC_TIM   0x40  // General Time Out\r
-#define KBC_AUXB  0x20  // Output buffer for auxiliary device (PS/2):\r
-//    0 - Holds keyboard data\r
-//    1 - Holds data for auxiliary device\r
-//\r
-#define KBC_KEYL  0x10  // Keyboard lock status:\r
-//    0 - keyboard locked\r
-//    1 - keyboard free\r
-//\r
-#define KBC_CD  0x08  // Command/Data:\r
-//    0 - data byte written via port 60h\r
-//    1 - command byte written via port 64h\r
-//\r
-#define KBC_SYSF  0x04  // System Flag:\r
-//    0 - power-on reset\r
-//    1 - self-test successful\r
-//\r
-#define KBC_INPB  0x02  // Input Buffer Status :\r
-//    0 - input buffer empty\r
-//    1 - CPU data in input buffer\r
-//\r
-#define KBC_OUTB  0x01  // Output Buffer Status :\r
-//    0 - output buffer empty\r
-//    1 - keyboard controller data in output buffer\r
-//\r
+///\r
+/// Parity Error\r
+///\r
+#define KBC_PARE  0x80  \r
+///\r
+/// General Time Out\r
+///\r
+#define KBC_TIM   0x40  \r
+///\r
+/// Output buffer for auxiliary device (PS/2):\r
+///    0 - Holds keyboard data\r
+///    1 - Holds data for auxiliary device\r
+///\r
+#define KBC_AUXB  0x20  \r
+///\r
+/// Keyboard lock status:\r
+///    0 - keyboard locked\r
+///    1 - keyboard free\r
+///\r
+#define KBC_KEYL  0x10 \r
+///\r
+/// Command/Data:\r
+///    0 - data byte written via port 60h\r
+///    1 - command byte written via port 64h\r
+///\r
+#define KBC_CD  0x08\r
+///\r
+/// System Flag:\r
+///    0 - power-on reset\r
+///    1 - self-test successful\r
+///\r
+#define KBC_SYSF  0x04  \r
+///\r
+/// Input Buffer Status :\r
+///    0 - input buffer empty\r
+///    1 - CPU data in input buffer\r
+///\r
+#define KBC_INPB  0x02  \r
+///\r
+/// Output Buffer Status :\r
+///    0 - output buffer empty\r
+///    1 - keyboard controller data in output buffer\r
+///\r
+#define KBC_OUTB  0x01  \r
 \r
 /**\r
   Issue self test command via IsaIo interface.\r
@@ -360,7 +377,7 @@ In8042AuxData (
   I/O work flow of outing 8042 Aux data.\r
   \r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  @param Command Aux I/O command\r
+  @param Data    Buffer holding return value\r
   \r
   @retval EFI_SUCCESS Success to excute I/O work flow\r
   @retval EFI_TIMEOUT Keyboard controller time out.\r
@@ -372,7 +389,7 @@ Out8042AuxData (
   );\r
 \r
 /**\r
-  Check keyboard controller status, if it is output buffer full and for auxiliary device\r
+  Check keyboard controller status, if it is output buffer full and for auxiliary device.\r
   \r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   \r
@@ -414,4 +431,5 @@ WaitOutputFull (
   IN UINTN                                Timeout\r
   );\r
 \r
-#endif // _COMMPS2_H_\r
+#endif\r
+\r