2 PS/2 Mouse driver. Routines that interacts with callers,
3 conforming to EFI driver model
5 Copyright (c) 2006 - 2007, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 // DriverBinding Protocol Instance
22 EFI_DRIVER_BINDING_PROTOCOL gPS2MouseDriver
= {
23 PS2MouseDriverSupported
,
32 Test to see if this driver supports ControllerHandle. Any ControllerHandle
33 than contains a IsaIo protocol can be supported.
35 @param This Protocol instance pointer.
36 @param ControllerHandle Handle of device to test
37 @param RemainingDevicePath Optional parameter use to pick a specific child
40 @retval EFI_SUCCESS This driver supports this device
41 @retval EFI_ALREADY_STARTED This driver is already running on this device
42 @retval other This driver does not support this device
47 PS2MouseDriverSupported (
48 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
49 IN EFI_HANDLE Controller
,
50 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
54 EFI_ISA_IO_PROTOCOL
*IsaIo
;
59 // Open the IO Abstraction(s) needed to perform the supported test
61 Status
= gBS
->OpenProtocol (
63 &gEfiIsaIoProtocolGuid
,
65 This
->DriverBindingHandle
,
67 EFI_OPEN_PROTOCOL_BY_DRIVER
69 if (EFI_ERROR (Status
)) {
73 // Use the ISA I/O Protocol to see if Controller is the Keyboard controller
75 switch (IsaIo
->ResourceList
->Device
.HID
) {
76 case EISA_PNP_ID (0xF03):
78 // Microsoft PS/2 style mouse
80 case EISA_PNP_ID (0xF13):
82 // PS/2 Port for PS/2-style Mice
86 case EISA_PNP_ID (0x303):
88 // IBM Enhanced (101/102-key, PS/2 mouse support)
90 if (IsaIo
->ResourceList
->Device
.UID
== 1) {
95 Status
= EFI_UNSUPPORTED
;
99 // Close the I/O Abstraction(s) used to perform the supported test
103 &gEfiIsaIoProtocolGuid
,
104 This
->DriverBindingHandle
,
112 Start this driver on ControllerHandle by opening a IsaIo
113 protocol, creating PS2_MOUSE_ABSOLUTE_POINTER_DEV device and install gEfiAbsolutePointerProtocolGuid
116 @param This Protocol instance pointer.
117 @param ControllerHandle Handle of device to bind driver to
118 @param RemainingDevicePath Optional parameter use to pick a specific child
121 @retval EFI_SUCCESS This driver is added to ControllerHandle
122 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
123 @retval other This driver does not support this device
128 PS2MouseDriverStart (
129 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
130 IN EFI_HANDLE Controller
,
131 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
135 EFI_STATUS EmptyStatus
;
136 EFI_ISA_IO_PROTOCOL
*IsaIo
;
137 PS2_MOUSE_DEV
*MouseDev
;
140 EFI_STATUS_CODE_VALUE StatusCode
;
141 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
148 // Open the device path protocol
150 Status
= gBS
->OpenProtocol (
152 &gEfiDevicePathProtocolGuid
,
153 (VOID
**) &ParentDevicePath
,
154 This
->DriverBindingHandle
,
156 EFI_OPEN_PROTOCOL_BY_DRIVER
158 if (EFI_ERROR (Status
)) {
162 // Report that the keyboard is being enabled
164 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
166 EFI_PERIPHERAL_MOUSE
| EFI_P_PC_ENABLE
,
171 // Get the ISA I/O Protocol on Controller's handle
173 Status
= gBS
->OpenProtocol (
175 &gEfiIsaIoProtocolGuid
,
177 This
->DriverBindingHandle
,
179 EFI_OPEN_PROTOCOL_BY_DRIVER
181 if (EFI_ERROR (Status
)) {
184 &gEfiDevicePathProtocolGuid
,
185 This
->DriverBindingHandle
,
188 return EFI_INVALID_PARAMETER
;
191 // Raise TPL to avoid keyboard operation impact
193 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
196 // Allocate private data
198 MouseDev
= AllocateZeroPool (sizeof (PS2_MOUSE_DEV
));
199 if (MouseDev
== NULL
) {
200 Status
= EFI_OUT_OF_RESOURCES
;
204 // Setup the device instance
206 MouseDev
->Signature
= PS2_MOUSE_DEV_SIGNATURE
;
207 MouseDev
->Handle
= Controller
;
208 MouseDev
->SampleRate
= SSR_20
;
209 MouseDev
->Resolution
= CMR4
;
210 MouseDev
->Scaling
= SF1
;
211 MouseDev
->DataPackageSize
= 3;
212 MouseDev
->IsaIo
= IsaIo
;
213 MouseDev
->DevicePath
= ParentDevicePath
;
216 // Resolution = 4 counts/mm
218 MouseDev
->Mode
.ResolutionX
= 4;
219 MouseDev
->Mode
.ResolutionY
= 4;
220 MouseDev
->Mode
.LeftButton
= TRUE
;
221 MouseDev
->Mode
.RightButton
= TRUE
;
223 MouseDev
->SimplePointerProtocol
.Reset
= MouseReset
;
224 MouseDev
->SimplePointerProtocol
.GetState
= MouseGetState
;
225 MouseDev
->SimplePointerProtocol
.Mode
= &(MouseDev
->Mode
);
228 // Initialize keyboard controller if necessary
230 IsaIo
->Io
.Read (IsaIo
, EfiIsaIoWidthUint8
, KBC_CMD_STS_PORT
, 1, &Data
);
232 // Fix for random hangs in System waiting for the Key if no KBC is present in BIOS.
234 if ((Data
& (KBC_PARE
| KBC_TIM
)) == (KBC_PARE
| KBC_TIM
)) {
236 // If nobody decodes KBC I/O port, it will read back as 0xFF.
237 // Check the Time-Out and Parity bit to see if it has an active KBC in system
239 Status
= EFI_DEVICE_ERROR
;
240 StatusCode
= EFI_PERIPHERAL_MOUSE
| EFI_P_EC_NOT_DETECTED
;
243 if ((Data
& KBC_SYSF
) != KBC_SYSF
) {
244 Status
= KbcSelfTest (IsaIo
);
245 if (EFI_ERROR (Status
)) {
246 StatusCode
= EFI_PERIPHERAL_MOUSE
| EFI_P_EC_CONTROLLER_ERROR
;
251 KbcEnableAux (IsaIo
);
253 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
255 EFI_PERIPHERAL_MOUSE
| EFI_P_PC_PRESENCE_DETECT
,
262 Status
= MouseDev
->SimplePointerProtocol
.Reset (&MouseDev
->SimplePointerProtocol
, TRUE
);
263 if (EFI_ERROR (Status
)) {
265 // mouse not connected
267 Status
= EFI_SUCCESS
;
268 StatusCode
= EFI_PERIPHERAL_MOUSE
| EFI_P_EC_NOT_DETECTED
;
272 // Setup the WaitForKey event
274 Status
= gBS
->CreateEvent (
279 &((MouseDev
->SimplePointerProtocol
).WaitForInput
)
281 if (EFI_ERROR (Status
)) {
282 Status
= EFI_OUT_OF_RESOURCES
;
286 // Setup a periodic timer, used to poll mouse state
288 Status
= gBS
->CreateEvent (
289 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
293 &MouseDev
->TimerEvent
295 if (EFI_ERROR (Status
)) {
296 Status
= EFI_OUT_OF_RESOURCES
;
300 // Start timer to poll mouse (100 samples per second)
302 Status
= gBS
->SetTimer (MouseDev
->TimerEvent
, TimerPeriodic
, 100000);
303 if (EFI_ERROR (Status
)) {
304 Status
= EFI_OUT_OF_RESOURCES
;
308 MouseDev
->ControllerNameTable
= NULL
;
311 gPs2MouseComponentName
.SupportedLanguages
,
312 &MouseDev
->ControllerNameTable
,
313 L
"PS/2 Mouse Device",
318 gPs2MouseComponentName2
.SupportedLanguages
,
319 &MouseDev
->ControllerNameTable
,
320 L
"PS/2 Mouse Device",
326 // Install protocol interfaces for the mouse device.
328 Status
= gBS
->InstallMultipleProtocolInterfaces (
330 &gEfiSimplePointerProtocolGuid
,
331 &MouseDev
->SimplePointerProtocol
,
334 if (EFI_ERROR (Status
)) {
338 gBS
->RestoreTPL (OldTpl
);
344 if (Status
!= EFI_DEVICE_ERROR
) {
345 KbcDisableAux (IsaIo
);
348 if (StatusCode
!= 0) {
349 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
350 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
356 if ((MouseDev
!= NULL
) && (MouseDev
->SimplePointerProtocol
.WaitForInput
!= NULL
)) {
357 gBS
->CloseEvent (MouseDev
->SimplePointerProtocol
.WaitForInput
);
360 if ((MouseDev
!= NULL
) && (MouseDev
->TimerEvent
!= NULL
)) {
361 gBS
->CloseEvent (MouseDev
->TimerEvent
);
364 if ((MouseDev
!= NULL
) && (MouseDev
->ControllerNameTable
!= NULL
)) {
365 FreeUnicodeStringTable (MouseDev
->ControllerNameTable
);
368 if (Status
!= EFI_DEVICE_ERROR
) {
370 // Since there will be no timer handler for mouse input any more,
371 // exhaust input data just in case there is still mouse data left
373 EmptyStatus
= EFI_SUCCESS
;
374 while (!EFI_ERROR (EmptyStatus
)) {
375 EmptyStatus
= In8042Data (IsaIo
, &Data
);
379 if (MouseDev
!= NULL
) {
380 gBS
->FreePool (MouseDev
);
385 &gEfiDevicePathProtocolGuid
,
386 This
->DriverBindingHandle
,
392 &gEfiIsaIoProtocolGuid
,
393 This
->DriverBindingHandle
,
397 gBS
->RestoreTPL (OldTpl
);
403 Stop this driver on ControllerHandle. Support stoping any child handles
404 created by this driver.
406 @param This Protocol instance pointer.
407 @param ControllerHandle Handle of device to stop driver on
408 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
409 children is zero stop the entire bus driver.
410 @param ChildHandleBuffer List of Child Handles to Stop.
412 @retval EFI_SUCCESS This driver is removed ControllerHandle
413 @retval other This driver was not removed from this device
419 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
420 IN EFI_HANDLE Controller
,
421 IN UINTN NumberOfChildren
,
422 IN EFI_HANDLE
*ChildHandleBuffer
426 EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointerProtocol
;
427 PS2_MOUSE_DEV
*MouseDev
;
430 Status
= gBS
->OpenProtocol (
432 &gEfiSimplePointerProtocolGuid
,
433 (VOID
**) &SimplePointerProtocol
,
434 This
->DriverBindingHandle
,
436 EFI_OPEN_PROTOCOL_GET_PROTOCOL
438 if (EFI_ERROR (Status
)) {
442 MouseDev
= PS2_MOUSE_DEV_FROM_THIS (SimplePointerProtocol
);
445 // Report that the keyboard is being disabled
447 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
449 EFI_PERIPHERAL_MOUSE
| EFI_P_PC_DISABLE
,
453 Status
= gBS
->UninstallProtocolInterface (
455 &gEfiSimplePointerProtocolGuid
,
456 &MouseDev
->SimplePointerProtocol
458 if (EFI_ERROR (Status
)) {
462 // Disable mouse on keyboard controller
464 KbcDisableAux (MouseDev
->IsaIo
);
467 // Cancel mouse data polling timer, close timer event
469 gBS
->SetTimer (MouseDev
->TimerEvent
, TimerCancel
, 0);
470 gBS
->CloseEvent (MouseDev
->TimerEvent
);
473 // Since there will be no timer handler for mouse input any more,
474 // exhaust input data just in case there is still mouse data left
476 Status
= EFI_SUCCESS
;
477 while (!EFI_ERROR (Status
)) {
478 Status
= In8042Data (MouseDev
->IsaIo
, &Data
);
481 gBS
->CloseEvent (MouseDev
->SimplePointerProtocol
.WaitForInput
);
482 FreeUnicodeStringTable (MouseDev
->ControllerNameTable
);
483 gBS
->FreePool (MouseDev
);
487 &gEfiDevicePathProtocolGuid
,
488 This
->DriverBindingHandle
,
494 &gEfiIsaIoProtocolGuid
,
495 This
->DriverBindingHandle
,
503 Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system
505 @param This - Pointer of simple pointer Protocol.
506 @param ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.
509 @retval EFI_SUCCESS - The command byte is written successfully.
510 @retval EFI_DEVICE_ERROR - Errors occurred during reseting keyboard.
516 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
517 IN BOOLEAN ExtendedVerification
521 PS2_MOUSE_DEV
*MouseDev
;
523 BOOLEAN KeyboardEnable
;
526 MouseDev
= PS2_MOUSE_DEV_FROM_THIS (This
);
529 // Report reset progress code
531 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
533 EFI_PERIPHERAL_MOUSE
| EFI_P_PC_RESET
,
537 KeyboardEnable
= FALSE
;
540 // Raise TPL to avoid keyboard operation impact
542 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
544 ZeroMem (&MouseDev
->State
, sizeof (EFI_SIMPLE_POINTER_STATE
));
545 MouseDev
->StateChanged
= FALSE
;
548 // Exhaust input data
550 Status
= EFI_SUCCESS
;
551 while (!EFI_ERROR (Status
)) {
552 Status
= In8042Data (MouseDev
->IsaIo
, &Data
);
555 CheckKbStatus (MouseDev
->IsaIo
, &KeyboardEnable
);
557 KbcDisableKb (MouseDev
->IsaIo
);
559 MouseDev
->IsaIo
->Io
.Read (MouseDev
->IsaIo
, EfiIsaIoWidthUint8
, KBC_CMD_STS_PORT
, 1, &Data
);
562 // if there's data block on KBC data port, read it out
564 if ((Data
& KBC_OUTB
) == KBC_OUTB
) {
565 MouseDev
->IsaIo
->Io
.Read (MouseDev
->IsaIo
, EfiIsaIoWidthUint8
, KBC_DATA_PORT
, 1, &Data
);
568 Status
= EFI_SUCCESS
;
570 // The PS2 mouse driver reset behavior is always successfully return no matter wheater or not there is mouse connected to system.
571 // This behavior is needed by performance speed. The following mouse command only succeessfully finish when mouse device is
572 // connected to system, so if PS2 mouse device not connect to system or user not ask for, we skip the mouse configuration and enabling
574 if (ExtendedVerification
&& CheckMouseConnect (MouseDev
)) {
576 // Send mouse reset command and set mouse default configure
578 Status
= PS2MouseReset (MouseDev
->IsaIo
);
579 if (EFI_ERROR (Status
)) {
580 Status
= EFI_DEVICE_ERROR
;
584 Status
= PS2MouseSetSampleRate (MouseDev
->IsaIo
, MouseDev
->SampleRate
);
585 if (EFI_ERROR (Status
)) {
586 Status
= EFI_DEVICE_ERROR
;
590 Status
= PS2MouseSetResolution (MouseDev
->IsaIo
, MouseDev
->Resolution
);
591 if (EFI_ERROR (Status
)) {
592 Status
= EFI_DEVICE_ERROR
;
596 Status
= PS2MouseSetScaling (MouseDev
->IsaIo
, MouseDev
->Scaling
);
597 if (EFI_ERROR (Status
)) {
598 Status
= EFI_DEVICE_ERROR
;
602 Status
= PS2MouseEnable (MouseDev
->IsaIo
);
603 if (EFI_ERROR (Status
)) {
604 Status
= EFI_DEVICE_ERROR
;
609 gBS
->RestoreTPL (OldTpl
);
611 if (KeyboardEnable
) {
612 KbcEnableKb (MouseDev
->IsaIo
);
619 Check whether there is Ps/2 mouse device in system
621 @param MouseDev - Mouse Private Data Structure
623 @retval TRUE - Keyboard in System.
624 @retval FALSE - Keyboard not in System.
629 IN PS2_MOUSE_DEV
*MouseDev
635 Status
= PS2MouseEnable (MouseDev
->IsaIo
);
636 if (!EFI_ERROR (Status
)) {
644 Get and Clear mouse status.
646 @param This - Pointer of simple pointer Protocol.
647 @param State - Output buffer holding status.
649 @retval EFI_INVALID_PARAMETER Output buffer is invalid.
650 @retval EFI_NOT_READY Mouse is not changed status yet.
651 @retval EFI_SUCCESS Mouse status is changed and get successful.
656 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
657 IN OUT EFI_SIMPLE_POINTER_STATE
*State
660 PS2_MOUSE_DEV
*MouseDev
;
663 MouseDev
= PS2_MOUSE_DEV_FROM_THIS (This
);
666 return EFI_INVALID_PARAMETER
;
669 if (!MouseDev
->StateChanged
) {
670 return EFI_NOT_READY
;
673 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
674 CopyMem (State
, &(MouseDev
->State
), sizeof (EFI_SIMPLE_POINTER_STATE
));
679 MouseDev
->State
.RelativeMovementX
= 0;
680 MouseDev
->State
.RelativeMovementY
= 0;
681 MouseDev
->State
.RelativeMovementZ
= 0;
682 MouseDev
->StateChanged
= FALSE
;
683 gBS
->RestoreTPL (OldTpl
);
690 Event notification function for SIMPLE_POINTER.WaitForInput event.
691 Signal the event if there is input from mouse.
693 @param Event event object
694 @param Context event context
704 PS2_MOUSE_DEV
*MouseDev
;
706 MouseDev
= (PS2_MOUSE_DEV
*) Context
;
709 // Someone is waiting on the mouse event, if there's
710 // input from mouse, signal the event
712 if (MouseDev
->StateChanged
) {
713 gBS
->SignalEvent (Event
);
719 Event notification function for TimerEvent event.
720 If mouse device is connected to system, try to get the mouse packet data.
722 @param Event - TimerEvent in PS2_MOUSE_DEV
723 @param Context - Pointer to PS2_MOUSE_DEV structure
734 PS2_MOUSE_DEV
*MouseDev
;
736 MouseDev
= (PS2_MOUSE_DEV
*) Context
;
739 // Polling mouse packet data
741 PS2MouseGetPacket (MouseDev
);
745 The user Entry Point for module Ps2Mouse. The user code starts with this function.
747 @param[in] ImageHandle The firmware allocated handle for the EFI image.
748 @param[in] SystemTable A pointer to the EFI System Table.
750 @retval EFI_SUCCESS The entry point is executed successfully.
751 @retval other Some error occurs when executing this entry point.
757 IN EFI_HANDLE ImageHandle
,
758 IN EFI_SYSTEM_TABLE
*SystemTable
764 // Install driver model protocol(s).
766 Status
= EfiLibInstallDriverBindingComponentName2 (
771 &gPs2MouseComponentName
,
772 &gPs2MouseComponentName2
774 ASSERT_EFI_ERROR (Status
);