[mirror_edk2.git] / EmulatorPkg / EmuGopDxe / GopInput.c

/*++ @file\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
Portions copyright (c) 2010 0 2011,Apple Inc. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
\r
**/\r
\r
#include "Gop.h"\r
\r
BOOLEAN\r
GopPrivateIsKeyRegistered (\r
  IN EFI_KEY_DATA  *RegsiteredData,\r
  IN EFI_KEY_DATA  *InputData\r
  )\r
\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
  RegsiteredData    - A pointer to a buffer that is filled in with the keystroke\r
                      state data for the key that was registered.\r
  InputData         - A pointer to a buffer that is filled in with the keystroke\r
                      state data for the key that was pressed.\r
\r
Returns:\r
  TRUE              - Key be pressed matches a registered key.\r
  FLASE             - Match failed.\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
  {\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
  {\r
    return FALSE;\r
  }\r
\r
  if ((RegsiteredData->KeyState.KeyToggleState != 0) &&\r
      (RegsiteredData->KeyState.KeyToggleState != InputData->KeyState.KeyToggleState))\r
  {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
VOID\r
EFIAPI\r
GopPrivateMakeCallbackFunction (\r
  IN VOID          *Context,\r
  IN EFI_KEY_DATA  *KeyData\r
  )\r
{\r
  LIST_ENTRY                       *Link;\r
  EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY  *CurrentNotify;\r
  GOP_PRIVATE_DATA                 *Private = (GOP_PRIVATE_DATA *)Context;\r
\r
  KeyMapMake (KeyData);\r
\r
  for (Link = Private->NotifyList.ForwardLink; Link != &Private->NotifyList; Link = Link->ForwardLink) {\r
    CurrentNotify = CR (\r
                      Link,\r
                      EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY,\r
                      NotifyEntry,\r
                      EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE\r
                      );\r
    if (GopPrivateIsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {\r
      // We could be called at a high TPL so signal an event to call the registered function\r
      // at a lower TPL.\r
      gBS->SignalEvent (CurrentNotify->Event);\r
    }\r
  }\r
}\r
\r
VOID\r
EFIAPI\r
GopPrivateBreakCallbackFunction (\r
  IN VOID          *Context,\r
  IN EFI_KEY_DATA  *KeyData\r
  )\r
{\r
  KeyMapBreak (KeyData);\r
}\r
\r
//\r
// Simple Text In implementation.\r
//\r
\r
/**\r
  Reset the input device and optionally 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 not be reset.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimpleTextInReset (\r
  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,\r
  IN BOOLEAN                         ExtendedVerification\r
  )\r
{\r
  GOP_PRIVATE_DATA  *Private;\r
  EFI_KEY_DATA      KeyData;\r
  EFI_TPL           OldTpl;\r
\r
  Private = GOP_PRIVATE_DATA_FROM_TEXT_IN_THIS (This);\r
  if (Private->EmuGraphicsWindow == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  //\r
  // A reset is draining the Queue\r
  //\r
  while (Private->EmuGraphicsWindow->GetKey (Private->EmuGraphicsWindow, &KeyData) == EFI_SUCCESS) {\r
  }\r
\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Reads the next keystroke from the input device. The WaitForKey Event can\r
  be used to test for existence of a keystroke via WaitForEvent () call.\r
\r
  @param  This  Protocol instance pointer.\r
  @param  Key   A pointer to a buffer that is filled in with the keystroke\r
                information 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 available.\r
  @retval EFI_DEVICE_ERROR The keystroke information was not returned due to\r
                           hardware errors.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimpleTextInReadKeyStroke (\r
  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,\r
  OUT EFI_INPUT_KEY                  *Key\r
  )\r
{\r
  GOP_PRIVATE_DATA  *Private;\r
  EFI_STATUS        Status;\r
  EFI_TPL           OldTpl;\r
  EFI_KEY_DATA      KeyData;\r
\r
  Private = GOP_PRIVATE_DATA_FROM_TEXT_IN_THIS (This);\r
  if (Private->EmuGraphicsWindow == NULL) {\r
    return EFI_NOT_READY;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  Status = Private->EmuGraphicsWindow->GetKey (Private->EmuGraphicsWindow, &KeyData);\r
  if (!EFI_ERROR (Status)) {\r
    if ((KeyData.Key.ScanCode == 0) && (KeyData.Key.UnicodeChar == 0)) {\r
      // Modifier key was pressed\r
      Status = EFI_NOT_READY;\r
    } else {\r
      CopyMem (Key, &KeyData.Key, sizeof (EFI_INPUT_KEY));\r
    }\r
  }\r
\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  SimpleTextIn and SimpleTextInEx Notify Wait Event\r
\r
  @param  Event                 Event whose notification function is being invoked.\r
  @param  Context               Pointer to GOP_PRIVATE_DATA.\r
\r
**/\r
VOID\r
EFIAPI\r
EmuGopSimpleTextInWaitForKey (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  GOP_PRIVATE_DATA  *Private;\r
  EFI_STATUS        Status;\r
  EFI_TPL           OldTpl;\r
\r
  Private = (GOP_PRIVATE_DATA *)Context;\r
  if (Private->EmuGraphicsWindow == NULL) {\r
    return;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  Status = Private->EmuGraphicsWindow->CheckKey (Private->EmuGraphicsWindow);\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // If a there is a key in the queue signal our event.\r
    //\r
    gBS->SignalEvent (Event);\r
  }\r
\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
}\r
\r
//\r
// Simple Text Input Ex protocol functions\r
//\r
\r
/**\r
  The Reset() function resets the input device hardware. As part\r
  of initialization process, the firmware/device will make a quick\r
  but reasonable attempt to verify that the device is functioning.\r
  If the ExtendedVerification flag is TRUE the firmware may take\r
  an extended amount of time to verify the device is operating on\r
  reset. Otherwise the reset operation is to occur as quickly as\r
  possible. The hardware verification process is not defined by\r
  this specification and is left up to the platform firmware or\r
  driver to implement.\r
\r
  @param This                 A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
  @param ExtendedVerification Indicates that the driver may\r
                              perform a more exhaustive\r
                              verification operation of the\r
                              device during reset.\r
\r
\r
  @retval EFI_SUCCESS       The device was reset.\r
\r
  @retval EFI_DEVICE_ERROR  The device is not functioning\r
                            correctly and could not be reset.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimpleTextInExResetEx (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  IN BOOLEAN                            ExtendedVerification\r
  )\r
\r
/*++\r
\r
  Routine Description:\r
    Reset the input device and optionaly run diagnostics\r
\r
  Arguments:\r
    This                 - Protocol instance pointer.\r
    ExtendedVerification - Driver may perform diagnostics on reset.\r
\r
  Returns:\r
    EFI_SUCCESS           - The device was reset.\r
\r
**/\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The function reads the next keystroke from the input device. If\r
  there is no pending keystroke the function returns\r
  EFI_NOT_READY. If there is a pending keystroke, then\r
  KeyData.Key.ScanCode is the EFI scan code defined in Error!\r
  Reference source not found. The KeyData.Key.UnicodeChar is the\r
  actual printable character or is zero if the key does not\r
  represent a printable character (control key, function key,\r
  etc.). The KeyData.KeyState is shift state for the character\r
  reflected in KeyData.Key.UnicodeChar or KeyData.Key.ScanCode .\r
  When interpreting the data from this function, it should be\r
  noted that if a class of printable characters that are\r
  normally adjusted by shift modifiers (e.g. Shift Key + "f"\r
  key) would be presented solely as a KeyData.Key.UnicodeChar\r
  without the associated shift state. So in the previous example\r
  of a Shift Key + "f" key being pressed, the only pertinent\r
  data returned would be KeyData.Key.UnicodeChar with the value\r
  of "F". This of course would not typically be the case for\r
  non-printable characters such as the pressing of the Right\r
  Shift Key + F10 key since the corresponding returned data\r
  would be reflected both in the KeyData.KeyState.KeyShiftState\r
  and KeyData.Key.ScanCode values. UEFI drivers which implement\r
  the EFI_SIMPLE_TEXT_INPUT_EX protocol are required to return\r
  KeyData.Key and KeyData.KeyState values. These drivers must\r
  always return the most current state of\r
  KeyData.KeyState.KeyShiftState and\r
  KeyData.KeyState.KeyToggleState. It should also be noted that\r
  certain input devices may not be able to produce shift or toggle\r
  state information, and in those cases the high order bit in the\r
  respective Toggle and Shift state fields should not be active.\r
\r
\r
  @param This     A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
  @param KeyData  A pointer to a buffer that is filled in with\r
                  the keystroke state data for the key that was\r
                  pressed.\r
\r
\r
  @retval EFI_SUCCESS     The keystroke information was\r
                          returned.\r
\r
  @retval EFI_NOT_READY   There was no keystroke data available.\r
                          EFI_DEVICE_ERROR The keystroke\r
                          information was not returned due to\r
                          hardware errors.\r
\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimpleTextInExReadKeyStrokeEx (\r
  IN  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  OUT EFI_KEY_DATA                       *KeyData\r
  )\r
\r
/*++\r
\r
  Routine Description:\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
  Arguments:\r
    This       - Protocol instance pointer.\r
    KeyData    - A pointer to a buffer that is filled in with the keystroke\r
                 state data for the key that was pressed.\r
\r
  Returns:\r
    EFI_SUCCESS           - The keystroke information was returned.\r
    EFI_NOT_READY         - There was no keystroke data availiable.\r
    EFI_DEVICE_ERROR      - The keystroke information was not returned due to\r
                            hardware errors.\r
    EFI_INVALID_PARAMETER - KeyData is NULL.\r
\r
**/\r
{\r
  EFI_STATUS        Status;\r
  GOP_PRIVATE_DATA  *Private;\r
  EFI_TPL           OldTpl;\r
\r
  if (KeyData == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS (This);\r
  if (Private->EmuGraphicsWindow == NULL) {\r
    return EFI_NOT_READY;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  Status = Private->EmuGraphicsWindow->GetKey (Private->EmuGraphicsWindow, KeyData);\r
\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  The SetState() function allows the input device hardware to\r
  have state settings adjusted.\r
\r
  @param This           A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
  @param KeyToggleState Pointer to the EFI_KEY_TOGGLE_STATE to\r
                        set the state for the input device.\r
\r
\r
  @retval EFI_SUCCESS       The device state was set appropriately.\r
\r
  @retval EFI_DEVICE_ERROR  The device is not functioning\r
                            correctly and could not have the\r
                            setting adjusted.\r
\r
  @retval EFI_UNSUPPORTED   The device does not support the\r
                            ability to have its state set.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimpleTextInExSetState (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  IN EFI_KEY_TOGGLE_STATE               *KeyToggleState\r
  )\r
{\r
  GOP_PRIVATE_DATA  *Private;\r
  EFI_STATUS        Status;\r
  EFI_TPL           OldTpl;\r
\r
  if (KeyToggleState == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS (This);\r
  if (Private->EmuGraphicsWindow == NULL) {\r
    return EFI_NOT_READY;\r
  }\r
\r
  if (((Private->KeyState.KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID) ||\r
      ((*KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID))\r
  {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  Status = Private->EmuGraphicsWindow->KeySetState (Private->EmuGraphicsWindow, KeyToggleState);\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  SimpleTextIn and SimpleTextInEx Notify Wait Event\r
\r
  @param  Event                 Event whose notification function is being invoked.\r
  @param  Context               Pointer to GOP_PRIVATE_DATA.\r
\r
**/\r
VOID\r
EFIAPI\r
EmuGopRegisterKeyCallback (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY  *ExNotify = (EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY *)Context;\r
\r
  ExNotify->KeyNotificationFn (&ExNotify->KeyData);\r
}\r
\r
/**\r
  The RegisterKeystrokeNotify() function registers a function\r
  which will be called when a specified keystroke will occur.\r
\r
  @param This                     A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
  @param KeyData                  A pointer to a buffer that is filled in with\r
                                  the keystroke information for the key that was\r
                                  pressed.\r
\r
  @param KeyNotificationFunction  Points to the function to be\r
                                  called when the key sequence\r
                                  is typed specified by KeyData.\r
\r
\r
  @param NotifyHandle             Points to the unique handle assigned to\r
                                  the registered notification.\r
\r
  @retval EFI_SUCCESS           The device state was set\r
                                appropriately.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Unable to allocate necessary\r
                                data structures.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimpleTextInExRegisterKeyNotify (\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
  GOP_PRIVATE_DATA                 *Private;\r
  EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY  *CurrentNotify;\r
  LIST_ENTRY                       *Link;\r
  EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY  *NewNotify;\r
\r
  if ((KeyData == NULL) || (KeyNotificationFunction == NULL) || (NotifyHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS (This);\r
\r
  //\r
  // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.\r
  //\r
  for (Link = Private->NotifyList.ForwardLink; Link != &Private->NotifyList; Link = Link->ForwardLink) {\r
    CurrentNotify = CR (\r
                      Link,\r
                      EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY,\r
                      NotifyEntry,\r
                      EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE\r
                      );\r
    if (GopPrivateIsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {\r
      if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) {\r
        *NotifyHandle = CurrentNotify->NotifyHandle;\r
        return EFI_SUCCESS;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Allocate resource to save the notification function\r
  //\r
  NewNotify = (EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY *)AllocateZeroPool (sizeof (EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY));\r
  if (NewNotify == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  NewNotify->Signature         = EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE;\r
  NewNotify->KeyNotificationFn = KeyNotificationFunction;\r
  NewNotify->NotifyHandle      = (EFI_HANDLE)NewNotify;\r
  CopyMem (&NewNotify->KeyData, KeyData, sizeof (KeyData));\r
  InsertTailList (&Private->NotifyList, &NewNotify->NotifyEntry);\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  EmuGopRegisterKeyCallback,\r
                  NewNotify,\r
                  &NewNotify->Event\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  *NotifyHandle = NewNotify->NotifyHandle;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The UnregisterKeystrokeNotify() function removes the\r
  notification which was previously registered.\r
\r
  @param This               A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
  @param NotificationHandle The handle of the notification\r
                            function being unregistered.\r
\r
  @retval EFI_SUCCESS The device state was set appropriately.\r
\r
  @retval EFI_INVALID_PARAMETER The NotificationHandle is\r
                                invalid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimpleTextInExUnregisterKeyNotify (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
  IN VOID                               *NotificationHandle\r
  )\r
\r
/*++\r
\r
  Routine Description:\r
    Remove a registered notification function from a particular keystroke.\r
\r
  Arguments:\r
    This                    - Protocol instance pointer.\r
    NotificationHandle      - The handle of the notification function being unregistered.\r
\r
  Returns:\r
    EFI_SUCCESS             - The notification function was unregistered successfully.\r
    EFI_INVALID_PARAMETER   - The NotificationHandle is invalid.\r
\r
**/\r
{\r
  GOP_PRIVATE_DATA                 *Private;\r
  LIST_ENTRY                       *Link;\r
  EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY  *CurrentNotify;\r
\r
  if (NotificationHandle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (((EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY *)NotificationHandle)->Signature != EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS (This);\r
\r
  for (Link = Private->NotifyList.ForwardLink; Link != &Private->NotifyList; Link = Link->ForwardLink) {\r
    CurrentNotify = CR (\r
                      Link,\r
                      EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY,\r
                      NotifyEntry,\r
                      EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE\r
                      );\r
    if (CurrentNotify->NotifyHandle == NotificationHandle) {\r
      //\r
      // Remove the notification function from NotifyList and free resources\r
      //\r
      RemoveEntryList (&CurrentNotify->NotifyEntry);\r
\r
      gBS->CloseEvent (CurrentNotify->Event);\r
\r
      gBS->FreePool (CurrentNotify);\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  //\r
  // Can not find the specified Notification Handle\r
  //\r
  return EFI_INVALID_PARAMETER;\r
}\r
\r
/**\r
  Initialize SimplelTextIn and SimpleTextInEx protocols in the Private\r
  context structure.\r
\r
  @param  Private               Context structure to fill in.\r
\r
  @return EFI_SUCCESS           Initialization was a success\r
\r
**/\r
EFI_STATUS\r
EmuGopInitializeSimpleTextInForWindow (\r
  IN  GOP_PRIVATE_DATA  *Private\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Initialize Simple Text In protoocol\r
  //\r
  Private->SimpleTextIn.Reset         = EmuGopSimpleTextInReset;\r
  Private->SimpleTextIn.ReadKeyStroke = EmuGopSimpleTextInReadKeyStroke;\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_WAIT,\r
                  TPL_NOTIFY,\r
                  EmuGopSimpleTextInWaitForKey,\r
                  Private,\r
                  &Private->SimpleTextIn.WaitForKey\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Initialize Simple Text In Ex\r
  //\r
\r
  Private->SimpleTextInEx.Reset               = EmuGopSimpleTextInExResetEx;\r
  Private->SimpleTextInEx.ReadKeyStrokeEx     = EmuGopSimpleTextInExReadKeyStrokeEx;\r
  Private->SimpleTextInEx.SetState            = EmuGopSimpleTextInExSetState;\r
  Private->SimpleTextInEx.RegisterKeyNotify   = EmuGopSimpleTextInExRegisterKeyNotify;\r
  Private->SimpleTextInEx.UnregisterKeyNotify = EmuGopSimpleTextInExUnregisterKeyNotify;\r
\r
  Private->SimpleTextInEx.Reset (&Private->SimpleTextInEx, FALSE);\r
\r
  InitializeListHead (&Private->NotifyList);\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_WAIT,\r
                  TPL_NOTIFY,\r
                  EmuGopSimpleTextInWaitForKey,\r
                  Private,\r
                  &Private->SimpleTextInEx.WaitForKeyEx\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
\r
//\r
// Simple Pointer implementation.\r
//\r
\r
/**\r
  Resets the pointer device hardware.\r
\r
  @param  This                  A pointer to the EFI_SIMPLE_POINTER_PROTOCOL\r
                                instance.\r
  @param  ExtendedVerification  Indicates that the driver may perform a more exhaustive\r
                                verification operation of the device during reset.\r
\r
  @retval EFI_SUCCESS           The device was reset.\r
  @retval EFI_DEVICE_ERROR      The device is not functioning correctly and could not be reset.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimplePointerReset (\r
  IN EFI_SIMPLE_POINTER_PROTOCOL  *This,\r
  IN BOOLEAN                      ExtendedVerification\r
  )\r
{\r
  GOP_PRIVATE_DATA          *Private;\r
  EFI_SIMPLE_POINTER_STATE  State;\r
  EFI_TPL                   OldTpl;\r
\r
  Private = GOP_PRIVATE_DATA_FROM_POINTER_MODE_THIS (This);\r
  if (Private->EmuGraphicsWindow == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  //\r
  // A reset is draining the Queue\r
  //\r
  while (Private->EmuGraphicsWindow->GetPointerState (Private->EmuGraphicsWindow, &State) == EFI_SUCCESS) {\r
  }\r
\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Retrieves the current state of a pointer device.\r
\r
  @param  This                  A pointer to the EFI_SIMPLE_POINTER_PROTOCOL\r
                                instance.\r
  @param  State                 A pointer to the state information on the pointer device.\r
\r
  @retval EFI_SUCCESS           The state of the pointer device was returned in State.\r
  @retval EFI_NOT_READY         The state of the pointer device has not changed since the last call to\r
                                GetState().\r
  @retval EFI_DEVICE_ERROR      A device error occurred while attempting to retrieve the pointer device's\r
                                current state.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EmuGopSimplePointerGetState (\r
  IN EFI_SIMPLE_POINTER_PROTOCOL   *This,\r
  IN OUT EFI_SIMPLE_POINTER_STATE  *State\r
  )\r
{\r
  GOP_PRIVATE_DATA  *Private;\r
  EFI_STATUS        Status;\r
  EFI_TPL           OldTpl;\r
\r
  Private = GOP_PRIVATE_DATA_FROM_POINTER_MODE_THIS (This);\r
  if (Private->EmuGraphicsWindow == NULL) {\r
    return EFI_NOT_READY;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  Status = Private->EmuGraphicsWindow->GetPointerState (Private->EmuGraphicsWindow, State);\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  SimplePointer Notify Wait Event\r
\r
  @param  Event                 Event whose notification function is being invoked.\r
  @param  Context               Pointer to GOP_PRIVATE_DATA.\r
\r
**/\r
VOID\r
EFIAPI\r
EmuGopSimplePointerWaitForInput (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  GOP_PRIVATE_DATA  *Private;\r
  EFI_STATUS        Status;\r
  EFI_TPL           OldTpl;\r
\r
  Private = (GOP_PRIVATE_DATA *)Context;\r
  if (Private->EmuGraphicsWindow == NULL) {\r
    return;\r
  }\r
\r
  //\r
  // Enter critical section\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  Status = Private->EmuGraphicsWindow->CheckPointer (Private->EmuGraphicsWindow);\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // If the pointer state has changed, signal our event.\r
    //\r
    gBS->SignalEvent (Event);\r
  }\r
\r
  //\r
  // Leave critical section and return\r
  //\r
  gBS->RestoreTPL (OldTpl);\r
}\r
\r
/**\r
  SimplePointer constructor\r
\r
  @param  Private Context structure to fill in.\r
\r
  @retval EFI_SUCCESS Constructor had success\r
\r
**/\r
EFI_STATUS\r
EmuGopInitializeSimplePointerForWindow (\r
  IN  GOP_PRIVATE_DATA  *Private\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Initialize Simple Pointer protoocol\r
  //\r
  Private->PointerMode.ResolutionX = 1;\r
  Private->PointerMode.ResolutionY = 1;\r
  Private->PointerMode.ResolutionZ = 1;\r
  Private->PointerMode.LeftButton  = TRUE;\r
  Private->PointerMode.RightButton = TRUE;\r
\r
  Private->SimplePointer.Reset    = EmuGopSimplePointerReset;\r
  Private->SimplePointer.GetState = EmuGopSimplePointerGetState;\r
  Private->SimplePointer.Mode     = &Private->PointerMode;\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_WAIT,\r
                  TPL_NOTIFY,\r
                  EmuGopSimplePointerWaitForInput,\r
                  Private,\r
                  &Private->SimplePointer.WaitForInput\r
                  );\r
\r
  return Status;\r
}\r