[mirror_edk2.git] / IntelFrameworkModulePkg / 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 - 2007, Intel Corporation\r
All rights reserved. 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
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\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\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\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_ISA_IO_PROTOCOL                 *IsaIo;\r
\r
  //\r
  // Open the IO Abstraction(s) needed to perform the supported test\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiIsaIoProtocolGuid,\r
                  (VOID **) &IsaIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // Use the ISA I/O Protocol to see if Controller is the Keyboard controller\r
  //\r
  if (IsaIo->ResourceList->Device.HID != EISA_PNP_ID (0x303) || IsaIo->ResourceList->Device.UID != 0) {\r
    Status = EFI_UNSUPPORTED;\r
  }\r
  //\r
  // Close the I/O Abstraction(s) used to perform the supported test\r
  //\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiIsaIoProtocolGuid,\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_ISA_IO_PROTOCOL                       *IsaIo;\r
  KEYBOARD_CONSOLE_IN_DEV                   *ConsoleIn;\r
  UINT8                                     Data;\r
  EFI_STATUS_CODE_VALUE                     StatusCode;\r
  EFI_DEVICE_PATH_PROTOCOL                  *ParentDevicePath;\r
\r
  StatusCode = 0;\r
\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **) &ParentDevicePath,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\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
    ParentDevicePath\r
    );\r
\r
  //\r
  // Get the ISA I/O Protocol on Controller's handle\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiIsaIoProtocolGuid,\r
                  (VOID **) &IsaIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    gBS->CloseProtocol (\r
           Controller,\r
           &gEfiDevicePathProtocolGuid,\r
           This->DriverBindingHandle,\r
           Controller\r
           );\r
    return EFI_INVALID_PARAMETER;\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->IsaIo                  = IsaIo;\r
  ConsoleIn->ScancodeBufStartPos    = 0;\r
  ConsoleIn->ScancodeBufEndPos      = KEYBOARD_BUFFER_MAX_COUNT - 1;\r
  ConsoleIn->ScancodeBufCount       = 0;\r
  ConsoleIn->Ctrled                 = FALSE;\r
  ConsoleIn->Alted                  = FALSE;\r
  ConsoleIn->DevicePath             = ParentDevicePath;\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
  // Setup the WaitForKey event\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_WAIT,\r
                  TPL_NOTIFY,\r
                  KeyboardWaitForKey,\r
                  &(ConsoleIn->ConIn),\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->ConInEx),\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
  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
    EFI_PROGRESS_CODE,\r
    EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_PRESENCE_DETECT,\r
    ParentDevicePath\r
    );\r
\r
  //\r
  // Reset the keyboard device\r
  //\r
  Status = ConsoleIn->ConIn.Reset (&ConsoleIn->ConIn, TRUE);\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
  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
      ParentDevicePath\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
  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)) {\r
      Status1 = KeyboardRead (ConsoleIn, &Data);;\r
    }\r
  }\r
  \r
  if (ConsoleIn != NULL) {\r
    gBS->FreePool (ConsoleIn);\r
  }\r
