1. Add Partial Keystroke Support in Ps2Kb drivers. See the Uefi2.3.1a chapter 11.2

2. Fix the bug of "In Ps2Keyboard the CAPs LOCK's LED should NOT be light when user press the SysReq key".
3. Fix the bug of "The PS2Keyboard driver outputs wrong EFI_INPUT_KEY value for PrintScr/SysRq keystroke"

Signed-off-by: qianouyang
Reviewed-by: niruiyu vanjeff




git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12495 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 155 insertions, 119 deletions

diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
index eb3c9338ce..a968a3b5f3 100644
--- a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
@@ -32,31 +32,9 @@ IsEfikeyBufEmpty (
   return (BOOLEAN) (Queue->Head == Queue->Tail);

 }

 

-

-

-/**

-  Push one key data to the EFI key buffer.

-

-  @param Queue     Pointer to instance of EFI_KEY_QUEUE.

-  @param KeyData   The key data to push.

-**/

-VOID

-PushEfikeyBufTail (

-  IN  EFI_KEY_QUEUE         *Queue,

-  IN  EFI_KEY_DATA          *KeyData

-  )

-{

-  if ((Queue->Tail + 1) % KEYBOARD_EFI_KEY_MAX_COUNT == Queue->Head) {

-    return;

-  }

-  

-  CopyMem (&Queue->Buffer[Queue->Tail], KeyData, sizeof (EFI_KEY_DATA));

-  Queue->Tail = (Queue->Tail + 1) % KEYBOARD_EFI_KEY_MAX_COUNT;

-}

-

 /**

   Read & remove one key data from the EFI key buffer.

-  

+

   @param Queue     Pointer to instance of EFI_KEY_QUEUE.

   @param KeyData   Receive the key data.

 

@@ -66,7 +44,7 @@ PushEfikeyBufTail (
 EFI_STATUS

 PopEfikeyBufHead (

   IN  EFI_KEY_QUEUE         *Queue,

-  OUT EFI_KEY_DATA          *KeyData

+  OUT EFI_KEY_DATA          *KeyData OPTIONAL

   )

 {

   if (IsEfikeyBufEmpty (Queue)) {

@@ -75,22 +53,46 @@ PopEfikeyBufHead (
   //

   // Retrieve and remove the values

   //

-  CopyMem (KeyData, &Queue->Buffer[Queue->Head], sizeof (EFI_KEY_DATA));

+  if (KeyData != NULL) {

+    CopyMem (KeyData, &Queue->Buffer[Queue->Head], sizeof (EFI_KEY_DATA));

+  }

   Queue->Head = (Queue->Head + 1) % KEYBOARD_EFI_KEY_MAX_COUNT;

   return EFI_SUCCESS;

 }

 

 /**

+  Push one key data to the EFI key buffer.

+

+  @param Queue     Pointer to instance of EFI_KEY_QUEUE.

+  @param KeyData   The key data to push.

+**/

+VOID

+PushEfikeyBufTail (

+  IN  EFI_KEY_QUEUE         *Queue,

+  IN  EFI_KEY_DATA          *KeyData

+  )

+{

+  if ((Queue->Tail + 1) % KEYBOARD_EFI_KEY_MAX_COUNT == Queue->Head) {

+    //

+    // If Queue is full, pop the one from head.

+    //

+    PopEfikeyBufHead (Queue, NULL);

+  }

+  CopyMem (&Queue->Buffer[Queue->Tail], KeyData, sizeof (EFI_KEY_DATA));

+  Queue->Tail = (Queue->Tail + 1) % KEYBOARD_EFI_KEY_MAX_COUNT;

+}

+

