]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c
Update the copyright notice format
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2MouseDxe / CommPs2.c
index e1898bb5256bfbdb91ca2485ec32423f48371745..1c763e97f394de2003da0d62ec1f15fb1cd9f6a6 100644 (file)
@@ -1,7 +1,8 @@
-/*++\r
-\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+/** @file\r
+  PS2 Mouse Communication Interface.\r
+  \r
+Copyright (c) 2006 - 2009, 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
 http://opensource.org/licenses/bsd-license.php\r
@@ -9,40 +10,27 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Abstract:   \r
-\r
-  PS2 Mouse Communication Interface \r
-\r
-\r
---*/\r
+**/\r
 \r
 #include "Ps2Mouse.h"\r
 #include "CommPs2.h"\r
 \r
-UINT8 SampleRateTbl[MAX_SR]   = { 0xa, 0x14, 0x28, 0x3c, 0x50, 0x64, 0xc8 };\r
+UINT8 SampleRateTbl[MaxSampleRate]   = { 0xa, 0x14, 0x28, 0x3c, 0x50, 0x64, 0xc8 };\r
 \r
-UINT8 ResolutionTbl[MAX_CMR]  = { 0, 1, 2, 3 };\r
+UINT8 ResolutionTbl[MaxResolution]  = { 0, 1, 2, 3 };\r
 \r
+/**\r
+  Issue self test command via IsaIo interface.\r
+  \r
+  @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  \r
+  @return EFI_SUCCESS  Success to do keyboard self testing.\r
+  @return others       Fail to do keyboard self testing.\r
+**/\r
 EFI_STATUS\r
 KbcSelfTest (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       Data;\r
@@ -92,25 +80,17 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Issue command to enable keyboard AUX functionality.\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 KbcEnableAux (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   //\r
   // Send 8042 enable mouse command\r
@@ -118,25 +98,17 @@ Returns:
   return Out8042Command (IsaIo, ENABLE_AUX);\r
 }\r
 \r
+/**\r
+  Issue command to disable keyboard AUX functionality.\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 KbcDisableAux (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   //\r
   // Send 8042 disable mouse command\r
@@ -144,25 +116,17 @@ Returns:
   return Out8042Command (IsaIo, DISABLE_AUX);\r
 }\r
 \r
+/**\r
+  Issue command to enable keyboard.\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 KbcEnableKb (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   //\r
   // Send 8042 enable keyboard command\r
@@ -170,25 +134,17 @@ Returns:
   return Out8042Command (IsaIo, ENABLE_KB);\r
 }\r
 \r
+/**\r
+  Issue command to disable keyboard.\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 KbcDisableKb (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   //\r
   // Send 8042 disable keyboard command\r
@@ -196,27 +152,19 @@ Returns:
   return Out8042Command (IsaIo, DISABLE_KB);\r
 }\r
 \r
+/**\r
+  Issue command to check keyboard status.\r
+  \r
+  @param IsaIo          Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param KeyboardEnable return whether keyboard is enable.\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 CheckKbStatus (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   OUT BOOLEAN                             *KeyboardEnable\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo           - GC_TODO: add argument description\r
-  KeyboardEnable  - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       Data;\r
@@ -245,27 +193,17 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Issue command to reset keyboard.\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 PS2MouseReset (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       Data;\r
@@ -300,27 +238,19 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Issue command to set mouse's sample rate\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param SampleRate value of sample rate \r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 PS2MouseSetSampleRate (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN MOUSE_SR                             SampleRate\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo       - GC_TODO: add argument description\r
-  SampleRate  - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
 \r
@@ -337,27 +267,19 @@ Returns:
   return Status;\r
 }\r
 \r
+/**\r
+  Issue command to set mouse's resolution.\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param Resolution value of resolution\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 PS2MouseSetResolution (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN MOUSE_RE                             Resolution\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo       - GC_TODO: add argument description\r
-  Resolution  - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
 \r
@@ -374,31 +296,23 @@ Returns:
   return Status;\r
 }\r
 \r
+/**\r
+  Issue command to set mouse's scaling.\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param Scaling value of scaling\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 PS2MouseSetScaling (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN MOUSE_SF                             Scaling\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo   - GC_TODO: add argument description\r
-  Scaling - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   UINT8 Command;\r
 \r
-  Command = (UINT8) (Scaling == SF1 ? SETSF1_CMD : SETSF2_CMD);\r
+  Command = (UINT8) (Scaling == Scaling1 ? SETSF1_CMD : SETSF2_CMD);\r
 \r
   //\r
   // Send auxiliary command to set mouse scaling data\r
@@ -406,25 +320,17 @@ Returns:
   return Out8042AuxCommand (IsaIo, Command, FALSE);\r
 }\r
 \r
+/**\r
+  Issue command to enable Ps2 mouse.\r
+  \r
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  \r
+  @return Status of command issuing.\r
+**/\r
 EFI_STATUS\r
 PS2MouseEnable (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   //\r
   // Send auxiliary command to enable mouse\r
@@ -432,26 +338,20 @@ Returns:
   return Out8042AuxCommand (IsaIo, ENABLE_CMD, FALSE);\r
 }\r
 \r
-EFI_STATUS\r
-PS2MouseGetPacket (\r
-  PS2_MOUSE_DEV     *MouseDev\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Get mouse packet . Only care first 3 bytes\r
 \r
-Arguments:\r
-\r
-  MouseDev  - Pointer of PS2 Mouse Private Data Structure \r
+  @param MouseDev  Pointer of PS2 Mouse Private Data Structure \r
 \r
-Returns:\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
 \r
-  EFI_NOT_READY -  Mouse Device not ready to input data packet, or some error happened during getting the packet\r
-  EFI_SUCCESS - The data packet is gotten successfully.\r
+**/\r
+EFI_STATUS\r
+PS2MouseGetPacket (\r
+  PS2_MOUSE_DEV     *MouseDev\r
+  )\r
 \r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   BOOLEAN     KeyboardEnable;\r
@@ -573,6 +473,16 @@ Returns:
   }\r
 }\r
 \r