\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiDevicePathProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiIsaIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop this driver on ControllerHandle. Support stoping 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) {\r
    gBS->CloseEvent (ConsoleIn->TimerEvent);\r
    ConsoleIn->TimerEvent = NULL;\r
  }\r
  //\r
  // Disable the keyboard interface\r
  //\r
  Status = DisableKeyboard (ConsoleIn);\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
         &gEfiDevicePathProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiIsaIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
  //\r
  // Free other resources\r
  //\r
  if ((ConsoleIn->ConIn).WaitForKey) {\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
  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
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 user Entry Point for module Ps2Keyboard. The user code starts with this function.\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
f8cd287b	1	/**@file\r
	2	\r
	3	PS/2 Keyboard driver. Routines that interacts with callers,\r
	4	conforming to EFI driver model\r
05fbd06d	5	\r
df0dcb5e	6	Copyright (c) 2006 - 2007, Intel Corporation\r
	7	All rights reserved. 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
05fbd06d	14	\r
f8cd287b	15	**/\r
05fbd06d	16	\r
05fbd06d	17	#include "Ps2Keyboard.h"\r
	18	\r
	19	//\r
	20	// Function prototypes\r
	21	//\r
	22	EFI_STATUS\r
	23	EFIAPI\r
	24	KbdControllerDriverSupported (\r
	25	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	26	IN EFI_HANDLE Controller,\r
	27	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	28	);\r
	29	\r
	30	EFI_STATUS\r
	31	EFIAPI\r
	32	KbdControllerDriverStart (\r
	33	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	34	IN EFI_HANDLE Controller,\r
	35	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	36	);\r
	37	\r
	38	EFI_STATUS\r
	39	EFIAPI\r
	40	KbdControllerDriverStop (\r
	41	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	42	IN EFI_HANDLE Controller,\r
	43	IN UINTN NumberOfChildren,\r
	44	IN EFI_HANDLE *ChildHandleBuffer\r
	45	);\r
	46	\r
f3d1e940	47	EFI_STATUS\r
	48	KbdFreeNotifyList (\r
	49	IN OUT LIST_ENTRY *ListHead\r
	50	); \r
	51	\r
05fbd06d	52	//\r
	53	// DriverBinding Protocol Instance\r
	54	//\r
	55	EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver = {\r
	56	KbdControllerDriverSupported,\r
	57	KbdControllerDriverStart,\r
	58	KbdControllerDriverStop,\r
	59	0xa,\r
	60	NULL,\r
	61	NULL\r
	62	};\r
	63	\r
bcd70414	64	/**\r
	65	Test controller is a keyboard Controller\r
	66	\r
	67	@param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
	68	@param Controller driver's controller\r
	69	@param RemainingDevicePath children device path\r
	70	\r
	71	@retval EFI_UNSUPPORTED controller is not floppy disk\r
	72	@retval EFI_SUCCESS controller is floppy disk\r
	73	**/\r
05fbd06d	74	EFI_STATUS\r
	75	EFIAPI\r
	76	KbdControllerDriverSupported (\r
	77	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	78	IN EFI_HANDLE Controller,\r
	79	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	80	)\r
05fbd06d	81	{\r
	82	EFI_STATUS Status;\r
	83	EFI_ISA_IO_PROTOCOL *IsaIo;\r
	84	\r
	85	//\r
	86	// Open the IO Abstraction(s) needed to perform the supported test\r
	87	//\r
	88	Status = gBS->OpenProtocol (\r
	89	Controller,\r
	90	&gEfiIsaIoProtocolGuid,\r
	91	(VOID **) &IsaIo,\r
	92	This->DriverBindingHandle,\r
	93	Controller,\r
	94	EFI_OPEN_PROTOCOL_BY_DRIVER\r
	95	);\r
	96	if (EFI_ERROR (Status)) {\r
	97	return Status;\r
	98	}\r
	99	//\r
	100	// Use the ISA I/O Protocol to see if Controller is the Keyboard controller\r
	101	//\r
	102	if (IsaIo->ResourceList->Device.HID != EISA_PNP_ID (0x303) \|\| IsaIo->ResourceList->Device.UID != 0) {\r
	103	Status = EFI_UNSUPPORTED;\r
	104	}\r
	105	//\r
	106	// Close the I/O Abstraction(s) used to perform the supported test\r
	107	//\r
	108	gBS->CloseProtocol (\r
	109	Controller,\r
	110	&gEfiIsaIoProtocolGuid,\r
	111	This->DriverBindingHandle,\r
	112	Controller\r
	113	);\r
	114	\r
	115	return Status;\r
	116	}\r
	117	\r
bcd70414	118	/**\r
	119	Create KEYBOARD_CONSOLE_IN_DEV instance on controller.\r
	120	\r
	121	@param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
	122	@param Controller driver controller handle\r
	123	@param RemainingDevicePath Children's device path\r
	124	\r
	125	@retval whether success to create floppy control instance.\r
	126	**/\r
05fbd06d	127	EFI_STATUS\r
	128	EFIAPI\r
	129	KbdControllerDriverStart (\r
	130	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	131	IN EFI_HANDLE Controller,\r
	132	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	133	)\r
05fbd06d	134	{\r
	135	EFI_STATUS Status;\r
	136	EFI_STATUS Status1;\r
	137	EFI_ISA_IO_PROTOCOL *IsaIo;\r
	138	KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
	139	UINT8 Data;\r
	140	EFI_STATUS_CODE_VALUE StatusCode;\r
	141	EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
	142	\r
	143	StatusCode = 0;\r
	144	\r
	145	Status = gBS->OpenProtocol (\r
	146	Controller,\r
	147	&gEfiDevicePathProtocolGuid,\r
	148	(VOID **) &ParentDevicePath,\r
	149	This->DriverBindingHandle,\r
	150	Controller,\r
	151	EFI_OPEN_PROTOCOL_BY_DRIVER\r
	152	);\r
	153	if (EFI_ERROR (Status)) {\r
	154	return Status;\r
	155	}\r
	156	//\r
	157	// Report that the keyboard is being enabled\r
	158	//\r
	159	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	160	EFI_PROGRESS_CODE,\r
	161	EFI_PERIPHERAL_KEYBOARD \| EFI_P_PC_ENABLE,\r
	162	ParentDevicePath\r
	163	);\r
	164	\r
	165	//\r
	166	// Get the ISA I/O Protocol on Controller's handle\r
	167	//\r
	168	Status = gBS->OpenProtocol (\r
	169	Controller,\r
	170	&gEfiIsaIoProtocolGuid,\r
	171	(VOID **) &IsaIo,\r
	172	This->DriverBindingHandle,\r
	173	Controller,\r
	174	EFI_OPEN_PROTOCOL_BY_DRIVER\r
	175	);\r
	176	if (EFI_ERROR (Status)) {\r
	177	gBS->CloseProtocol (\r
	178	Controller,\r
	179	&gEfiDevicePathProtocolGuid,\r
	180	This->DriverBindingHandle,\r
	181	Controller\r
	182	);\r
	183	return EFI_INVALID_PARAMETER;\r
	184	}\r
	185	//\r
	186	// Allocate private data\r
	187	//\r
	188	ConsoleIn = AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_DEV));\r
	189	if (ConsoleIn == NULL) {\r
	190	Status = EFI_OUT_OF_RESOURCES;\r
	191	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	192	goto ErrorExit;\r
	193	}\r
	194	//\r
	195	// Setup the device instance\r
	196	//\r
	197	ConsoleIn->Signature = KEYBOARD_CONSOLE_IN_DEV_SIGNATURE;\r