+/**

   Judge whether is a registed key

 

-  @param RegsiteredData       A pointer to a buffer that is filled in with the keystroke 

+  @param RegsiteredData       A pointer to a buffer that is filled in with the keystroke

                               state data for the key that was registered.

-  @param InputData            A pointer to a buffer that is filled in with the keystroke 

+  @param InputData            A pointer to a buffer that is filled in with the keystroke

                               state data for the key that was pressed.

 

   @retval TRUE                Key be pressed matches a registered key.

-  @retval FLASE               Match failed. 

-  

+  @retval FLASE               Match failed.

+

 **/

 BOOLEAN

 IsKeyRegistered (

@@ -100,42 +102,42 @@ IsKeyRegistered (
 

 {

   ASSERT (RegsiteredData != NULL && InputData != NULL);

-  

+

   if ((RegsiteredData->Key.ScanCode    != InputData->Key.ScanCode) ||

       (RegsiteredData->Key.UnicodeChar != InputData->Key.UnicodeChar)) {

-    return FALSE;  

-  }      

-  

+    return FALSE;

+  }

+

   //

   // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored.

   //

   if (RegsiteredData->KeyState.KeyShiftState != 0 &&

       RegsiteredData->KeyState.KeyShiftState != InputData->KeyState.KeyShiftState) {

-    return FALSE;    

-  }   

+    return FALSE;

+  }

   if (RegsiteredData->KeyState.KeyToggleState != 0 &&

       RegsiteredData->KeyState.KeyToggleState != InputData->KeyState.KeyToggleState) {

-    return FALSE;    

-  }     

-  

+    return FALSE;

+  }

+

   return TRUE;

 

 }

 

 /**

-    Reads the next keystroke from the input device. The WaitForKey Event can 

+    Reads the next keystroke from the input device. The WaitForKey Event can

     be used to test for existance of a keystroke via WaitForEvent () call.

-  

+

     @param ConsoleInDev          Ps2 Keyboard private structure

-    @param KeyData               A pointer to a buffer that is filled in with the keystroke 

+    @param KeyData               A pointer to a buffer that is filled in with the keystroke

                                  state data for the key that was pressed.

 

-  

+

     @retval EFI_SUCCESS             The keystroke information was returned.

     @retval EFI_NOT_READY           There was no keystroke data availiable.

-    @retval EFI_DEVICE_ERROR        The keystroke information was not returned due to 

+    @retval EFI_DEVICE_ERROR        The keystroke information was not returned due to

                                     hardware errors.

-    @retval EFI_INVALID_PARAMETER   KeyData is NULL.                        

+    @retval EFI_INVALID_PARAMETER   KeyData is NULL.

 

 **/

 EFI_STATUS

