[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2KeyboardDxe / Ps2Keyboard.h

/** @file\r
  PS/2 keyboard driver header file\r
\r
Copyright (c) 2006 - 2011, 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
\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
#ifndef _PS2KEYBOARD_H_\r
#define _PS2KEYBOARD_H_\r
\r
#include <FrameworkDxe.h>\r
\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/SimpleTextInEx.h>\r
#include <Protocol/IsaIo.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/Ps2Policy.h>\r
\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/PcdLib.h>\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL   gKeyboardControllerDriver;\r
extern EFI_COMPONENT_NAME_PROTOCOL   gPs2KeyboardComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gPs2KeyboardComponentName2;\r
\r
//\r
// Driver Private Data\r
//\r
#define KEYBOARD_CONSOLE_IN_DEV_SIGNATURE       SIGNATURE_32 ('k', 'k', 'e', 'y')\r
#define KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('k', 'c', 'e', 'n')\r
\r
typedef struct _KEYBOARD_CONSOLE_IN_EX_NOTIFY {\r
  UINTN                               Signature;\r
  EFI_HANDLE                          NotifyHandle;\r
  EFI_KEY_DATA                        KeyData;\r
  EFI_KEY_NOTIFY_FUNCTION             KeyNotificationFn;\r
  LIST_ENTRY                          NotifyEntry;\r
} KEYBOARD_CONSOLE_IN_EX_NOTIFY;\r
\r
#define KEYBOARD_SCAN_CODE_MAX_COUNT  32\r
typedef struct {\r
  UINT8                               Buffer[KEYBOARD_SCAN_CODE_MAX_COUNT];\r
  UINTN                               Head;\r
  UINTN                               Tail;\r
} SCAN_CODE_QUEUE;\r
\r
#define KEYBOARD_EFI_KEY_MAX_COUNT    256\r
typedef struct {\r
  EFI_KEY_DATA                        Buffer[KEYBOARD_EFI_KEY_MAX_COUNT];\r
  UINTN                               Head;\r
  UINTN                               Tail;\r
} EFI_KEY_QUEUE;\r
\r
typedef struct {\r
  UINTN                               Signature;\r
\r
  EFI_HANDLE                          Handle;\r
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL      ConIn;\r
  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL   ConInEx;\r
  EFI_ISA_IO_PROTOCOL                 *IsaIo;\r
\r
  EFI_EVENT                           TimerEvent;\r
\r
  UINT32                              DataRegisterAddress;\r
  UINT32                              StatusRegisterAddress;\r
  UINT32                              CommandRegisterAddress;\r
\r
  BOOLEAN                             LeftShift;\r
  BOOLEAN                             RightShift;  \r
  BOOLEAN                             LeftLogo;\r
  BOOLEAN                             RightLogo;\r
  BOOLEAN                             Menu;\r
  BOOLEAN                             SysReq;\r
\r
  BOOLEAN                             Ctrl;\r
  BOOLEAN                             Alt;\r
  BOOLEAN                             Shift;\r
  BOOLEAN                             CapsLock;\r
  BOOLEAN                             NumLock;\r
  BOOLEAN                             ScrollLock;\r
\r
  //\r
  // Queue storing key scancodes\r
  //\r
  SCAN_CODE_QUEUE                     ScancodeQueue;\r
  EFI_KEY_QUEUE                       EfiKeyQueue;\r
\r
  //\r
  // Error state\r
  //\r
  BOOLEAN                             KeyboardErr;\r
\r
  EFI_UNICODE_STRING_TABLE            *ControllerNameTable;\r
\r
  EFI_DEVICE_PATH_PROTOCOL            *DevicePath;\r
  //\r
  // Notification Function List\r
  //\r
  LIST_ENTRY                          NotifyList;\r
} KEYBOARD_CONSOLE_IN_DEV;\r
\r
#define KEYBOARD_CONSOLE_IN_DEV_FROM_THIS(a)  CR (a, KEYBOARD_CONSOLE_IN_DEV, ConIn, KEYBOARD_CONSOLE_IN_DEV_SIGNATURE)\r
#define TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS(a) \\r
  CR (a, \\r
      KEYBOARD_CONSOLE_IN_DEV, \\r
      ConInEx, \\r
      KEYBOARD_CONSOLE_IN_DEV_SIGNATURE \\r
      )\r
\r
#define TABLE_END 0x0\r
\r
//\r
// Driver entry point\r
//\r
/**\r
  The user Entry Point for module Ps2Keyboard. The user code starts with this function.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  \r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
  \r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InstallPs2KeyboardDriver (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  );\r
\r
#define KEYBOARD_8042_DATA_REGISTER     0x60\r
#define KEYBOARD_8042_STATUS_REGISTER   0x64\r
#define KEYBOARD_8042_COMMAND_REGISTER  0x64\r
\r
#define KEYBOARD_KBEN                   0xF4\r
#define KEYBOARD_CMDECHO_ACK            0xFA\r
\r
#define KEYBOARD_MAX_TRY                256     // 256\r
#define KEYBOARD_TIMEOUT                65536   // 0.07s\r
#define KEYBOARD_WAITFORVALUE_TIMEOUT   1000000 // 1s\r
#define KEYBOARD_BAT_TIMEOUT            4000000 // 4s\r
#define KEYBOARD_TIMER_INTERVAL         200000  // 0.02s\r
#define SCANCODE_EXTENDED               0xE0\r
#define SCANCODE_EXTENDED1              0xE1\r
#define SCANCODE_CTRL_MAKE              0x1D\r
#define SCANCODE_CTRL_BREAK             0x9D\r
#define SCANCODE_ALT_MAKE               0x38\r
#define SCANCODE_ALT_BREAK              0xB8\r
#define SCANCODE_LEFT_SHIFT_MAKE        0x2A\r
#define SCANCODE_LEFT_SHIFT_BREAK       0xAA\r
#define SCANCODE_RIGHT_SHIFT_MAKE       0x36\r
#define SCANCODE_RIGHT_SHIFT_BREAK      0xB6\r
#define SCANCODE_CAPS_LOCK_MAKE         0x3A\r
#define SCANCODE_NUM_LOCK_MAKE          0x45\r
#define SCANCODE_SCROLL_LOCK_MAKE       0x46\r
#define SCANCODE_DELETE_MAKE            0x53\r
#define SCANCODE_LEFT_LOGO_MAKE         0x5B //GUI key defined in Keyboard scan code\r
#define SCANCODE_LEFT_LOGO_BREAK        0xDB\r
#define SCANCODE_RIGHT_LOGO_MAKE        0x5C\r
#define SCANCODE_RIGHT_LOGO_BREAK       0xDC\r
#define SCANCODE_MENU_MAKE              0x5D //APPS key defined in Keyboard scan code \r
#define SCANCODE_MENU_BREAK             0xDD\r
#define SCANCODE_SYS_REQ_MAKE           0x37\r
#define SCANCODE_MAX_MAKE               0x60\r
\r
#define SCANCODE_PAUSE_MAKE             0x1D45\r
\r
#define KEYBOARD_STATUS_REGISTER_HAS_OUTPUT_DATA     BIT0        ///< 0 - Output register has no data; 1 - Output register has data\r
#define KEYBOARD_STATUS_REGISTER_HAS_INPUT_DATA      BIT1        ///< 0 - Input register has no data;  1 - Input register has data\r
#define KEYBOARD_STATUS_REGISTER_SYSTEM_FLAG         BIT2        ///< Set to 0 after power on reset\r
#define KEYBOARD_STATUS_REGISTER_INPUT_DATA_TYPE     BIT3        ///< 0 - Data in input register is data; 1 - Data in input register is command\r
#define KEYBOARD_STATUS_REGISTER_ENABLE_FLAG         BIT4        ///< 0 - Keyboard is disable; 1 - Keyboard is enable\r
#define KEYBOARD_STATUS_REGISTER_TRANSMIT_TIMEOUT    BIT5        ///< 0 - Transmit is complete without timeout; 1 - Transmit is timeout without complete\r
#define KEYBOARD_STATUS_REGISTER_RECEIVE_TIMEOUT     BIT6        ///< 0 - Receive is complete without timeout; 1 - Receive is timeout without complete\r
#define KEYBOARD_STATUS_REGISTER_PARITY              BIT7        ///< 0 - Odd parity; 1 - Even parity\r
\r
#define KEYBOARD_8042_COMMAND_READ                          0x20\r
#define KEYBOARD_8042_COMMAND_WRITE                         0x60\r
#define KEYBOARD_8042_COMMAND_DISABLE_MOUSE_INTERFACE       0xA7\r
#define KEYBOARD_8042_COMMAND_ENABLE_MOUSE_INTERFACE        0xA8\r
#define KEYBOARD_8042_COMMAND_CONTROLLER_SELF_TEST          0xAA\r
#define KEYBOARD_8042_COMMAND_KEYBOARD_INTERFACE_SELF_TEST  0xAB\r
#define KEYBOARD_8042_COMMAND_DISABLE_KEYBOARD_INTERFACE    0xAD\r
\r
#define KEYBOARD_8048_COMMAND_CLEAR_OUTPUT_DATA             0xF4\r
#define KEYBOARD_8048_COMMAND_RESET                         0xFF\r
#define KEYBOARD_8048_COMMAND_SELECT_SCAN_CODE_SET          0xF0\r
\r
#define KEYBOARD_8048_RETURN_8042_BAT_SUCCESS               0xAA\r
#define KEYBOARD_8048_RETURN_8042_BAT_ERROR                 0xFC\r
#define KEYBOARD_8048_RETURN_8042_ACK                       0xFA\r
\r
\r
//\r
// Keyboard Controller Status\r
//\r
#define KBC_PARE  0x80  // Parity Error\r
#define KBC_TIM   0x40  // General Time Out\r
\r
//\r
// Other functions that are used among .c files\r
//\r
/**\r
  Show keyboard status lights according to\r
  indicators in ConsoleIn.\r
\r
  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
  \r
  @return status\r
\r
**/\r
EFI_STATUS\r
UpdateStatusLights (\r
  IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
  );\r
\r
/**\r
  write key to keyboard.\r
\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
\r
**/\r
EFI_STATUS\r
KeyboardRead (\r
  IN KEYBOARD_CONSOLE_IN_DEV  *ConsoleIn,\r
  OUT UINT8                   *Data\r
  );\r
\r
/**\r
  Get scancode from scancode buffer and translate into EFI-scancode and unicode defined by EFI spec.\r
\r
  The function is always called in TPL_NOTIFY.\r
\r
  @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
\r
**/\r
VOID\r
KeyGetchar (\r
  IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
  );\r
\r
/**\r
  Perform 8042 controller and keyboard Initialization.\r
  If ExtendedVerification is TRUE, do additional test for\r
  the keyboard interface\r
\r
  @param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
  @param ExtendedVerification - indicates a thorough initialization\r
\r
  @retval EFI_DEVICE_ERROR Fail to init keyboard\r
  @retval EFI_SUCCESS      Success to init keyboard\r
**/\r
EFI_STATUS\r
InitKeyboard (\r
  IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
  IN BOOLEAN                     ExtendedVerification\r
  );\r
\r
/**\r
  Disable the keyboard interface of the 8042 controller.\r
\r
  @param ConsoleIn   - the device instance\r
\r
  @return status of issuing disable command\r
\r
**/\r
EFI_STATUS\r
DisableKeyboard (\r
  IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
  );\r
\r
/**\r
  Timer event handler: read a series of scancodes from 8042\r
  and put them into memory scancode buffer.\r
  it read as much scancodes to either fill\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
\r
**/\r
VOID\r
EFIAPI\r
KeyboardTimerHandler (\r
  IN EFI_EVENT    Event,\r
  IN VOID         *Context\r
  );\r
\r
/**\r
  logic reset keyboard\r
  Implement SIMPLE_TEXT_IN.Reset()\r
  Perform 8042 controller and keyboard initialization\r
\r
  @param This    Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
  @param ExtendedVerification Indicate that the driver may perform a more \r
                              exhaustive verification operation of the device during \r
                              reset, now this par is ignored in this driver    \r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardEfiReset (\r
  IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,\r
  IN  BOOLEAN                         ExtendedVerification\r
  );\r
\r
/**\r
  Implement SIMPLE_TEXT_IN.ReadKeyStroke().\r
  Retrieve key values for driver user.\r
\r
  @param This    Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
  @param Key     The output buffer for key value \r
\r
  @retval EFI_SUCCESS success to read key stroke\r
**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardReadKeyStroke (\r
  IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,\r
  OUT EFI_INPUT_KEY                   *Key\r
  );\r
\r
/**\r
  Event notification function for SIMPLE_TEXT_IN.WaitForKey event\r
  Signal the event if there is key available\r
\r
  @param Event    the event object\r
  @param Context  waitting context\r
\r
**/\r
VOID\r
EFIAPI\r
KeyboardWaitForKey (\r
  IN  EFI_EVENT               Event,\r
  IN  VOID                    *Context\r
  );\r
\r
/**\r
  Read status register.\r
\r
  @param ConsoleIn  Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
\r
  @return value in status register\r
\r
**/\r
UINT8\r
KeyReadStatusRegister (\r
  IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
  );\r
\r
/**\r
  Check whether there is Ps/2 Keyboard device in system by 0xF4 Keyboard Command\r
  If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device\r
  should not be in system.\r
\r
  @param[in]  ConsoleIn   Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
\r
  @retval     TRUE                  Keyboard in System.\r
  @retval     FALSE                 Keyboard not in System.\r
**/\r
BOOLEAN\r
EFIAPI\r
CheckKeyboardConnect (\r
  IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
  );\r
\r
/**\r
  Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event\r
  Signal the event if there is key available\r
\r
  @param Event    event object\r
  @param Context  waiting context\r
\r
**/\r
VOID\r
EFIAPI\r
KeyboardWaitForKeyEx (\r
  IN  EFI_EVENT               Event,\r
  IN  VOID                    *Context\r
  );  \r
\r
//\r
// Simple Text Input Ex protocol function prototypes\r
//\r
\r
/**\r
  Reset the input device and optionaly run diagnostics\r
\r
  @param This                 - Protocol instance pointer.\r
  @param ExtendedVerification - Driver may perform diagnostics on reset.\r
\r
  @retval EFI_SUCCESS           - The device was reset.\r
  @retval EFI_DEVICE_ERROR      - The device is not functioning properly and could \r
                                  not be reset.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardEfiResetEx (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  IN BOOLEAN                            ExtendedVerification\r
  );\r
\r
/**\r
    Reads the next keystroke from the input device. The WaitForKey Event can \r
    be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
\r
    @param This       - Protocol instance pointer.\r
    @param KeyData    - A pointer to a buffer that is filled in with the keystroke \r
                 state data for the key that was pressed.\r
\r
    @retval EFI_SUCCESS           - The keystroke information was returned.\r
    @retval EFI_NOT_READY         - There was no keystroke data availiable.\r
    @retval EFI_DEVICE_ERROR      - The keystroke information was not returned due to \r
                            hardware errors.\r
    @retval EFI_INVALID_PARAMETER - KeyData is NULL.                        \r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardReadKeyStrokeEx (\r
  IN  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
  OUT EFI_KEY_DATA                      *KeyData\r
  );\r
\r
/**\r
  Set certain state for the input device.\r
\r
  @param This              - Protocol instance pointer.\r
  @param KeyToggleState    - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
                        state for the input device.\r
\r
  @retval EFI_SUCCESS           - The device state was set successfully.\r
  @retval EFI_DEVICE_ERROR      - The device is not functioning correctly and could \r
                            not have the setting adjusted.\r
  @retval EFI_UNSUPPORTED       - The device does not have the ability to set its state.\r
  @retval EFI_INVALID_PARAMETER - KeyToggleState is NULL.                       \r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardSetState (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  IN EFI_KEY_TOGGLE_STATE               *KeyToggleState\r
  );\r
\r
/**\r
    Register a notification function for a particular keystroke for the input device.\r
\r
    @param This                    - Protocol instance pointer.\r
    @param KeyData                 - A pointer to a buffer that is filled in with the keystroke \r
                              information data for the key that was pressed.\r
    @param KeyNotificationFunction - Points to the function to be called when the key \r
                              sequence is typed specified by KeyData.                        \r
    @param NotifyHandle            - Points to the unique handle assigned to the registered notification.                          \r
\r
    @retval EFI_SUCCESS             - The notification function was registered successfully.\r
    @retval EFI_OUT_OF_RESOURCES    - Unable to allocate resources for necesssary data structures.\r
    @retval EFI_INVALID_PARAMETER   - KeyData or NotifyHandle is NULL.                       \r
                              \r
**/   \r
EFI_STATUS\r
EFIAPI\r
KeyboardRegisterKeyNotify (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  IN EFI_KEY_DATA                       *KeyData,\r
  IN EFI_KEY_NOTIFY_FUNCTION            KeyNotificationFunction,\r
  OUT EFI_HANDLE                        *NotifyHandle\r
  );\r
\r
/**\r
    Remove a registered notification function from a particular keystroke.\r
\r
    @param This                    - Protocol instance pointer.    \r
    @param NotificationHandle      - The handle of the notification function being unregistered.\r
\r
  \r
    @retval EFI_SUCCESS             - The notification function was unregistered successfully.\r
    @retval EFI_INVALID_PARAMETER   - The NotificationHandle is invalid.\r
    @retval EFI_NOT_FOUND           - Can not find the matching entry in database.  \r
                              \r
**/ \r
EFI_STATUS\r
EFIAPI\r
KeyboardUnregisterKeyNotify (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  IN EFI_HANDLE                         NotificationHandle\r
  );\r
\r
/**\r
  Push one key data to the EFI key buffer.\r
\r
  @param Queue     Pointer to instance of EFI_KEY_QUEUE.\r
  @param KeyData   The key data to push.\r
**/\r
VOID\r
PushEfikeyBufTail (\r
  IN  EFI_KEY_QUEUE         *Queue,\r
  IN  EFI_KEY_DATA          *KeyData\r
  );\r
\r
/**\r
  Judge whether is a registed key\r
\r
  @param RegsiteredData       A pointer to a buffer that is filled in with the keystroke \r
                              state data for the key that was registered.\r
  @param InputData            A pointer to a buffer that is filled in with the keystroke \r
                              state data for the key that was pressed.\r
\r
  @retval TRUE                Key be pressed matches a registered key.\r
  @retval FLASE               Match failed. \r
  \r
**/\r
BOOLEAN\r
IsKeyRegistered (\r
  IN EFI_KEY_DATA  *RegsiteredData,\r
  IN EFI_KEY_DATA  *InputData\r
  );\r
#endif\r
Commit	Line	Data
f713c4fe	1	/** @file\r
f3d1e940	2	PS/2 keyboard driver header file\r
05fbd06d	3	\r
c220787b	4	Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
180a5a35	5	This program and the accompanying materials\r
df0dcb5e	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
05fbd06d	12	\r
	13	**/\r
	14	\r
f713c4fe	15	#ifndef _PS2KEYBOARD_H_\r
f713c4fe	16	#define _PS2KEYBOARD_H_\r
05fbd06d	17	\r
79bc7a89	18	#include <FrameworkDxe.h>\r
752f2e26	19	\r
752f2e26	20	#include <Protocol/SimpleTextIn.h>\r
f3d1e940	21	#include <Protocol/SimpleTextInEx.h>\r
752f2e26	22	#include <Protocol/IsaIo.h>\r
	23	#include <Protocol/DevicePath.h>\r
	24	#include <Protocol/Ps2Policy.h>\r
	25	\r
	26	#include <Library/UefiDriverEntryPoint.h>\r
	27	#include <Library/UefiLib.h>\r
	28	#include <Library/UefiBootServicesTableLib.h>\r
	29	#include <Library/ReportStatusCodeLib.h>\r
	30	#include <Library/DebugLib.h>\r
	31	#include <Library/UefiRuntimeServicesTableLib.h>\r
	32	#include <Library/MemoryAllocationLib.h>\r
f3d1e940	33	#include <Library/BaseLib.h>\r
f3d1e940	34	#include <Library/BaseMemoryLib.h>\r
b6763e03	35	#include <Library/TimerLib.h>\r
f6c014fb	36	#include <Library/PcdLib.h>\r
05fbd06d	37	\r
9f6531d1	38	//\r
	39	// Global Variables\r
	40	//\r
	41	extern EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver;\r
	42	extern EFI_COMPONENT_NAME_PROTOCOL gPs2KeyboardComponentName;\r
	43	extern EFI_COMPONENT_NAME2_PROTOCOL gPs2KeyboardComponentName2;\r
	44	\r
05fbd06d	45	//\r
	46	// Driver Private Data\r
	47	//\r
c220787b	48	#define KEYBOARD_CONSOLE_IN_DEV_SIGNATURE SIGNATURE_32 ('k', 'k', 'e', 'y')\r
f02bd376	49	#define KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('k', 'c', 'e', 'n')\r
f3d1e940	50	\r
f3d1e940	51	typedef struct _KEYBOARD_CONSOLE_IN_EX_NOTIFY {\r
c220787b RN	52	UINTN Signature;\r
	53	EFI_HANDLE NotifyHandle;\r
	54	EFI_KEY_DATA KeyData;\r
	55	EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn;\r
	56	LIST_ENTRY NotifyEntry;\r
f3d1e940	57	} KEYBOARD_CONSOLE_IN_EX_NOTIFY;\r
f3d1e940	58	\r
c220787b RN	59	#define KEYBOARD_SCAN_CODE_MAX_COUNT 32\r
	60	typedef struct {\r
	61	UINT8 Buffer[KEYBOARD_SCAN_CODE_MAX_COUNT];\r
	62	UINTN Head;\r
	63	UINTN Tail;\r
	64	} SCAN_CODE_QUEUE;\r
	65	\r
	66	#define KEYBOARD_EFI_KEY_MAX_COUNT 256\r
	67	typedef struct {\r
	68	EFI_KEY_DATA Buffer[KEYBOARD_EFI_KEY_MAX_COUNT];\r
	69	UINTN Head;\r
	70	UINTN Tail;\r
	71	} EFI_KEY_QUEUE;\r
05fbd06d	72	\r
	73	typedef struct {\r
	74	UINTN Signature;\r
	75	\r
	76	EFI_HANDLE Handle;\r
	77	EFI_SIMPLE_TEXT_INPUT_PROTOCOL ConIn;\r
f3d1e940	78	EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL ConInEx;\r
05fbd06d	79	EFI_ISA_IO_PROTOCOL *IsaIo;\r
	80	\r
	81	EFI_EVENT TimerEvent;\r
	82	\r
	83	UINT32 DataRegisterAddress;\r
	84	UINT32 StatusRegisterAddress;\r
	85	UINT32 CommandRegisterAddress;\r
	86	\r
f3d1e940	87	BOOLEAN LeftShift;\r
	88	BOOLEAN RightShift; \r
	89	BOOLEAN LeftLogo;\r
	90	BOOLEAN RightLogo;\r
	91	BOOLEAN Menu;\r
	92	BOOLEAN SysReq;\r
05fbd06d	93	\r
	94	BOOLEAN Ctrl;\r
	95	BOOLEAN Alt;\r
	96	BOOLEAN Shift;\r
	97	BOOLEAN CapsLock;\r
	98	BOOLEAN NumLock;\r
	99	BOOLEAN ScrollLock;\r
	100	\r
	101	//\r
c220787b	102	// Queue storing key scancodes\r
05fbd06d	103	//\r
c220787b RN	104	SCAN_CODE_QUEUE ScancodeQueue;\r
c220787b RN	105	EFI_KEY_QUEUE EfiKeyQueue;\r
05fbd06d	106	\r
	107	//\r
	108	// Error state\r
	109	//\r
	110	BOOLEAN KeyboardErr;\r
	111	\r
	112	EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
	113	\r
	114	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
f3d1e940	115	//\r
	116	// Notification Function List\r
	117	//\r
	118	LIST_ENTRY NotifyList;\r
05fbd06d	119	} KEYBOARD_CONSOLE_IN_DEV;\r
	120	\r
	121	#define KEYBOARD_CONSOLE_IN_DEV_FROM_THIS(a) CR (a, KEYBOARD_CONSOLE_IN_DEV, ConIn, KEYBOARD_CONSOLE_IN_DEV_SIGNATURE)\r
f3d1e940	122	#define TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS(a) \\r
	123	CR (a, \\r
	124	KEYBOARD_CONSOLE_IN_DEV, \\r
	125	ConInEx, \\r
	126	KEYBOARD_CONSOLE_IN_DEV_SIGNATURE \\r
	127	)\r
05fbd06d	128	\r
	129	#define TABLE_END 0x0\r
	130	\r
05fbd06d	131	//\r
	132	// Driver entry point\r
	133	//\r
bcd70414	134	/**\r
	135	The user Entry Point for module Ps2Keyboard. The user code starts with this function.\r
	136	\r
	137	@param[in] ImageHandle The firmware allocated handle for the EFI image. \r
	138	@param[in] SystemTable A pointer to the EFI System Table.\r
	139	\r
	140	@retval EFI_SUCCESS The entry point is executed successfully.\r
	141	@retval other Some error occurs when executing this entry point.\r
	142	\r
	143	**/\r
05fbd06d	144	EFI_STATUS\r
f3d1e940	145	EFIAPI\r
05fbd06d	146	InstallPs2KeyboardDriver (\r
	147	IN EFI_HANDLE ImageHandle,\r
	148	IN EFI_SYSTEM_TABLE *SystemTable\r
ed66e1bc	149	);\r
05fbd06d	150	\r
	151	#define KEYBOARD_8042_DATA_REGISTER 0x60\r
	152	#define KEYBOARD_8042_STATUS_REGISTER 0x64\r
	153	#define KEYBOARD_8042_COMMAND_REGISTER 0x64\r
	154	\r
	155	#define KEYBOARD_KBEN 0xF4\r
	156	#define KEYBOARD_CMDECHO_ACK 0xFA\r
	157	\r
05f89b17	158	#define KEYBOARD_MAX_TRY 256 // 256\r
05fbd06d	159	#define KEYBOARD_TIMEOUT 65536 // 0.07s\r
	160	#define KEYBOARD_WAITFORVALUE_TIMEOUT 1000000 // 1s\r
	161	#define KEYBOARD_BAT_TIMEOUT 4000000 // 4s\r
	162	#define KEYBOARD_TIMER_INTERVAL 200000 // 0.02s\r
	163	#define SCANCODE_EXTENDED 0xE0\r
	164	#define SCANCODE_EXTENDED1 0xE1\r
	165	#define SCANCODE_CTRL_MAKE 0x1D\r
	166	#define SCANCODE_CTRL_BREAK 0x9D\r
	167	#define SCANCODE_ALT_MAKE 0x38\r
	168	#define SCANCODE_ALT_BREAK 0xB8\r
	169	#define SCANCODE_LEFT_SHIFT_MAKE 0x2A\r
	170	#define SCANCODE_LEFT_SHIFT_BREAK 0xAA\r
	171	#define SCANCODE_RIGHT_SHIFT_MAKE 0x36\r
	172	#define SCANCODE_RIGHT_SHIFT_BREAK 0xB6\r
	173	#define SCANCODE_CAPS_LOCK_MAKE 0x3A\r
	174	#define SCANCODE_NUM_LOCK_MAKE 0x45\r
	175	#define SCANCODE_SCROLL_LOCK_MAKE 0x46\r
c220787b	176	#define SCANCODE_DELETE_MAKE 0x53\r
f3d1e940	177	#define SCANCODE_LEFT_LOGO_MAKE 0x5B //GUI key defined in Keyboard scan code\r
	178	#define SCANCODE_LEFT_LOGO_BREAK 0xDB\r
	179	#define SCANCODE_RIGHT_LOGO_MAKE 0x5C\r
	180	#define SCANCODE_RIGHT_LOGO_BREAK 0xDC\r
	181	#define SCANCODE_MENU_MAKE 0x5D //APPS key defined in Keyboard scan code \r
	182	#define SCANCODE_MENU_BREAK 0xDD\r
	183	#define SCANCODE_SYS_REQ_MAKE 0x37\r
	184	#define SCANCODE_MAX_MAKE 0x60\r
05fbd06d	185	\r
e8123186	186	#define SCANCODE_PAUSE_MAKE 0x1D45\r
e8123186	187	\r
b6763e03	188	#define KEYBOARD_STATUS_REGISTER_HAS_OUTPUT_DATA BIT0 ///< 0 - Output register has no data; 1 - Output register has data\r
	189	#define KEYBOARD_STATUS_REGISTER_HAS_INPUT_DATA BIT1 ///< 0 - Input register has no data; 1 - Input register has data\r
	190	#define KEYBOARD_STATUS_REGISTER_SYSTEM_FLAG BIT2 ///< Set to 0 after power on reset\r
	191	#define KEYBOARD_STATUS_REGISTER_INPUT_DATA_TYPE BIT3 ///< 0 - Data in input register is data; 1 - Data in input register is command\r
	192	#define KEYBOARD_STATUS_REGISTER_ENABLE_FLAG BIT4 ///< 0 - Keyboard is disable; 1 - Keyboard is enable\r
	193	#define KEYBOARD_STATUS_REGISTER_TRANSMIT_TIMEOUT BIT5 ///< 0 - Transmit is complete without timeout; 1 - Transmit is timeout without complete\r
	194	#define KEYBOARD_STATUS_REGISTER_RECEIVE_TIMEOUT BIT6 ///< 0 - Receive is complete without timeout; 1 - Receive is timeout without complete\r
	195	#define KEYBOARD_STATUS_REGISTER_PARITY BIT7 ///< 0 - Odd parity; 1 - Even parity\r
	196	\r
	197	#define KEYBOARD_8042_COMMAND_READ 0x20\r
	198	#define KEYBOARD_8042_COMMAND_WRITE 0x60\r
	199	#define KEYBOARD_8042_COMMAND_DISABLE_MOUSE_INTERFACE 0xA7\r
	200	#define KEYBOARD_8042_COMMAND_ENABLE_MOUSE_INTERFACE 0xA8\r
	201	#define KEYBOARD_8042_COMMAND_CONTROLLER_SELF_TEST 0xAA\r
	202	#define KEYBOARD_8042_COMMAND_KEYBOARD_INTERFACE_SELF_TEST 0xAB\r
	203	#define KEYBOARD_8042_COMMAND_DISABLE_KEYBOARD_INTERFACE 0xAD\r
	204	\r
	205	#define KEYBOARD_8048_COMMAND_CLEAR_OUTPUT_DATA 0xF4\r
	206	#define KEYBOARD_8048_COMMAND_RESET 0xFF\r
	207	#define KEYBOARD_8048_COMMAND_SELECT_SCAN_CODE_SET 0xF0\r
	208	\r
	209	#define KEYBOARD_8048_RETURN_8042_BAT_SUCCESS 0xAA\r
	210	#define KEYBOARD_8048_RETURN_8042_BAT_ERROR 0xFC\r
	211	#define KEYBOARD_8048_RETURN_8042_ACK 0xFA\r
	212	\r
	213	\r
007c18f5	214	//\r
	215	// Keyboard Controller Status\r
	216	//\r
	217	#define KBC_PARE 0x80 // Parity Error\r
	218	#define KBC_TIM 0x40 // General Time Out\r
	219	\r
05fbd06d	220	//\r
	221	// Other functions that are used among .c files\r
	222	//\r
bcd70414	223	/**\r
	224	Show keyboard status lights according to\r
	225	indicators in ConsoleIn.\r
	226	\r
	227	@param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
	228	\r
	229	@return status\r
f3d1e940	230	\r
bcd70414	231	**/\r
f3d1e940	232	EFI_STATUS\r
	233	UpdateStatusLights (\r
	234	IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
ed66e1bc	235	);\r
f3d1e940	236	\r
bcd70414	237	/**\r
f713c4fe	238	write key to keyboard.\r
f3d1e940	239	\r
bcd70414	240	@param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
bcd70414	241	@param Data value wanted to be written\r
f3d1e940	242	\r
bcd70414	243	@retval EFI_TIMEOUT - GC_TODO: Add description for return value\r
bcd70414	244	@retval EFI_SUCCESS - GC_TODO: Add description for return value\r
f3d1e940	245	\r
bcd70414	246	**/\r
05fbd06d	247	EFI_STATUS\r
	248	KeyboardRead (\r
	249	IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
	250	OUT UINT8 *Data\r
ed66e1bc	251	);\r
05fbd06d	252	\r
bcd70414	253	/**\r
c220787b	254	Get scancode from scancode buffer and translate into EFI-scancode and unicode defined by EFI spec.\r
05fbd06d	255	\r
c220787b	256	The function is always called in TPL_NOTIFY.\r
05fbd06d	257	\r
c220787b	258	@param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
05fbd06d	259	\r
bcd70414	260	**/\r
c220787b	261	VOID\r
05fbd06d	262	KeyGetchar (\r
05fbd06d	263	IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
ed66e1bc	264	);\r
05fbd06d	265	\r
bcd70414	266	/**\r
f713c4fe	267	Perform 8042 controller and keyboard Initialization.\r
bcd70414	268	If ExtendedVerification is TRUE, do additional test for\r
bcd70414	269	the keyboard interface\r
05fbd06d	270	\r
bcd70414	271	@param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
bcd70414	272	@param ExtendedVerification - indicates a thorough initialization\r
05fbd06d	273	\r
bcd70414	274	@retval EFI_DEVICE_ERROR Fail to init keyboard\r
	275	@retval EFI_SUCCESS Success to init keyboard\r
	276	**/\r
05fbd06d	277	EFI_STATUS\r
	278	InitKeyboard (\r
	279	IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
	280	IN BOOLEAN ExtendedVerification\r
ed66e1bc	281	);\r
05fbd06d	282	\r
bcd70414	283	/**\r
f713c4fe	284	Disable the keyboard interface of the 8042 controller.\r
05fbd06d	285	\r
bcd70414	286	@param ConsoleIn - the device instance\r
05fbd06d	287	\r
bcd70414	288	@return status of issuing disable command\r
05fbd06d	289	\r
bcd70414	290	**/\r
05fbd06d	291	EFI_STATUS\r
	292	DisableKeyboard (\r
	293	IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
ed66e1bc	294	);\r
05fbd06d	295	\r
bcd70414	296	/**\r
	297	Timer event handler: read a series of scancodes from 8042\r
	298	and put them into memory scancode buffer.\r
	299	it read as much scancodes to either fill\r
	300	the memory buffer or empty the keyboard buffer.\r
	301	It is registered as running under TPL_NOTIFY\r
05fbd06d	302	\r
bcd70414	303	@param Event - The timer event\r
bcd70414	304	@param Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r
05fbd06d	305	\r
bcd70414	306	**/\r
05fbd06d	307	VOID\r
	308	EFIAPI\r
	309	KeyboardTimerHandler (\r
	310	IN EFI_EVENT Event,\r
	311	IN VOID *Context\r
ed66e1bc	312	);\r
05fbd06d	313	\r
bcd70414	314	/**\r
	315	logic reset keyboard\r
	316	Implement SIMPLE_TEXT_IN.Reset()\r
	317	Perform 8042 controller and keyboard initialization\r
05fbd06d	318	\r
bcd70414	319	@param This Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
	320	@param ExtendedVerification Indicate that the driver may perform a more \r
	321	exhaustive verification operation of the device during \r
	322	reset, now this par is ignored in this driver \r
05fbd06d	323	\r
bcd70414	324	**/\r
05fbd06d	325	EFI_STATUS\r
	326	EFIAPI\r
	327	KeyboardEfiReset (\r
	328	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
	329	IN BOOLEAN ExtendedVerification\r
ed66e1bc	330	);\r
05fbd06d	331	\r
bcd70414	332	/**\r
	333	Implement SIMPLE_TEXT_IN.ReadKeyStroke().\r
	334	Retrieve key values for driver user.\r
05fbd06d	335	\r
bcd70414	336	@param This Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
bcd70414	337	@param Key The output buffer for key value \r
05fbd06d	338	\r
bcd70414	339	@retval EFI_SUCCESS success to read key stroke\r
bcd70414	340	**/\r
05fbd06d	341	EFI_STATUS\r
	342	EFIAPI\r
	343	KeyboardReadKeyStroke (\r
	344	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
	345	OUT EFI_INPUT_KEY *Key\r
ed66e1bc	346	);\r
05fbd06d	347	\r
bcd70414	348	/**\r
	349	Event notification function for SIMPLE_TEXT_IN.WaitForKey event\r
	350	Signal the event if there is key available\r
05fbd06d	351	\r
bcd70414	352	@param Event the event object\r
bcd70414	353	@param Context waitting context\r
05fbd06d	354	\r
bcd70414	355	**/\r
05fbd06d	356	VOID\r
	357	EFIAPI\r
	358	KeyboardWaitForKey (\r
	359	IN EFI_EVENT Event,\r
	360	IN VOID *Context\r
ed66e1bc	361	);\r
05fbd06d	362	\r
bcd70414	363	/**\r
f713c4fe	364	Read status register.\r
05fbd06d	365	\r
bcd70414	366	@param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
05fbd06d	367	\r
bcd70414	368	@return value in status register\r
05fbd06d	369	\r
bcd70414	370	**/\r
05fbd06d	371	UINT8\r
	372	KeyReadStatusRegister (\r
	373	IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
ed66e1bc	374	);\r
05fbd06d	375	\r
	376	/**\r
	377	Check whether there is Ps/2 Keyboard device in system by 0xF4 Keyboard Command\r
	378	If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device\r
	379	should not be in system.\r
	380	\r
f713c4fe	381	@param[in] ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
05fbd06d	382	\r
f3d1e940	383	@retval TRUE Keyboard in System.\r
f3d1e940	384	@retval FALSE Keyboard not in System.\r
05fbd06d	385	**/\r
	386	BOOLEAN\r
	387	EFIAPI\r
	388	CheckKeyboardConnect (\r
	389	IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
ed66e1bc	390	);\r
f3d1e940	391	\r
bcd70414	392	/**\r
	393	Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event\r
	394	Signal the event if there is key available\r
	395	\r
	396	@param Event event object\r
	397	@param Context waiting context\r
	398	\r
	399	**/\r
f3d1e940	400	VOID\r
	401	EFIAPI\r
	402	KeyboardWaitForKeyEx (\r
	403	IN EFI_EVENT Event,\r
	404	IN VOID *Context\r
ed66e1bc	405	); \r
f3d1e940	406	\r
	407	//\r
	408	// Simple Text Input Ex protocol function prototypes\r
	409	//\r
	410	\r
bcd70414	411	/**\r
	412	Reset the input device and optionaly run diagnostics\r
	413	\r
	414	@param This - Protocol instance pointer.\r
	415	@param ExtendedVerification - Driver may perform diagnostics on reset.\r
	416	\r
	417	@retval EFI_SUCCESS - The device was reset.\r
	418	@retval EFI_DEVICE_ERROR - The device is not functioning properly and could \r
	419	not be reset.\r
	420	\r
	421	**/\r
f3d1e940	422	EFI_STATUS\r
	423	EFIAPI\r
	424	KeyboardEfiResetEx (\r
	425	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
	426	IN BOOLEAN ExtendedVerification\r
ed66e1bc	427	);\r
f3d1e940	428	\r
bcd70414	429	/**\r
	430	Reads the next keystroke from the input device. The WaitForKey Event can \r
	431	be used to test for existance of a keystroke via WaitForEvent () call.\r
f3d1e940	432	\r
f3d1e940	433	\r
bcd70414	434	@param This - Protocol instance pointer.\r
	435	@param KeyData - A pointer to a buffer that is filled in with the keystroke \r
	436	state data for the key that was pressed.\r
f3d1e940	437	\r
bcd70414	438	@retval EFI_SUCCESS - The keystroke information was returned.\r
	439	@retval EFI_NOT_READY - There was no keystroke data availiable.\r
	440	@retval EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
	441	hardware errors.\r
	442	@retval EFI_INVALID_PARAMETER - KeyData is NULL. \r
f3d1e940	443	\r
bcd70414	444	**/\r
f3d1e940	445	EFI_STATUS\r
	446	EFIAPI\r
	447	KeyboardReadKeyStrokeEx (\r
	448	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
	449	OUT EFI_KEY_DATA *KeyData\r
ed66e1bc	450	);\r
f3d1e940	451	\r
bcd70414	452	/**\r
bcd70414	453	Set certain state for the input device.\r
f3d1e940	454	\r
bcd70414	455	@param This - Protocol instance pointer.\r
	456	@param KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
	457	state for the input device.\r
f3d1e940	458	\r
bcd70414	459	@retval EFI_SUCCESS - The device state was set successfully.\r
	460	@retval EFI_DEVICE_ERROR - The device is not functioning correctly and could \r
	461	not have the setting adjusted.\r
	462	@retval EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
	463	@retval EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r
f3d1e940	464	\r
bcd70414	465	**/\r
f3d1e940	466	EFI_STATUS\r
	467	EFIAPI\r
	468	KeyboardSetState (\r
	469	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
	470	IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
ed66e1bc	471	);\r
f3d1e940	472	\r
bcd70414	473	/**\r
	474	Register a notification function for a particular keystroke for the input device.\r
	475	\r
	476	@param This - Protocol instance pointer.\r
	477	@param KeyData - A pointer to a buffer that is filled in with the keystroke \r
	478	information data for the key that was pressed.\r
	479	@param KeyNotificationFunction - Points to the function to be called when the key \r
	480	sequence is typed specified by KeyData. \r
	481	@param NotifyHandle - Points to the unique handle assigned to the registered notification. \r
	482	\r
	483	@retval EFI_SUCCESS - The notification function was registered successfully.\r
	484	@retval EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
	485	@retval EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r
	486	\r
	487	**/ \r
f3d1e940	488	EFI_STATUS\r
	489	EFIAPI\r
	490	KeyboardRegisterKeyNotify (\r
	491	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
	492	IN EFI_KEY_DATA *KeyData,\r
	493	IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
	494	OUT EFI_HANDLE *NotifyHandle\r
ed66e1bc	495	);\r
f3d1e940	496	\r
bcd70414	497	/**\r
bcd70414	498	Remove a registered notification function from a particular keystroke.\r
f3d1e940	499	\r
bcd70414	500	@param This - Protocol instance pointer. \r
bcd70414	501	@param NotificationHandle - The handle of the notification function being unregistered.\r
f3d1e940	502	\r
bcd70414	503	\r
	504	@retval EFI_SUCCESS - The notification function was unregistered successfully.\r
	505	@retval EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
	506	@retval EFI_NOT_FOUND - Can not find the matching entry in database. \r
f3d1e940	507	\r
bcd70414	508	**/ \r
f3d1e940	509	EFI_STATUS\r
	510	EFIAPI\r
	511	KeyboardUnregisterKeyNotify (\r
	512	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
	513	IN EFI_HANDLE NotificationHandle\r
ed66e1bc	514	);\r
f3d1e940	515	\r
c220787b RN	516	/**\r
	517	Push one key data to the EFI key buffer.\r
	518	\r
	519	@param Queue Pointer to instance of EFI_KEY_QUEUE.\r
	520	@param KeyData The key data to push.\r
	521	**/\r
	522	VOID\r
	523	PushEfikeyBufTail (\r
	524	IN EFI_KEY_QUEUE *Queue,\r
	525	IN EFI_KEY_DATA *KeyData\r
	526	);\r
	527	\r
	528	/**\r
	529	Judge whether is a registed key\r
	530	\r
	531	@param RegsiteredData A pointer to a buffer that is filled in with the keystroke \r
	532	state data for the key that was registered.\r
	533	@param InputData A pointer to a buffer that is filled in with the keystroke \r
	534	state data for the key that was pressed.\r
	535	\r
	536	@retval TRUE Key be pressed matches a registered key.\r
	537	@retval FLASE Match failed. \r
	538	\r
	539	**/\r
	540	BOOLEAN\r
	541	IsKeyRegistered (\r
	542	IN EFI_KEY_DATA *RegsiteredData,\r
	543	IN EFI_KEY_DATA *InputData\r
	544	);\r
05fbd06d	545	#endif\r