198	ConsoleIn->Handle = Controller;\r
199	(ConsoleIn->ConIn).Reset = KeyboardEfiReset;\r
200	(ConsoleIn->ConIn).ReadKeyStroke = KeyboardReadKeyStroke;\r
201	ConsoleIn->DataRegisterAddress = KEYBOARD_8042_DATA_REGISTER;\r
202	ConsoleIn->StatusRegisterAddress = KEYBOARD_8042_STATUS_REGISTER;\r
203	ConsoleIn->CommandRegisterAddress = KEYBOARD_8042_COMMAND_REGISTER;\r
204	ConsoleIn->IsaIo = IsaIo;\r
205	ConsoleIn->ScancodeBufStartPos = 0;\r
206	ConsoleIn->ScancodeBufEndPos = KEYBOARD_BUFFER_MAX_COUNT - 1;\r
207	ConsoleIn->ScancodeBufCount = 0;\r
208	ConsoleIn->Ctrled = FALSE;\r
209	ConsoleIn->Alted = FALSE;\r
210	ConsoleIn->DevicePath = ParentDevicePath;\r
211	\r
f3d1e940	212	ConsoleIn->ConInEx.Reset = KeyboardEfiResetEx;\r
	213	ConsoleIn->ConInEx.ReadKeyStrokeEx = KeyboardReadKeyStrokeEx;\r
	214	ConsoleIn->ConInEx.SetState = KeyboardSetState;\r
	215	ConsoleIn->ConInEx.RegisterKeyNotify = KeyboardRegisterKeyNotify;\r
	216	ConsoleIn->ConInEx.UnregisterKeyNotify = KeyboardUnregisterKeyNotify; \r
	217	\r
	218	InitializeListHead (&ConsoleIn->NotifyList);\r