@@ -147,18 +149,18 @@ KeyboardReadKeyStrokeWorker (
 {

   EFI_STATUS                            Status;

   EFI_TPL                               OldTpl;

-  

+

   if (KeyData == NULL) {

     return EFI_INVALID_PARAMETER;

   }

-  

+

   //

   // Enter critical section

   //

   OldTpl = gBS->RaiseTPL (TPL_NOTIFY);

 

   KeyboardTimerHandler (NULL, ConsoleInDev);

-  

+

   if (ConsoleInDev->KeyboardErr) {

     Status = EFI_DEVICE_ERROR;

   } else {

@@ -173,9 +175,9 @@ KeyboardReadKeyStrokeWorker (
   Perform 8042 controller and keyboard initialization which implement SIMPLE_TEXT_IN.Reset()

 

   @param This                 Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL

-  @param ExtendedVerification Indicate that the driver may perform a more 

-                              exhaustive verification operation of the device during 

-                              reset, now this par is ignored in this driver    

+  @param ExtendedVerification Indicate that the driver may perform a more

+                              exhaustive verification operation of the device during

+                              reset, now this par is ignored in this driver

 

 **/

 EFI_STATUS

@@ -250,7 +252,7 @@ KeyboardEfiReset (
   Retrieve key values for driver user which implement SIMPLE_TEXT_IN.ReadKeyStroke().

 

   @param This    Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL

-  @param Key     The output buffer for key value 

+  @param Key     The output buffer for key value

 

   @retval EFI_SUCCESS success to read key stroke

 **/

@@ -266,14 +268,29 @@ KeyboardReadKeyStroke (
   EFI_KEY_DATA            KeyData;

 

   ConsoleIn = KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);

-  Status = KeyboardReadKeyStrokeWorker (ConsoleIn, &KeyData);

-  if (EFI_ERROR (Status)) {

-    return Status;

-  }

-

-  CopyMem (Key, &KeyData.Key, sizeof (EFI_INPUT_KEY));

-  return EFI_SUCCESS;

   

+  //

+  // Considering if the partial keystroke is enabled, there maybe a partial

+  // keystroke in the queue, so here skip the partial keystroke and get the

+  // next key from the queue

+  //

+  while (1) {

+    //

+    // If there is no pending key, then return.

+    //

+    Status = KeyboardReadKeyStrokeWorker (ConsoleIn, &KeyData);

+    if (EFI_ERROR (Status)) {

+      return Status;

+    }

+    //

+    // If it is partial keystroke, skip it.

+    //

+    if (KeyData.Key.ScanCode == SCAN_NULL && KeyData.Key.UnicodeChar == CHAR_NULL) {

+      continue;

+    }

+    CopyMem (Key, &KeyData.Key, sizeof (EFI_INPUT_KEY));

+    return EFI_SUCCESS;

+  }

 }

 

 /**

@@ -293,6 +310,7 @@ KeyboardWaitForKey (
 {

   EFI_TPL                     OldTpl;

   KEYBOARD_CONSOLE_IN_DEV     *ConsoleIn;

+  EFI_KEY_DATA                KeyData;

 

   ConsoleIn = (KEYBOARD_CONSOLE_IN_DEV *) Context;

 

@@ -300,16 +318,31 @@ KeyboardWaitForKey (
   // Enter critical section

   //

   OldTpl = gBS->RaiseTPL (TPL_NOTIFY);

-  

+

   KeyboardTimerHandler (NULL, ConsoleIn);

 

   if (!ConsoleIn->KeyboardErr) {

     //

-    // Someone is waiting on the keyboard event, if there's

-    // a key pending, signal the event

+    // WaitforKey doesn't suppor the partial key.

+    // Considering if the partial keystroke is enabled, there maybe a partial

+    // keystroke in the queue, so here skip the partial keystroke and get the

+    // next key from the queue

     //

-    if (!IsEfikeyBufEmpty (&ConsoleIn->EfiKeyQueue)) {

+    while (!IsEfikeyBufEmpty (&ConsoleIn->EfiKeyQueue)) {

+      CopyMem (

+        &KeyData,

+        &(ConsoleIn->EfiKeyQueue.Buffer[ConsoleIn->EfiKeyQueue.Head]),

+        sizeof (EFI_KEY_DATA)

+        );

+      if (KeyData.Key.ScanCode == SCAN_NULL && KeyData.Key.UnicodeChar == CHAR_NULL) {

+        PopEfikeyBufHead (&ConsoleIn->EfiKeyQueue, &KeyData);

+        continue;

+      }

+      //

+      // if there is pending value key, signal the event.

+      //

       gBS->SignalEvent (Event);

+      break;

     }

   }

   //

@@ -344,7 +377,7 @@ KeyboardWaitForKeyEx (
   @param ExtendedVerification     Driver may perform diagnostics on reset.

 

   @retval EFI_SUCCESS             The device was reset.

-  @retval EFI_DEVICE_ERROR        The device is not functioning properly and could 

+  @retval EFI_DEVICE_ERROR        The device is not functioning properly and could

                                   not be reset.

 

 **/

@@ -358,28 +391,28 @@ KeyboardEfiResetEx (
 {

   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;

 

-  ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This); 

+  ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);

 

   return ConsoleInDev->ConIn.Reset (

-                               &ConsoleInDev->ConIn, 

+                               &ConsoleInDev->ConIn,

                                ExtendedVerification

                                );

 }

 

 /**

-    Reads the next keystroke from the input device. The WaitForKey Event can 

+    Reads the next keystroke from the input device. The WaitForKey Event can

     be used to test for existance of a keystroke via WaitForEvent () call.

 

 

     @param This         Protocol instance pointer.

-    @param KeyData      A pointer to a buffer that is filled in with the keystroke 

+    @param KeyData      A pointer to a buffer that is filled in with the keystroke

                         state data for the key that was pressed.

 

     @retval EFI_SUCCESS           The keystroke information was returned.

     @retval EFI_NOT_READY         There was no keystroke data availiable.

-    @retval EFI_DEVICE_ERROR      The keystroke information was not returned due to 

+    @retval EFI_DEVICE_ERROR      The keystroke information was not returned due to

                                   hardware errors.

-    @retval EFI_INVALID_PARAMETER KeyData is NULL.                        

+    @retval EFI_INVALID_PARAMETER KeyData is NULL.

 

 **/

 EFI_STATUS

@@ -398,23 +431,22 @@ KeyboardReadKeyStrokeEx (
 

   ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);

   return KeyboardReadKeyStrokeWorker (ConsoleInDev, KeyData);

-  

 }

 

 /**

   Set certain state for the input device.

 

   @param This               Protocol instance pointer.

-  @param KeyToggleState     A pointer to the EFI_KEY_TOGGLE_STATE to set the 

+  @param KeyToggleState     A pointer to the EFI_KEY_TOGGLE_STATE to set the

                             state for the input device.

 

   @retval EFI_SUCCESS           The device state was set successfully.

-  @retval EFI_DEVICE_ERROR      The device is not functioning correctly and could 

+  @retval EFI_DEVICE_ERROR      The device is not functioning correctly and could

                                 not have the setting adjusted.

   @retval EFI_UNSUPPORTED       The device does not have the ability to set its state.

-  @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.                       

+  @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.

 

-**/   

+**/

 EFI_STATUS

 EFIAPI

 KeyboardSetState (

@@ -430,7 +462,7 @@ KeyboardSetState (
   if (KeyToggleState == NULL) {

     return EFI_INVALID_PARAMETER;

   }

-  

+

   ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);

 

   //

@@ -447,30 +479,34 @@ KeyboardSetState (
     Status = EFI_UNSUPPORTED;

     goto Exit;

   }

-  

+

   //

   // Update the status light

   //

-  ConsoleInDev->ScrollLock = FALSE;

-  ConsoleInDev->NumLock    = FALSE;

-  ConsoleInDev->CapsLock   = FALSE;

+  ConsoleInDev->ScrollLock          = FALSE;

+  ConsoleInDev->NumLock             = FALSE;

+  ConsoleInDev->CapsLock            = FALSE;

+  ConsoleInDev->IsSupportPartialKey = FALSE;

 

   if ((*KeyToggleState & EFI_SCROLL_LOCK_ACTIVE) == EFI_SCROLL_LOCK_ACTIVE) {

     ConsoleInDev->ScrollLock = TRUE;

-  } 

+  }

   if ((*KeyToggleState & EFI_NUM_LOCK_ACTIVE) == EFI_NUM_LOCK_ACTIVE) {

     ConsoleInDev->NumLock = TRUE;

   }

   if ((*KeyToggleState & EFI_CAPS_LOCK_ACTIVE) == EFI_CAPS_LOCK_ACTIVE) {

     ConsoleInDev->CapsLock = TRUE;

   }

+  if ((*KeyToggleState & EFI_KEY_STATE_EXPOSED) == EFI_KEY_STATE_EXPOSED) {

+    ConsoleInDev->IsSupportPartialKey = TRUE;

+  }

 

   Status = UpdateStatusLights (ConsoleInDev);

   if (EFI_ERROR (Status)) {

-    Status = EFI_DEVICE_ERROR;    

+    Status = EFI_DEVICE_ERROR;

   }

 

-Exit:   

+Exit:

   //

   // Leave critical section and return

   //

@@ -484,17 +520,17 @@ Exit:
     Register a notification function for a particular keystroke for the input device.

 

     @param This                       Protocol instance pointer.

-    @param KeyData                    A pointer to a buffer that is filled in with the keystroke 

+    @param KeyData                    A pointer to a buffer that is filled in with the keystroke

                                       information data for the key that was pressed.

-    @param KeyNotificationFunction    Points to the function to be called when the key 

-                                      sequence is typed specified by KeyData.                        

-    @param NotifyHandle               Points to the unique handle assigned to the registered notification.                          

+    @param KeyNotificationFunction    Points to the function to be called when the key

+                                      sequence is typed specified by KeyData.

+    @param NotifyHandle               Points to the unique handle assigned to the registered notification.

 

     @retval EFI_SUCCESS               The notification function was registered successfully.

     @retval EFI_OUT_OF_RESOURCES      Unable to allocate resources for necesssary data structures.

-    @retval EFI_INVALID_PARAMETER     KeyData or NotifyHandle or KeyNotificationFunction is NULL.                       

-                              

-**/   

+    @retval EFI_INVALID_PARAMETER     KeyData or NotifyHandle or KeyNotificationFunction is NULL.

+

+**/

 EFI_STATUS

 EFIAPI

 KeyboardRegisterKeyNotify (

@@ -508,13 +544,13 @@ KeyboardRegisterKeyNotify (
   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;

   EFI_TPL                               OldTpl;

   LIST_ENTRY                            *Link;

-  KEYBOARD_CONSOLE_IN_EX_NOTIFY         *CurrentNotify;  

+  KEYBOARD_CONSOLE_IN_EX_NOTIFY         *CurrentNotify;

   KEYBOARD_CONSOLE_IN_EX_NOTIFY         *NewNotify;

 

   if (KeyData == NULL || NotifyHandle == NULL || KeyNotificationFunction == NULL) {

     return EFI_INVALID_PARAMETER;

   }

-  

+

   ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);

 

   //

@@ -527,36 +563,36 @@ KeyboardRegisterKeyNotify (
   //

   for (Link = ConsoleInDev->NotifyList.ForwardLink; Link != &ConsoleInDev->NotifyList; Link = Link->ForwardLink) {

     CurrentNotify = CR (

-                      Link, 

-                      KEYBOARD_CONSOLE_IN_EX_NOTIFY, 

-                      NotifyEntry, 

+                      Link,

+                      KEYBOARD_CONSOLE_IN_EX_NOTIFY,

+                      NotifyEntry,

                       KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE

                       );

-    if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { 

+    if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {

       if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) {

-        *NotifyHandle = CurrentNotify->NotifyHandle;        

+        *NotifyHandle = CurrentNotify->NotifyHandle;

         Status = EFI_SUCCESS;

         goto Exit;

       }

     }

-  }    

-  

+  }

+

   //

   // Allocate resource to save the notification function

-  //  

+  //

   NewNotify = (KEYBOARD_CONSOLE_IN_EX_NOTIFY *) AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_EX_NOTIFY));

   if (NewNotify == NULL) {

     Status = EFI_OUT_OF_RESOURCES;

     goto Exit;

   }

 

-  NewNotify->Signature         = KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE;     

+  NewNotify->Signature         = KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE;

   NewNotify->KeyNotificationFn = KeyNotificationFunction;

   NewNotify->NotifyHandle      = (EFI_HANDLE) NewNotify;

   CopyMem (&NewNotify->KeyData, KeyData, sizeof (EFI_KEY_DATA));

   InsertTailList (&ConsoleInDev->NotifyList, &NewNotify->NotifyEntry);

 

-  *NotifyHandle                = NewNotify->NotifyHandle;  

+  *NotifyHandle                = NewNotify->NotifyHandle;

   Status                       = EFI_SUCCESS;

 

 Exit:

@@ -564,21 +600,21 @@ Exit:
   // Leave critical section and return

   //

   gBS->RestoreTPL (OldTpl);

-  return Status;  

+  return Status;

 

 }

 

 /**

     Remove a registered notification function from a particular keystroke.

 

-    @param This                       Protocol instance pointer.    

+    @param This                       Protocol instance pointer.

     @param NotificationHandle         The handle of the notification function being unregistered.

 

-  

+

     @retval EFI_SUCCESS               The notification function was unregistered successfully.

     @retval EFI_INVALID_PARAMETER     The NotificationHandle is invalid.

-                              

-**/   

