]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
Fix Ps2KeyboardDxe driver to return correct key data when Shift/Ctrl/Alt and PrtSc...
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2KeyboardDxe / Ps2Keyboard.h
index 55b56a10451a2f6df826a1bcc457073f12460e31..deeb59b95182e46876c7feaea9cf48cff236103a 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   PS/2 keyboard driver header file\r
 \r
-Copyright (c) 2006 - 2009, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\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
@@ -15,8 +15,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef _PS2KEYBOARD_H_\r
 #define _PS2KEYBOARD_H_\r
 \r
-#include <PiDxe.h>\r
-#include <Framework/StatusCode.h>\r
+#include <FrameworkDxe.h>\r
 \r
 #include <Protocol/SimpleTextIn.h>\r
 #include <Protocol/SimpleTextInEx.h>\r
@@ -34,6 +33,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #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
@@ -45,18 +45,30 @@ extern EFI_COMPONENT_NAME2_PROTOCOL  gPs2KeyboardComponentName2;
 //\r
 // Driver Private Data\r
 //\r
-#define KEYBOARD_BUFFER_MAX_COUNT         32\r
-#define KEYBOARD_CONSOLE_IN_DEV_SIGNATURE SIGNATURE_32 ('k', 'k', 'e', 'y')\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
+  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
@@ -72,9 +84,10 @@ typedef struct {
   UINT32                              StatusRegisterAddress;\r
   UINT32                              CommandRegisterAddress;\r
 \r
-  EFI_INPUT_KEY                       Key;\r
-  EFI_KEY_STATE                       KeyState;\r
-\r
+  BOOLEAN                             LeftCtrl;\r
+  BOOLEAN                             RightCtrl;\r
+  BOOLEAN                             LeftAlt;\r
+  BOOLEAN                             RightAlt;\r
   BOOLEAN                             LeftShift;\r
   BOOLEAN                             RightShift;  \r
   BOOLEAN                             LeftLogo;\r
@@ -82,26 +95,15 @@ typedef struct {
   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
-  // Buffer storing key scancodes\r
-  //\r
-  UINT8                               ScancodeBuf[KEYBOARD_BUFFER_MAX_COUNT];\r
-  UINT32                              ScancodeBufStartPos;\r
-  UINT32                              ScancodeBufEndPos;\r
-  UINT32                              ScancodeBufCount;\r
-\r
-  //\r
-  // Indicators of the key pressing state, used in detecting Alt+Ctrl+Del\r
+  // Queue storing key scancodes\r
   //\r
-  BOOLEAN                             Ctrled;\r
-  BOOLEAN                             Alted;\r
+  SCAN_CODE_QUEUE                     ScancodeQueue;\r
+  EFI_KEY_QUEUE                       EfiKeyQueue;\r
 \r
   //\r
   // Error state\r
@@ -159,7 +161,7 @@ InstallPs2KeyboardDriver (
 #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_EXTENDED0              0xE0\r
 #define SCANCODE_EXTENDED1              0xE1\r
 #define SCANCODE_CTRL_MAKE              0x1D\r
 #define SCANCODE_CTRL_BREAK             0x9D\r
@@ -172,6 +174,7 @@ InstallPs2KeyboardDriver (
 #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
@@ -179,8 +182,13 @@ InstallPs2KeyboardDriver (
 #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_SYS_REQ_BREAK          0xB7\r
+#define SCANCODE_SYS_REQ_MAKE_WITH_ALT  0x54\r
+#define SCANCODE_SYS_REQ_BREAK_WITH_ALT 0xD4\r
+\r
 #define SCANCODE_MAX_MAKE               0x60\r
 \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
@@ -247,17 +255,14 @@ KeyboardRead (
   );\r
 \r
 /**\r
-  Get scancode from scancode buffer\r
-  and translate into EFI-scancode and unicode defined by EFI spec\r
-  The function is always called in TPL_NOTIFY\r
+  Get scancode from scancode buffer and translate into EFI-scancode and unicode defined by EFI spec.\r
 \r
-  @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
+  The function is always called in TPL_NOTIFY.\r
 \r
-  @retval EFI_NOT_READY - Input from console not ready yet.\r
-  @retval EFI_SUCCESS   - Function executed successfully.\r
+  @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
 \r
 **/\r
-EFI_STATUS\r
+VOID\r
 KeyGetchar (\r
   IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
   );\r
@@ -512,4 +517,33 @@ KeyboardUnregisterKeyNotify (
   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