05fbd06d	219	//\r
	220	// Setup the WaitForKey event\r
	221	//\r
	222	Status = gBS->CreateEvent (\r
	223	EVT_NOTIFY_WAIT,\r
	224	TPL_NOTIFY,\r
	225	KeyboardWaitForKey,\r
	226	&(ConsoleIn->ConIn),\r
	227	&((ConsoleIn->ConIn).WaitForKey)\r
	228	);\r
	229	if (EFI_ERROR (Status)) {\r
	230	Status = EFI_OUT_OF_RESOURCES;\r
	231	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	232	goto ErrorExit;\r
	233	}\r
	234	//\r
f3d1e940	235	// Setup the WaitForKeyEx event\r
	236	// \r
	237	Status = gBS->CreateEvent (\r
	238	EVT_NOTIFY_WAIT,\r
	239	TPL_NOTIFY,\r
	240	KeyboardWaitForKeyEx,\r
	241	&(ConsoleIn->ConInEx),\r
	242	&(ConsoleIn->ConInEx.WaitForKeyEx)\r
	243	);\r
	244	if (EFI_ERROR (Status)) {\r
	245	Status = EFI_OUT_OF_RESOURCES;\r
	246	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	247	goto ErrorExit;\r
	248	}\r
05fbd06d	249	// Setup a periodic timer, used for reading keystrokes at a fixed interval\r
	250	//\r
	251	Status = gBS->CreateEvent (\r
	252	EVT_TIMER \| EVT_NOTIFY_SIGNAL,\r
	253	TPL_NOTIFY,\r
	254	KeyboardTimerHandler,\r
	255	ConsoleIn,\r
	256	&ConsoleIn->TimerEvent\r
	257	);\r
	258	if (EFI_ERROR (Status)) {\r
	259	Status = EFI_OUT_OF_RESOURCES;\r
	260	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	261	goto ErrorExit;\r
	262	}\r
	263	\r
	264	Status = gBS->SetTimer (\r
	265	ConsoleIn->TimerEvent,\r
	266	TimerPeriodic,\r
	267	KEYBOARD_TIMER_INTERVAL\r
	268	);\r
	269	if (EFI_ERROR (Status)) {\r
	270	Status = EFI_OUT_OF_RESOURCES;\r
	271	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	272	goto ErrorExit;\r
	273	}\r
	274	\r
	275	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	276	EFI_PROGRESS_CODE,\r
	277	EFI_PERIPHERAL_KEYBOARD \| EFI_P_PC_PRESENCE_DETECT,\r
	278	ParentDevicePath\r
	279	);\r
	280	\r
	281	//\r
	282	// Reset the keyboard device\r
	283	//\r
	284	Status = ConsoleIn->ConIn.Reset (&ConsoleIn->ConIn, TRUE);\r
	285	if (EFI_ERROR (Status)) {\r
	286	Status = EFI_DEVICE_ERROR;\r
	287	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_NOT_DETECTED;\r
	288	goto ErrorExit;\r
	289	}\r
	290	\r
	291	ConsoleIn->ControllerNameTable = NULL;\r