+

+**/

 EFI_STATUS

 EFIAPI

 KeyboardUnregisterKeyNotify (

@@ -590,37 +626,37 @@ KeyboardUnregisterKeyNotify (
   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;

   EFI_TPL                               OldTpl;

   LIST_ENTRY                            *Link;

-  KEYBOARD_CONSOLE_IN_EX_NOTIFY         *CurrentNotify;    

+  KEYBOARD_CONSOLE_IN_EX_NOTIFY         *CurrentNotify;

 

   if (NotificationHandle == NULL) {

     return EFI_INVALID_PARAMETER;

-  } 

+  }

 

   if (((KEYBOARD_CONSOLE_IN_EX_NOTIFY *) NotificationHandle)->Signature != KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE) {

     return EFI_INVALID_PARAMETER;

-  } 

-   

+  }

+

   ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);

-  

+

   //

   // Enter critical section

   //

-  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);  

+  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);

 

   for (Link = ConsoleInDev->NotifyList.ForwardLink; Link != &ConsoleInDev->NotifyList; Link = Link->ForwardLink) {

     CurrentNotify = CR (

-                      Link, 

-                      KEYBOARD_CONSOLE_IN_EX_NOTIFY, 

-                      NotifyEntry, 

+                      Link,

+                      KEYBOARD_CONSOLE_IN_EX_NOTIFY,

+                      NotifyEntry,

                       KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE

-                      );       

+                      );

     if (CurrentNotify->NotifyHandle == NotificationHandle) {

       //

       // Remove the notification function from NotifyList and free resources

       //

-      RemoveEntryList (&CurrentNotify->NotifyEntry);      

- 

-      gBS->FreePool (CurrentNotify);            

+      RemoveEntryList (&CurrentNotify->NotifyEntry);

+

+      gBS->FreePool (CurrentNotify);

       Status = EFI_SUCCESS;

       goto Exit;

     }