[mirror_edk2.git] / MdeModulePkg / Bus / Isa / Ps2KeyboardDxe / Ps2KbdTextIn.c

/** @file\r
  Routines implements SIMPLE_TEXT_IN protocol's interfaces based on 8042 interfaces\r
  provided by Ps2KbdCtrller.c.\r
\r
Copyright (c) 2006 - 2018, 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
\r
#include "Ps2Keyboard.h"\r
\r
/**\r
  Check whether the EFI key buffer is empty.\r
\r
  @param Queue     Pointer to instance of EFI_KEY_QUEUE.\r
\r
  @retval TRUE    The EFI key buffer is empty.\r
  @retval FALSE   The EFI key buffer isn't empty.\r
**/\r
BOOLEAN\r
IsEfikeyBufEmpty (\r
  IN  EFI_KEY_QUEUE         *Queue\r
  )\r
{\r
  return (BOOLEAN) (Queue->Head == Queue->Tail);\r
}\r
\r
/**\r
  Read & remove one key data from the EFI key buffer.\r
\r
  @param Queue     Pointer to instance of EFI_KEY_QUEUE.\r
  @param KeyData   Receive the key data.\r
\r
  @retval EFI_SUCCESS   The key data is popped successfully.\r
  @retval EFI_NOT_READY There is no key data available.\r
**/\r
EFI_STATUS\r
PopEfikeyBufHead (\r
  IN  EFI_KEY_QUEUE         *Queue,\r
  OUT EFI_KEY_DATA          *KeyData OPTIONAL\r
  )\r
{\r
  if (IsEfikeyBufEmpty (Queue)) {\r
    return EFI_NOT_READY;\r
  }\r
  //\r
  // Retrieve and remove the values\r
  //\r
  if (KeyData != NULL) {\r
    CopyMem (KeyData, &Queue->Buffer[Queue->Head], sizeof (EFI_KEY_DATA));\r
  }\r
  Queue->Head = (Queue->Head + 1) % KEYBOARD_EFI_KEY_MAX_COUNT;\r
  return EFI_SUCCESS;\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
  if ((Queue->Tail + 1) % KEYBOARD_EFI_KEY_MAX_COUNT == Queue->Head) {\r
    //\r
    // If Queue is full, pop the one from head.\r
    //\r
    PopEfikeyBufHead (Queue, NULL);\r
  }\r
  CopyMem (&Queue->Buffer[Queue->Tail], KeyData, sizeof (EFI_KEY_DATA));\r
  Queue->Tail = (Queue->Tail + 1) % KEYBOARD_EFI_KEY_MAX_COUNT;\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
\r
{\r
  ASSERT (RegsiteredData != NULL && InputData != NULL);\r
\r
  if ((RegsiteredData->Key.ScanCode    != InputData->Key.ScanCode) ||\r
      (RegsiteredData->Key.UnicodeChar != InputData->Key.UnicodeChar)) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored.\r
  //\r
  if (RegsiteredData->KeyState.KeyShiftState != 0 &&\r
      RegsiteredData->KeyState.KeyShiftState != InputData->KeyState.KeyShiftState) {\r
    return FALSE;\r
  }\r
  if (RegsiteredData->KeyState.KeyToggleState != 0 &&\r
      RegsiteredData->KeyState.KeyToggleState != InputData->KeyState.KeyToggleState) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
\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
    @param ConsoleInDev          Ps2 Keyboard private structure\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
\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
KeyboardReadKeyStrokeWorker (\r
  IN  KEYBOARD_CONSOLE_IN_DEV           *ConsoleInDev,\r
  OUT EFI_KEY_DATA                      *KeyData\r
  )\r
\r
{\r
  EFI_STATUS                            Status;\r
  EFI_TPL                               OldTpl;\r
\r
  if (KeyData == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  KeyboardTimerHandler (NULL, ConsoleInDev);\r
\r
  if (ConsoleInDev->KeyboardErr) {\r
    Status = EFI_DEVICE_ERROR;\r
  } else {\r
    Status = PopEfikeyBufHead (&ConsoleInDev->EfiKeyQueue, KeyData);\r
    if (Status == EFI_NOT_READY) {\r
      ZeroMem (&KeyData->Key, sizeof (KeyData->Key));\r
      InitializeKeyState (ConsoleInDev, &KeyData->KeyState);\r
    }\r
  }\r
\r
  gBS->RestoreTPL (OldTpl);\r
  return Status;\r
}\r
\r
/**\r
  Perform 8042 controller and keyboard initialization which implement SIMPLE_TEXT_IN.Reset()\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
  EFI_STATUS              Status;\r
  KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
  EFI_TPL                 OldTpl;\r
\r
  ConsoleIn = KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);\r
  if (ConsoleIn->KeyboardErr) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
    EFI_PROGRESS_CODE,\r
    EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_RESET,\r
    ConsoleIn->DevicePath\r
    );\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  //\r
  // Call InitKeyboard to initialize the keyboard\r
  //\r
  Status = InitKeyboard (ConsoleIn, ExtendedVerification);\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Leave critical section and return\r
    //\r
    gBS->RestoreTPL (OldTpl);\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
\r
  //\r
  // Report the status If a stuck key was detected\r
  //\r
  if (KeyReadStatusRegister (ConsoleIn) & 0x01) {\r
    REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
      EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
      EFI_PERIPHERAL_KEYBOARD | EFI_P_KEYBOARD_EC_STUCK_KEY,\r
      ConsoleIn->DevicePath\r
      );\r
  }\r
  //\r
  // Report the status If keyboard is locked\r
  //\r
  if ((KeyReadStatusRegister (ConsoleIn) & 0x10) == 0) {\r
    REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
      EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
      EFI_PERIPHERAL_KEYBOARD | EFI_P_KEYBOARD_EC_LOCKED,\r
      ConsoleIn->DevicePath\r
      );\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Retrieve key values for driver user which implement SIMPLE_TEXT_IN.ReadKeyStroke().\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
  EFI_STATUS              Status;\r
  KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
  EFI_KEY_DATA            KeyData;\r
\r
  ConsoleIn = KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);\r
\r
  //\r
  // Considering if the partial keystroke is enabled, there maybe a partial\r
  // keystroke in the queue, so here skip the partial keystroke and get the\r
  // next key from the queue\r
  //\r
  while (1) {\r
    //\r
    // If there is no pending key, then return.\r
    //\r
    Status = KeyboardReadKeyStrokeWorker (ConsoleIn, &KeyData);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
    //\r
    // If it is partial keystroke, skip it.\r
    //\r
    if (KeyData.Key.ScanCode == SCAN_NULL && KeyData.Key.UnicodeChar == CHAR_NULL) {\r
      continue;\r
    }\r
    //\r
    // Translate the CTRL-Alpha characters to their corresponding control value\r
    // (ctrl-a = 0x0001 through ctrl-Z = 0x001A)\r
    //\r
    if ((KeyData.KeyState.KeyShiftState & (EFI_LEFT_CONTROL_PRESSED | EFI_RIGHT_CONTROL_PRESSED)) != 0) {\r
      if (KeyData.Key.UnicodeChar >= L'a' && KeyData.Key.UnicodeChar <= L'z') {\r
        KeyData.Key.UnicodeChar = (CHAR16) (KeyData.Key.UnicodeChar - L'a' + 1);\r
      } else if (KeyData.Key.UnicodeChar >= L'A' && KeyData.Key.UnicodeChar <= L'Z') {\r
        KeyData.Key.UnicodeChar = (CHAR16) (KeyData.Key.UnicodeChar - L'A' + 1);\r
      }\r
    }\r
\r
    CopyMem (Key, &KeyData.Key, sizeof (EFI_INPUT_KEY));\r
    return EFI_SUCCESS;\r
  }\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
  EFI_TPL                     OldTpl;\r
  KEYBOARD_CONSOLE_IN_DEV     *ConsoleIn;\r
  EFI_KEY_DATA                KeyData;\r
\r
  ConsoleIn = (KEYBOARD_CONSOLE_IN_DEV *) Context;\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  KeyboardTimerHandler (NULL, ConsoleIn);\r
\r
  if (!ConsoleIn->KeyboardErr) {\r
    //\r
    // WaitforKey doesn't suppor the partial key.\r
    // Considering if the partial keystroke is enabled, there maybe a partial\r
    // keystroke in the queue, so here skip the partial keystroke and get the\r
    // next key from the queue\r
    //\r
    while (!IsEfikeyBufEmpty (&ConsoleIn->EfiKeyQueue)) {\r
      CopyMem (\r
        &KeyData,\r
        &(ConsoleIn->EfiKeyQueue.Buffer[ConsoleIn->EfiKeyQueue.Head]),\r
        sizeof (EFI_KEY_DATA)\r
        );\r
      if (KeyData.Key.ScanCode == SCAN_NULL && KeyData.Key.UnicodeChar == CHAR_NULL) {\r
        PopEfikeyBufHead (&ConsoleIn->EfiKeyQueue, &KeyData);\r
        continue;\r
      }\r
      //\r
      // if there is pending value key, signal the event.\r
      //\r
      gBS->SignalEvent (Event);\r
      break;\r
    }\r
  }\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\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
  KeyboardWaitForKey (Event, Context);\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
  KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;\r
\r
  ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);\r
\r
  return ConsoleInDev->ConIn.Reset (\r
                               &ConsoleInDev->ConIn,\r
                               ExtendedVerification\r
                               );\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
  KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;\r
\r
  if (KeyData == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);\r
  return KeyboardReadKeyStrokeWorker (ConsoleInDev, 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
  EFI_STATUS                            Status;\r
  KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;\r
  EFI_TPL                               OldTpl;\r
\r
  if (KeyToggleState == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  if (ConsoleInDev->KeyboardErr) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto Exit;\r
  }\r
\r
  if ((*KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID) {\r
    Status = EFI_UNSUPPORTED;\r
    goto Exit;\r
  }\r
\r
  //\r
  // Update the status light\r
  //\r
  ConsoleInDev->ScrollLock          = FALSE;\r
  ConsoleInDev->NumLock             = FALSE;\r
  ConsoleInDev->CapsLock            = FALSE;\r
  ConsoleInDev->IsSupportPartialKey = FALSE;\r
\r
  if ((*KeyToggleState & EFI_SCROLL_LOCK_ACTIVE) == EFI_SCROLL_LOCK_ACTIVE) {\r
    ConsoleInDev->ScrollLock = TRUE;\r
  }\r
  if ((*KeyToggleState & EFI_NUM_LOCK_ACTIVE) == EFI_NUM_LOCK_ACTIVE) {\r
    ConsoleInDev->NumLock = TRUE;\r
  }\r
  if ((*KeyToggleState & EFI_CAPS_LOCK_ACTIVE) == EFI_CAPS_LOCK_ACTIVE) {\r
    ConsoleInDev->CapsLock = TRUE;\r
  }\r
  if ((*KeyToggleState & EFI_KEY_STATE_EXPOSED) == EFI_KEY_STATE_EXPOSED) {\r
    ConsoleInDev->IsSupportPartialKey = TRUE;\r
  }\r
\r
  Status = UpdateStatusLights (ConsoleInDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
Exit:\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
\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. If KeyData.Key,\r
                                      KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState are 0,\r
                                      then any incomplete keystroke will trigger a notification of the KeyNotificationFunction.\r
    @param KeyNotificationFunction    Points to the function to be called when the key\r
                                      sequence is typed specified by KeyData. This notification function\r
                                      should be called at <=TPL_CALLBACK.\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 or KeyNotificationFunction 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 VOID                              **NotifyHandle\r
  )\r
{\r
  EFI_STATUS                            Status;\r
  KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;\r
  EFI_TPL                               OldTpl;\r
  LIST_ENTRY                            *Link;\r
  KEYBOARD_CONSOLE_IN_EX_NOTIFY         *CurrentNotify;\r
  KEYBOARD_CONSOLE_IN_EX_NOTIFY         *NewNotify;\r
\r
  if (KeyData == NULL || NotifyHandle == NULL || KeyNotificationFunction == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  //\r
  // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.\r
  //\r
  for (Link = ConsoleInDev->NotifyList.ForwardLink; Link != &ConsoleInDev->NotifyList; Link = Link->ForwardLink) {\r
    CurrentNotify = CR (\r
                      Link,\r
                      KEYBOARD_CONSOLE_IN_EX_NOTIFY,\r
                      NotifyEntry,\r
                      KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
                      );\r
    if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {\r
      if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) {\r
        *NotifyHandle = CurrentNotify;\r
        Status = EFI_SUCCESS;\r
        goto Exit;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Allocate resource to save the notification function\r
  //\r
  NewNotify = (KEYBOARD_CONSOLE_IN_EX_NOTIFY *) AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_EX_NOTIFY));\r
  if (NewNotify == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Exit;\r
  }\r
\r
  NewNotify->Signature         = KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE;\r
  NewNotify->KeyNotificationFn = KeyNotificationFunction;\r
  CopyMem (&NewNotify->KeyData, KeyData, sizeof (EFI_KEY_DATA));\r
  InsertTailList (&ConsoleInDev->NotifyList, &NewNotify->NotifyEntry);\r
\r
  *NotifyHandle                = NewNotify;\r
  Status                       = EFI_SUCCESS;\r
\r
Exit:\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
  return Status;\r
\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
\r
**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardUnregisterKeyNotify (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  IN VOID                               *NotificationHandle\r
  )\r
{\r
  EFI_STATUS                            Status;\r
  KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;\r
  EFI_TPL                               OldTpl;\r
  LIST_ENTRY                            *Link;\r
  KEYBOARD_CONSOLE_IN_EX_NOTIFY         *CurrentNotify;\r
\r
  if (NotificationHandle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ConsoleInDev = TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (This);\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  for (Link = ConsoleInDev->NotifyList.ForwardLink; Link != &ConsoleInDev->NotifyList; Link = Link->ForwardLink) {\r
    CurrentNotify = CR (\r
                      Link,\r
                      KEYBOARD_CONSOLE_IN_EX_NOTIFY,\r
                      NotifyEntry,\r
                      KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
                      );\r
    if (CurrentNotify == NotificationHandle) {\r
      //\r
      // Remove the notification function from NotifyList and free resources\r
      //\r
      RemoveEntryList (&CurrentNotify->NotifyEntry);\r
\r
      gBS->FreePool (CurrentNotify);\r
      Status = EFI_SUCCESS;\r
      goto Exit;\r
    }\r
  }\r
\r
  //\r
  // Can not find the specified Notification Handle\r
  //\r
  Status = EFI_INVALID_PARAMETER;\r
Exit:\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
  return Status;\r
}\r
\r
/**\r
  Process key notify.\r
\r
  @param  Event                 Indicates the event that invoke this function.\r
  @param  Context               Indicates the calling context.\r
**/\r
VOID\r
EFIAPI\r
KeyNotifyProcessHandler (\r
  IN  EFI_EVENT                 Event,\r
  IN  VOID                      *Context\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  KEYBOARD_CONSOLE_IN_DEV       *ConsoleIn;\r
  EFI_KEY_DATA                  KeyData;\r
  LIST_ENTRY                    *Link;\r
  LIST_ENTRY                    *NotifyList;\r
  KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify;\r
  EFI_TPL                       OldTpl;\r
\r
  ConsoleIn = (KEYBOARD_CONSOLE_IN_DEV *) Context;\r
\r
  //\r
  // Invoke notification functions.\r
  //\r
  NotifyList = &ConsoleIn->NotifyList;\r
  while (TRUE) {\r
    //\r
    // Enter critical section\r
    //  \r
    OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
    Status = PopEfikeyBufHead (&ConsoleIn->EfiKeyQueueForNotify, &KeyData);\r
    //\r
    // Leave critical section\r
    //\r
    gBS->RestoreTPL (OldTpl);\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
    for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList, Link); Link = GetNextNode (NotifyList, Link)) {\r
      CurrentNotify = CR (Link, KEYBOARD_CONSOLE_IN_EX_NOTIFY, NotifyEntry, KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE);\r
      if (IsKeyRegistered (&CurrentNotify->KeyData, &KeyData)) {\r
        CurrentNotify->KeyNotificationFn (&KeyData);\r
      }\r
    }\r
  }\r
}\r
\r