f3d08ccf	292	AddUnicodeString2 (\r
05fbd06d	293	"eng",\r
	294	gPs2KeyboardComponentName.SupportedLanguages,\r
	295	&ConsoleIn->ControllerNameTable,\r
f3d08ccf	296	L"PS/2 Keyboard Device",\r
f3d08ccf	297	TRUE\r
05fbd06d	298	);\r
f3d08ccf	299	AddUnicodeString2 (\r
	300	"en",\r
	301	gPs2KeyboardComponentName2.SupportedLanguages,\r
	302	&ConsoleIn->ControllerNameTable,\r
	303	L"PS/2 Keyboard Device",\r
	304	FALSE\r
	305	);\r
	306	\r
05fbd06d	307	\r
	308	//\r
	309	// Install protocol interfaces for the keyboard device.\r
	310	//\r
	311	Status = gBS->InstallMultipleProtocolInterfaces (\r
	312	&Controller,\r
	313	&gEfiSimpleTextInProtocolGuid,\r
	314	&ConsoleIn->ConIn,\r
f3d1e940	315	&gEfiSimpleTextInputExProtocolGuid,\r
f3d1e940	316	&ConsoleIn->ConInEx,\r
05fbd06d	317	NULL\r
	318	);\r
	319	if (EFI_ERROR (Status)) {\r
	320	StatusCode = EFI_PERIPHERAL_KEYBOARD \| EFI_P_EC_CONTROLLER_ERROR;\r
	321	goto ErrorExit;\r
	322	}\r
	323	\r
	324	return Status;\r
	325	\r
	326	ErrorExit:\r
	327	//\r
	328	// Report error code\r
	329	//\r
	330	if (StatusCode != 0) {\r
	331	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	332	EFI_ERROR_CODE \| EFI_ERROR_MINOR,\r
	333	StatusCode,\r
	334	ParentDevicePath\r
	335	);\r
	336	}\r
	337	\r
	338	if ((ConsoleIn != NULL) && (ConsoleIn->ConIn.WaitForKey != NULL)) {\r
	339	gBS->CloseEvent (ConsoleIn->ConIn.WaitForKey);\r
	340	}\r
	341	\r
	342	if ((ConsoleIn != NULL) && (ConsoleIn->TimerEvent != NULL)) {\r
	343	gBS->CloseEvent (ConsoleIn->TimerEvent);\r
	344	}\r
f3d1e940	345	if ((ConsoleIn != NULL) && (ConsoleIn->ConInEx.WaitForKeyEx != NULL)) {\r
	346	gBS->CloseEvent (ConsoleIn->ConInEx.WaitForKeyEx);\r
	347	}\r
	348	KbdFreeNotifyList (&ConsoleIn->NotifyList);\r
05fbd06d	349	if ((ConsoleIn != NULL) && (ConsoleIn->ControllerNameTable != NULL)) {\r
	350	FreeUnicodeStringTable (ConsoleIn->ControllerNameTable);\r
	351	}\r
	352	//\r
	353	// Since there will be no timer handler for keyboard input any more,\r
	354	// exhaust input data just in case there is still keyboard data left\r
	355	//\r
261136bc	356	if (ConsoleIn != NULL) {\r
	357	Status1 = EFI_SUCCESS;\r
	358	while (!EFI_ERROR (Status1)) {\r
	359	Status1 = KeyboardRead (ConsoleIn, &Data);;\r
	360	}\r
05fbd06d	361	}\r
261136bc	362	\r
05fbd06d	363	if (ConsoleIn != NULL) {\r
	364	gBS->FreePool (ConsoleIn);\r
	365	}\r
	366	\r
	367	gBS->CloseProtocol (\r
	368	Controller,\r
	369	&gEfiDevicePathProtocolGuid,\r
	370	This->DriverBindingHandle,\r
	371	Controller\r
	372	);\r
	373	\r
	374	gBS->CloseProtocol (\r
	375	Controller,\r
	376	&gEfiIsaIoProtocolGuid,\r
	377	This->DriverBindingHandle,\r
	378	Controller\r
	379	);\r
	380	\r
	381	return Status;\r
	382	}\r
	383	\r