+/**\r
+  Read data via IsaIo protocol with given number.\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
+  @return status of reading mouse data.\r
+**/\r
 EFI_STATUS\r
 PS2MouseRead (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
@@ -580,24 +490,6 @@ PS2MouseRead (
   IN OUT UINTN                            *BufSize,\r
   IN  UINTN                               State\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo   - GC_TODO: add argument description\r
-  Buffer  - GC_TODO: add argument description\r
-  BufSize - GC_TODO: add argument description\r
-  State   - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   UINTN       BytesRead;\r
@@ -641,27 +533,20 @@ Returns:
 //\r
 // 8042 I/O function\r
 //\r
+/**\r
+  I/O work flow of outing 8042 command.\r
+  \r
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param Command I/O command.\r
+  \r
+  @retval EFI_SUCCESS Success to excute I/O work flow\r
+  @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
 EFI_STATUS\r
 Out8042Command (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN UINT8                                Command\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo   - GC_TODO: add argument description\r
-  Command - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       Data;\r
@@ -687,30 +572,23 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  I/O work flow of outing 8042 data.\r
+  \r
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param Data    Data value\r
+  \r
+  @retval EFI_SUCCESS Success to excute I/O work flow\r
+  @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
 EFI_STATUS\r
 Out8042Data (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN UINT8                                Data\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-  Data  - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
-  UINT8       temp;\r
+  UINT8       Temp;\r
   //\r
   // Wait keyboard controller input buffer empty\r
   //\r
@@ -719,8 +597,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  temp = Data;\r
-  IsaIo->Io.Write (IsaIo, EfiIsaIoWidthUint8, KBC_DATA_PORT, 1, &temp);\r
+  Temp = Data;\r
+  IsaIo->Io.Write (IsaIo, EfiIsaIoWidthUint8, KBC_DATA_PORT, 1, &Temp);\r
 \r
   Status = WaitInputEmpty (IsaIo, TIMEOUT);\r
   if (EFI_ERROR (Status)) {\r
@@ -730,47 +608,39 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  I/O work flow of in 8042 data.\r
+  \r
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param Data    Data value\r
+  \r
+  @retval EFI_SUCCESS Success to excute I/O work flow\r
+  @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
 EFI_STATUS\r
 In8042Data (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN OUT UINT8                            *Data\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-  Data  - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_TIMEOUT - GC_TODO: Add description for return value\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   UINTN Delay;\r
-  UINT8 temp;\r
+  UINT8 Temp;\r
 \r
   Delay = TIMEOUT / 50;\r
 \r
   do {\r
-    IsaIo->Io.Read (IsaIo, EfiIsaIoWidthUint8, KBC_CMD_STS_PORT, 1, &temp);\r
+    IsaIo->Io.Read (IsaIo, EfiIsaIoWidthUint8, KBC_CMD_STS_PORT, 1, &Temp);\r
 \r
     //\r
     // Check keyboard controller status bit 0(output buffer status)\r
     //\r
-    if ((temp & KBC_OUTB) == KBC_OUTB) {\r
+    if ((Temp & KBC_OUTB) == KBC_OUTB) {\r
       break;\r
     }\r
 \r
     gBS->Stall (50);\r
     Delay--;\r
-  } while (Delay);\r
+  } while (Delay != 0);\r
 \r
   if (Delay == 0) {\r
     return EFI_TIMEOUT;\r
@@ -781,32 +651,22 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  I/O work flow of outing 8042 Aux command.\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
+  @retval EFI_SUCCESS Success to excute I/O work flow\r
+  @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
 EFI_STATUS\r
 Out8042AuxCommand (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN UINT8                                Command,\r
   IN BOOLEAN                              Resend\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo   - GC_TODO: add argument description\r
-  Command - GC_TODO: add argument description\r
-  Resend  - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       Data;\r
@@ -873,27 +733,20 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  I/O work flow of outing 8042 Aux data.\r
+  \r
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\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
+**/\r
 EFI_STATUS\r
 Out8042AuxData (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN UINT8                                Data\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-  Data  - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       Temp;\r
@@ -926,27 +779,20 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  I/O work flow of in 8042 Aux data.\r
+  \r
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\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
+**/\r
 EFI_STATUS\r
 In8042AuxData (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN OUT UINT8                            *Data\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-  Data  - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
 \r
@@ -963,26 +809,19 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+\r
+/**\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
+  @retval EFI_SUCCESS   Keyboard controller is ready\r
+  @retval EFI_NOT_READY Keyboard controller is not ready\r
+**/\r
 EFI_STATUS\r
 CheckForInput (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_NOT_READY - GC_TODO: Add description for return value\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   UINT8 Data;\r
 \r
@@ -998,28 +837,20 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  I/O work flow to wait input buffer empty in given time.\r
+  \r
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param Timeout Wating time.\r
+  \r
+  @retval EFI_TIMEOUT if input is still not empty in given time.\r
+  @retval EFI_SUCCESS input is empty.\r
+**/\r
 EFI_STATUS\r
 WaitInputEmpty (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN UINTN                                Timeout\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo   - GC_TODO: add argument description\r
-  Timeout - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_TIMEOUT - GC_TODO: Add description for return value\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   UINTN Delay;\r
   UINT8 Data;\r
@@ -1038,7 +869,7 @@ Returns:
 \r
     gBS->Stall (50);\r
     Delay--;\r
-  } while (Delay);\r
+  } while (Delay != 0);\r
 \r
   if (Delay == 0) {\r
     return EFI_TIMEOUT;\r
@@ -1047,28 +878,20 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  I/O work flow to wait output buffer full in given time.\r
+  \r
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param Timeout given time\r
+  \r
+  @retval EFI_TIMEOUT  output is not full in given time\r
+  @retval EFI_SUCCESS  output is full in given time.\r
+**/\r
 EFI_STATUS\r
 WaitOutputFull (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN UINTN                                Timeout\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IsaIo   - GC_TODO: add argument description\r
-  Timeout - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_TIMEOUT - GC_TODO: Add description for return value\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
 {\r
   UINTN Delay;\r
   UINT8 Data;\r
@@ -1088,7 +911,7 @@ Returns:
 \r
     gBS->Stall (50);\r
     Delay--;\r
-  } while (Delay);\r
+  } while (Delay != 0);\r
 \r
   if (Delay == 0) {\r
     return EFI_TIMEOUT;\r