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

/** @file\r
\r
  PS/2 Keyboard driver. Routines that interacts with callers,\r
  conforming to EFI driver model\r
\r
Copyright (c) 2006 - 2016, 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
#include "Ps2Keyboard.h"\r
\r
//\r
// Function prototypes\r
//\r
/**\r
  Test controller is a keyboard Controller.\r
\r
  @param This                 Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
  @param Controller           driver's controller\r
  @param RemainingDevicePath  children device path\r
\r
  @retval EFI_UNSUPPORTED controller is not floppy disk\r
  @retval EFI_SUCCESS     controller is floppy disk\r
**/\r
EFI_STATUS\r
EFIAPI\r
KbdControllerDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
/**\r
  Create KEYBOARD_CONSOLE_IN_DEV instance on controller.\r
\r
  @param This         Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
  @param Controller   driver controller handle\r
  @param RemainingDevicePath Children's device path\r
\r
  @retval whether success to create floppy control instance.\r
**/\r
EFI_STATUS\r
EFIAPI\r
KbdControllerDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
/**\r
  Stop this driver on ControllerHandle. Support stopping any child handles\r
  created by this driver.\r
\r
  @param  This              Protocol instance pointer.\r
  @param  ControllerHandle  Handle of device to stop driver on\r
  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                            children is zero stop the entire bus driver.\r
  @param  ChildHandleBuffer List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCESS       This driver is removed ControllerHandle\r
  @retval other             This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
KbdControllerDriverStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN  EFI_HANDLE                     Controller,\r
  IN  UINTN                          NumberOfChildren,\r
  IN  EFI_HANDLE                     *ChildHandleBuffer\r
  );\r
\r
/**\r
  Free the waiting key notify list.\r
\r
  @param ListHead  Pointer to list head\r
\r
  @retval EFI_INVALID_PARAMETER  ListHead is NULL\r
  @retval EFI_SUCCESS            Sucess to free NotifyList\r
**/\r
EFI_STATUS\r
KbdFreeNotifyList (\r
  IN OUT LIST_ENTRY           *ListHead\r
  );\r
\r
//\r
// DriverBinding Protocol Instance\r
//\r
EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver = {\r
  KbdControllerDriverSupported,\r
  KbdControllerDriverStart,\r
  KbdControllerDriverStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  Test controller is a keyboard Controller.\r
\r
  @param This                 Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
  @param Controller           driver's controller\r
  @param RemainingDevicePath  children device path\r
\r
  @retval EFI_UNSUPPORTED controller is not floppy disk\r
  @retval EFI_SUCCESS     controller is floppy disk\r
**/\r
EFI_STATUS\r
EFIAPI\r
KbdControllerDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS                                 Status;\r
  EFI_SIO_PROTOCOL                           *Sio;\r
  EFI_DEVICE_PATH_PROTOCOL                   *DevicePath;\r
  ACPI_HID_DEVICE_PATH                       *Acpi;\r
\r
  //\r
  // Check whether the controller is keyboard.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **) &DevicePath,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  do {\r
    Acpi = (ACPI_HID_DEVICE_PATH *) DevicePath;\r
    DevicePath = NextDevicePathNode (DevicePath);\r
  } while (!IsDevicePathEnd (DevicePath));\r
\r
  if (DevicePathType (Acpi) != ACPI_DEVICE_PATH ||\r
      (DevicePathSubType (Acpi) != ACPI_DP && DevicePathSubType (Acpi) != ACPI_EXTENDED_DP)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (Acpi->HID != EISA_PNP_ID (0x303) || Acpi->UID != 0) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Open the IO Abstraction(s) needed to perform the supported test\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiSioProtocolGuid,\r
                  (VOID **) &Sio,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Close the I/O Abstraction(s) used to perform the supported test\r
  //\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiSioProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  return Status;\r
}\r
\r
/**\r
  Create KEYBOARD_CONSOLE_IN_DEV instance on controller.\r
\r
  @param This         Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
  @param Controller   driver controller handle\r
  @param RemainingDevicePath Children's device path\r
\r
  @retval whether success to create floppy control instance.\r
**/\r
EFI_STATUS\r
EFIAPI\r
KbdControllerDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS                                Status;\r
  EFI_STATUS                                Status1;\r
  EFI_SIO_PROTOCOL                          *Sio;\r
  KEYBOARD_CONSOLE_IN_DEV                   *ConsoleIn;\r
  UINT8                                     Data;\r
  EFI_STATUS_CODE_VALUE                     StatusCode;\r
  EFI_DEVICE_PATH_PROTOCOL                  *DevicePath;\r
\r
  StatusCode = 0;\r
\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **) &DevicePath,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // Report that the keyboard is being enabled\r
  //\r
  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
    EFI_PROGRESS_CODE,\r
    EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_ENABLE,\r
    DevicePath\r
    );\r
\r
  //\r
  // Get the ISA I/O Protocol on Controller's handle\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiSioProtocolGuid,\r
                  (VOID **) &Sio,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // Allocate private data\r
  //\r
  ConsoleIn = AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_DEV));\r
  if (ConsoleIn == NULL) {\r
    Status      = EFI_OUT_OF_RESOURCES;\r
    StatusCode  = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;\r
    goto ErrorExit;\r
  }\r
  //\r
  // Setup the device instance\r
  //\r
  ConsoleIn->Signature              = KEYBOARD_CONSOLE_IN_DEV_SIGNATURE;\r
  ConsoleIn->Handle                 = Controller;\r
  (ConsoleIn->ConIn).Reset          = KeyboardEfiReset;\r
  (ConsoleIn->ConIn).ReadKeyStroke  = KeyboardReadKeyStroke;\r
  ConsoleIn->DataRegisterAddress    = KEYBOARD_8042_DATA_REGISTER;\r
  ConsoleIn->StatusRegisterAddress  = KEYBOARD_8042_STATUS_REGISTER;\r
  ConsoleIn->CommandRegisterAddress = KEYBOARD_8042_COMMAND_REGISTER;\r
  ConsoleIn->DevicePath             = DevicePath;\r