bcd70414	384	/**\r
	385	Stop this driver on ControllerHandle. Support stoping any child handles\r
	386	created by this driver.\r
	387	\r
	388	@param This Protocol instance pointer.\r
	389	@param ControllerHandle Handle of device to stop driver on\r
	390	@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
	391	children is zero stop the entire bus driver.\r
	392	@param ChildHandleBuffer List of Child Handles to Stop.\r
	393	\r
	394	@retval EFI_SUCCESS This driver is removed ControllerHandle\r
	395	@retval other This driver was not removed from this device\r
	396	\r
	397	**/\r
05fbd06d	398	EFI_STATUS\r
	399	EFIAPI\r
	400	KbdControllerDriverStop (\r
	401	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	402	IN EFI_HANDLE Controller,\r
	403	IN UINTN NumberOfChildren,\r
	404	IN EFI_HANDLE *ChildHandleBuffer\r
	405	)\r
05fbd06d	406	{\r
	407	EFI_STATUS Status;\r
	408	EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;\r
	409	KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
	410	UINT8 Data;\r
	411	\r
	412	//\r
	413	// Disable Keyboard\r
	414	//\r
	415	Status = gBS->OpenProtocol (\r
	416	Controller,\r
	417	&gEfiSimpleTextInProtocolGuid,\r
	418	(VOID **) &ConIn,\r
	419	This->DriverBindingHandle,\r
	420	Controller,\r
	421	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	422	);\r
	423	if (EFI_ERROR (Status)) {\r
	424	return Status;\r
	425	}\r
f3d1e940	426	Status = gBS->OpenProtocol (\r
	427	Controller,\r
	428	&gEfiSimpleTextInputExProtocolGuid,\r
	429	NULL,\r
	430	This->DriverBindingHandle,\r
	431	Controller,\r
	432	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
	433	);\r
	434	if (EFI_ERROR (Status)) {\r
	435	return Status;\r
	436	}\r
	437	\r
05fbd06d	438	ConsoleIn = KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (ConIn);\r
	439	\r
	440	//\r
	441	// Report that the keyboard is being disabled\r
	442	//\r
	443	REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
	444	EFI_PROGRESS_CODE,\r
	445	EFI_PERIPHERAL_KEYBOARD \| EFI_P_PC_DISABLE,\r
	446	ConsoleIn->DevicePath\r
	447	);\r
	448	\r
	449	if (ConsoleIn->TimerEvent) {\r
	450	gBS->CloseEvent (ConsoleIn->TimerEvent);\r
	451	ConsoleIn->TimerEvent = NULL;\r
	452	}\r
	453	//\r
	454	// Disable the keyboard interface\r
	455	//\r
	456	Status = DisableKeyboard (ConsoleIn);\r
	457	\r
	458	//\r
	459	// Since there will be no timer handler for keyboard input any more,\r
	460	// exhaust input data just in case there is still keyboard data left\r
	461	//\r
	462	Status = EFI_SUCCESS;\r
	463	while (!EFI_ERROR (Status)) {\r
	464	Status = KeyboardRead (ConsoleIn, &Data);;\r
	465	}\r
	466	//\r
f3d1e940	467	// Uninstall the SimpleTextIn and SimpleTextInEx protocols\r
05fbd06d	468	//\r
f3d1e940	469	Status = gBS->UninstallMultipleProtocolInterfaces (\r
05fbd06d	470	Controller,\r
05fbd06d	471	&gEfiSimpleTextInProtocolGuid,\r
f3d1e940	472	&ConsoleIn->ConIn,\r
	473	&gEfiSimpleTextInputExProtocolGuid,\r
	474	&ConsoleIn->ConInEx,\r
	475	NULL\r
05fbd06d	476	);\r
	477	if (EFI_ERROR (Status)) {\r
	478	return Status;\r
	479	}\r
	480	\r
	481	gBS->CloseProtocol (\r
	482	Controller,\r
	483	&gEfiDevicePathProtocolGuid,\r
	484	This->DriverBindingHandle,\r
	485	Controller\r
	486	);\r
	487	\r
	488	gBS->CloseProtocol (\r
	489	Controller,\r
	490	&gEfiIsaIoProtocolGuid,\r
	491	This->DriverBindingHandle,\r
	492	Controller\r
	493	);\r
	494	\r
	495	//\r
	496	// Free other resources\r
	497	//\r
	498	if ((ConsoleIn->ConIn).WaitForKey) {\r
	499	gBS->CloseEvent ((ConsoleIn->ConIn).WaitForKey);\r
	500	(ConsoleIn->ConIn).WaitForKey = NULL;\r
	501	}\r
