--- /dev/null
+/**@file\r
+ PS2 Mouse Communication Interface \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
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+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
+**/\r
+\r
+#include "Ps2MouseAbsolutePointer.h"\r
+#include "CommPs2.h"\r
+\r
+UINT8 SampleRateTbl[MAX_SR] = { 0xa, 0x14, 0x28, 0x3c, 0x50, 0x64, 0xc8 };\r
+\r
+UINT8 ResolutionTbl[MAX_CMR] = { 0, 1, 2, 3 };\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
+\r
+ //\r
+ // Keyboard controller self test\r
+ //\r
+ Status = Out8042Command (IsaIo, SELF_TEST);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Read return code\r
+ //\r
+ Status = In8042Data (IsaIo, &Data);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ if (Data != 0x55) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+ //\r
+ // Set system flag\r
+ //\r
+ Status = Out8042Command (IsaIo, READ_CMD_BYTE);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ Status = In8042Data (IsaIo, &Data);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ Status = Out8042Command (IsaIo, WRITE_CMD_BYTE);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ Data |= CMD_SYS_FLAG;\r
+ Status = Out8042Data (IsaIo, Data);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+ //\r
+ return Out8042Command (IsaIo, ENABLE_AUX);\r
+}\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
+ //\r
+ return Out8042Command (IsaIo, DISABLE_AUX);\r
+}\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
+ //\r
+ return Out8042Command (IsaIo, ENABLE_KB);\r
+}\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
+ //\r
+ return Out8042Command (IsaIo, DISABLE_KB);\r
+}\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
+\r
+ //\r
+ // Send command to read KBC command byte\r
+ //\r
+ Status = Out8042Command (IsaIo, READ_CMD_BYTE);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ Status = In8042Data (IsaIo, &Data);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Check keyboard enable or not\r
+ //\r
+ if ((Data & CMD_KB_STS) == CMD_KB_DIS) {\r
+ *KeyboardEnable = FALSE;\r
+ } else {\r
+ *KeyboardEnable = TRUE;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+\r
+ Status = Out8042AuxCommand (IsaIo, RESET_CMD, FALSE);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ Status = In8042AuxData (IsaIo, &Data);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Check BAT Complete Code\r
+ //\r
+ if (Data != PS2MOUSE_BAT1) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ Status = In8042AuxData (IsaIo, &Data);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Check BAT Complete Code\r
+ //\r
+ if (Data != PS2MOUSE_BAT2) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+ //\r
+ // Send auxiliary command to set mouse sample rate\r
+ //\r
+ Status = Out8042AuxCommand (IsaIo, SETSR_CMD, FALSE);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ Status = Out8042AuxData (IsaIo, SampleRateTbl[SampleRate]);\r
+\r
+ return Status;\r
+}\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
+ //\r
+ // Send auxiliary command to set mouse resolution\r
+ //\r
+ Status = Out8042AuxCommand (IsaIo, SETRE_CMD, FALSE);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ Status = Out8042AuxData (IsaIo, ResolutionTbl[Resolution]);\r
+\r
+ return Status;\r
+}\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
+\r
+ //\r
+ // Send auxiliary command to set mouse scaling data\r
+ //\r
+ return Out8042AuxCommand (IsaIo, Command, FALSE);\r
+}\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
+ //\r
+ return Out8042AuxCommand (IsaIo, ENABLE_CMD, FALSE);\r
+}\r
+\r
+EFI_STATUS\r
+PS2MouseGetPacket (\r
+ PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev\r
+ )\r
+/*++\r
+\r
+Routine Description:\r
+\r
+ Get mouse packet . Only care first 3 bytes\r
+\r
+Arguments:\r
+\r
+ MouseDev - Pointer of PS2 Mouse Private Data Structure \r
+\r
+Returns:\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
+--*/\r
+{\r
+ EFI_STATUS Status;\r
+ BOOLEAN KeyboardEnable;\r
+ UINT8 Packet[PS2_PACKET_LENGTH];\r
+ UINT8 Data;\r
+ UINTN Count;\r
+ UINTN State;\r
+ INT16 RelativeMovementX;\r
+ INT16 RelativeMovementY;\r
+ BOOLEAN LButton;\r
+ BOOLEAN RButton;\r
+\r
+ KeyboardEnable = FALSE;\r
+ Count = 1;\r
+ State = PS2_READ_BYTE_ONE;\r
+\r
+ //\r
+ // State machine to get mouse packet\r
+ //\r
+ while (1) {\r
+\r
+ switch (State) {\r
+ case PS2_READ_BYTE_ONE:\r
+ //\r
+ // Read mouse first byte data, if failed, immediately return\r
+ //\r
+ KbcDisableAux (MouseAbsolutePointerDev->IsaIo);\r
+ Status = PS2MouseRead (MouseAbsolutePointerDev->IsaIo, &Data, &Count, State);\r
+ if (EFI_ERROR (Status)) {\r
+ KbcEnableAux (MouseAbsolutePointerDev->IsaIo);\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ if (Count != 1) {\r
+ KbcEnableAux (MouseAbsolutePointerDev->IsaIo);\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ if (IS_PS2_SYNC_BYTE (Data)) {\r
+ Packet[0] = Data;\r
+ State = PS2_READ_DATA_BYTE;\r
+\r
+ CheckKbStatus (MouseAbsolutePointerDev->IsaIo, &KeyboardEnable);\r
+ KbcDisableKb (MouseAbsolutePointerDev->IsaIo);\r
+ KbcEnableAux (MouseAbsolutePointerDev->IsaIo);\r
+ }\r
+ break;\r
+\r
+ case PS2_READ_DATA_BYTE:\r
+ Count = 2;\r
+ Status = PS2MouseRead (MouseAbsolutePointerDev->IsaIo, (Packet + 1), &Count, State);\r
+ if (EFI_ERROR (Status)) {\r
+ if (KeyboardEnable) {\r
+ KbcEnableKb (MouseAbsolutePointerDev->IsaIo);\r
+ }\r
+\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ if (Count != 2) {\r
+ if (KeyboardEnable) {\r
+ KbcEnableKb (MouseAbsolutePointerDev->IsaIo);\r
+ }\r
+\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ State = PS2_PROCESS_PACKET;\r
+ break;\r
+\r
+ case PS2_PROCESS_PACKET:\r
+ if (KeyboardEnable) {\r
+ KbcEnableKb (MouseAbsolutePointerDev->IsaIo);\r
+ }\r
+ //\r
+ // Decode the packet\r
+ //\r
+ 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
+ // 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
+ //\r
+ // Second, if the 9-bit signed twos complement integer is negative, set the high 8 bit 0xff\r
+ //\r
+ if ((Packet[0] & 0x10) != 0) {\r
+ RelativeMovementX = (INT16) (RelativeMovementX | 0xFF00);\r
+ }\r
+ if ((Packet[0] & 0x20) != 0) {\r
+ RelativeMovementY = (INT16) (RelativeMovementY | 0xFF00);\r
+ }\r
+\r
+ \r
+ RButton = (UINT8) (Packet[0] & 0x2);\r
+ LButton = (UINT8) (Packet[0] & 0x1);\r
+\r
+ //\r
+ // Update mouse state\r
+ //\r
+ MouseAbsolutePointerDev->State.CurrentX += RelativeMovementX;\r
+ MouseAbsolutePointerDev->State.CurrentY -= RelativeMovementY;\r
+ MouseAbsolutePointerDev->State.CurrentZ = 0;\r
+ MouseAbsolutePointerDev->State.ActiveButtons = (UINT8) (LButton || RButton) & 0x3;\r
+ MouseAbsolutePointerDev->StateChanged = TRUE;\r
+\r
+ return EFI_SUCCESS;\r
+ }\r
+ }\r
+}\r
+\r
+EFI_STATUS\r
+PS2MouseRead (\r
+ IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
+ OUT VOID *Buffer,\r
+ 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
+\r
+ Status = EFI_SUCCESS;\r
+ BytesRead = 0;\r
+\r
+ if (State == PS2_READ_BYTE_ONE) {\r
+ //\r
+ // Check input for mouse\r
+ //\r
+ Status = CheckForInput (IsaIo);\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ }\r
+\r
+ while (BytesRead < *BufSize) {\r
+\r
+ Status = WaitOutputFull (IsaIo, TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ break;\r
+ }\r
+\r
+ IsaIo->Io.Read (IsaIo, EfiIsaIoWidthUint8, KBC_DATA_PORT, 1, Buffer);\r
+\r
+ BytesRead++;\r
+ Buffer = (UINT8 *) Buffer + 1;\r
+ }\r
+ //\r
+ // Verify the correct number of bytes read\r
+ //\r
+ if (BytesRead == 0 || BytesRead != *BufSize) {\r
+ Status = EFI_NOT_FOUND;\r
+ }\r
+\r
+ *BufSize = BytesRead;\r
+ return Status;\r
+}\r
+//\r
+// 8042 I/O function\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
+\r
+ //\r
+ // Wait keyboard controller input buffer empty\r
+ //\r
+ Status = WaitInputEmpty (IsaIo, TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Send command\r
+ //\r
+ Data = Command;\r
+ IsaIo->Io.Write (IsaIo, EfiIsaIoWidthUint8, KBC_CMD_STS_PORT, 1, &Data);\r
+\r
+ Status = WaitInputEmpty (IsaIo, TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+ //\r
+ // Wait keyboard controller input buffer empty\r
+ //\r
+ Status = WaitInputEmpty (IsaIo, TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\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
+ return Status;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+\r
+ Delay = TIMEOUT / 50;\r
+\r
+ do {\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
+ break;\r
+ }\r
+\r
+ gBS->Stall (50);\r
+ Delay--;\r
+ } while (Delay);\r
+\r
+ if (Delay == 0) {\r
+ return EFI_TIMEOUT;\r
+ }\r
+\r
+ IsaIo->Io.Read (IsaIo, EfiIsaIoWidthUint8, KBC_DATA_PORT, 1, Data);\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+\r
+ //\r
+ // Wait keyboard controller input buffer empty\r
+ //\r
+ Status = WaitInputEmpty (IsaIo, TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Send write to auxiliary device command\r
+ //\r
+ Data = WRITE_AUX_DEV;\r
+ IsaIo->Io.Write (IsaIo, EfiIsaIoWidthUint8, KBC_CMD_STS_PORT, 1, &Data);\r
+\r
+ Status = WaitInputEmpty (IsaIo, TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Send auxiliary device command\r
+ //\r
+ IsaIo->Io.Write (IsaIo, EfiIsaIoWidthUint8, KBC_DATA_PORT, 1, &Command);\r
+\r
+ //\r
+ // Read return code\r
+ //\r
+ Status = In8042AuxData (IsaIo, &Data);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ if (Data == PS2_ACK) {\r
+ //\r
+ // Receive mouse acknowledge, command send success\r
+ //\r
+ return EFI_SUCCESS;\r
+\r
+ } else if (Resend) {\r
+ //\r
+ // Resend fail\r
+ //\r
+ return EFI_DEVICE_ERROR;\r
+\r
+ } else if (Data == PS2_RESEND) {\r
+ //\r
+ // Resend command\r
+ //\r
+ Status = Out8042AuxCommand (IsaIo, Command, TRUE);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ } else {\r
+ //\r
+ // Invalid return code\r
+ //\r
+ return EFI_DEVICE_ERROR;\r
+\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+ //\r
+ // Wait keyboard controller input buffer empty\r
+ //\r
+ Status = WaitInputEmpty (IsaIo, TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Send write to auxiliary device command\r
+ //\r
+ Temp = WRITE_AUX_DEV;\r
+ IsaIo->Io.Write (IsaIo, EfiIsaIoWidthUint8, KBC_CMD_STS_PORT, 1, &Temp);\r
+\r
+ Status = WaitInputEmpty (IsaIo, TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\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
+ return Status;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+ //\r
+ // wait for output data\r
+ //\r
+ Status = WaitOutputFull (IsaIo, BAT_TIMEOUT);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ IsaIo->Io.Read (IsaIo, EfiIsaIoWidthUint8, KBC_DATA_PORT, 1, Data);\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+ IsaIo->Io.Read (IsaIo, EfiIsaIoWidthUint8, KBC_CMD_STS_PORT, 1, &Data);\r
+\r
+ //\r
+ // Check keyboard controller status, if it is output buffer full and for auxiliary device\r
+ //\r
+ if ((Data & (KBC_OUTB | KBC_AUXB)) != (KBC_OUTB | KBC_AUXB)) {\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+\r
+ Delay = Timeout / 50;\r
+\r
+ do {\r
+ IsaIo->Io.Read (IsaIo, EfiIsaIoWidthUint8, KBC_CMD_STS_PORT, 1, &Data);\r
+\r
+ //\r
+ // Check keyboard controller status bit 1(input buffer status)\r
+ //\r
+ if ((Data & KBC_INPB) == 0) {\r
+ break;\r
+ }\r
+\r
+ gBS->Stall (50);\r
+ Delay--;\r
+ } while (Delay);\r
+\r
+ if (Delay == 0) {\r
+ return EFI_TIMEOUT;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+\r
+ Delay = Timeout / 50;\r
+\r
+ do {\r
+ IsaIo->Io.Read (IsaIo, EfiIsaIoWidthUint8, KBC_CMD_STS_PORT, 1, &Data);\r
+\r
+ //\r
+ // Check keyboard controller status bit 0(output buffer status)\r
+ // & bit5(output buffer for auxiliary device)\r
+ //\r
+ if ((Data & (KBC_OUTB | KBC_AUXB)) == (KBC_OUTB | KBC_AUXB)) {\r
+ break;\r
+ }\r
+\r
+ gBS->Stall (50);\r
+ Delay--;\r
+ } while (Delay);\r
+\r
+ if (Delay == 0) {\r
+ return EFI_TIMEOUT;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r