Fix NT32 Keyboard driver to call hotkey callback even no one is calling ReadKeyStroke().

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11561 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
niruiyu 2011-04-19 06:46:55 +00:00
parent 7eb2c64d34
commit 66fe714632
3 changed files with 211 additions and 105 deletions

View File

@ -1,6 +1,6 @@
/** @file /** @file
Copyright (c) 2006, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -57,14 +57,15 @@ Abstract:
#define GOP_EXTENDED_KEY (0x1 << 24) #define GOP_EXTENDED_KEY (0x1 << 24)
#define GOP_ALT_KEY_PRESSED (0x1 << 29) #define GOP_ALT_KEY_PRESSED (0x1 << 29)
#define KEYBOARD_TIMER_INTERVAL 200000 // 0.02s
#define MAX_Q 256 #define MAX_Q 256
typedef struct { typedef struct {
UINTN Front; UINTN Front;
UINTN Rear; UINTN Rear;
UINTN Count; EFI_KEY_DATA Q[MAX_Q];
EFI_INPUT_KEY Q[MAX_Q]; CRITICAL_SECTION Cs;
} GOP_QUEUE_FIXED; } GOP_QUEUE_FIXED;
#define WIN_NT_GOP_CLASS_NAME L"WinNtGopWindow" #define WIN_NT_GOP_CLASS_NAME L"WinNtGopWindow"
@ -131,11 +132,12 @@ typedef struct {
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *FillLine; EFI_GRAPHICS_OUTPUT_BLT_PIXEL *FillLine;
// //
// Keyboard Queue used by Simple Text In. WinProc thread adds, and main // Keyboard Queue used by Simple Text In.
// thread removes. // QueueForRead: WinProc thread adds, and main thread removes.
// QueueForNotify: WinProc thread adds, and timer thread removes.
// //
CRITICAL_SECTION QCriticalSection; GOP_QUEUE_FIXED QueueForRead;
GOP_QUEUE_FIXED Queue; GOP_QUEUE_FIXED QueueForNotify;
EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleTextInEx; EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleTextInEx;
EFI_KEY_STATE KeyState; EFI_KEY_STATE KeyState;
@ -152,7 +154,8 @@ typedef struct {
BOOLEAN SysReq; BOOLEAN SysReq;
BOOLEAN NumLock; BOOLEAN NumLock;
BOOLEAN ScrollLock; BOOLEAN ScrollLock;
BOOLEAN CapsLock; BOOLEAN CapsLock;
EFI_EVENT TimerEvent;
} GOP_PRIVATE_DATA; } GOP_PRIVATE_DATA;
#define GOP_PRIVATE_DATA_FROM_THIS(a) \ #define GOP_PRIVATE_DATA_FROM_THIS(a) \
@ -308,7 +311,7 @@ WinNtGopDriverBindingStop (
**/ **/
EFI_STATUS EFI_STATUS
GopPrivateAddQ ( GopPrivateAddKey (
IN GOP_PRIVATE_DATA *Private, IN GOP_PRIVATE_DATA *Private,
IN EFI_INPUT_KEY Key IN EFI_INPUT_KEY Key
); );

View File