\r
  ConsoleIn->ConInEx.Reset               = KeyboardEfiResetEx;\r
  ConsoleIn->ConInEx.ReadKeyStrokeEx     = KeyboardReadKeyStrokeEx;\r
  ConsoleIn->ConInEx.SetState            = KeyboardSetState;\r
  ConsoleIn->ConInEx.RegisterKeyNotify   = KeyboardRegisterKeyNotify;\r
  ConsoleIn->ConInEx.UnregisterKeyNotify = KeyboardUnregisterKeyNotify;\r
\r
  InitializeListHead (&ConsoleIn->NotifyList);\r
\r
  //\r
  // Fix for random hangs in System waiting for the Key if no KBC is present in BIOS.\r
  // When KBC decode (IO port 0x60/0x64 decode) is not enabled,\r
  // KeyboardRead will read back as 0xFF and return status is EFI_SUCCESS.\r
  // So instead we read status register to detect after read if KBC decode is enabled.\r
  //\r
\r
  //\r
  // Return code is ignored on purpose.\r
  //\r
  if (!PcdGetBool (PcdFastPS2Detection)) {\r
    KeyboardRead (ConsoleIn, &Data);\r
    if ((KeyReadStatusRegister (ConsoleIn) & (KBC_PARE | KBC_TIM)) == (KBC_PARE | KBC_TIM)) {\r
      //\r
      // If nobody decodes KBC I/O port, it will read back as 0xFF.\r
      // Check the Time-Out and Parity bit to see if it has an active KBC in system\r
      //\r
      Status      = EFI_DEVICE_ERROR;\r
      StatusCode  = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_NOT_DETECTED;\r
      goto ErrorExit;\r
    }\r
  }\r
\r
  //\r
  // Setup the WaitForKey event\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_WAIT,\r
                  TPL_NOTIFY,\r
                  KeyboardWaitForKey,\r
                  ConsoleIn,\r
                  &((ConsoleIn->ConIn).WaitForKey)\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status      = EFI_OUT_OF_RESOURCES;\r
    StatusCode  = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;\r
    goto ErrorExit;\r
  }\r
  //\r
  // Setup the WaitForKeyEx event\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_WAIT,\r
                  TPL_NOTIFY,\r
                  KeyboardWaitForKeyEx,\r
                  ConsoleIn,\r
                  &(ConsoleIn->ConInEx.WaitForKeyEx)\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status      = EFI_OUT_OF_RESOURCES;\r
    StatusCode  = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;\r
    goto ErrorExit;\r
  }\r
  // Setup a periodic timer, used for reading keystrokes at a fixed interval\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  KeyboardTimerHandler,\r
                  ConsoleIn,\r
                  &ConsoleIn->TimerEvent\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status      = EFI_OUT_OF_RESOURCES;\r
    StatusCode  = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;\r
    goto ErrorExit;\r
  }\r
\r
  Status = gBS->SetTimer (\r
                  ConsoleIn->TimerEvent,\r
                  TimerPeriodic,\r
                  KEYBOARD_TIMER_INTERVAL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status      = EFI_OUT_OF_RESOURCES;\r
    StatusCode  = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;\r
    goto ErrorExit;\r
  }\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_CALLBACK,\r
                  KeyNotifyProcessHandler,\r
                  ConsoleIn,\r
                  &ConsoleIn->KeyNotifyProcessEvent\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status      = EFI_OUT_OF_RESOURCES;\r
    StatusCode  = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;\r
    goto ErrorExit;\r
  }\r
\r
  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
    EFI_PROGRESS_CODE,\r
    EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_PRESENCE_DETECT,\r
    DevicePath\r
    );\r
\r
  //\r
  // Reset the keyboard device\r
  //\r
  Status = ConsoleIn->ConInEx.Reset (&ConsoleIn->ConInEx, FeaturePcdGet (PcdPs2KbdExtendedVerification));\r
  if (EFI_ERROR (Status)) {\r
    Status      = EFI_DEVICE_ERROR;\r
    StatusCode  = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_NOT_DETECTED;\r
    goto ErrorExit;\r
  }\r
\r
  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
    EFI_PROGRESS_CODE,\r
    EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_DETECTED,\r
    DevicePath\r
    );\r
\r
  ConsoleIn->ControllerNameTable = NULL;\r
  AddUnicodeString2 (\r
    "eng",\r
    gPs2KeyboardComponentName.SupportedLanguages,\r
    &ConsoleIn->ControllerNameTable,\r
    L"PS/2 Keyboard Device",\r
    TRUE\r
    );\r
  AddUnicodeString2 (\r
    "en",\r
    gPs2KeyboardComponentName2.SupportedLanguages,\r
    &ConsoleIn->ControllerNameTable,\r
    L"PS/2 Keyboard Device",\r
    FALSE\r
    );\r
\r
\r
  //\r
  // Install protocol interfaces for the keyboard device.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Controller,\r
                  &gEfiSimpleTextInProtocolGuid,\r
                  &ConsoleIn->ConIn,\r
                  &gEfiSimpleTextInputExProtocolGuid,\r
                  &ConsoleIn->ConInEx,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    StatusCode = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;\r
    goto ErrorExit;\r
  }\r
