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
);
231 if ((Data
& KBC_SYSF
) != KBC_SYSF
) {
232 Status
= KbcSelfTest (IsaIo
);
233 if (EFI_ERROR (Status
)) {
234 StatusCode
= EFI_PERIPHERAL_MOUSE
| EFI_P_EC_CONTROLLER_ERROR
;
239 KbcEnableAux (IsaIo
);
241 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
243 EFI_PERIPHERAL_MOUSE
| EFI_P_PC_PRESENCE_DETECT
,
250 Status
= MouseDev
->SimplePointerProtocol
.Reset (&MouseDev
->SimplePointerProtocol
, TRUE
);
251 if (EFI_ERROR (Status
)) {
253 // mouse not connected
255 Status
= EFI_SUCCESS
;
256 StatusCode
= EFI_PERIPHERAL_MOUSE
| EFI_P_EC_NOT_DETECTED
;
260 // Setup the WaitForKey event
262 Status
= gBS
->CreateEvent (
267 &((MouseDev
->SimplePointerProtocol
).WaitForInput
)
269 if (EFI_ERROR (Status
)) {
270 Status
= EFI_OUT_OF_RESOURCES
;
274 // Setup a periodic timer, used to poll mouse state
276 Status
= gBS
->CreateEvent (
277 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
281 &MouseDev
->TimerEvent
283 if (EFI_ERROR (Status
)) {
284 Status
= EFI_OUT_OF_RESOURCES
;
288 // Start timer to poll mouse (100 samples per second)
290 Status
= gBS
->SetTimer (MouseDev
->TimerEvent
, TimerPeriodic
, 100000);
291 if (EFI_ERROR (Status
)) {
292 Status
= EFI_OUT_OF_RESOURCES
;
296 MouseDev
->ControllerNameTable
= NULL
;
299 gPs2MouseComponentName
.SupportedLanguages
,
300 &MouseDev
->ControllerNameTable
,
301 L
"PS/2 Mouse Device",
306 gPs2MouseComponentName2
.SupportedLanguages
,
307 &MouseDev
->ControllerNameTable
,
308 L
"PS/2 Mouse Device",
314 // Install protocol interfaces for the mouse device.
316 Status
= gBS
->InstallMultipleProtocolInterfaces (
318 &gEfiSimplePointerProtocolGuid
,
319 &MouseDev
->SimplePointerProtocol
,
322 if (EFI_ERROR (Status
)) {
326 gBS
->RestoreTPL (OldTpl
);
332 KbcDisableAux (IsaIo
);
334 if (StatusCode
!= 0) {
335 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
336 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
342 if ((MouseDev
!= NULL
) && (MouseDev
->SimplePointerProtocol
.WaitForInput
!= NULL
)) {
343 gBS
->CloseEvent (MouseDev
->SimplePointerProtocol
.WaitForInput
);
346 if ((MouseDev
!= NULL
) && (MouseDev
->TimerEvent
!= NULL
)) {
347 gBS
->CloseEvent (MouseDev
->TimerEvent
);
350 if ((MouseDev
!= NULL
) && (MouseDev
->ControllerNameTable
!= NULL
)) {
351 FreeUnicodeStringTable (MouseDev
->ControllerNameTable
);
354 // Since there will be no timer handler for mouse input any more,
355 // exhaust input data just in case there is still mouse data left
357 EmptyStatus
= EFI_SUCCESS
;
358 while (!EFI_ERROR (EmptyStatus
)) {
359 EmptyStatus
= In8042Data (IsaIo
, &Data
);
362 if (MouseDev
!= NULL
) {
363 gBS
->FreePool (MouseDev
);
368 &gEfiDevicePathProtocolGuid
,
369 This
->DriverBindingHandle
,
375 &gEfiIsaIoProtocolGuid
,
376 This
->DriverBindingHandle
,
380 gBS
->RestoreTPL (OldTpl
);
386 Stop this driver on ControllerHandle. Support stoping any child handles
387 created by this driver.
389 @param This Protocol instance pointer.
390 @param ControllerHandle Handle of device to stop driver on
391 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
392 children is zero stop the entire bus driver.
393 @param ChildHandleBuffer List of Child Handles to Stop.
395 @retval EFI_SUCCESS This driver is removed ControllerHandle
396 @retval other This driver was not removed from this device
402 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
403 IN EFI_HANDLE Controller
,
404 IN UINTN NumberOfChildren
,
405 IN EFI_HANDLE
*ChildHandleBuffer
409 EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointerProtocol
;
410 PS2_MOUSE_DEV
*MouseDev
;
413 Status
= gBS
->OpenProtocol (
415 &gEfiSimplePointerProtocolGuid
,
416 (VOID
**) &SimplePointerProtocol
,
417 This
->DriverBindingHandle
,
419 EFI_OPEN_PROTOCOL_GET_PROTOCOL
421 if (EFI_ERROR (Status
)) {
425 MouseDev
= PS2_MOUSE_DEV_FROM_THIS (SimplePointerProtocol
);
428 // Report that the keyboard is being disabled
430 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
432 EFI_PERIPHERAL_MOUSE
| EFI_P_PC_DISABLE
,
436 Status
= gBS
->UninstallProtocolInterface (
438 &gEfiSimplePointerProtocolGuid
,
439 &MouseDev
->SimplePointerProtocol
441 if (EFI_ERROR (Status
)) {
445 // Disable mouse on keyboard controller
447 KbcDisableAux (MouseDev
->IsaIo
);
450 // Cancel mouse data polling timer, close timer event
452 gBS
->SetTimer (MouseDev
->TimerEvent
, TimerCancel
, 0);
453 gBS
->CloseEvent (MouseDev
->TimerEvent
);
456 // Since there will be no timer handler for mouse input any more,
457 // exhaust input data just in case there is still mouse data left
459 Status
= EFI_SUCCESS
;
460 while (!EFI_ERROR (Status
)) {
461 Status
= In8042Data (MouseDev
->IsaIo
, &Data
);
464 gBS
->CloseEvent (MouseDev
->SimplePointerProtocol
.WaitForInput
);
465 FreeUnicodeStringTable (MouseDev
->ControllerNameTable
);
466 gBS
->FreePool (MouseDev
);
470 &gEfiDevicePathProtocolGuid
,
471 This
->DriverBindingHandle
,
477 &gEfiIsaIoProtocolGuid
,
478 This
->DriverBindingHandle
,
486 Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system
488 @param This - Pointer of simple pointer Protocol.
489 @param ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.
492 @retval EFI_SUCCESS - The command byte is written successfully.
493 @retval EFI_DEVICE_ERROR - Errors occurred during reseting keyboard.
499 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
500 IN BOOLEAN ExtendedVerification
504 PS2_MOUSE_DEV
*MouseDev
;
506 BOOLEAN KeyboardEnable
;
509 MouseDev
= PS2_MOUSE_DEV_FROM_THIS (This
);
512 // Report reset progress code
514 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
516 EFI_PERIPHERAL_MOUSE
| EFI_P_PC_RESET
,
520 KeyboardEnable
= FALSE
;
523 // Raise TPL to avoid keyboard operation impact
525 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
527 ZeroMem (&MouseDev
->State
, sizeof (EFI_SIMPLE_POINTER_STATE
));
528 MouseDev
->StateChanged
= FALSE
;
531 // Exhaust input data
533 Status
= EFI_SUCCESS
;
534 while (!EFI_ERROR (Status
)) {
535 Status
= In8042Data (MouseDev
->IsaIo
, &Data
);
538 CheckKbStatus (MouseDev
->IsaIo
, &KeyboardEnable
);
540 KbcDisableKb (MouseDev
->IsaIo
);
542 MouseDev
->IsaIo
->Io
.Read (MouseDev
->IsaIo
, EfiIsaIoWidthUint8
, KBC_CMD_STS_PORT
, 1, &Data
);
545 // if there's data block on KBC data port, read it out
547 if ((Data
& KBC_OUTB
) == KBC_OUTB
) {
548 MouseDev
->IsaIo
->Io
.Read (MouseDev
->IsaIo
, EfiIsaIoWidthUint8
, KBC_DATA_PORT
, 1, &Data
);
551 Status
= EFI_SUCCESS
;
553 // The PS2 mouse driver reset behavior is always successfully return no matter wheater or not there is mouse connected to system.
554 // This behavior is needed by performance speed. The following mouse command only succeessfully finish when mouse device is
555 // connected to system, so if PS2 mouse device not connect to system or user not ask for, we skip the mouse configuration and enabling
557 if (ExtendedVerification
&& CheckMouseConnect (MouseDev
)) {
559 // Send mouse reset command and set mouse default configure
561 Status
= PS2MouseReset (MouseDev
->IsaIo
);
562 if (EFI_ERROR (Status
)) {
563 Status
= EFI_DEVICE_ERROR
;
567 Status
= PS2MouseSetSampleRate (MouseDev
->IsaIo
, MouseDev
->SampleRate
);
568 if (EFI_ERROR (Status
)) {
569 Status
= EFI_DEVICE_ERROR
;
573 Status
= PS2MouseSetResolution (MouseDev
->IsaIo
, MouseDev
->Resolution
);
574 if (EFI_ERROR (Status
)) {
575 Status
= EFI_DEVICE_ERROR
;
579 Status
= PS2MouseSetScaling (MouseDev
->IsaIo
, MouseDev
->Scaling
);
580 if (EFI_ERROR (Status
)) {
581 Status
= EFI_DEVICE_ERROR
;
585 Status
= PS2MouseEnable (MouseDev
->IsaIo
);
586 if (EFI_ERROR (Status
)) {
587 Status
= EFI_DEVICE_ERROR
;
592 gBS
->RestoreTPL (OldTpl
);
594 if (KeyboardEnable
) {
595 KbcEnableKb (MouseDev
->IsaIo
);
602 Check whether there is Ps/2 mouse device in system
604 @param PS2_MOUSE_DEV - Mouse Private Data Structure
606 @retval TRUE - Keyboard in System.
607 @retval FALSE - Keyboard not in System.
612 IN PS2_MOUSE_DEV
*MouseDev
618 Status
= PS2MouseEnable (MouseDev
->IsaIo
);
619 if (!EFI_ERROR (Status
)) {
627 Get and Clear mouse status.
629 @param This - Pointer of simple pointer Protocol.
630 @param State - Output buffer holding status.
632 @retval EFI_INVALID_PARAMETER Output buffer is invalid.
633 @retval EFI_NOT_READY Mouse is not changed status yet.
634 @retval EFI_SUCCESS Mouse status is changed and get successful.
639 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
640 IN OUT EFI_SIMPLE_POINTER_STATE
*State
643 PS2_MOUSE_DEV
*MouseDev
;
646 MouseDev
= PS2_MOUSE_DEV_FROM_THIS (This
);
649 return EFI_INVALID_PARAMETER
;
652 if (!MouseDev
->StateChanged
) {
653 return EFI_NOT_READY
;
656 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
657 CopyMem (State
, &(MouseDev
->State
), sizeof (EFI_SIMPLE_POINTER_STATE
));
662 MouseDev
->State
.RelativeMovementX
= 0;
663 MouseDev
->State
.RelativeMovementY
= 0;
664 MouseDev
->State
.RelativeMovementZ
= 0;
665 MouseDev
->StateChanged
= FALSE
;
666 gBS
->RestoreTPL (OldTpl
);
673 Event notification function for SIMPLE_POINTER.WaitForInput event
674 Signal the event if there is input from mouse
676 @param Event event object
677 @param Context event context
687 // GC_TODO: Event - add argument and description to function comment
688 // GC_TODO: Context - add argument and description to function comment
690 PS2_MOUSE_DEV
*MouseDev
;
692 MouseDev
= (PS2_MOUSE_DEV
*) Context
;
695 // Someone is waiting on the mouse event, if there's
696 // input from mouse, signal the event
698 if (MouseDev
->StateChanged
) {
699 gBS
->SignalEvent (Event
);
705 Event notification function for TimerEvent event
706 If mouse device is connected to system, try to get the mouse packet data
708 @param Event - TimerEvent in PS2_MOUSE_DEV
709 @param Context - Pointer to PS2_MOUSE_DEV structure
720 PS2_MOUSE_DEV
*MouseDev
;
722 MouseDev
= (PS2_MOUSE_DEV
*) Context
;
725 // Polling mouse packet data
727 PS2MouseGetPacket (MouseDev
);
731 The user Entry Point for module Ps2Mouse. The user code starts with this function.
733 @param[in] ImageHandle The firmware allocated handle for the EFI image.
734 @param[in] SystemTable A pointer to the EFI System Table.
736 @retval EFI_SUCCESS The entry point is executed successfully.
737 @retval other Some error occurs when executing this entry point.
743 IN EFI_HANDLE ImageHandle
,
744 IN EFI_SYSTEM_TABLE
*SystemTable
750 // Install driver model protocol(s).
752 Status
= EfiLibInstallDriverBindingComponentName2 (
757 &gPs2MouseComponentName
,
758 &gPs2MouseComponentName2
760 ASSERT_EFI_ERROR (Status
);