/**@file\r
- PS/2 Keyboard driver\r
Routines that access 8042 keyboard controller\r
\r
Copyright (c) 2006 - 2007, Intel Corporation\r
\r
BOOLEAN mEnableMouseInterface;\r
\r
-//\r
-// Function declarations\r
-//\r
-UINT8\r
-KeyReadDataRegister (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
- );\r
-\r
-VOID\r
-KeyWriteDataRegister (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN UINT8 Data\r
- );\r
-\r
-VOID\r
-KeyWriteCommandRegister (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN UINT8 Data\r
- );\r
-\r
-VOID\r
-KeyboardError (\r
- IN KEYBOARD_CONSOLE_IN_DEV*ConsoleIn,\r
- IN CHAR16 *ErrMsg // should be a unicode string\r
- );\r
-\r
-EFI_STATUS\r
-GetScancodeBufHead (\r
- KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN UINT32 Count,\r
- OUT UINT8 *Buf\r
- );\r
-\r
-EFI_STATUS\r
-PopScancodeBufHead (\r
- KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN UINT32 Count,\r
- OUT UINT8 *Buf\r
- );\r
-\r
-EFI_STATUS\r
-KeyboardWrite (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN UINT8 Data\r
- );\r
-\r
-EFI_STATUS\r
-KeyboardCommand (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN UINT8 Data\r
- );\r
-\r
-EFI_STATUS\r
-KeyboardWaitForValue (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN UINT8 Value\r
- );\r
-\r
/**\r
Read data register \r
\r
&Data\r
);\r
\r
- //\r
- // outp(ConsoleIn->DataRegisterAddress, Data);\r
- //\r
}\r
\r
/**\r
)\r
{\r
ConsoleIn->KeyboardErr = TRUE;\r
-\r
- //\r
- // gST -> ConOut -> OutputString (gST -> ConOut, L"Keyboard Driver: ");\r
- // gST -> ConOut -> OutputString (gST -> ConOut, ErrMsg);\r
- //\r
}\r
\r
/**\r
the memory buffer or empty the keyboard buffer.\r
It is registered as running under TPL_NOTIFY\r
\r
- @param Event - The timer event\r
- @param Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r
+ @param Event The timer event\r
+ @param Context A KEYBOARD_CONSOLE_IN_DEV pointer\r
\r
**/\r
VOID\r
gBS->RestoreTPL (OldTpl);\r
return ;\r
}\r
+\r
//\r
// To let KB driver support Hot plug, here should skip the 'resend' command for the case that\r
// KB is not connected to system. If KB is not connected to system, driver will find there's something\r
//\r
// if there is no key present, just return\r
//\r
- if ((KeyReadStatusRegister (Context) & 0x21) != 0x1) {\r
+ if ((KeyReadStatusRegister (Context) & (KEYBOARD_STATUS_REGISTER_TRANSMIT_TIMEOUT|KEYBOARD_STATUS_REGISTER_HAS_OUTPUT_DATA)) != KEYBOARD_STATUS_REGISTER_HAS_OUTPUT_DATA) {\r
//\r
// Leave critical section and return\r
//\r
// wait till output buffer full then perform the read\r
//\r
for (TimeOut = 0; TimeOut < KEYBOARD_TIMEOUT; TimeOut += 30) {\r
- if (KeyReadStatusRegister (ConsoleIn) & 0x01) {\r
+ if (KeyReadStatusRegister (ConsoleIn) & KEYBOARD_STATUS_REGISTER_HAS_OUTPUT_DATA) {\r
RegFilled = 1;\r
*Data = KeyReadDataRegister (ConsoleIn);\r
break;\r
}\r
\r
- gBS->Stall (30);\r
+ MicroSecondDelay (30);\r
}\r
\r
if (!RegFilled) {\r
@param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
@param Data value wanted to be written\r
\r
- @retval EFI_TIMEOUT - GC_TODO: Add description for return value\r
- @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
+ @retval EFI_TIMEOUT The input buffer register is full for putting new value util timeout\r
+ @retval EFI_SUCCESS The new value is sucess put into input buffer register.\r
\r
**/\r
EFI_STATUS\r
break;\r
}\r
\r
- gBS->Stall (30);\r
+ MicroSecondDelay (30);\r
}\r
\r
if (!RegEmptied) {\r
break;\r
}\r
\r
- gBS->Stall (30);\r
+ MicroSecondDelay (30);\r
}\r
\r
if (!RegEmptied) {\r
break;\r
}\r
\r
- gBS->Stall (30);\r
+ MicroSecondDelay (30);\r
}\r
\r
if (!RegEmptied) {\r
break;\r
}\r
\r
- gBS->Stall (30);\r
+ MicroSecondDelay (30);\r
}\r
\r
SumTimeOut += TimeOut;\r
//\r
// Check results\r
//\r
- if (GotIt) {\r
+ if (GotIt == 1) {\r
return EFI_SUCCESS;\r
} else {\r
return EFI_TIMEOUT;\r
\r
@param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
\r
- @return status\r
+ @return status of updating keyboard register\r
\r
**/\r
EFI_STATUS\r
\r
@param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
\r
- @retval EFI_NOT_READY - Input from console not ready yet.\r
- @retval EFI_SUCCESS - Function executed successfully.\r
+ @retval EFI_NOT_READY Input from console not ready yet.\r
+ @retval EFI_SUCCESS Function executed successfully.\r
\r
**/\r
EFI_STATUS\r
// Check if there are enough bytes of scancode representing a single key\r
// available in the buffer\r
//\r
- while (1) {\r
+ while (TRUE) {\r
\r
Status = GetScancodeBufHead (ConsoleIn, 1, ScancodeArr);\r
ScancodeArrPos = 0;\r
//\r
if (Extended && ScanCode == 0x35) {\r
ConsoleIn->Key.ScanCode = SCAN_NULL;\r
- ConsoleIn->Key.UnicodeChar = '/';\r
+ ConsoleIn->Key.UnicodeChar = L'/';\r
return EFI_SUCCESS;\r
}\r
//\r
// Need not return associated shift state if a class of printable characters that\r
// are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'\r
//\r
- if (ConsoleIn->Key.UnicodeChar >= 'A' && ConsoleIn->Key.UnicodeChar <= 'Z') {\r
+ if (ConsoleIn->Key.UnicodeChar >= L'A' && ConsoleIn->Key.UnicodeChar <= L'Z') {\r
ConsoleIn->LeftShift = FALSE;\r
ConsoleIn->RightShift = FALSE;\r
}\r
// alphabetic key is affected by CapsLock State\r
//\r
if (ConsoleIn->CapsLock) {\r
- if (ConsoleIn->Key.UnicodeChar >= 'a' && ConsoleIn->Key.UnicodeChar <= 'z') {\r
+ if (ConsoleIn->Key.UnicodeChar >= L'a' && ConsoleIn->Key.UnicodeChar <= L'z') {\r
ConsoleIn->Key.UnicodeChar = ConvertKeyboardScanCodeToEfiKey[Index].ShiftUnicodeChar;\r
- } else if (ConsoleIn->Key.UnicodeChar >= 'A' && ConsoleIn->Key.UnicodeChar <= 'Z') {\r
+ } else if (ConsoleIn->Key.UnicodeChar >= L'A' && ConsoleIn->Key.UnicodeChar <= L'Z') {\r
ConsoleIn->Key.UnicodeChar = ConvertKeyboardScanCodeToEfiKey[Index].UnicodeChar;\r
}\r
}\r
// Translate the CTRL-Alpha characters to their corresponding control value (ctrl-a = 0x0001 through ctrl-Z = 0x001A)\r
//\r
if (ConsoleIn->Ctrled) {\r
- if (ConsoleIn->Key.UnicodeChar >= 'a' && ConsoleIn->Key.UnicodeChar <= 'z') {\r
- ConsoleIn->Key.UnicodeChar = (UINT16) (ConsoleIn->Key.UnicodeChar - 'a' + 1);\r
- } else if (ConsoleIn->Key.UnicodeChar >= 'A' && ConsoleIn->Key.UnicodeChar <= 'Z') {\r
- ConsoleIn->Key.UnicodeChar = (UINT16) (ConsoleIn->Key.UnicodeChar - 'A' + 1);\r
+ if (ConsoleIn->Key.UnicodeChar >= L'a' && ConsoleIn->Key.UnicodeChar <= L'z') {\r
+ ConsoleIn->Key.UnicodeChar = (UINT16) (ConsoleIn->Key.UnicodeChar - L'a' + 1);\r
+ } else if (ConsoleIn->Key.UnicodeChar >= L'A' && ConsoleIn->Key.UnicodeChar <= L'Z') {\r
+ ConsoleIn->Key.UnicodeChar = (UINT16) (ConsoleIn->Key.UnicodeChar - L'A' + 1);\r
}\r
}\r
\r
if (ConsoleIn->NumLock && !ConsoleIn->Shift && !Extended) {\r
ConsoleIn->Key.ScanCode = SCAN_NULL;\r
} else if (ScanCode != 0x4a && ScanCode != 0x4e) {\r
- ConsoleIn->Key.UnicodeChar = 0x00;\r
+ ConsoleIn->Key.UnicodeChar = 0x0000;\r
}\r
}\r
//\r
// If the key can not be converted then just return.\r
//\r
- if (ConsoleIn->Key.ScanCode == SCAN_NULL && ConsoleIn->Key.UnicodeChar == 0x00) {\r
+ if (ConsoleIn->Key.ScanCode == SCAN_NULL && ConsoleIn->Key.UnicodeChar == 0x0000) {\r
return EFI_NOT_READY;\r
}\r
\r
// Test the system flag in to determine whether this is the first\r
// time initialization\r
//\r
- if ((KeyReadStatusRegister (ConsoleIn) & 0x04)) {\r
+ if ((KeyReadStatusRegister (ConsoleIn) & KEYBOARD_STATUS_REGISTER_SYSTEM_FLAG)) {\r
//\r
// 8042 controller is already setup (by myself or by mouse driver):\r
// See whether mouse interface is already enabled\r
//\r
// Read the command byte of 8042 controller\r
//\r
- Status = KeyboardCommand (ConsoleIn, 0x20);\r
+ Status = KeyboardCommand (ConsoleIn, KEYBOARD_8042_COMMAND_READ);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"\n\r");\r
goto Done;\r
//\r
// Disable keyboard and mouse interfaces\r
//\r
- Status = KeyboardCommand (ConsoleIn, 0xad);\r
+ Status = KeyboardCommand (ConsoleIn, KEYBOARD_8042_COMMAND_DISABLE_KEYBOARD_INTERFACE);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"\n\r");\r
goto Done;\r
}\r
\r
- Status = KeyboardCommand (ConsoleIn, 0xa7);\r
+ Status = KeyboardCommand (ConsoleIn, KEYBOARD_8042_COMMAND_DISABLE_MOUSE_INTERFACE);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"\n\r");\r
goto Done;\r
//\r
// 8042 Controller Self Test\r
//\r
- Status = KeyboardCommand (ConsoleIn, 0xaa);\r
+ Status = KeyboardCommand (ConsoleIn, KEYBOARD_8042_COMMAND_CONTROLLER_SELF_TEST);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"8042 controller command write error!\n\r");\r
goto Done;\r
// 1: Enable Auxiliary device interrupt\r
// 0: Enable Keyboard interrupt )\r
//\r
- Status = KeyboardCommand (ConsoleIn, 0x60);\r
+ Status = KeyboardCommand (ConsoleIn, KEYBOARD_8042_COMMAND_WRITE);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"8042 controller command write error!\n\r");\r
goto Done;\r
//\r
// Keyboard Interface Test\r
//\r
- Status = KeyboardCommand (ConsoleIn, 0xab);\r
+ Status = KeyboardCommand (ConsoleIn, KEYBOARD_8042_COMMAND_KEYBOARD_INTERFACE_SELF_TEST);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"8042 controller command write error!\n\r");\r
goto Done;\r
//\r
// Keyboard reset with a BAT(Basic Assurance Test)\r
//\r
- Status = KeyboardWrite (ConsoleIn, 0xff);\r
+ Status = KeyboardWrite (ConsoleIn, KEYBOARD_8048_COMMAND_RESET);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"8042 controller data write error!\n\r");\r
goto Done;\r
}\r
\r
- Status = KeyboardWaitForValue (ConsoleIn, 0xfa);\r
+ Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_ACK);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");\r
goto Done;\r
//\r
mWaitForValueTimeOut = KEYBOARD_BAT_TIMEOUT;\r
\r
- Status = KeyboardWaitForValue (ConsoleIn, 0xaa);\r
+ Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_BAT_SUCCESS);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"Keyboard self test failed!\n\r");\r
goto Done;\r
//\r
// Set Keyboard to use Scan Code Set 2\r
//\r
- Status = KeyboardWrite (ConsoleIn, 0xf0);\r
+ Status = KeyboardWrite (ConsoleIn, KEYBOARD_8048_COMMAND_SELECT_SCAN_CODE_SET);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"8042 controller data write error!\n\r");\r
goto Done;\r
}\r
\r
- Status = KeyboardWaitForValue (ConsoleIn, 0xfa);\r
+ Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_ACK);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");\r
goto Done;\r
goto Done;\r
}\r
\r
- Status = KeyboardWaitForValue (ConsoleIn, 0xfa);\r
+ Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_ACK);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");\r
goto Done;\r
//\r
// Clear Keyboard Scancode Buffer\r
//\r
- Status = KeyboardWrite (ConsoleIn, 0xf4);\r
+ Status = KeyboardWrite (ConsoleIn, KEYBOARD_8048_COMMAND_CLEAR_OUTPUT_DATA);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"8042 controller data write error!\n\r");\r
goto Done;\r
}\r
\r
- Status = KeyboardWaitForValue (ConsoleIn, 0xfa);\r
+ Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_ACK);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");\r
goto Done;\r
//\r
// Enable mouse interface\r
//\r
- Status1 = KeyboardCommand (ConsoleIn, 0xa8);\r
+ Status1 = KeyboardCommand (ConsoleIn, KEYBOARD_8042_COMMAND_ENABLE_MOUSE_INTERFACE);\r
if (EFI_ERROR (Status1)) {\r
KeyboardError (ConsoleIn, L"8042 controller command write error!\n\r");\r
return EFI_DEVICE_ERROR;\r
//\r
// Disable keyboard interface\r
//\r
- Status = KeyboardCommand (ConsoleIn, 0xad);\r
+ Status = KeyboardCommand (ConsoleIn, KEYBOARD_8042_COMMAND_DISABLE_KEYBOARD_INTERFACE);\r
if (EFI_ERROR (Status)) {\r
KeyboardError (ConsoleIn, L"\n\r");\r
return EFI_DEVICE_ERROR;\r