IntelFrameworkModulePkg: Clean up source files

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

diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c b/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c
index 27d378db22ee22c1f158f62bd28f0fcf5eabe9aa..d1c07f65b772f052d254a94994dabee27f79b956 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c
@@ -1,7 +1,7 @@
 /** @file\r
   PS2 Mouse Communication Interface.\r
-  \r
-Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -21,9 +21,9 @@ UINT8 ResolutionTbl[MaxResolution]  = { 0, 1, 2, 3 };
 \r
 /**\r
   Issue self test command via IsaIo interface.\r
-  \r
+\r
   @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  \r
+\r
   @return EFI_SUCCESS  Success to do keyboard self testing.\r
   @return others       Fail to do keyboard self testing.\r
 **/\r
@@ -82,9 +82,9 @@ KbcSelfTest (
 \r
 /**\r
   Issue command to enable keyboard AUX functionality.\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -100,9 +100,9 @@ KbcEnableAux (
 \r
 /**\r
   Issue command to disable keyboard AUX functionality.\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -118,9 +118,9 @@ KbcDisableAux (
 \r
 /**\r
   Issue command to enable keyboard.\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -136,9 +136,9 @@ KbcEnableKb (
 \r
 /**\r
   Issue command to disable keyboard.\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -154,10 +154,10 @@ KbcDisableKb (
 \r
 /**\r
   Issue command to check keyboard status.\r
-  \r
+\r
   @param IsaIo          Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param KeyboardEnable return whether keyboard is enable.\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -195,9 +195,9 @@ CheckKbStatus (
 \r
 /**\r
   Issue command to reset keyboard.\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -240,10 +240,10 @@ PS2MouseReset (
 \r
 /**\r
   Issue command to set mouse's sample rate\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  @param SampleRate value of sample rate \r
-  \r
+  @param SampleRate value of sample rate\r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -269,10 +269,10 @@ PS2MouseSetSampleRate (
 \r
 /**\r
   Issue command to set mouse's resolution.\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Resolution value of resolution\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -298,10 +298,10 @@ PS2MouseSetResolution (
 \r
 /**\r
   Issue command to set mouse's scaling.\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Scaling value of scaling\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -322,9 +322,9 @@ PS2MouseSetScaling (
 \r
 /**\r
   Issue command to enable Ps2 mouse.\r
-  \r
+\r
   @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  \r
+\r
   @return Status of command issuing.\r
 **/\r
 EFI_STATUS\r
@@ -341,7 +341,7 @@ PS2MouseEnable (
 /**\r
   Get mouse packet . Only care first 3 bytes\r
 \r
-  @param MouseDev  Pointer of PS2 Mouse Private Data Structure \r
+  @param MouseDev  Pointer of PS2 Mouse Private Data Structure\r
 \r
   @retval EFI_NOT_READY  Mouse Device not ready to input data packet, or some error happened during getting the packet\r
   @retval EFI_SUCCESS    The data packet is gotten successfully.\r
@@ -432,19 +432,19 @@ PS2MouseGetPacket (
       RelativeMovementX = Packet[1];\r
       RelativeMovementY = Packet[2];\r
       //\r
-      //               Bit 7   |    Bit 6   |    Bit 5   |   Bit 4    |   Bit 3  |   Bit 2    |   Bit 1   |   Bit 0 \r
-      //  Byte 0  | Y overflow | X overflow | Y sign bit | X sign bit | Always 1 | Middle Btn | Right Btn | Left Btn \r
-      //  Byte 1  |                                           8 bit X Movement \r
-      //  Byte 2  |                                           8 bit Y Movement \r
-      // \r
+      //               Bit 7   |    Bit 6   |    Bit 5   |   Bit 4    |   Bit 3  |   Bit 2    |   Bit 1   |   Bit 0\r
+      //  Byte 0  | Y overflow | X overflow | Y sign bit | X sign bit | Always 1 | Middle Btn | Right Btn | Left Btn\r
+      //  Byte 1  |                                           8 bit X Movement\r
+      //  Byte 2  |                                           8 bit Y Movement\r
+      //\r
       // X sign bit + 8 bit X Movement : 9-bit signed twos complement integer that presents the relative displacement of the device in the X direction since the last data transmission.\r
       // Y sign bit + 8 bit Y Movement : Same as X sign bit + 8 bit X Movement.\r
       //\r
       //\r
       // First, Clear X and Y high 8 bits\r
       //\r
-      RelativeMovementX = (INT16) (RelativeMovementX & 0xFF); \r
-      RelativeMovementY = (INT16) (RelativeMovementY & 0xFF); \r
+      RelativeMovementX = (INT16) (RelativeMovementX & 0xFF);\r
+      RelativeMovementY = (INT16) (RelativeMovementY & 0xFF);\r
       //\r
       // Second, if the 9-bit signed twos complement integer is negative, set the high 8 bit 0xff\r
       //\r
@@ -455,7 +455,7 @@ PS2MouseGetPacket (
         RelativeMovementY = (INT16) (RelativeMovementY | 0xFF00);\r
       }\r
 \r
-      \r
+\r
       RButton           = (UINT8) (Packet[0] & 0x2);\r
       LButton           = (UINT8) (Packet[0] & 0x1);\r
 \r
@@ -475,12 +475,12 @@ PS2MouseGetPacket (
 \r
 /**\r
   Read data via IsaIo protocol with given number.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Buffer  Buffer receive data of mouse\r
   @param BufSize The size of buffer\r
   @param State   Check input or read data\r
-  \r
+\r
   @return status of reading mouse data.\r
 **/\r
 EFI_STATUS\r
@@ -535,10 +535,10 @@ PS2MouseRead (
 //\r
 /**\r
   I/O work flow of outing 8042 command.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Command I/O command.\r
-  \r
+\r
   @retval EFI_SUCCESS Success to execute I/O work flow\r
   @retval EFI_TIMEOUT Keyboard controller time out.\r
 **/\r
@@ -574,10 +574,10 @@ Out8042Command (
 \r
 /**\r
   I/O work flow of outing 8042 data.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Data    Data value\r
-  \r
+\r
   @retval EFI_SUCCESS Success to execute I/O work flow\r
   @retval EFI_TIMEOUT Keyboard controller time out.\r
 **/\r
@@ -610,10 +610,10 @@ Out8042Data (
 \r
 /**\r
   I/O work flow of in 8042 data.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Data    Data value\r
-  \r
+\r
   @retval EFI_SUCCESS Success to execute I/O work flow\r
   @retval EFI_TIMEOUT Keyboard controller time out.\r
 **/\r
@@ -653,11 +653,11 @@ In8042Data (
 \r
 /**\r
   I/O work flow of outing 8042 Aux command.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Command Aux I/O command\r
   @param Resend  Whether need resend the Aux command.\r
-  \r
+\r
   @retval EFI_SUCCESS Success to execute I/O work flow\r
   @retval EFI_TIMEOUT Keyboard controller time out.\r
 **/\r
@@ -735,10 +735,10 @@ Out8042AuxCommand (
 \r
 /**\r
   I/O work flow of outing 8042 Aux data.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Data    Buffer holding return value\r
-  \r
+\r
   @retval EFI_SUCCESS Success to execute I/O work flow\r
   @retval EFI_TIMEOUT Keyboard controller time out.\r
 **/\r
@@ -781,10 +781,10 @@ Out8042AuxData (
 \r
 /**\r
   I/O work flow of in 8042 Aux data.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Data    Buffer holding return value.\r
-  \r
+\r
   @retval EFI_SUCCESS Success to execute I/O work flow\r
   @retval EFI_TIMEOUT Keyboard controller time out.\r
 **/\r
@@ -812,9 +812,9 @@ In8042AuxData (
 \r
 /**\r
   Check keyboard controller status, if it is output buffer full and for auxiliary device.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
-  \r
+\r
   @retval EFI_SUCCESS   Keyboard controller is ready\r
   @retval EFI_NOT_READY Keyboard controller is not ready\r
 **/\r
@@ -839,10 +839,10 @@ CheckForInput (
 \r
 /**\r
   I/O work flow to wait input buffer empty in given time.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Timeout Wating time.\r
-  \r
+\r
   @retval EFI_TIMEOUT if input is still not empty in given time.\r
   @retval EFI_SUCCESS input is empty.\r
 **/\r
@@ -880,10 +880,10 @@ WaitInputEmpty (
 \r
 /**\r
   I/O work flow to wait output buffer full in given time.\r
-  \r
+\r
   @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
   @param Timeout given time\r
-  \r
+\r
   @retval EFI_TIMEOUT  output is not full in given time\r
   @retval EFI_SUCCESS  output is full in given time.\r
 **/\r