]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/CommPs2.h
IntelFrameworkModulePkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2MouseAbsolutePointerDxe / CommPs2.h
index 560389df47b8a9ae5516ba9ca21aad1576ddb40e..e6ec21c6aad7422e2970772d5aa93b1228c83a02 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Using PS2 Mouse to simulation Absolution Pointer Device.\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
@@ -78,23 +78,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 ///\r
 /// Parity Error\r
 ///\r
-#define KBC_PARE  0x80  \r
+#define KBC_PARE  0x80\r
 ///\r
 /// General Time Out\r
 ///\r
-#define KBC_TIM   0x40  \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
+#define KBC_AUXB  0x20\r
 ///\r
 /// Keyboard lock status:\r
 ///    0 - keyboard locked\r
 ///    1 - keyboard free\r
 ///\r
-#define KBC_KEYL  0x10 \r
+#define KBC_KEYL  0x10\r
 ///\r
 /// Command/Data:\r
 ///    0 - data byte written via port 60h\r
@@ -106,25 +106,25 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 ///    0 - power-on reset\r
 ///    1 - self-test successful\r
 ///\r
-#define KBC_SYSF  0x04  \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
+#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
+#define KBC_OUTB  0x01\r
 \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
@@ -135,9 +135,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
@@ -147,9 +147,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
@@ -159,9 +159,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
@@ -171,9 +171,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
@@ -183,10 +183,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
@@ -197,9 +197,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
@@ -209,10 +209,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
@@ -223,10 +223,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
@@ -237,10 +237,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
@@ -251,9 +251,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
@@ -277,12 +277,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
@@ -298,10 +298,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
@@ -313,10 +313,10 @@ Out8042Command (
 \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
@@ -328,10 +328,10 @@ In8042Data (
 \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
@@ -343,11 +343,11 @@ Out8042Data (
 \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
@@ -360,10 +360,10 @@ Out8042AuxCommand (
 \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
@@ -375,10 +375,10 @@ In8042AuxData (
 \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
@@ -390,9 +390,9 @@ Out8042AuxData (
 \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
@@ -403,10 +403,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
@@ -418,10 +418,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