\r
  return Status;\r
\r
ErrorExit:\r
  //\r
  // Report error code\r
  //\r
  if (StatusCode != 0) {\r
    REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
      EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
      StatusCode,\r
      DevicePath\r
      );\r
  }\r
\r
  if ((ConsoleIn != NULL) && (ConsoleIn->ConIn.WaitForKey != NULL)) {\r
    gBS->CloseEvent (ConsoleIn->ConIn.WaitForKey);\r
  }\r
\r
  if ((ConsoleIn != NULL) && (ConsoleIn->TimerEvent != NULL)) {\r
    gBS->CloseEvent (ConsoleIn->TimerEvent);\r
  }\r
  if ((ConsoleIn != NULL) && (ConsoleIn->ConInEx.WaitForKeyEx != NULL)) {\r
    gBS->CloseEvent (ConsoleIn->ConInEx.WaitForKeyEx);\r
  }\r
  if ((ConsoleIn != NULL) && (ConsoleIn->KeyNotifyProcessEvent != NULL)) {\r
    gBS->CloseEvent (ConsoleIn->KeyNotifyProcessEvent);\r
  }\r
  KbdFreeNotifyList (&ConsoleIn->NotifyList);\r
  if ((ConsoleIn != NULL) && (ConsoleIn->ControllerNameTable != NULL)) {\r
    FreeUnicodeStringTable (ConsoleIn->ControllerNameTable);\r
  }\r
  //\r
  // Since there will be no timer handler for keyboard input any more,\r
  // exhaust input data just in case there is still keyboard data left\r
  //\r
  if (ConsoleIn != NULL) {\r
    Status1 = EFI_SUCCESS;\r
    while (!EFI_ERROR (Status1) && (Status != EFI_DEVICE_ERROR)) {\r
      Status1 = KeyboardRead (ConsoleIn, &Data);;\r
    }\r
  }\r
\r
  if (ConsoleIn != NULL) {\r
    gBS->FreePool (ConsoleIn);\r
  }\r
\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiSioProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop this driver on ControllerHandle. Support stopping any child handles\r
  created by this driver.\r
\r
  @param  This              Protocol instance pointer.\r
  @param  ControllerHandle  Handle of device to stop driver on\r
  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                            children is zero stop the entire bus driver.\r
  @param  ChildHandleBuffer List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCESS       This driver is removed ControllerHandle\r
  @retval other             This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
KbdControllerDriverStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN  EFI_HANDLE                     Controller,\r
  IN  UINTN                          NumberOfChildren,\r
  IN  EFI_HANDLE                     *ChildHandleBuffer\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;\r
  KEYBOARD_CONSOLE_IN_DEV        *ConsoleIn;\r
  UINT8                          Data;\r
\r
  //\r
  // Disable Keyboard\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiSimpleTextInProtocolGuid,\r
                  (VOID **) &ConIn,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiSimpleTextInputExProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ConsoleIn = KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (ConIn);\r
\r
  //\r
  // Report that the keyboard is being disabled\r
  //\r
  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
    EFI_PROGRESS_CODE,\r
    EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_DISABLE,\r
    ConsoleIn->DevicePath\r
    );\r
\r
  if (ConsoleIn->TimerEvent != NULL) {\r
    gBS->CloseEvent (ConsoleIn->TimerEvent);\r
    ConsoleIn->TimerEvent = NULL;\r
  }\r
\r
  //\r
  // Since there will be no timer handler for keyboard input any more,\r
  // exhaust input data just in case there is still keyboard data left\r
  //\r
  Status = EFI_SUCCESS;\r
  while (!EFI_ERROR (Status)) {\r
    Status = KeyboardRead (ConsoleIn, &Data);;\r
  }\r
  //\r
  // Uninstall the SimpleTextIn and SimpleTextInEx protocols\r
  //\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  Controller,\r
                  &gEfiSimpleTextInProtocolGuid,\r
                  &ConsoleIn->ConIn,\r
                  &gEfiSimpleTextInputExProtocolGuid,\r
                  &ConsoleIn->ConInEx,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiSioProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  //\r
  // Free other resources\r
  //\r
  if ((ConsoleIn->ConIn).WaitForKey != NULL) {\r
    gBS->CloseEvent ((ConsoleIn->ConIn).WaitForKey);\r
    (ConsoleIn->ConIn).WaitForKey = NULL;\r
  }\r
  if (ConsoleIn->ConInEx.WaitForKeyEx != NULL) {\r
    gBS->CloseEvent (ConsoleIn->ConInEx.WaitForKeyEx);\r
    ConsoleIn->ConInEx.WaitForKeyEx = NULL;\r
  }\r
  if (ConsoleIn->KeyNotifyProcessEvent != NULL) {\r
    gBS->CloseEvent (ConsoleIn->KeyNotifyProcessEvent);\r
    ConsoleIn->KeyNotifyProcessEvent = NULL;\r
  }\r
  KbdFreeNotifyList (&ConsoleIn->NotifyList);\r
  FreeUnicodeStringTable (ConsoleIn->ControllerNameTable);\r
  gBS->FreePool (ConsoleIn);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Free the waiting key notify list.\r
\r
  @param ListHead  Pointer to list head\r
\r
  @retval EFI_INVALID_PARAMETER  ListHead is NULL\r
  @retval EFI_SUCCESS            Sucess to free NotifyList\r