@ -1,6 +1,6 @@
/** @file /** @file
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -42,14 +42,13 @@ Abstract:
**/ **/
EFI_STATUS EFI_STATUS
GopPrivateCreateQ ( GopPrivateCreateQ (
IN GOP_PRIVATE_DATA *Private IN GOP_PRIVATE_DATA *Private,
IN GOP_QUEUE_FIXED *Queue
) )
{ {
Private->WinNtThunk->InitializeCriticalSection (&Private->QCriticalSection); Private->WinNtThunk->InitializeCriticalSection (&Queue->Cs);
Queue->Front = 0;
Private->Queue.Front = 0; Queue->Rear = 0;
Private->Queue.Rear = MAX_Q - 1;
Private->Queue.Count = 0;
return EFI_SUCCESS; return EFI_SUCCESS;
} }
@ -64,11 +63,13 @@ GopPrivateCreateQ (
**/ **/
EFI_STATUS EFI_STATUS
GopPrivateDestroyQ ( GopPrivateDestroyQ (
IN GOP_PRIVATE_DATA *Private IN GOP_PRIVATE_DATA *Private,
IN GOP_QUEUE_FIXED *Queue
) )
{ {
Private->Queue.Count = 0; Queue->Front = 0;
Private->WinNtThunk->DeleteCriticalSection (&Private->QCriticalSection); Queue->Rear = 0;
Private->WinNtThunk->DeleteCriticalSection (&Queue->Cs);
return EFI_SUCCESS; return EFI_SUCCESS;
} }
@ -85,22 +86,22 @@ GopPrivateDestroyQ (
**/ **/
EFI_STATUS EFI_STATUS
GopPrivateAddQ ( GopPrivateAddQ (
IN GOP_PRIVATE_DATA *Private, IN GOP_PRIVATE_DATA *Private,
IN EFI_INPUT_KEY Key IN GOP_QUEUE_FIXED *Queue,
IN EFI_KEY_DATA *KeyData
) )
{ {
Private->WinNtThunk->EnterCriticalSection (&Private->QCriticalSection); Private->WinNtThunk->EnterCriticalSection (&Queue->Cs);
if (Private->Queue.Count == MAX_Q) { if ((Queue->Rear + 1) % MAX_Q == Queue->Front) {
Private->WinNtThunk->LeaveCriticalSection (&Private->QCriticalSection); Private->WinNtThunk->LeaveCriticalSection (&Queue->Cs);
return EFI_NOT_READY; return EFI_NOT_READY;
} }
Private->Queue.Rear = (Private->Queue.Rear + 1) % MAX_Q; CopyMem (&Queue->Q[Queue->Rear], KeyData, sizeof (EFI_KEY_DATA));
Private->Queue.Q[Private->Queue.Rear] = Key; Queue->Rear = (Queue->Rear + 1) % MAX_Q;
Private->Queue.Count++;
Private->WinNtThunk->LeaveCriticalSection (&Private->QCriticalSection); Private->WinNtThunk->LeaveCriticalSection (&Queue->Cs);
return EFI_SUCCESS; return EFI_SUCCESS;
} }
@ -118,21 +119,21 @@ GopPrivateAddQ (
EFI_STATUS EFI_STATUS
GopPrivateDeleteQ ( GopPrivateDeleteQ (
IN GOP_PRIVATE_DATA *Private, IN GOP_PRIVATE_DATA *Private,
OUT EFI_INPUT_KEY *Key IN GOP_QUEUE_FIXED *Queue,
OUT EFI_KEY_DATA *Key
) )
{ {
Private->WinNtThunk->EnterCriticalSection (&Private->QCriticalSection); Private->WinNtThunk->EnterCriticalSection (&Queue->Cs);
if (Private->Queue.Count == 0) { if (Queue->Front == Queue->Rear) {
Private->WinNtThunk->LeaveCriticalSection (&Private->QCriticalSection); Private->WinNtThunk->LeaveCriticalSection (&Queue->Cs);
return EFI_NOT_READY; return EFI_NOT_READY;
} }
*Key = Private->Queue.Q[Private->Queue.Front]; CopyMem (Key, &Queue->Q[Queue->Front], sizeof (EFI_KEY_DATA));
Private->Queue.Front = (Private->Queue.Front + 1) % MAX_Q; Queue->Front = (Queue->Front + 1) % MAX_Q;
Private->Queue.Count--;
Private->WinNtThunk->LeaveCriticalSection (&Private->QCriticalSection); Private->WinNtThunk->LeaveCriticalSection (&Queue->Cs);
return EFI_SUCCESS; return EFI_SUCCESS;
} }
@ -148,10 +149,10 @@ GopPrivateDeleteQ (
**/ **/
EFI_STATUS EFI_STATUS
GopPrivateCheckQ ( GopPrivateCheckQ (
IN GOP_PRIVATE_DATA *Private IN GOP_QUEUE_FIXED *Queue
) )
{ {
if (Private->Queue.Count == 0) { if (Queue->Front == Queue->Rear) {
return EFI_NOT_READY; return EFI_NOT_READY;
} }
@ -237,12 +238,130 @@ Returns:
NotifyEntry, NotifyEntry,
WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE
); );
if (GopPrivateIsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { if (GopPrivateIsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {
CurrentNotify->KeyNotificationFn (KeyData); CurrentNotify->KeyNotificationFn (KeyData);
} }
} }
} }
VOID
WinNtGopSimpleTextInTimerHandler (
IN EFI_EVENT Event,
IN GOP_PRIVATE_DATA *Private
)
{
EFI_KEY_DATA KeyData;
while (GopPrivateDeleteQ (Private, &Private->QueueForNotify, &KeyData) == EFI_SUCCESS) {
GopPrivateInvokeRegisteredFunction (Private, &KeyData);
}
}
/**
TODO: Add function description
@param Private TODO: add argument description
@param Key TODO: add argument description
@retval EFI_NOT_READY TODO: Add description for return value
@retval EFI_SUCCESS TODO: Add description for return value
**/
EFI_STATUS
GopPrivateAddKey (
IN GOP_PRIVATE_DATA *Private,
IN EFI_INPUT_KEY Key
)
{
EFI_KEY_DATA KeyData;
KeyData.Key = Key;
KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID;
KeyData.KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID;
//
// Record Key shift state and toggle state
//
if (Private->LeftCtrl) {
KeyData.KeyState.KeyShiftState |= EFI_LEFT_CONTROL_PRESSED;
}
if (Private->RightCtrl) {
KeyData.KeyState.KeyShiftState |= EFI_RIGHT_CONTROL_PRESSED;
}
if (Private->LeftAlt) {
KeyData.KeyState.KeyShiftState |= EFI_LEFT_ALT_PRESSED;
}
if (Private->RightAlt) {
KeyData.KeyState.KeyShiftState |= EFI_RIGHT_ALT_PRESSED;
}
if (Private->LeftShift) {
KeyData.KeyState.KeyShiftState |= EFI_LEFT_SHIFT_PRESSED;
}
if (Private->RightShift) {
KeyData.KeyState.KeyShiftState |= EFI_RIGHT_SHIFT_PRESSED;
}
if (Private->LeftLogo) {
KeyData.KeyState.KeyShiftState |= EFI_LEFT_LOGO_PRESSED;
}
if (Private->RightLogo) {
KeyData.KeyState.KeyShiftState |= EFI_RIGHT_LOGO_PRESSED;
}
if (Private->Menu) {
KeyData.KeyState.KeyShiftState |= EFI_MENU_KEY_PRESSED;
}
if (Private->SysReq) {
KeyData.KeyState.KeyShiftState |= EFI_SYS_REQ_PRESSED;
}
if (Private->CapsLock) {
KeyData.KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;
}
if (Private->NumLock) {
KeyData.KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;
}
if (Private->ScrollLock) {
KeyData.KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;
}
//
// Convert Ctrl+[1-26] to Ctrl+[A-Z]
//
if ((Private->LeftCtrl || Private->RightCtrl) &&
(KeyData.Key.UnicodeChar >= 1) && (KeyData.Key.UnicodeChar <= 26)
) {
if ((Private->LeftShift || Private->RightShift) == Private->CapsLock) {
KeyData.Key.UnicodeChar = KeyData.Key.UnicodeChar + L'a' - 1;
} else {
KeyData.Key.UnicodeChar = KeyData.Key.UnicodeChar + L'A' - 1;
}
}
//
// Unmask the Shift bit for printable char
//
if (((KeyData.Key.UnicodeChar >= L'a') && (KeyData.Key.UnicodeChar <= L'z')) ||
((KeyData.Key.UnicodeChar >= L'A') && (KeyData.Key.UnicodeChar <= L'Z'))
) {
KeyData.KeyState.KeyShiftState &= ~(EFI_LEFT_SHIFT_PRESSED | EFI_RIGHT_SHIFT_PRESSED);
}
GopPrivateAddQ (Private, &Private->QueueForNotify, &KeyData);
//
// Convert Ctrl+[A-Z] to Ctrl+[1-26]
//
if (Private->LeftCtrl || Private->RightCtrl) {
if ((KeyData.Key.UnicodeChar >= L'a') && (KeyData.Key.UnicodeChar <= L'z')) {
KeyData.Key.UnicodeChar = KeyData.Key.UnicodeChar - L'a' + 1;
} else if ((KeyData.Key.UnicodeChar >= L'A') && (KeyData.Key.UnicodeChar <= L'Z')) {
KeyData.Key.UnicodeChar = KeyData.Key.UnicodeChar - L'A' + 1;
}
}
GopPrivateAddQ (Private, &Private->QueueForRead, &KeyData);
return EFI_SUCCESS;
}
EFI_STATUS EFI_STATUS
GopPrivateUpdateStatusLight ( GopPrivateUpdateStatusLight (
IN GOP_PRIVATE_DATA *Private IN GOP_PRIVATE_DATA *Private
@ -294,7 +413,7 @@ Returns:
--*/ --*/
{ {
EFI_INPUT_KEY Key; EFI_KEY_DATA KeyData;
EFI_TPL OldTpl; EFI_TPL OldTpl;
// //
@ -305,7 +424,9 @@ Returns:
// //
// A reset is draining the Queue // A reset is draining the Queue
// //
while (GopPrivateDeleteQ (Private, &Key) == EFI_SUCCESS) while (GopPrivateDeleteQ (Private, &Private->QueueForRead, &KeyData) == EFI_SUCCESS)
;
while (GopPrivateDeleteQ (Private, &Private->QueueForNotify, &KeyData) == EFI_SUCCESS)
; ;
Private->LeftShift = FALSE; Private->LeftShift = FALSE;
@ -371,69 +492,22 @@ GopPrivateReadKeyStrokeWorker (
// //
OldTpl = gBS->RaiseTPL (TPL_NOTIFY); OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
Status = GopPrivateCheckQ (Private); //
// Call hot key callback before telling caller there is a key available
//
WinNtGopSimpleTextInTimerHandler (NULL, Private);
Status = GopPrivateCheckQ (&Private->QueueForRead);
if (!EFI_ERROR (Status)) { if (!EFI_ERROR (Status)) {
// //
// If a Key press exists try and read it. // If a Key press exists try and read it.
// //
Status = GopPrivateDeleteQ (Private, &KeyData->Key); Status = GopPrivateDeleteQ (Private, &Private->QueueForRead, KeyData);
if (!EFI_ERROR (Status)) { if (!EFI_ERROR (Status)) {
//
// Record Key shift state and toggle state
//
if (Private->LeftCtrl) {
Private->KeyState.KeyShiftState |= EFI_LEFT_CONTROL_PRESSED;
}
if (Private->RightCtrl) {
Private->KeyState.KeyShiftState |= EFI_RIGHT_CONTROL_PRESSED;
}
if (Private->LeftAlt) {
Private->KeyState.KeyShiftState |= EFI_LEFT_ALT_PRESSED;
}
if (Private->RightAlt) {
Private->KeyState.KeyShiftState |= EFI_RIGHT_ALT_PRESSED;
}
if (Private->LeftShift) {
Private->KeyState.KeyShiftState |= EFI_LEFT_SHIFT_PRESSED;
}
if (Private->RightShift) {
Private->KeyState.KeyShiftState |= EFI_RIGHT_SHIFT_PRESSED;
}
if (Private->LeftLogo) {
Private->KeyState.KeyShiftState |= EFI_LEFT_LOGO_PRESSED;
}
if (Private->RightLogo) {
Private->KeyState.KeyShiftState |= EFI_RIGHT_LOGO_PRESSED;
}
if (Private->Menu) {
Private->KeyState.KeyShiftState |= EFI_MENU_KEY_PRESSED;
}
if (Private->SysReq) {
Private->KeyState.KeyShiftState |= EFI_SYS_REQ_PRESSED;
}
if (Private->CapsLock) {
Private->KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;
}
if (Private->NumLock) {
Private->KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;
}
if (Private->ScrollLock) {
Private->KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;
}
KeyData->KeyState.KeyShiftState = Private->KeyState.KeyShiftState;
KeyData->KeyState.KeyToggleState = Private->KeyState.KeyToggleState;
Private->KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID;
Private->KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID;
// //
// Leave critical section and return // Leave critical section and return
// //
gBS->RestoreTPL (OldTpl); gBS->RestoreTPL (OldTpl);
GopPrivateInvokeRegisteredFunction (Private, KeyData);
return EFI_SUCCESS; return EFI_SUCCESS;
} }
} }
@ -536,8 +610,13 @@ WinNtGopSimpleTextInWaitForKey (
// Enter critical section // Enter critical section
// //
OldTpl = gBS->RaiseTPL (TPL_NOTIFY); OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
//
// Call hot key callback before telling caller there is a key available
//
WinNtGopSimpleTextInTimerHandler (NULL, Private);
Status = GopPrivateCheckQ (Private); Status = GopPrivateCheckQ (&Private->QueueForRead);
if (!EFI_ERROR (Status)) { if (!EFI_ERROR (Status)) {
// //
// If a there is a key in the queue signal our event. // If a there is a key in the queue signal our event.
@ -827,6 +906,7 @@ WinNtGopSimpleTextInExUnregisterKeyNotify (
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
/** /**
TODO: Add function description TODO: Add function description
@ -842,7 +922,8 @@ WinNtGopInitializeSimpleTextInForWindow (
{ {
EFI_STATUS Status; EFI_STATUS Status;
GopPrivateCreateQ (Private); GopPrivateCreateQ (Private, &Private->QueueForRead);
GopPrivateCreateQ (Private, &Private->QueueForNotify);
// //
// Initialize Simple Text In protoocol // Initialize Simple Text In protoocol
@ -878,6 +959,24 @@ WinNtGopInitializeSimpleTextInForWindow (
); );
ASSERT_EFI_ERROR (Status); ASSERT_EFI_ERROR (Status);
//
// Create the Timer to trigger hot key notifications
//
Status = gBS->CreateEvent (
EVT_TIMER | EVT_NOTIFY_SIGNAL,
TPL_NOTIFY,
WinNtGopSimpleTextInTimerHandler,
Private,
&Private->TimerEvent
);
ASSERT_EFI_ERROR (Status);
Status = gBS->SetTimer (
Private->TimerEvent,
TimerPeriodic,
KEYBOARD_TIMER_INTERVAL
);
ASSERT_EFI_ERROR (Status);
return Status; return Status;
} }
@ -897,6 +996,10 @@ WinNtGopDestroySimpleTextInForWindow (
IN GOP_PRIVATE_DATA *Private IN GOP_PRIVATE_DATA *Private
) )
{ {
GopPrivateDestroyQ (Private); gBS->CloseEvent (Private->TimerEvent);
GopPrivateDestroyQ (Private, &Private->QueueForRead);
GopPrivateDestroyQ (Private, &Private->QueueForNotify);
return EFI_SUCCESS; return EFI_SUCCESS;
} }

View File

@ -1,6 +1,6 @@
/** @file /** @file
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -697,7 +697,7 @@ WinNtGopThreadWindowProc (
case VK_F10: case VK_F10:
Key.ScanCode = SCAN_F10; Key.ScanCode = SCAN_F10;
Key.UnicodeChar = 0; Key.UnicodeChar = 0;
GopPrivateAddQ (Private, Key); GopPrivateAddKey (Private, Key);
return 0; return 0;
} }
@ -720,7 +720,7 @@ WinNtGopThreadWindowProc (
if (Key.ScanCode != 0) { if (Key.ScanCode != 0) {
Key.UnicodeChar = 0; Key.UnicodeChar = 0;
GopPrivateAddQ (Private, Key); GopPrivateAddKey (Private, Key);
} }
return 0; return 0;
@ -749,7 +749,7 @@ WinNtGopThreadWindowProc (
WinNtGopConvertParamToEfiKey (Private, &wParam, &Key); WinNtGopConvertParamToEfiKey (Private, &wParam, &Key);
if (Key.ScanCode != 0) { if (Key.ScanCode != 0) {
Key.UnicodeChar = 0; Key.UnicodeChar = 0;
GopPrivateAddQ (Private, Key); GopPrivateAddKey (Private, Key);
} }
return 0; return 0;
@ -770,7 +770,7 @@ WinNtGopThreadWindowProc (
if (wParam != 0) { if (wParam != 0) {
Key.UnicodeChar = (CHAR16) wParam; Key.UnicodeChar = (CHAR16) wParam;
Key.ScanCode = 0; Key.ScanCode = 0;
GopPrivateAddQ (Private, Key); GopPrivateAddKey (Private, Key);
} }
} }