f3d1e940	502	if (ConsoleIn->ConInEx.WaitForKeyEx != NULL) {\r
	503	gBS->CloseEvent (ConsoleIn->ConInEx.WaitForKeyEx);\r
	504	ConsoleIn->ConInEx.WaitForKeyEx = NULL;\r
	505	}\r
	506	KbdFreeNotifyList (&ConsoleIn->NotifyList);\r
05fbd06d	507	FreeUnicodeStringTable (ConsoleIn->ControllerNameTable);\r
	508	gBS->FreePool (ConsoleIn);\r
	509	\r
	510	return EFI_SUCCESS;\r
	511	}\r
c21fc3e8	512	\r
bcd70414	513	/**\r
	514	Free the waiting key notify list.\r
	515	\r
	516	@param ListHead Pointer to list head\r
	517	**/\r
f3d1e940	518	EFI_STATUS\r
	519	KbdFreeNotifyList (\r
	520	IN OUT LIST_ENTRY *ListHead\r
	521	)\r
f3d1e940	522	{\r
	523	KEYBOARD_CONSOLE_IN_EX_NOTIFY *NotifyNode;\r
	524	\r
	525	if (ListHead == NULL) {\r
	526	return EFI_INVALID_PARAMETER;\r
	527	}\r
	528	while (!IsListEmpty (ListHead)) {\r
	529	NotifyNode = CR (\r
	530	ListHead->ForwardLink, \r
	531	KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
	532	NotifyEntry, \r
	533	KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
	534	);\r
	535	RemoveEntryList (ListHead->ForwardLink);\r
	536	gBS->FreePool (NotifyNode);\r
	537	}\r
	538	\r
	539	return EFI_SUCCESS;\r
	540	}\r
c21fc3e8	541	\r
	542	/**\r
	543	The user Entry Point for module Ps2Keyboard. The user code starts with this function.\r
	544	\r
	545	@param[in] ImageHandle The firmware allocated handle for the EFI image. \r
	546	@param[in] SystemTable A pointer to the EFI System Table.\r
	547	\r
	548	@retval EFI_SUCCESS The entry point is executed successfully.\r
	549	@retval other Some error occurs when executing this entry point.\r
	550	\r
	551	**/\r
	552	EFI_STATUS\r
	553	EFIAPI\r
	554	InitializePs2Keyboard(\r
	555	IN EFI_HANDLE ImageHandle,\r
	556	IN EFI_SYSTEM_TABLE *SystemTable\r
	557	)\r
	558	{\r
	559	EFI_STATUS Status;\r
	560	\r
	561	//\r
	562	// Install driver model protocol(s).\r
	563	//\r
f3d08ccf	564	Status = EfiLibInstallDriverBindingComponentName2 (\r
c21fc3e8	565	ImageHandle,\r
	566	SystemTable,\r
	567	&gKeyboardControllerDriver,\r
	568	ImageHandle,\r
	569	&gPs2KeyboardComponentName,\r
f3d08ccf	570	&gPs2KeyboardComponentName2\r
c21fc3e8	571	);\r
	572	ASSERT_EFI_ERROR (Status);\r
	573	\r
	574	\r
	575	return Status;\r
	576	}\r
bcd70414	577	\r