**/\r
EFI_STATUS\r
KbdFreeNotifyList (\r
  IN OUT LIST_ENTRY           *ListHead\r
  )\r
{\r
  KEYBOARD_CONSOLE_IN_EX_NOTIFY *NotifyNode;\r
\r
  if (ListHead == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  while (!IsListEmpty (ListHead)) {\r
    NotifyNode = CR (\r
                   ListHead->ForwardLink,\r
                   KEYBOARD_CONSOLE_IN_EX_NOTIFY,\r
                   NotifyEntry,\r
                   KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
                   );\r
    RemoveEntryList (ListHead->ForwardLink);\r
    gBS->FreePool (NotifyNode);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The module Entry Point for module Ps2Keyboard.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.\r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializePs2Keyboard(\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  EFI_STATUS              Status;\r
\r
  //\r
  // Install driver model protocol(s).\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gKeyboardControllerDriver,\r
             ImageHandle,\r
             &gPs2KeyboardComponentName,\r
             &gPs2KeyboardComponentName2\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
\r
  return Status;\r
}\r
\r
Commit	Line	Data
	1	/** @file\r
	2	\r
	3	PS/2 Keyboard driver. Routines that interacts with callers,\r
	4	conforming to EFI driver model\r
	5	\r
	6	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
	7	This program and the accompanying materials\r
	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
	15	**/\r
	16	\r
	17	#include "Ps2Keyboard.h"\r
	18	\r
	19	//\r
	20	// Function prototypes\r
	21	//\r
	22	/**\r
	23	Test controller is a keyboard Controller.\r
	24	\r
	25	@param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
	26	@param Controller driver's controller\r
	27	@param RemainingDevicePath children device path\r
	28	\r
	29	@retval EFI_UNSUPPORTED controller is not floppy disk\r
	30	@retval EFI_SUCCESS controller is floppy disk\r
	31	**/\r
	32	EFI_STATUS\r
	33	EFIAPI\r
	34	KbdControllerDriverSupported (\r
	35	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	36	IN EFI_HANDLE Controller,\r
	37	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	38	);\r
	39	\r
	40	/**\r
	41	Create KEYBOARD_CONSOLE_IN_DEV instance on controller.\r
	42	\r
	43	@param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
	44	@param Controller driver controller handle\r
	45	@param RemainingDevicePath Children's device path\r
	46	\r
	47	@retval whether success to create floppy control instance.\r
	48	**/\r
	49	EFI_STATUS\r
	50	EFIAPI\r
	51	KbdControllerDriverStart (\r
	52	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	53	IN EFI_HANDLE Controller,\r
	54	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	55	);\r
	56	\r
	57	/**\r
	58	Stop this driver on ControllerHandle. Support stopping any child handles\r
	59	created by this driver.\r
	60	\r
	61	@param This Protocol instance pointer.\r
	62	@param ControllerHandle Handle of device to stop driver on\r
	63	@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
	64	children is zero stop the entire bus driver.\r
	65	@param ChildHandleBuffer List of Child Handles to Stop.\r
	66	\r
	67	@retval EFI_SUCCESS This driver is removed ControllerHandle\r
	68	@retval other This driver was not removed from this device\r
	69	\r
	70	**/\r
	71	EFI_STATUS\r
	72	EFIAPI\r
	73	KbdControllerDriverStop (\r
	74	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	75	IN EFI_HANDLE Controller,\r
	76	IN UINTN NumberOfChildren,\r
	77	IN EFI_HANDLE *ChildHandleBuffer\r
	78	);\r
	79	\r
	80	/**\r
	81	Free the waiting key notify list.\r
	82	\r
	83	@param ListHead Pointer to list head\r
	84	\r
	85	@retval EFI_INVALID_PARAMETER ListHead is NULL\r
	86	@retval EFI_SUCCESS Sucess to free NotifyList\r
	87	**/\r
	88	EFI_STATUS\r
	89	KbdFreeNotifyList (\r
	90	IN OUT LIST_ENTRY *ListHead\r
	91	);\r
	92	\r
	93	//\r
	94	// DriverBinding Protocol Instance\r
	95	//\r
	96	EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver = {\r
	97	KbdControllerDriverSupported,\r
	98	KbdControllerDriverStart,\r
	99	KbdControllerDriverStop,\r
	100	0xa,\r
	101	NULL,\r
	102	NULL\r
	103	};\r
	104	\r
	105	/**\r
	106	Test controller is a keyboard Controller.\r
	107	\r
	108	@param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
	109	@param Controller driver's controller\r
	110	@param RemainingDevicePath children device path\r
	111	\r
	112	@retval EFI_UNSUPPORTED controller is not floppy disk\r
	113	@retval EFI_SUCCESS controller is floppy disk\r
	114	**/\r
	115	EFI_STATUS\r
	116	EFIAPI\r
	117	KbdControllerDriverSupported (\r
	118	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	119	IN EFI_HANDLE Controller,\r
	120	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	121	)\r
	122	{\r
	123	EFI_STATUS Status;\r
	124	EFI_SIO_PROTOCOL *Sio;\r
	125	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	126	ACPI_HID_DEVICE_PATH *Acpi;\r
	127	\r
	128	//\r
	129	// Check whether the controller is keyboard.\r
	130	//\r
	131	Status = gBS->OpenProtocol (\r
	132	Controller,\r
	133	&gEfiDevicePathProtocolGuid,\r
	134	(VOID **) &DevicePath,\r
	135	This->DriverBindingHandle,\r
	136	Controller,\r
	137	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	138	);\r
	139	if (EFI_ERROR (Status)) {\r
	140	return Status;\r
	141	}\r
	142	\r
	143	do {\r
	144	Acpi = (ACPI_HID_DEVICE_PATH *) DevicePath;\r
	145	DevicePath = NextDevicePathNode (DevicePath);\r
	146	} while (!IsDevicePathEnd (DevicePath));\r
	147	\r
	148	if (DevicePathType (Acpi) != ACPI_DEVICE_PATH \|\|\r
	149	(DevicePathSubType (Acpi) != ACPI_DP && DevicePathSubType (Acpi) != ACPI_EXTENDED_DP)) {\r
	150	return EFI_UNSUPPORTED;\r
	151	}\r
	152	\r
	153	if (Acpi->HID != EISA_PNP_ID (0x303) \|\| Acpi->UID != 0) {\r
	154	return EFI_UNSUPPORTED;\r
	155	}\r
	156	\r
	157	//\r
	158	// Open the IO Abstraction(s) needed to perform the supported test\r
	159	//\r
	160	Status = gBS->OpenProtocol (\r
	161	Controller,\r
	162	&gEfiSioProtocolGuid,\r
	163	(VOID **) &Sio,\r
	164	This->DriverBindingHandle,\r
	165	Controller,\r
	166	EFI_OPEN_PROTOCOL_BY_DRIVER\r
	167	);\r
	168	if (EFI_ERROR (Status)) {\r
	169	return Status;\r
	170	}\r
	171	\r
	172	//\r
	173	// Close the I/O Abstraction(s) used to perform the supported test\r
	174	//\r
	175	gBS->CloseProtocol (\r
	176	Controller,\r
	177	&gEfiSioProtocolGuid,\r
	178	This->DriverBindingHandle,\r
	179	Controller\r
	180	);\r
	181	\r
	182	return Status;\r
	183	}\r
	184	\r
	185	/**\r
	186	Create KEYBOARD_CONSOLE_IN_DEV instance on controller.\r
	187	\r
	188	@param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
	189	@param Controller driver controller handle\r
	190	@param RemainingDevicePath Children's device path\r
	191	\r
	192	@retval whether success to create floppy control instance.\r
	193	**/\r
	194	EFI_STATUS\r
	195	EFIAPI\r
	196	KbdControllerDriverStart (\r
	197	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	198	IN EFI_HANDLE Controller,\r
	199	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	200	)\r
	201	{\r
	202	EFI_STATUS Status;\r
	203	EFI_STATUS Status1;\r
	204	EFI_SIO_PROTOCOL *Sio;\r
	205	KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
	206	UINT8 Data;\r
	207	EFI_STATUS_CODE_VALUE StatusCode;\r
	208	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	209	\r
	210	StatusCode = 0;\r
	211	\r
	212	Status = gBS->OpenProtocol (\r
	213	Controller,\r
	214	&gEfiDevicePathProtocolGuid,\r
	215	(VOID **) &DevicePath,\r
	216	This->DriverBindingHandle,\r
	217	Controller,\r
	218	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	219	);\r
	220	if (EFI_ERROR (Status)) {\r
	221	return Status;\r
	222	}\r
	223	//\r
	224	// Report that the keyboard is being enabled\r
	225	//\r
	226	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	227	EFI_PROGRESS_CODE,\r
	228	EFI_PERIPHERAL_KEYBOARD \| EFI_P_PC_ENABLE,\r
	229	DevicePath\r
	230	);\r
	231	\r
	232	//\r
	233	// Get the ISA I/O Protocol on Controller's handle\r
	234	//\r
	235	Status = gBS->OpenProtocol (\r
	236	Controller,\r
	237	&gEfiSioProtocolGuid,\r
	238	(VOID **) &Sio,\r
	239	This->DriverBindingHandle,\r
	240	Controller,\r
	241	EFI_OPEN_PROTOCOL_BY_DRIVER\r
	242	);\r
	243	if (EFI_ERROR (Status)) {\r
	244	return Status;\r
	245	}\r
	246	//\r
	247	// Allocate private data\r
	248	//\r
	249	ConsoleIn = AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_DEV));\r
	250	if (ConsoleIn == NULL) {\r
	251	Status = EFI_OUT_OF_RESOURCES;\r
	252	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	253	goto ErrorExit;\r
	254	}\r
	255	//\r
	256	// Setup the device instance\r
	257	//\r
	258	ConsoleIn->Signature = KEYBOARD_CONSOLE_IN_DEV_SIGNATURE;\r
	259	ConsoleIn->Handle = Controller;\r
	260	(ConsoleIn->ConIn).Reset = KeyboardEfiReset;\r
	261	(ConsoleIn->ConIn).ReadKeyStroke = KeyboardReadKeyStroke;\r
	262	ConsoleIn->DataRegisterAddress = KEYBOARD_8042_DATA_REGISTER;\r
	263	ConsoleIn->StatusRegisterAddress = KEYBOARD_8042_STATUS_REGISTER;\r
	264	ConsoleIn->CommandRegisterAddress = KEYBOARD_8042_COMMAND_REGISTER;\r
	265	ConsoleIn->DevicePath = DevicePath;\r
	266	\r
	267	ConsoleIn->ConInEx.Reset = KeyboardEfiResetEx;\r
	268	ConsoleIn->ConInEx.ReadKeyStrokeEx = KeyboardReadKeyStrokeEx;\r
	269	ConsoleIn->ConInEx.SetState = KeyboardSetState;\r
	270	ConsoleIn->ConInEx.RegisterKeyNotify = KeyboardRegisterKeyNotify;\r
	271	ConsoleIn->ConInEx.UnregisterKeyNotify = KeyboardUnregisterKeyNotify;\r
	272	\r
	273	InitializeListHead (&ConsoleIn->NotifyList);\r
	274	\r
	275	//\r
	276	// Fix for random hangs in System waiting for the Key if no KBC is present in BIOS.\r
	277	// When KBC decode (IO port 0x60/0x64 decode) is not enabled,\r
	278	// KeyboardRead will read back as 0xFF and return status is EFI_SUCCESS.\r
	279	// So instead we read status register to detect after read if KBC decode is enabled.\r
	280	//\r
	281	\r
	282	//\r
	283	// Return code is ignored on purpose.\r
	284	//\r
	285	if (!PcdGetBool (PcdFastPS2Detection)) {\r
	286	KeyboardRead (ConsoleIn, &Data);\r
	287	if ((KeyReadStatusRegister (ConsoleIn) & (KBC_PARE \| KBC_TIM)) == (KBC_PARE \| KBC_TIM)) {\r
	288	//\r
	289	// If nobody decodes KBC I/O port, it will read back as 0xFF.\r
	290	// Check the Time-Out and Parity bit to see if it has an active KBC in system\r
	291	//\r
	292	Status = EFI_DEVICE_ERROR;\r
	293	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_NOT_DETECTED;\r
	294	goto ErrorExit;\r
	295	}\r
	296	}\r
	297	\r
	298	//\r
	299	// Setup the WaitForKey event\r
	300	//\r
	301	Status = gBS->CreateEvent (\r
	302	EVT_NOTIFY_WAIT,\r
	303	TPL_NOTIFY,\r
	304	KeyboardWaitForKey,\r
	305	ConsoleIn,\r
	306	&((ConsoleIn->ConIn).WaitForKey)\r
	307	);\r
	308	if (EFI_ERROR (Status)) {\r
	309	Status = EFI_OUT_OF_RESOURCES;\r
	310	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	311	goto ErrorExit;\r
	312	}\r
	313	//\r
	314	// Setup the WaitForKeyEx event\r
	315	//\r
	316	Status = gBS->CreateEvent (\r
	317	EVT_NOTIFY_WAIT,\r
	318	TPL_NOTIFY,\r
	319	KeyboardWaitForKeyEx,\r
	320	ConsoleIn,\r
	321	&(ConsoleIn->ConInEx.WaitForKeyEx)\r
	322	);\r
	323	if (EFI_ERROR (Status)) {\r
	324	Status = EFI_OUT_OF_RESOURCES;\r
	325	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	326	goto ErrorExit;\r
	327	}\r
	328	// Setup a periodic timer, used for reading keystrokes at a fixed interval\r
	329	//\r
	330	Status = gBS->CreateEvent (\r
	331	EVT_TIMER \| EVT_NOTIFY_SIGNAL,\r
	332	TPL_NOTIFY,\r
	333	KeyboardTimerHandler,\r
	334	ConsoleIn,\r
	335	&ConsoleIn->TimerEvent\r
	336	);\r
	337	if (EFI_ERROR (Status)) {\r
	338	Status = EFI_OUT_OF_RESOURCES;\r
	339	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	340	goto ErrorExit;\r
	341	}\r
	342	\r
	343	Status = gBS->SetTimer (\r
	344	ConsoleIn->TimerEvent,\r
	345	TimerPeriodic,\r
	346	KEYBOARD_TIMER_INTERVAL\r
	347	);\r
	348	if (EFI_ERROR (Status)) {\r
	349	Status = EFI_OUT_OF_RESOURCES;\r
	350	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	351	goto ErrorExit;\r
	352	}\r
	353	\r
	354	Status = gBS->CreateEvent (\r
	355	EVT_NOTIFY_SIGNAL,\r
	356	TPL_CALLBACK,\r
	357	KeyNotifyProcessHandler,\r
	358	ConsoleIn,\r
	359	&ConsoleIn->KeyNotifyProcessEvent\r
	360	);\r
	361	if (EFI_ERROR (Status)) {\r
	362	Status = EFI_OUT_OF_RESOURCES;\r
	363	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	364	goto ErrorExit;\r
	365	}\r
	366	\r
	367	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	368	EFI_PROGRESS_CODE,\r
	369	EFI_PERIPHERAL_KEYBOARD \| EFI_P_PC_PRESENCE_DETECT,\r
	370	DevicePath\r
	371	);\r
	372	\r
	373	//\r
	374	// Reset the keyboard device\r
	375	//\r
	376	Status = ConsoleIn->ConInEx.Reset (&ConsoleIn->ConInEx, FeaturePcdGet (PcdPs2KbdExtendedVerification));\r
	377	if (EFI_ERROR (Status)) {\r
	378	Status = EFI_DEVICE_ERROR;\r
	379	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_NOT_DETECTED;\r
	380	goto ErrorExit;\r
	381	}\r
	382	\r
	383	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	384	EFI_PROGRESS_CODE,\r
	385	EFI_PERIPHERAL_KEYBOARD \| EFI_P_PC_DETECTED,\r
	386	DevicePath\r
	387	);\r
	388	\r
	389	ConsoleIn->ControllerNameTable = NULL;\r
	390	AddUnicodeString2 (\r
	391	"eng",\r
	392	gPs2KeyboardComponentName.SupportedLanguages,\r
	393	&ConsoleIn->ControllerNameTable,\r
	394	L"PS/2 Keyboard Device",\r
	395	TRUE\r
	396	);\r
	397	AddUnicodeString2 (\r
	398	"en",\r
	399	gPs2KeyboardComponentName2.SupportedLanguages,\r
	400	&ConsoleIn->ControllerNameTable,\r
	401	L"PS/2 Keyboard Device",\r
	402	FALSE\r
	403	);\r
	404	\r
	405	\r
	406	//\r
	407	// Install protocol interfaces for the keyboard device.\r
	408	//\r
	409	Status = gBS->InstallMultipleProtocolInterfaces (\r
	410	&Controller,\r
	411	&gEfiSimpleTextInProtocolGuid,\r
	412	&ConsoleIn->ConIn,\r
	413	&gEfiSimpleTextInputExProtocolGuid,\r
	414	&ConsoleIn->ConInEx,\r
	415	NULL\r
	416	);\r
	417	if (EFI_ERROR (Status)) {\r
	418	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	419	goto ErrorExit;\r
	420	}\r
	421	\r
	422	return Status;\r
	423	\r
	424	ErrorExit:\r
	425	//\r
	426	// Report error code\r
	427	//\r
	428	if (StatusCode != 0) {\r
	429	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	430	EFI_ERROR_CODE \| EFI_ERROR_MINOR,\r
	431	StatusCode,\r
	432	DevicePath\r
	433	);\r
	434	}\r
	435	\r
	436	if ((ConsoleIn != NULL) && (ConsoleIn->ConIn.WaitForKey != NULL)) {\r
	437	gBS->CloseEvent (ConsoleIn->ConIn.WaitForKey);\r
	438	}\r
	439	\r
	440	if ((ConsoleIn != NULL) && (ConsoleIn->TimerEvent != NULL)) {\r
	441	gBS->CloseEvent (ConsoleIn->TimerEvent);\r
	442	}\r
	443	if ((ConsoleIn != NULL) && (ConsoleIn->ConInEx.WaitForKeyEx != NULL)) {\r
	444	gBS->CloseEvent (ConsoleIn->ConInEx.WaitForKeyEx);\r
	445	}\r
	446	if ((ConsoleIn != NULL) && (ConsoleIn->KeyNotifyProcessEvent != NULL)) {\r
	447	gBS->CloseEvent (ConsoleIn->KeyNotifyProcessEvent);\r
	448	}\r
	449	KbdFreeNotifyList (&ConsoleIn->NotifyList);\r
	450	if ((ConsoleIn != NULL) && (ConsoleIn->ControllerNameTable != NULL)) {\r
	451	FreeUnicodeStringTable (ConsoleIn->ControllerNameTable);\r
	452	}\r
	453	//\r
	454	// Since there will be no timer handler for keyboard input any more,\r
	455	// exhaust input data just in case there is still keyboard data left\r
	456	//\r
	457	if (ConsoleIn != NULL) {\r
	458	Status1 = EFI_SUCCESS;\r
	459	while (!EFI_ERROR (Status1) && (Status != EFI_DEVICE_ERROR)) {\r
	460	Status1 = KeyboardRead (ConsoleIn, &Data);;\r
	461	}\r
	462	}\r
	463	\r
	464	if (ConsoleIn != NULL) {\r
	465	gBS->FreePool (ConsoleIn);\r
	466	}\r
	467	\r
	468	gBS->CloseProtocol (\r
	469	Controller,\r
	470	&gEfiSioProtocolGuid,\r
	471	This->DriverBindingHandle,\r
	472	Controller\r
	473	);\r
	474	\r
	475	return Status;\r
	476	}\r
	477	\r
	478	/**\r
	479	Stop this driver on ControllerHandle. Support stopping any child handles\r
	480	created by this driver.\r
	481	\r
	482	@param This Protocol instance pointer.\r
	483	@param ControllerHandle Handle of device to stop driver on\r
	484	@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
	485	children is zero stop the entire bus driver.\r
	486	@param ChildHandleBuffer List of Child Handles to Stop.\r
	487	\r
	488	@retval EFI_SUCCESS This driver is removed ControllerHandle\r
	489	@retval other This driver was not removed from this device\r
	490	\r
	491	**/\r
	492	EFI_STATUS\r
	493	EFIAPI\r
	494	KbdControllerDriverStop (\r
	495	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	496	IN EFI_HANDLE Controller,\r
	497	IN UINTN NumberOfChildren,\r
	498	IN EFI_HANDLE *ChildHandleBuffer\r
	499	)\r
	500	{\r
	501	EFI_STATUS Status;\r
	502	EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;\r
	503	KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
	504	UINT8 Data;\r
	505	\r
	506	//\r
	507	// Disable Keyboard\r
	508	//\r
	509	Status = gBS->OpenProtocol (\r
	510	Controller,\r
	511	&gEfiSimpleTextInProtocolGuid,\r
	512	(VOID **) &ConIn,\r
	513	This->DriverBindingHandle,\r
	514	Controller,\r
	515	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	516	);\r
	517	if (EFI_ERROR (Status)) {\r
	518	return Status;\r
	519	}\r
	520	Status = gBS->OpenProtocol (\r
	521	Controller,\r
	522	&gEfiSimpleTextInputExProtocolGuid,\r
	523	NULL,\r
	524	This->DriverBindingHandle,\r
	525	Controller,\r
	526	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
	527	);\r
	528	if (EFI_ERROR (Status)) {\r
	529	return Status;\r
	530	}\r
	531	\r
	532	ConsoleIn = KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (ConIn);\r
	533	\r
	534	//\r
	535	// Report that the keyboard is being disabled\r
	536	//\r
	537	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	538	EFI_PROGRESS_CODE,\r
	539	EFI_PERIPHERAL_KEYBOARD \| EFI_P_PC_DISABLE,\r
	540	ConsoleIn->DevicePath\r
	541	);\r
	542	\r
	543	if (ConsoleIn->TimerEvent != NULL) {\r
	544	gBS->CloseEvent (ConsoleIn->TimerEvent);\r
	545	ConsoleIn->TimerEvent = NULL;\r
	546	}\r
	547	\r
	548	//\r
	549	// Since there will be no timer handler for keyboard input any more,\r
	550	// exhaust input data just in case there is still keyboard data left\r
	551	//\r
	552	Status = EFI_SUCCESS;\r
	553	while (!EFI_ERROR (Status)) {\r
	554	Status = KeyboardRead (ConsoleIn, &Data);;\r
	555	}\r
	556	//\r
	557	// Uninstall the SimpleTextIn and SimpleTextInEx protocols\r
	558	//\r
	559	Status = gBS->UninstallMultipleProtocolInterfaces (\r
	560	Controller,\r
	561	&gEfiSimpleTextInProtocolGuid,\r
	562	&ConsoleIn->ConIn,\r
	563	&gEfiSimpleTextInputExProtocolGuid,\r
	564	&ConsoleIn->ConInEx,\r
	565	NULL\r
	566	);\r
	567	if (EFI_ERROR (Status)) {\r
	568	return Status;\r
	569	}\r
	570	\r
	571	gBS->CloseProtocol (\r
	572	Controller,\r
	573	&gEfiSioProtocolGuid,\r
	574	This->DriverBindingHandle,\r
	575	Controller\r
	576	);\r
	577	\r
	578	//\r
	579	// Free other resources\r
	580	//\r
	581	if ((ConsoleIn->ConIn).WaitForKey != NULL) {\r
	582	gBS->CloseEvent ((ConsoleIn->ConIn).WaitForKey);\r
	583	(ConsoleIn->ConIn).WaitForKey = NULL;\r
	584	}\r
	585	if (ConsoleIn->ConInEx.WaitForKeyEx != NULL) {\r
	586	gBS->CloseEvent (ConsoleIn->ConInEx.WaitForKeyEx);\r
	587	ConsoleIn->ConInEx.WaitForKeyEx = NULL;\r
	588	}\r
	589	if (ConsoleIn->KeyNotifyProcessEvent != NULL) {\r
	590	gBS->CloseEvent (ConsoleIn->KeyNotifyProcessEvent);\r
	591	ConsoleIn->KeyNotifyProcessEvent = NULL;\r
	592	}\r
	593	KbdFreeNotifyList (&ConsoleIn->NotifyList);\r
	594	FreeUnicodeStringTable (ConsoleIn->ControllerNameTable);\r
	595	gBS->FreePool (ConsoleIn);\r
	596	\r
	597	return EFI_SUCCESS;\r
	598	}\r
	599	\r
	600	/**\r
	601	Free the waiting key notify list.\r
	602	\r
	603	@param ListHead Pointer to list head\r
	604	\r
	605	@retval EFI_INVALID_PARAMETER ListHead is NULL\r
	606	@retval EFI_SUCCESS Sucess to free NotifyList\r
	607	**/\r
	608	EFI_STATUS\r
	609	KbdFreeNotifyList (\r
	610	IN OUT LIST_ENTRY *ListHead\r
	611	)\r
	612	{\r
	613	KEYBOARD_CONSOLE_IN_EX_NOTIFY *NotifyNode;\r
	614	\r
	615	if (ListHead == NULL) {\r
	616	return EFI_INVALID_PARAMETER;\r
	617	}\r
	618	while (!IsListEmpty (ListHead)) {\r
	619	NotifyNode = CR (\r
	620	ListHead->ForwardLink,\r
	621	KEYBOARD_CONSOLE_IN_EX_NOTIFY,\r
	622	NotifyEntry,\r
	623	KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
	624	);\r
	625	RemoveEntryList (ListHead->ForwardLink);\r
	626	gBS->FreePool (NotifyNode);\r
	627	}\r
	628	\r
	629	return EFI_SUCCESS;\r
	630	}\r
	631	\r
	632	/**\r
	633	The module Entry Point for module Ps2Keyboard.\r
	634	\r
	635	@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
	636	@param[in] SystemTable A pointer to the EFI System Table.\r
	637	\r
	638	@retval EFI_SUCCESS The entry point is executed successfully.\r
	639	@retval other Some error occurs when executing this entry point.\r
	640	\r
	641	**/\r
	642	EFI_STATUS\r
	643	EFIAPI\r
	644	InitializePs2Keyboard(\r
	645	IN EFI_HANDLE ImageHandle,\r
	646	IN EFI_SYSTEM_TABLE *SystemTable\r
	647	)\r
	648	{\r
	649	EFI_STATUS Status;\r
	650	\r
	651	//\r
	652	// Install driver model protocol(s).\r
	653	//\r
	654	Status = EfiLibInstallDriverBindingComponentName2 (\r
	655	ImageHandle,\r
	656	SystemTable,\r
	657	&gKeyboardControllerDriver,\r
	658	ImageHandle,\r
	659	&gPs2KeyboardComponentName,\r
	660	&gPs2KeyboardComponentName2\r
	661	);\r
	662	ASSERT_EFI_ERROR (Status);\r
	663	\r
	664	\r
	665	return Status;\r
	666	}\r
	667	\r